diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 17:32:43 +0000 |
commit | 6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch) | |
tree | a68f146d7fa01f0134297619fbe7e33db084e0aa /js/src/jit-test/README | |
parent | Initial commit. (diff) | |
download | thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.tar.xz thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.zip |
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | js/src/jit-test/README | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/js/src/jit-test/README b/js/src/jit-test/README new file mode 100644 index 0000000000..b8b01af4b5 --- /dev/null +++ b/js/src/jit-test/README @@ -0,0 +1,107 @@ +JS Internal Test Suite + +* PURPOSE + +This is a test suite primarily for testing the SpiderMonkey JIT, GC, and any +other internal mechanisms that are not visible to test262. All tests are run in +the JS shell. + +In the future, we intend to migrate the "non262" jstests over to this framework. + +* CONTINUOUS INTEGRATION + +In CI, these tests will be run as part of the "SM(...)" set of jobs. They will +also be packaged up and then run via mozharness as separate test jobs on some +platforms. These will appear on treeherder as jobs starting with "Jit", eg +"Jit", "Jit3", "Jit-1proc3", etc. + +Unlike jstests, we do not run jit-tests in the browser. All tests may assume +they are running in the JS shell environment. + +* REQUIREMENTS + +Python 3.6. This is already a standard requirement for building our tree. + +* RUNNING THE TESTS + +Basic usage: + + ./mach jit-test + +from the top of the checkout. Directly invoking + + python jit_test.py <path-to-js-shell> + +will also work. The progress bar shows [#tests passed, #tests failed, #tests +run] at the left. If all tests pass, the output is 'PASSED ALL'. The test suite +can be interrupted at any time with Ctrl+C and partial results will be printed. + +To run only the basic tests, not including the slow tests: + + ./mach jit-test <path-to-js-shell> basic + +For more options: + + ./mach jit-test -- -h + +or + + python jit_test.py -h + +for the jit-test harness options, or + + ./mach jit-test -h + +for the mach driver's options (eg --cgc). + +* CREATING NEW TESTS + +Simply create a JS file under the 'tests/' directory. Most tests should go in +'tests/basic/'. + +All tests are run with 'lib/prologue.js' included first on the command line. The +command line also creates a global variable 'libdir' that is set to the path +of the 'lib' directory. To include a file 'foo.js' from the lib directory in a +test case: + + load(libdir + 'foo.js') + +* TEST METALINES + +The first line of a test case can contain a special comment controlling how the +test is run. For example: + + // |jit-test| allow-oom; --no-threads + +The general format in EBNF is: + + metaline ::= cookie { item ";" } + cookie ::= "|jit-test|" + item ::= flag | attribute + + flag ::= "slow" | "allow-oom" | "valgrind" | "tz-pacific" | "debug" | + "--" switch + + attribute ::= name ":" value + name ::= "error" | "exitstatus" + value ::= <string> + switch ::= <string> + +The metaline may appear anywhere in the first line of the file: this allows it +to be placed inside any kind of comment. + +The meaning of the items: + + slow Test runs slowly. Do not run if the --no-slow option is given. + allow-oom If the test runs out of memory, it counts as passing. + valgrind Run test under valgrind. + tz-pacific Always run test with the Pacific time zone (TZ=PST8PDT). + + error The test should be considered to pass iff it throws the + given JS exception. + exitstatus The test should exit with the given status value (an integer). + + debug Run js with -d, whether --jitflags says to or not + --SWITCH Pass --SWITCH through to js + +* END |