| <!DOCTYPE html> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="generator" content="pandoc" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> |
| <title>Testing the JDK</title> |
| <style type="text/css"> |
| code{white-space: pre-wrap;} |
| span.smallcaps{font-variant: small-caps;} |
| span.underline{text-decoration: underline;} |
| div.column{display: inline-block; vertical-align: top; width: 50%;} |
| </style> |
| <link rel="stylesheet" href="../make/data/docs-resources/resources/jdk-default.css"> |
| <!--[if lt IE 9]> |
| <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> |
| <![endif]--> |
| <style type="text/css">pre, code, tt { color: #1d6ae5; }</style> |
| </head> |
| <body> |
| <header> |
| <h1 class="title">Testing the JDK</h1> |
| </header> |
| <nav id="TOC"> |
| <ul> |
| <li><a href="#using-the-run-test-framework">Using the run-test framework</a><ul> |
| <li><a href="#configuration">Configuration</a></li> |
| </ul></li> |
| <li><a href="#test-selection">Test selection</a><ul> |
| <li><a href="#jtreg">JTReg</a></li> |
| <li><a href="#gtest">Gtest</a></li> |
| </ul></li> |
| <li><a href="#test-results-and-summary">Test results and summary</a></li> |
| <li><a href="#test-suite-control">Test suite control</a><ul> |
| <li><a href="#jtreg-keywords">JTReg keywords</a></li> |
| <li><a href="#gtest-keywords">Gtest keywords</a></li> |
| </ul></li> |
| <li><a href="#notes-for-specific-tests">Notes for Specific Tests</a><ul> |
| <li><a href="#docker-tests">Docker Tests</a></li> |
| </ul></li> |
| </ul> |
| </nav> |
| <h2 id="using-the-run-test-framework">Using the run-test framework</h2> |
| <p>This new way of running tests is developer-centric. It assumes that you have built a JDK locally and want to test it. Running common test targets is simple, and more complex ad-hoc combination of tests is possible. The user interface is forgiving, and clearly report errors it cannot resolve.</p> |
| <p>The main target “run-test” uses the jdk-image as the tested product. There is also an alternate target “exploded-run-test” that uses the exploded image instead. Not all tests will run successfully on the exploded image, but using this target can greatly improve rebuild times for certain workflows.</p> |
| <p>Some example command-lines:</p> |
| <pre><code>$ make run-test-tier1 |
| $ make run-test-jdk_lang JTREG="JOBS=8" |
| $ make run-test TEST=jdk_lang |
| $ make run-test-only TEST="gtest:LogTagSet gtest:LogTagSetDescriptions" GTEST="REPEAT=-1" |
| $ make run-test TEST="hotspot:hotspot_gc" JTREG="JOBS=1;TIMEOUT=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug" |
| $ make run-test TEST="jtreg:test/hotspot:hotspot_gc test/hotspot/jtreg/native_sanity/JniVersion.java" |
| $ make exploded-run-test TEST=tier2</code></pre> |
| <h3 id="configuration">Configuration</h3> |
| <p>To be able to run JTReg tests, <code>configure</code> needs to know where to find the JTReg test framework. If it is not picked up automatically by configure, use the <code>--with-jtreg=<path to jtreg home></code> option to point to the JTReg framework. Note that this option should point to the JTReg home, i.e. the top directory, containing <code>lib/jtreg.jar</code> etc. (An alternative is to set the <code>JT_HOME</code> environment variable to point to the JTReg home before running <code>configure</code>.)</p> |
| <h2 id="test-selection">Test selection</h2> |
| <p>All functionality is available using the run-test make target. In this use case, the test or tests to be executed is controlled using the <code>TEST</code> variable. To speed up subsequent test runs with no source code changes, run-test-only can be used instead, which do not depend on the source and test image build.</p> |
| <p>For some common top-level tests, direct make targets have been generated. This includes all JTReg test groups, the hotspot gtest, and custom tests (if present). This means that <code>make run-test-tier1</code> is equivalent to <code>make run-test TEST="tier1"</code>, but the latter is more tab-completion friendly. For more complex test runs, the <code>run-test TEST="x"</code> solution needs to be used.</p> |
| <p>The test specifications given in <code>TEST</code> is parsed into fully qualified test descriptors, which clearly and unambigously show which tests will be run. As an example, <code>:tier1</code> will expand to <code>jtreg:$(TOPDIR)/test/hotspot/jtreg:tier1 jtreg:$(TOPDIR)/test/jdk:tier1 jtreg:$(TOPDIR)/test/langtools:tier1 jtreg:$(TOPDIR)/test/nashorn:tier1 jtreg:$(TOPDIR)/test/jaxp:tier1</code>. You can always submit a list of fully qualified test descriptors in the <code>TEST</code> variable if you want to shortcut the parser.</p> |
| <h3 id="jtreg">JTReg</h3> |
| <p>JTReg tests can be selected either by picking a JTReg test group, or a selection of files or directories containing JTReg tests.</p> |
| <p>JTReg test groups can be specified either without a test root, e.g. <code>:tier1</code> (or <code>tier1</code>, the initial colon is optional), or with, e.g. <code>hotspot:tier1</code>, <code>test/jdk:jdk_util</code> or <code>$(TOPDIR)/test/hotspot/jtreg:hotspot_all</code>. The test root can be specified either as an absolute path, or a path relative to the JDK top directory, or the <code>test</code> directory. For simplicity, the hotspot JTReg test root, which really is <code>hotspot/jtreg</code> can be abbreviated as just <code>hotspot</code>.</p> |
| <p>When specified without a test root, all matching groups from all test roots will be added. Otherwise, only the group from the specified test root will be added.</p> |
| <p>Individual JTReg tests or directories containing JTReg tests can also be specified, like <code>test/hotspot/jtreg/native_sanity/JniVersion.java</code> or <code>hotspot/jtreg/native_sanity</code>. Just like for test root selection, you can either specify an absolute path (which can even point to JTReg tests outside the source tree), or a path relative to either the JDK top directory or the <code>test</code> directory. <code>hotspot</code> can be used as an alias for <code>hotspot/jtreg</code> here as well.</p> |
| <p>As long as the test groups or test paths can be uniquely resolved, you do not need to enter the <code>jtreg:</code> prefix. If this is not possible, or if you want to use a fully qualified test descriptor, add <code>jtreg:</code>, e.g. <code>jtreg:test/hotspot/jtreg/native_sanity</code>.</p> |
| <h3 id="gtest">Gtest</h3> |
| <p>Since the Hotspot Gtest suite is so quick, the default is to run all tests. This is specified by just <code>gtest</code>, or as a fully qualified test descriptor <code>gtest:all</code>.</p> |
| <p>If you want, you can single out an individual test or a group of tests, for instance <code>gtest:LogDecorations</code> or <code>gtest:LogDecorations.level_test_vm</code>. This can be particularly useful if you want to run a shaky test repeatedly.</p> |
| <p>For Gtest, there is a separate test suite for each JVM variant. The JVM variant is defined by adding <code>/<variant></code> to the test descriptor, e.g. <code>gtest:Log/client</code>. If you specify no variant, gtest will run once for each JVM variant present (e.g. server, client). So if you only have the server JVM present, then <code>gtest:all</code> will be equivalent to <code>gtest:all/server</code>.</p> |
| <h2 id="test-results-and-summary">Test results and summary</h2> |
| <p>At the end of the test run, a summary of all tests run will be presented. This will have a consistent look, regardless of what test suites were used. This is a sample summary:</p> |
| <pre><code>============================== |
| Test summary |
| ============================== |
| TEST TOTAL PASS FAIL ERROR |
| >> jtreg:jdk/test:tier1 1867 1865 2 0 << |
| jtreg:langtools/test:tier1 4711 4711 0 0 |
| jtreg:nashorn/test:tier1 133 133 0 0 |
| ============================== |
| TEST FAILURE</code></pre> |
| <p>Tests where the number of TOTAL tests does not equal the number of PASSed tests will be considered a test failure. These are marked with the <code>>> ... <<</code> marker for easy identification.</p> |
| <p>The classification of non-passed tests differs a bit between test suites. In the summary, ERROR is used as a catch-all for tests that neither passed nor are classified as failed by the framework. This might indicate test framework error, timeout or other problems.</p> |
| <p>In case of test failures, <code>make run-test</code> will exit with a non-zero exit value.</p> |
| <p>All tests have their result stored in <code>build/$BUILD/test-results/$TEST_ID</code>, where TEST_ID is a path-safe conversion from the fully qualified test descriptor, e.g. for <code>jtreg:jdk/test:tier1</code> the TEST_ID is <code>jtreg_jdk_test_tier1</code>. This path is also printed in the log at the end of the test run.</p> |
| <p>Additional work data is stored in <code>build/$BUILD/test-support/$TEST_ID</code>. For some frameworks, this directory might contain information that is useful in determining the cause of a failed test.</p> |
| <h2 id="test-suite-control">Test suite control</h2> |
| <p>It is possible to control various aspects of the test suites using make control variables.</p> |
| <p>These variables use a keyword=value approach to allow multiple values to be set. So, for instance, <code>JTREG="JOBS=1;TIMEOUT=8"</code> will set the JTReg concurrency level to 1 and the timeout factor to 8. This is equivalent to setting <code>JTREG_JOBS=1 JTREG_TIMEOUT=8</code>, but using the keyword format means that the <code>JTREG</code> variable is parsed and verified for correctness, so <code>JTREG="TMIEOUT=8"</code> would give an error, while <code>JTREG_TMIEOUT=8</code> would just pass unnoticed.</p> |
| <p>To separate multiple keyword=value pairs, use <code>;</code> (semicolon). Since the shell normally eats <code>;</code>, the recommended usage is to write the assignment inside qoutes, e.g. <code>JTREG="...;..."</code>. This will also make sure spaces are preserved, as in <code>JTREG="VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug"</code>.</p> |
| <p>(Other ways are possible, e.g. using backslash: <code>JTREG=JOBS=1\;TIMEOUT=8</code>. Also, as a special technique, the string <code>%20</code> will be replaced with space for certain options, e.g. <code>JTREG=VM_OPTIONS=-XshowSettings%20-Xlog:gc+ref=debug</code>. This can be useful if you have layers of scripts and have trouble getting proper quoting of command line arguments through.)</p> |
| <p>As far as possible, the names of the keywords have been standardized between test suites.</p> |
| <h3 id="jtreg-keywords">JTReg keywords</h3> |
| <h4 id="jobs">JOBS</h4> |
| <p>The test concurrency (<code>-concurrency</code>).</p> |
| <p>Defaults to TEST_JOBS (if set by <code>--with-test-jobs=</code>), otherwise it defaults to JOBS, except for Hotspot, where the default is <em>number of CPU cores/2</em>, but never more than 12.</p> |
| <h4 id="timeout">TIMEOUT</h4> |
| <p>The timeout factor (<code>-timeoutFactor</code>).</p> |
| <p>Defaults to 4.</p> |
| <h4 id="test_mode">TEST_MODE</h4> |
| <p>The test mode (<code>-agentvm</code>, <code>-samevm</code> or <code>-othervm</code>).</p> |
| <p>Defaults to <code>-agentvm</code>.</p> |
| <h4 id="assert">ASSERT</h4> |
| <p>Enable asserts (<code>-ea -esa</code>, or none).</p> |
| <p>Set to <code>true</code> or <code>false</code>. If true, adds <code>-ea -esa</code>. Defaults to true, except for hotspot.</p> |
| <h4 id="verbose">VERBOSE</h4> |
| <p>The verbosity level (<code>-verbose</code>).</p> |
| <p>Defaults to <code>fail,error,summary</code>.</p> |
| <h4 id="retain">RETAIN</h4> |
| <p>What test data to retain (<code>-retain</code>).</p> |
| <p>Defaults to <code>fail,error</code>.</p> |
| <h4 id="max_mem">MAX_MEM</h4> |
| <p>Limit memory consumption (<code>-Xmx</code> and <code>-vmoption:-Xmx</code>, or none).</p> |
| <p>Limit memory consumption for JTReg test framework and VM under test. Set to 0 to disable the limits.</p> |
| <p>Defaults to 512m, except for hotspot, where it defaults to 0 (no limit).</p> |
| <h4 id="options">OPTIONS</h4> |
| <p>Additional options to the JTReg test framework.</p> |
| <p>Use <code>JTREG="OPTIONS=--help all"</code> to see all available JTReg options.</p> |
| <h4 id="java_options">JAVA_OPTIONS</h4> |
| <p>Additional Java options to JTReg (<code>-javaoption</code>).</p> |
| <h4 id="vm_options">VM_OPTIONS</h4> |
| <p>Additional VM options to JTReg (<code>-vmoption</code>).</p> |
| <h3 id="gtest-keywords">Gtest keywords</h3> |
| <h4 id="repeat">REPEAT</h4> |
| <p>The number of times to repeat the tests (<code>--gtest_repeat</code>).</p> |
| <p>Default is 1. Set to -1 to repeat indefinitely. This can be especially useful combined with <code>OPTIONS=--gtest_break_on_failure</code> to reproduce an intermittent problem.</p> |
| <h4 id="options-1">OPTIONS</h4> |
| <p>Additional options to the Gtest test framework.</p> |
| <p>Use <code>GTEST="OPTIONS=--help"</code> to see all available Gtest options.</p> |
| <h2 id="notes-for-specific-tests">Notes for Specific Tests</h2> |
| <h3 id="docker-tests">Docker Tests</h3> |
| <p>Docker tests with default parameters may fail on systems with glibc versions not compatible with the one used in the default docker image (e.g., Oracle Linux 7.6 for x86). For example, they pass on Ubuntu 16.04 but fail on Ubuntu 18.04 if run like this on x86:</p> |
| <pre><code>$ make run-test TEST="jtreg:test/hotspot/jtreg/containers/docker"</code></pre> |
| <p>To run these tests correctly, additional parameters for the correct docker image are required on Ubuntu 18.04 by using <code>JAVA_OPTIONS</code>.</p> |
| <pre><code>$ make run-test TEST="jtreg:test/hotspot/jtreg/containers/docker" JTREG="JAVA_OPTIONS=-Djdk.test.docker.image.name=ubuntu -Djdk.test.docker.image.version=latest"</code></pre> |
| </body> |
| </html> |
