JTREG(1) User Commands JTREG(1)
NAME
jtreg - Regression Test Harness
DESCRIPTION
Documentation Options
Options for additional documentation
-h [words...] | -help [words...] | -usage [words...]
Command line help. Give words to see help info containing those or use "-help all" to see all available help.
-n | -relnote
Release notes
-onlineHelp [words...]
Show the online help. You can also show the online help from the desktop Help menu.
-t | -tagspec
Tag specification supported by this implementation
-version
Give information about the version of jtreg in use.
General Options
-allowSetSecurityManager | -allowSetSecurityManager:<boolean-value>
Allow sameVM tests to set a security manager. Default is "yes" if option not given or no value given for option.
yes Allow sameVM tests to set a security manager
no Do not allow sameVM tests to set a security manager
on Allow sameVM tests to set a security manager
off Do not allow sameVM tests to set a security manager
true Allow sameVM tests to set a security manager
false Do not allow sameVM tests to set a security manager
-c | -check
Verify correctness of test descriptions. Does NOT run tests.
-dir:<dir>
Specify a base directory for test files and directories
-e:name[=value][,name[=value]...]
Specify additional environment variables to be passed to each test. If a value is not given for a name, the current value of the
environment variable will be used. Standard environment variables, like DISPLAY, LANG, windir, SystemRoot, etc, will automatically
be given to each test, if they are set in the current environment.
-g | -gui
Access regression extensions via the standard JavaTest harness gui
-ignore:<value>
Specify how to handle tests containing an @ignore tag.
quiet Completely ignore such tests.
error (Default.) Execute the actions up to the @ignore tag, then give an "Error" result.
run Run the test, as though the @ignore tag were not present.
-noignore
suppress the effect of any @ignore tags, allowing the test to proceed as if the @ignore tags were not present. Deprecated: see the
-ignore option.
-nr | -noreport
Do not generate a final report.
-o:<classname> | -observer:<classname>
Specifies the class to observe the progress of a test suite; the class must implement a specific interface; contact a developer for
details. E.g. -o:SampleRegressionObserver
-od:<path> | -observerDir:<path> | -op:<path> | -observerPath:<path>
Specifies the pathname of a directory or .JAR file in which the observer class is located. The given pathname is simply appended to
the CLASSPATH used for the tests, thus care should be taken when naming an observer not to collide with the names of classes inter-
nal to the JavaTest harness or the JRE, e.g., put the observer class in its own named package.
-r:<directory> | -reportDir:<directory>
All report files placed here; "./JTreport" is default
-retain | -retain:<pass,fail,error,all,file-pattern>,...
Specify files to be retained after each test completes executing. If -retain is not specified, only the files from the last test
executed will be retained. If -retain is specified with no argument, all files will be retained. Otherwise, the files may be
described by one or more of the following values:
none Do not retain any of the files generated by each test
pass Retain files generated by tests that pass
fail Retain files generated by tests that fail
error Retain files generated by tests that caused an error
all Retain all files generated by each test
file-pattern
Retain files that match a specific filename. The name may contain '*' to match any sequence of characters. For example, result.* or
*.err.
-ro | -reportOnly
Generate report for previously executed tests. This does not re-run any tests. A work directory containing the results of the exe-
cuted tests must be provided. The default location is "./JTwork". To specify an alternate directory, use -workDir.
-startHttpd
Start the http server to view test results
-timeout:<number> | -timeoutFactor:<number>
A scaling factor to extend the default timeout of all tests. Typically used when running on slow file systems.
-w:<directory> | -workDir:<directory>
Location for .class files, .jtr files, etc. "./JTwork" is default
JDK-related Options
By default, tests will be run using the default JVM in the test JDK. You can pass all applicable JVM options via using -vmoption; in
addition, most common JVM options are also supported directly. For full details of any option, consult the documentation for that
version of the JDK, or try using "java -help" or "java -X". If an option is not applicable to a particular platform or JDK release,
it will be rejected.
-agentlib:<libname><[=<options>]
Load native agent library
-agentpath:<pathname><[=<options>]
Load native agent library by full pathname
-classic | -green | -native | -hotspot | -client | -server | -d32 | -d64
VM Options
-compilejdk:<java.home>
Compile all tests using specified JDK. If not specified, tests are compiled with the JDK used to run the tests. See also -jdk. e.g.
-jdk:/usr/local/java/jdk1.5/solaris-sparc
-cpa:<path> | -classpathappend:<path>
Append the provided classPath to the CLASSPATH of every test. This is designed to be used primarily for tests which require non-core
JDK functionality. For example, to test Swing, which is not part of core JDK1.1, the following addition to the the CLASSPATH would
be necessary: -cpa:/usr/local/java/swing-1.0.3/swingall.jar
-D<name>=<value>
Define a system property
-enableassertions | -enableassertions:* | -ea | -ea:* | -disableassertions |
-disableassertions:* | -da | -da:*
Enable or disable assertions
-enablesystemassertions | -esa | -disablesystemassertions | -dsa
Enable or disable system assertions
-javaagent:<jarpath><[=<options>]
Load Java programming language agent
-javacoption:<option>
Additional compiler option. You can give this option multiple times. Any embedded filenames must be given with absolute paths.
-javacoptions:<option>...
Additional compiler options. You can give this option multiple times, or give many values together, separated by spaces. If you give
multiple values, you may need to enclose them in quotes, depending on the shell you use. Any embedded filenames must be given with
absolute paths. Warning: do not use this form if any of the options has an argument such as a filename that might contain spaces. In
that case, use one or more -javacoption options instead.
-javaoption:<option>
Additional java option for running test classes. You can give this option multiple times. Any embedded filenames must be given with
absolute paths. See also -vmoption.
-javaoptions:<option>...
Additional java options for running test classes. You can give this option multiple times, or give many values together, separated
by spaces. If you give multiple values, you may need to enclose them in quotes, depending on the shell you use. Any embedded file-
names must be given with absolute paths. Warning: do not use this form if any of the options has an argument such as a filename that
might contain spaces. In that case, use one or more -javaoption options instead. See also -vmoptions.
-jdk:<java.home> | -testjdk:<java.home>
Run all tests using specified JDK. e.g. -jdk:/usr/local/java/jdk1.5/solaris-sparc
-jit Enable the JIT for the tests. The JIT is turned on by default.
-nojit Disable the JIT for the tests.
-vmoption:<option>
Any other VM option. You can give this option multiple times. Any embedded filenames must be given with absolute paths. This option
will be used when compiling and running classes. See also -javaoption.
-vmoptions:<option>...
Any other VM options. You can give this option multiple times, or give many values together, separated by spaces. If you give multi-
ple values, you may need to enclose them in quotes, depending on the shell you use. Any embedded filenames must be given with abso-
lute paths. Warning: do not use this form if any of the options has an argument such as a filename that might contain spaces. In
that case, use one or more -vmption options instead. This option will be used when compiling and running classes. See also -javaop-
tions.
-X* Non-standard VM Options.
-Xbootclasspath/a:<path>
Append to end of bootstrap class pat
-Xbootclasspath/p:<path>
Prepend in front of bootstrap class path
-Xbootclasspath:<path>
Set search path for bootstrap classes and resources
-Xint* | -Xmixed* | -Xcomp*
Non-standard VM Options
-Xrunjcov*
Options for running jcov
-XX* | -Xms* | -Xmx*
Non-standard VM Options
Test Mode Options
When the JavaTest harness is used to run tests, two possibly different versions of the JDK are used: the JDK version used to run the
harness and the JDK version used to run the test(s). The following options provide a means to specify the JDK version used to run
the tests. The default is to use the same JDK version (provided by JAVA_HOME) for both the harness and the tests, and for each test
to run in its own JVM.
-avm | -agentvm
Run tests using a pool of reusable JVMs.
-ovm | -othervm
Run every test in its own JVM. The JDK version for the tests may be specified via the -testjdk option. If not provided, then the JDK
version specified by the JAVA_HOME environment variable will be used.
-s | -svm | -samevm
If possible, run each test in the same JVM as the JavaTest harness. The JDK version used may be specified with -testjdk. If -testjdk
is not provided, then the JDK version will be determined by the environment variable JT_JAVA if it is set. Otherwise, the environ-
ment variable JAVA_HOME is used.
Test Selection Options
These options can be used to refine the set of tests to be executed.
-a | -automatic | -automagic
Any test with /manual will not be run
-bug:<bugid>
Run only those tests which apply to the given bugid.
-exclude:<file> | -Xexclude:<file>
Provide a file specifying tests not to be run
-k:<keywordExpr> | -keywords:<keywordExpr>
A keyword boolean expression for test selection. The expression can contain keyword names, combined with & (and), | (or), ! (not)
and parentheses.
-m | -manual
Only tests with /manual will be run
-noshell
Any tests which contain shell actions will not be run
-shell Only tests which contain shell actions will be run
-status:<value>,...
Select tests according to their result in an earlier run. The value can be one or more of the following values, separated by com-
mas.
pass Tests that passed
fail Tests that failed
notRun Tests that have not been run
error Tests that could not be run because of errors, or tests that were ignored
Verbose Options
These options control the amount of output written to the console while running tests
-v | -v:<value> | -verbose | -verbose:<value>
Increase the amount of output written to the console. A value, or selected combinations of values separated by commas, may be given
to select the type of output desired.
default
Three lines of output per test: start, end, status
summary
One line of output per test: status, test name
all Selected contents of JTR file for all tests (includes stdout/stderr)
pass Selected contents of JTR file for passed tests
fail Selected contents of JTR file for failed tests
error Selected contents of JTR file for errored tests
nopass Suppress output for tests that passed
time Elapsed time per action
-v1 Short for -verbose:summary
-va Short for -verbose:all
-ve Short for -verbose:error
-vf Short for -verbose:fail
-vp Short for -verbose:pass
-vt Short for -verbose:time
For more details and examples, see the online help. You can access this directly from the command line with "-onlineHelp <word>...", or you
can start the JavaTest harness and use the Help menu.
jtreg can also be run with Ant. See the online help for details. For example, use the "-onlineHelp ant" command line option.
COPYRIGHT
Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
jtreg options... tests...
Tests can be given as files or folders containing test files.
For brief details about a topic, use "-help <term> ...". The argument <term> is a command option or other word related to the topic. Use
"-help all" to show all of the help entries.
Information is available for the following topics.
Verbose Options
These options control the amount of output written to the console while running tests
Documentation Options
Options for additional documentation
General Options
Test Selection Options
These options can be used to refine the set of tests to be executed.
Test Mode Options
When the JavaTest harness is used to run tests, two possibly different versions of the JDK are used: the JDK version used to run the
harness and the JDK version used to run the test(s). The following options provide a means to specify the JDK version used to run
the tests. The default is to use the same JDK version (provided by JAVA_HOME) for both the harness and the tests, and for each test
to run in its own JVM.
JDK-related Options
By default, tests will be run using the default JVM in the test JDK. You can pass all applicable JVM options via using -vmoption; in
addition, most common JVM options are also supported directly. For full details of any option, consult the documentation for that
version of the JDK, or try using "java -help" or "java -X". If an option is not applicable to a particular platform or JDK release,
it will be rejected.
For more details and examples, see the online help. You can access this directly from the command line with "-onlineHelp <word>...", or you
can start the JavaTest harness and use the Help menu.
jtreg can also be run with Ant. See the online help for details. For example, use the "-onlineHelp ant" command line option.
Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
SEE ALSO
The full documentation for jtreg is maintained as a Texinfo manual. If the info and jtreg programs are properly installed at your site,
the command
info jtreg
should give you access to the complete manual.
jtreg Usage: July 2011 JTREG(1)