| author | tschatzl |
| Fri, 22 Nov 2019 10:03:38 +0100 | |
| changeset 59220 | 72e15d757e6c |
| parent 58930 | a4ddd1667c72 |
| permissions | -rw-r--r-- |
| 45227 | 1 |
<!DOCTYPE html> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang=""> |
| 44511 | 3 |
<head> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
4 |
<meta charset="utf-8" /> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
5 |
<meta name="generator" content="pandoc" /> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
6 |
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> |
|
50885
7c728fa9d1af
8205956: Fix usage of "OpenJDK" in build and test instructions
mr
parents:
50267
diff
changeset
|
7 |
<title>Testing the JDK</title> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
8 |
<style> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
9 |
code{white-space: pre-wrap;}
|
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
10 |
span.smallcaps{font-variant: small-caps;}
|
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
11 |
span.underline{text-decoration: underline;}
|
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
12 |
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
13 |
</style> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
14 |
<link rel="stylesheet" href="../make/data/docs-resources/resources/jdk-default.css" /> |
| 45227 | 15 |
<!--[if lt IE 9]> |
16 |
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> |
|
17 |
<![endif]--> |
|
| 44511 | 18 |
<style type="text/css">pre, code, tt { color: #1d6ae5; }</style>
|
19 |
</head> |
|
20 |
<body> |
|
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
21 |
<header id="title-block-header"> |
|
50885
7c728fa9d1af
8205956: Fix usage of "OpenJDK" in build and test instructions
mr
parents:
50267
diff
changeset
|
22 |
<h1 class="title">Testing the JDK</h1> |
| 45227 | 23 |
</header> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
24 |
<nav id="TOC" role="doc-toc"> |
| 44511 | 25 |
<ul> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
26 |
<li><a href="#using-make-test-the-run-test-framework">Using "make test" (the run-test framework)</a><ul> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
27 |
<li><a href="#configuration">Configuration</a></li> |
|
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
28 |
</ul></li> |
| 44511 | 29 |
<li><a href="#test-selection">Test selection</a><ul> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
30 |
<li><a href="#jtreg">JTReg</a></li> |
| 44511 | 31 |
<li><a href="#gtest">Gtest</a></li> |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
32 |
<li><a href="#microbenchmarks">Microbenchmarks</a></li> |
| 52342 | 33 |
<li><a href="#special-tests">Special tests</a></li> |
| 44511 | 34 |
</ul></li> |
35 |
<li><a href="#test-results-and-summary">Test results and summary</a></li> |
|
36 |
<li><a href="#test-suite-control">Test suite control</a><ul> |
|
| 53464 | 37 |
<li><a href="#general-keywords-test_opts">General keywords (TEST_OPTS)</a></li> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
38 |
<li><a href="#jtreg-keywords">JTReg keywords</a></li> |
| 44511 | 39 |
<li><a href="#gtest-keywords">Gtest keywords</a></li> |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
40 |
<li><a href="#microbenchmark-keywords">Microbenchmark keywords</a></li> |
| 44511 | 41 |
</ul></li> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
42 |
<li><a href="#notes-for-specific-tests">Notes for Specific Tests</a><ul> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
43 |
<li><a href="#docker-tests">Docker Tests</a></li> |
|
54570
93b702d2a0cb
8222444: Add a suggestion for non-US locale in the test doc
erikj
parents:
54525
diff
changeset
|
44 |
<li><a href="#non-us-locale">Non-US locale</a></li> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
45 |
<li><a href="#pkcs11-tests">PKCS11 Tests</a></li> |
|
58930
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
46 |
<li><a href="#client-ui-tests">Client UI Tests</a></li> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
47 |
</ul></li> |
| 44511 | 48 |
</ul> |
| 45227 | 49 |
</nav> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
50 |
<h2 id="using-make-test-the-run-test-framework">Using "make test" (the run-test framework)</h2> |
|
50885
7c728fa9d1af
8205956: Fix usage of "OpenJDK" in build and test instructions
mr
parents:
50267
diff
changeset
|
51 |
<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> |
| 52342 | 52 |
<p>The main target <code>test</code> uses the jdk-image as the tested product. There is also an alternate target <code>exploded-test</code> 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> |
|
54268
0cf2c87ce79a
8221357: Update test documentation by deleting "cd test && make"
dholmes
parents:
53996
diff
changeset
|
53 |
<p>Previously, <code>make test</code> was used to invoke an old system for running tests, and <code>make run-test</code> was used for the new test framework. For backward compatibility with scripts and muscle memory, <code>run-test</code> (and variants like <code>exploded-run-test</code> or <code>run-test-tier1</code>) are kept as aliases.</p> |
| 44511 | 54 |
<p>Some example command-lines:</p> |
| 52342 | 55 |
<pre><code>$ make test-tier1 |
56 |
$ make test-jdk_lang JTREG="JOBS=8" |
|
57 |
$ make test TEST=jdk_lang |
|
58 |
$ make test-only TEST="gtest:LogTagSet gtest:LogTagSetDescriptions" GTEST="REPEAT=-1" |
|
|
57881
c414c554b38b
8230079: Update test document by changing "TIMEOUT" to "TIMEOUT_FACTOR"
erikj
parents:
57493
diff
changeset
|
59 |
$ make test TEST="hotspot:hotspot_gc" JTREG="JOBS=1;TIMEOUT_FACTOR=8;VM_OPTIONS=-XshowSettings -Xlog:gc+ref=debug" |
| 52342 | 60 |
$ make test TEST="jtreg:test/hotspot:hotspot_gc test/hotspot/jtreg/native_sanity/JniVersion.java" |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
61 |
$ make test TEST="micro:java.lang.reflect" MICRO="FORK=1;WARMUP_ITER=2" |
| 52342 | 62 |
$ make exploded-test TEST=tier2</code></pre> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
63 |
<h3 id="configuration">Configuration</h3> |
| 51644 | 64 |
<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> |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
65 |
<p>To be able to run microbenchmarks, <code>configure</code> needs to know where to find the JMH dependency. Use <code>--with-jmh=<path to JMH jars></code> to point to a directory containing the core JMH and transitive dependencies. The recommended dependencies can be retrieved by running <code>sh make/devkit/createJMHBundle.sh</code>, after which <code>--with-jmh=build/jmh/jars</code> should work.</p> |
| 44511 | 66 |
<h2 id="test-selection">Test selection</h2> |
| 52342 | 67 |
<p>All functionality is available using the <code>test</code> 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, <code>test-only</code> can be used instead, which do not depend on the source and test image build.</p> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
68 |
<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 test-tier1</code> is equivalent to <code>make test TEST="tier1"</code>, but the latter is more tab-completion friendly. For more complex test runs, the <code>test TEST="x"</code> solution needs to be used.</p> |
|
50267
1582de22e3a1
8198323: testing.md not updated for repository layout change
ihse
parents:
49293
diff
changeset
|
69 |
<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> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
70 |
<h3 id="jtreg">JTReg</h3> |
|
50267
1582de22e3a1
8198323: testing.md not updated for repository layout change
ihse
parents:
49293
diff
changeset
|
71 |
<p>JTReg tests can be selected either by picking a JTReg test group, or a selection of files or directories containing JTReg tests.</p> |
|
50885
7c728fa9d1af
8205956: Fix usage of "OpenJDK" in build and test instructions
mr
parents:
50267
diff
changeset
|
72 |
<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> |
|
50267
1582de22e3a1
8198323: testing.md not updated for repository layout change
ihse
parents:
49293
diff
changeset
|
73 |
<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> |
|
50885
7c728fa9d1af
8205956: Fix usage of "OpenJDK" in build and test instructions
mr
parents:
50267
diff
changeset
|
74 |
<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> |
|
50267
1582de22e3a1
8198323: testing.md not updated for repository layout change
ihse
parents:
49293
diff
changeset
|
75 |
<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> |
| 44511 | 76 |
<h3 id="gtest">Gtest</h3> |
77 |
<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> |
|
78 |
<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> |
|
| 51644 | 79 |
<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> |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
80 |
<h3 id="microbenchmarks">Microbenchmarks</h3> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
81 |
<p>Which microbenchmarks to run is selected using a regular expression following the <code>micro:</code> test descriptor, e.g., <code>micro:java.lang.reflect</code>. This delegates the test selection to JMH, meaning package name, class name and even benchmark method names can be used to select tests.</p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
82 |
<p>Using special characters like <code>|</code> in the regular expression is possible, but needs to be escaped multiple times: <code>micro:ArrayCopy\\\\\|reflect</code>.</p> |
| 52342 | 83 |
<h3 id="special-tests">Special tests</h3> |
|
52396
e292e94b448a
8213058: remove ExecuteInternalVMTests and VerboseInternalVMTests flags
iignatyev
parents:
52342
diff
changeset
|
84 |
<p>A handful of odd tests that are not covered by any other testing framework are accessible using the <code>special:</code> test descriptor. Currently, this includes <code>failure-handler</code> and <code>make</code>.</p> |
| 52342 | 85 |
<ul> |
86 |
<li><p>Failure handler testing is run using <code>special:failure-handler</code> or just <code>failure-handler</code> as test descriptor.</p></li> |
|
87 |
<li><p>Tests for the build system, including both makefiles and related functionality, is run using <code>special:make</code> or just <code>make</code> as test descriptor. This is equivalent to <code>special:make:all</code>.</p> |
|
88 |
<p>A specific make test can be run by supplying it as argument, e.g. <code>special:make:idea</code>. As a special syntax, this can also be expressed as <code>make-idea</code>, which allows for command lines as <code>make test-make-idea</code>.</p></li> |
|
89 |
</ul> |
|
| 44511 | 90 |
<h2 id="test-results-and-summary">Test results and summary</h2> |
91 |
<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> |
|
92 |
<pre><code>============================== |
|
93 |
Test summary |
|
94 |
============================== |
|
95 |
TEST TOTAL PASS FAIL ERROR |
|
96 |
>> jtreg:jdk/test:tier1 1867 1865 2 0 << |
|
97 |
jtreg:langtools/test:tier1 4711 4711 0 0 |
|
98 |
jtreg:nashorn/test:tier1 133 133 0 0 |
|
99 |
============================== |
|
100 |
TEST FAILURE</code></pre> |
|
101 |
<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> |
|
102 |
<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> |
|
| 52342 | 103 |
<p>In case of test failures, <code>make test</code> will exit with a non-zero exit value.</p> |
| 51644 | 104 |
<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> |
| 44511 | 105 |
<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> |
106 |
<h2 id="test-suite-control">Test suite control</h2> |
|
107 |
<p>It is possible to control various aspects of the test suites using make control variables.</p> |
|
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
108 |
<p>These variables use a keyword=value approach to allow multiple values to be set. So, for instance, <code>JTREG="JOBS=1;TIMEOUT_FACTOR=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_FACTOR=8</code>, but using the keyword format means that the <code>JTREG</code> variable is parsed and verified for correctness, so <code>JTREG="TMIEOUT_FACTOR=8"</code> would give an error, while <code>JTREG_TMIEOUT_FACTOR=8</code> would just pass unnoticed.</p> |
|
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
109 |
<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> |
|
57881
c414c554b38b
8230079: Update test document by changing "TIMEOUT" to "TIMEOUT_FACTOR"
erikj
parents:
57493
diff
changeset
|
110 |
<p>(Other ways are possible, e.g. using backslash: <code>JTREG=JOBS=1\;TIMEOUT_FACTOR=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> |
| 44511 | 111 |
<p>As far as possible, the names of the keywords have been standardized between test suites.</p> |
| 53464 | 112 |
<h3 id="general-keywords-test_opts">General keywords (TEST_OPTS)</h3> |
113 |
<p>Some keywords are valid across different test suites. If you want to run tests from multiple test suites, or just don't want to care which test suite specific control variable to use, then you can use the general TEST_OPTS control variable.</p> |
|
114 |
<p>There are also some keywords that applies globally to the test runner system, not to any specific test suites. These are also available as TEST_OPTS keywords.</p> |
|
115 |
<h4 id="jobs">JOBS</h4> |
|
116 |
<p>Currently only applies to JTReg.</p> |
|
117 |
<h4 id="timeout_factor">TIMEOUT_FACTOR</h4> |
|
118 |
<p>Currently only applies to JTReg.</p> |
|
119 |
<h4 id="vm_options">VM_OPTIONS</h4> |
|
120 |
<p>Applies to JTReg, GTest and Micro.</p> |
|
121 |
<h4 id="java_options">JAVA_OPTIONS</h4> |
|
122 |
<p>Applies to JTReg, GTest and Micro.</p> |
|
123 |
<h4 id="aot_modules">AOT_MODULES</h4> |
|
124 |
<p>Applies to JTReg and GTest.</p> |
|
125 |
<h4 id="jcov">JCOV</h4> |
|
126 |
<p>This keywords applies globally to the test runner system. If set to <code>true</code>, it enables JCov coverage reporting for all tests run. To be useful, the JDK under test must be run with a JDK built with JCov instrumentation (<code>configure --with-jcov=<path to directory containing lib/jcov.jar></code>, <code>make jcov-image</code>).</p> |
|
127 |
<p>The simplest way to run tests with JCov coverage report is to use the special target <code>jcov-test</code> instead of <code>test</code>, e.g. <code>make jcov-test TEST=jdk_lang</code>. This will make sure the JCov image is built, and that JCov reporting is enabled.</p> |
|
128 |
<p>The JCov report is stored in <code>build/$BUILD/test-results/jcov-output</code>.</p> |
|
129 |
<p>Please note that running with JCov reporting can be very memory intensive.</p> |
|
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
130 |
<h3 id="jtreg-keywords">JTReg keywords</h3> |
| 53464 | 131 |
<h4 id="jobs-1">JOBS</h4> |
| 44511 | 132 |
<p>The test concurrency (<code>-concurrency</code>).</p> |
|
53996
35a30b432396
8219906: Update test documentation with default test jobs settings
aoqi
parents:
53464
diff
changeset
|
133 |
<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> (for sparc, if more than 16 cpus, then <em>number of CPU cores/5</em>, otherwise <em>number of CPU cores/4</em>), but never more than <em>memory size in GB/2</em>.</p> |
| 53464 | 134 |
<h4 id="timeout_factor-1">TIMEOUT_FACTOR</h4> |
| 44511 | 135 |
<p>The timeout factor (<code>-timeoutFactor</code>).</p> |
136 |
<p>Defaults to 4.</p> |
|
137 |
<h4 id="test_mode">TEST_MODE</h4> |
|
138 |
<p>The test mode (<code>-agentvm</code>, <code>-samevm</code> or <code>-othervm</code>).</p> |
|
139 |
<p>Defaults to <code>-agentvm</code>.</p> |
|
140 |
<h4 id="assert">ASSERT</h4> |
|
141 |
<p>Enable asserts (<code>-ea -esa</code>, or none).</p> |
|
142 |
<p>Set to <code>true</code> or <code>false</code>. If true, adds <code>-ea -esa</code>. Defaults to true, except for hotspot.</p> |
|
143 |
<h4 id="verbose">VERBOSE</h4> |
|
144 |
<p>The verbosity level (<code>-verbose</code>).</p> |
|
145 |
<p>Defaults to <code>fail,error,summary</code>.</p> |
|
146 |
<h4 id="retain">RETAIN</h4> |
|
147 |
<p>What test data to retain (<code>-retain</code>).</p> |
|
148 |
<p>Defaults to <code>fail,error</code>.</p> |
|
149 |
<h4 id="max_mem">MAX_MEM</h4> |
|
150 |
<p>Limit memory consumption (<code>-Xmx</code> and <code>-vmoption:-Xmx</code>, or none).</p> |
|
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
151 |
<p>Limit memory consumption for JTReg test framework and VM under test. Set to 0 to disable the limits.</p> |
| 44511 | 152 |
<p>Defaults to 512m, except for hotspot, where it defaults to 0 (no limit).</p> |
| 53464 | 153 |
<h4 id="keywords">KEYWORDS</h4> |
154 |
<p>JTReg kewords sent to JTReg using <code>-k</code>. Please be careful in making sure that spaces and special characters (like <code>!</code>) are properly quoted. To avoid some issues, the special value <code>%20</code> can be used instead of space.</p> |
|
155 |
<h4 id="extra_problem_lists">EXTRA_PROBLEM_LISTS</h4> |
|
156 |
<p>Use additional problem lists file or files, in addition to the default ProblemList.txt located at the JTReg test roots.</p> |
|
157 |
<p>If multiple file names are specified, they should be separated by space (or, to help avoid quoting issues, the special value <code>%20</code>).</p> |
|
158 |
<p>The file names should be either absolute, or relative to the JTReg test root of the tests to be run.</p> |
|
|
57493
b95ebdbf68ca
8226910: make it possible to use jtreg's -match via run-test framework
iignatyev
parents:
54570
diff
changeset
|
159 |
<h4 id="run_problem_lists">RUN_PROBLEM_LISTS</h4> |
|
b95ebdbf68ca
8226910: make it possible to use jtreg's -match via run-test framework
iignatyev
parents:
54570
diff
changeset
|
160 |
<p>Use the problem lists to select tests instead of excluding them.</p> |
|
b95ebdbf68ca
8226910: make it possible to use jtreg's -match via run-test framework
iignatyev
parents:
54570
diff
changeset
|
161 |
<p>Set to <code>true</code> or <code>false</code>. If <code>true</code>, JTReg will use <code>-match:</code> option, otherwise <code>-exclude:</code> will be used. Default is <code>false</code>.</p> |
| 44511 | 162 |
<h4 id="options">OPTIONS</h4> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
163 |
<p>Additional options to the JTReg test framework.</p> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
164 |
<p>Use <code>JTREG="OPTIONS=--help all"</code> to see all available JTReg options.</p> |
| 53464 | 165 |
<h4 id="java_options-1">JAVA_OPTIONS</h4> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
166 |
<p>Additional Java options to JTReg (<code>-javaoption</code>).</p> |
| 53464 | 167 |
<h4 id="vm_options-1">VM_OPTIONS</h4> |
|
45618
74f490ba783a
8179537: Update testing.md for more clarity regarding JTReg configuration
ihse
parents:
45227
diff
changeset
|
168 |
<p>Additional VM options to JTReg (<code>-vmoption</code>).</p> |
| 53464 | 169 |
<h4 id="aot_modules-1">AOT_MODULES</h4> |
170 |
<p>Generate AOT modules before testing for the specified module, or set of modules. If multiple modules are specified, they should be separated by space (or, to help avoid quoting issues, the special value <code>%20</code>).</p> |
|
| 44511 | 171 |
<h3 id="gtest-keywords">Gtest keywords</h3> |
172 |
<h4 id="repeat">REPEAT</h4> |
|
173 |
<p>The number of times to repeat the tests (<code>--gtest_repeat</code>).</p> |
|
174 |
<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> |
|
175 |
<h4 id="options-1">OPTIONS</h4> |
|
176 |
<p>Additional options to the Gtest test framework.</p> |
|
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
177 |
<p>Use <code>GTEST="OPTIONS=--help"</code> to see all available Gtest options.</p> |
| 53464 | 178 |
<h4 id="aot_modules-2">AOT_MODULES</h4> |
179 |
<p>Generate AOT modules before testing for the specified module, or set of modules. If multiple modules are specified, they should be separated by space (or, to help avoid quoting issues, the special value <code>%20</code>).</p> |
|
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
180 |
<h3 id="microbenchmark-keywords">Microbenchmark keywords</h3> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
181 |
<h4 id="fork">FORK</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
182 |
<p>Override the number of benchmark forks to spawn. Same as specifying <code>-f <num></code>.</p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
183 |
<h4 id="iter">ITER</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
184 |
<p>Number of measurement iterations per fork. Same as specifying <code>-i <num></code>.</p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
185 |
<h4 id="time">TIME</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
186 |
<p>Amount of time to spend in each measurement iteration, in seconds. Same as specifying <code>-r <num></code></p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
187 |
<h4 id="warmup_iter">WARMUP_ITER</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
188 |
<p>Number of warmup iterations to run before the measurement phase in each fork. Same as specifying <code>-wi <num></code>.</p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
189 |
<h4 id="warmup_time">WARMUP_TIME</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
190 |
<p>Amount of time to spend in each warmup iteration. Same as specifying <code>-w <num></code>.</p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
191 |
<h4 id="results_format">RESULTS_FORMAT</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
192 |
<p>Specify to have the test run save a log of the values. Accepts the same values as <code>-rff</code>, i.e., <code>text</code>, <code>csv</code>, <code>scsv</code>, <code>json</code>, or <code>latex</code>.</p> |
| 53464 | 193 |
<h4 id="vm_options-2">VM_OPTIONS</h4> |
|
52595
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
194 |
<p>Additional VM arguments to provide to forked off VMs. Same as <code>-jvmArgs <args></code></p> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
195 |
<h4 id="options-2">OPTIONS</h4> |
|
16609197022c
8061281: Microbenchmark suite build support, directory layout and sample benchmarks
redestad
parents:
52396
diff
changeset
|
196 |
<p>Additional arguments to send to JMH.</p> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
197 |
<h2 id="notes-for-specific-tests">Notes for Specific Tests</h2> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
198 |
<h3 id="docker-tests">Docker Tests</h3> |
|
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
199 |
<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> |
|
54525
5ae4d3f46537
8222299: [TESTBUG] move hotspot container tests to hotspot/containers
mseledtsov
parents:
54473
diff
changeset
|
200 |
<pre><code>$ make test TEST="jtreg:test/hotspot/jtreg/containers/docker"</code></pre> |
|
54473
e437ad5643d6
8221894: Add comments for docker tests in the test doc
jiefu
parents:
54268
diff
changeset
|
201 |
<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> |
|
54525
5ae4d3f46537
8222299: [TESTBUG] move hotspot container tests to hotspot/containers
mseledtsov
parents:
54473
diff
changeset
|
202 |
<pre><code>$ make 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> |
|
54570
93b702d2a0cb
8222444: Add a suggestion for non-US locale in the test doc
erikj
parents:
54525
diff
changeset
|
203 |
<h3 id="non-us-locale">Non-US locale</h3> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
204 |
<p>If your locale is non-US, some tests are likely to fail. To work around this you can set the locale to US. On Unix platforms simply setting <code>LANG="en_US"</code> in the environment before running tests should work. On Windows, setting <code>JTREG="VM_OPTIONS=-Duser.language=en -Duser.country=US"</code> helps for most, but not all test cases. For example:</p> |
|
54570
93b702d2a0cb
8222444: Add a suggestion for non-US locale in the test doc
erikj
parents:
54525
diff
changeset
|
205 |
<pre><code>$ export LANG="en_US" && make test TEST=... |
|
93b702d2a0cb
8222444: Add a suggestion for non-US locale in the test doc
erikj
parents:
54525
diff
changeset
|
206 |
$ make test JTREG="VM_OPTIONS=-Duser.language=en -Duser.country=US" TEST=...</code></pre> |
|
58296
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
207 |
<h3 id="pkcs11-tests">PKCS11 Tests</h3> |
|
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
208 |
<p>It is highly recommended to use the latest NSS version when running PKCS11 tests. Improper NSS version may lead to unexpected failures which are hard to diagnose. For example, sun/security/pkcs11/Secmod/AddTrustedCert.java may fail on Ubuntu 18.04 with the default NSS version in the system. To run these tests correctly, the system property <code>test.nss.lib.paths</code> is required on Ubuntu 18.04 to specify the alternative NSS lib directories. For example:</p> |
|
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
209 |
<pre><code>$ make test TEST="jtreg:sun/security/pkcs11/Secmod/AddTrustedCert.java" JTREG="JAVA_OPTIONS=-Dtest.nss.lib.paths=/path/to/your/latest/NSS-libs"</code></pre> |
|
7b534a5088d9
8231351: Add notes for PKCS11 tests in the test doc
erikj
parents:
57881
diff
changeset
|
210 |
<p>For more notes about the PKCS11 tests, please refer to test/jdk/sun/security/pkcs11/README.</p> |
|
58930
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
211 |
<h3 id="client-ui-tests">Client UI Tests</h3> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
212 |
<p>Some Client UI tests use key sequences which may be reserved by the operating system. Usually that causes the test failure. So it is highly recommended to disable system key shortcuts prior testing. The steps to access and disable system key shortcuts for various platforms are provided below.</p> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
213 |
<h4 id="macos">MacOS</h4> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
214 |
<p>Choose Apple menu; System Preferences, click Keyboard, then click Shortcuts; select or deselect desired shortcut.</p> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
215 |
<p>For example, test/jdk/javax/swing/TooltipManager/JMenuItemToolTipKeyBindingsTest/JMenuItemToolTipKeyBindingsTest.java fails on MacOS because it uses <code>CTRL + F1</code> key sequence to show or hide tooltip message but the key combination is reserved by the operating system. To run the test correctly the default global key shortcut should be disabled using the steps described above, and then deselect "Turn keyboard access on or off" option which is responsible for <code>CTRL + F1</code> combination.</p> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
216 |
<h4 id="linux">Linux</h4> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
217 |
<p>Open the Activities overview and start typing Settings; Choose Settings, click Devices, then click Keyboard; set or override desired shortcut.</p> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
218 |
<h4 id="windows">Windows</h4> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
219 |
<p>Type <code>gpedit</code> in the Search and then click Edit group policy; navigate to User Configuration -> Administrative Templates -> Windows Components -> File Explorer; in the right-side pane look for "Turn off Windows key hotkeys" and double click on it; enable or disable hotkeys.</p> |
|
a4ddd1667c72
8232880: Update test documentation with additional settings for client UI tooltip tests
dmarkov
parents:
58296
diff
changeset
|
220 |
<p>Note: restart is required to make the settings take effect.</p> |
| 44511 | 221 |
</body> |
222 |
</html> |