annotate common/doc/testing.html @ 2689:1b1226687b89

Added tag jdk-9.0.4+12 for changeset 2e265b4b8622
author robm
date Wed, 14 Feb 2018 06:54:58 -0800
parents 8f7227c6012b
rev   line source
ihse@2591 1 <!DOCTYPE html>
ihse@2591 2 <html>
ihse@2536 3 <head>
ihse@2591 4 <meta charset="utf-8">
ihse@2591 5 <meta name="generator" content="pandoc">
ihse@2591 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
ihse@2536 7 <title>Testing OpenJDK</title>
ihse@2536 8 <style type="text/css">code{white-space: pre;}</style>
ihse@2619 9 <link rel="stylesheet" href="../../jdk/make/data/docs-resources/resources/jdk-default.css">
ihse@2591 10 <!--[if lt IE 9]>
ihse@2591 11 <script src="//"></script>
ihse@2591 12 <![endif]-->
ihse@2536 13 <style type="text/css">pre, code, tt { color: #1d6ae5; }</style>
ihse@2536 14 </head>
ihse@2536 15 <body>
ihse@2591 16 <header>
ihse@2536 17 <h1 class="title">Testing OpenJDK</h1>
ihse@2591 18 </header>
ihse@2591 19 <nav id="TOC">
ihse@2536 20 <ul>
ihse@2617 21 <li><a href="#using-the-run-test-framework">Using the run-test framework</a><ul>
ihse@2617 22 <li><a href="#configuration">Configuration</a></li>
ihse@2617 23 </ul></li>
ihse@2536 24 <li><a href="#test-selection">Test selection</a><ul>
ihse@2617 25 <li><a href="#jtreg">JTReg</a></li>
ihse@2536 26 <li><a href="#gtest">Gtest</a></li>
ihse@2536 27 </ul></li>
ihse@2536 28 <li><a href="#test-results-and-summary">Test results and summary</a></li>
ihse@2536 29 <li><a href="#test-suite-control">Test suite control</a><ul>
ihse@2617 30 <li><a href="#jtreg-keywords">JTReg keywords</a></li>
ihse@2536 31 <li><a href="#gtest-keywords">Gtest keywords</a></li>
ihse@2536 32 </ul></li>
ihse@2536 33 </ul>
ihse@2591 34 </nav>
ihse@2536 35 <h2 id="using-the-run-test-framework">Using the run-test framework</h2>
ihse@2536 36 <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>
ihse@2536 37 <p>Some example command-lines:</p>
ihse@2536 38 <pre><code>$ make run-test-tier1
ihse@2536 39 $ make run-test-jdk_lang JTREG=&quot;JOBS=8&quot;
ihse@2536 40 $ make run-test TEST=jdk_lang
ihse@2536 41 $ make run-test-only TEST=&quot;gtest:LogTagSet gtest:LogTagSetDescriptions&quot; GTEST=&quot;REPEAT=-1&quot;
ihse@2536 42 $ make run-test TEST=&quot;hotspot/test:hotspot_gc&quot; JTREG=&quot;JOBS=1;TIMEOUT=8;VM_OTIONS=-XshowSettings -Xlog:gc+ref=debug&quot;
ihse@2536 43 $ make run-test TEST=&quot;jtreg:hotspot/test:hotspot_gc hotspot/test/native_sanity/;</code></pre>
ihse@2617 44 <h3 id="configuration">Configuration</h3>
ihse@2617 45 <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=&lt;path to jtreg home&gt;</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>
ihse@2536 46 <h2 id="test-selection">Test selection</h2>
ihse@2536 47 <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>
ihse@2617 48 <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=&quot;tier1&quot;</code>, but the latter is more tab-completion friendly. For more complex test runs, the <code>run-test TEST=&quot;x&quot;</code> solution needs to be used.</p>
ihse@2536 49 <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:jdk/test:tier1 jtreg:langtools/test:tier1 jtreg:nashorn/test:tier1 jtreg:jaxp/test: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>
ihse@2617 50 <h3 id="jtreg">JTReg</h3>
ihse@2617 51 <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/test:tier1</code>, <code>jdk/test:jdk_util</code>.</p>
ihse@2536 52 <p>When specified without a test root, all matching groups from all tests roots will be added. Otherwise, only the group from the specified test root will be added.</p>
ihse@2617 53 <p>Individual JTReg tests or directories containing JTReg tests can also be specified, like <code>hotspot/test/native_sanity/</code> or <code>hotspot/test/native_sanity</code>. You can also specify an absolute path, to point to a JTReg test outside the source tree.</p>
ihse@2536 54 <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:hotspot/test/native_sanity</code>.</p>
ihse@2536 55 <h3 id="gtest">Gtest</h3>
ihse@2536 56 <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>
ihse@2536 57 <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>
ihse@2536 58 <h2 id="test-results-and-summary">Test results and summary</h2>
ihse@2536 59 <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>
ihse@2536 60 <pre><code>==============================
ihse@2536 61 Test summary
ihse@2536 62 ==============================
ihse@2536 64 &gt;&gt; jtreg:jdk/test:tier1 1867 1865 2 0 &lt;&lt;
ihse@2536 65 jtreg:langtools/test:tier1 4711 4711 0 0
ihse@2536 66 jtreg:nashorn/test:tier1 133 133 0 0
ihse@2536 67 ==============================
ihse@2536 68 TEST FAILURE</code></pre>
ihse@2536 69 <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>&gt;&gt; ... &lt;&lt;</code> marker for easy identification.</p>
ihse@2536 70 <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>
ihse@2536 71 <p>In case of test failures, <code>make run-test</code> will exit with a non-zero exit value.</p>
ihse@2617 72 <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>
ihse@2536 73 <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>
ihse@2536 74 <h2 id="test-suite-control">Test suite control</h2>
ihse@2536 75 <p>It is possible to control various aspects of the test suites using make control variables.</p>
ihse@2617 76 <p>These variables use a keyword=value approach to allow multiple values to be set. So, for instance, <code>JTREG=&quot;JOBS=1;TIMEOUT=8&quot;</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=&quot;TMIEOUT=8&quot;</code> would give an error, while <code>JTREG_TMIEOUT=8</code> would just pass unnoticed.</p>
ihse@2536 77 <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=&quot;...;...&quot;</code>. This will also make sure spaces are preserved, as in <code>JTREG=&quot;VM_OTIONS=-XshowSettings -Xlog:gc+ref=debug&quot;</code>.</p>
ihse@2536 78 <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_OTIONS=-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>
ihse@2536 79 <p>As far as possible, the names of the keywords have been standardized between test suites.</p>
ihse@2617 80 <h3 id="jtreg-keywords">JTReg keywords</h3>
ihse@2536 81 <h4 id="jobs">JOBS</h4>
ihse@2536 82 <p>The test concurrency (<code>-concurrency</code>).</p>
ihse@2536 83 <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>
ihse@2536 84 <h4 id="timeout">TIMEOUT</h4>
ihse@2536 85 <p>The timeout factor (<code>-timeoutFactor</code>).</p>
ihse@2536 86 <p>Defaults to 4.</p>
ihse@2536 87 <h4 id="test_mode">TEST_MODE</h4>
ihse@2536 88 <p>The test mode (<code>-agentvm</code>, <code>-samevm</code> or <code>-othervm</code>).</p>
ihse@2536 89 <p>Defaults to <code>-agentvm</code>.</p>
ihse@2536 90 <h4 id="assert">ASSERT</h4>
ihse@2536 91 <p>Enable asserts (<code>-ea -esa</code>, or none).</p>
ihse@2536 92 <p>Set to <code>true</code> or <code>false</code>. If true, adds <code>-ea -esa</code>. Defaults to true, except for hotspot.</p>
ihse@2536 93 <h4 id="verbose">VERBOSE</h4>
ihse@2536 94 <p>The verbosity level (<code>-verbose</code>).</p>
ihse@2536 95 <p>Defaults to <code>fail,error,summary</code>.</p>
ihse@2536 96 <h4 id="retain">RETAIN</h4>
ihse@2536 97 <p>What test data to retain (<code>-retain</code>).</p>
ihse@2536 98 <p>Defaults to <code>fail,error</code>.</p>
ihse@2536 99 <h4 id="max_mem">MAX_MEM</h4>
ihse@2536 100 <p>Limit memory consumption (<code>-Xmx</code> and <code>-vmoption:-Xmx</code>, or none).</p>
ihse@2617 101 <p>Limit memory consumption for JTReg test framework and VM under test. Set to 0 to disable the limits.</p>
ihse@2536 102 <p>Defaults to 512m, except for hotspot, where it defaults to 0 (no limit).</p>
ihse@2536 103 <h4 id="options">OPTIONS</h4>
ihse@2617 104 <p>Additional options to the JTReg test framework.</p>
ihse@2617 105 <p>Use <code>JTREG=&quot;OPTIONS=--help all&quot;</code> to see all available JTReg options.</p>
ihse@2536 106 <h4 id="java_options">JAVA_OPTIONS</h4>
ihse@2617 107 <p>Additional Java options to JTReg (<code>-javaoption</code>).</p>
ihse@2536 108 <h4 id="vm_options">VM_OPTIONS</h4>
ihse@2617 109 <p>Additional VM options to JTReg (<code>-vmoption</code>).</p>
ihse@2536 110 <h3 id="gtest-keywords">Gtest keywords</h3>
ihse@2536 111 <h4 id="repeat">REPEAT</h4>
ihse@2536 112 <p>The number of times to repeat the tests (<code>--gtest_repeat</code>).</p>
ihse@2536 113 <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>
ihse@2536 114 <h4 id="options-1">OPTIONS</h4>
ihse@2536 115 <p>Additional options to the Gtest test framework.</p>
ihse@2536 116 <p>Use <code>GTEST=&quot;OPTIONS=--help&quot;</code> to see all available Gtest options.</p>
ihse@2536 117 </body>
ihse@2536 118 </html>