js/src/tests/README.txt@b8a032363ba2 (annotated)
js/src/tests/README.txt
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | JS Test Suite Readme |
| michael@0 | 2 | ==================== |
| michael@0 | 3 | |
| michael@0 | 4 | The JS test suite is a fairly extensive collection of correctness and regression |
| michael@0 | 5 | tests for the Spidermonkey engine. Two harnesses run these tests: the shell test |
| michael@0 | 6 | harness in this directory and the "reftest" harness built into the browser, used |
| michael@0 | 7 | by Tinderbox. The browser reftests require additional manifest files; these are |
| michael@0 | 8 | generated automatically by the build phase 'package-tests' using the |
| michael@0 | 9 | '--make-manifests' option to jstests.py. |
| michael@0 | 10 | |
| michael@0 | 11 | Creating a test |
| michael@0 | 12 | --------------- |
| michael@0 | 13 | For general information, see |
| michael@0 | 14 | https://developer.mozilla.org/en-US/docs/SpiderMonkey/Creating_JavaScript_tests |
| michael@0 | 15 | |
| michael@0 | 16 | Adding a test |
| michael@0 | 17 | ------------- |
| michael@0 | 18 | Drop it in an appropriate directory under the tests directory. |
| michael@0 | 19 | |
| michael@0 | 20 | <fineprint> Some names are forbidden. Do not name your test browser.js, |
| michael@0 | 21 | shell.js, jsref.js, template.js, user.js, js-test-driver-begin.js, or |
| michael@0 | 22 | js-test-driver-end.js, or any of the names of the files in supporting/. |
| michael@0 | 23 | </fineprint> |
| michael@0 | 24 | |
| michael@0 | 25 | Adjusting when and how a test runs |
| michael@0 | 26 | ---------------------------------- |
| michael@0 | 27 | Put a comment at the top of the header matching the format: |
| michael@0 | 28 | // |reftest| <failure-type> -- <comment> |
| michael@0 | 29 | |
| michael@0 | 30 | Where <failure-type> is a standard reftest <failure-type> string, as documented by: |
| michael@0 | 31 | http://mxr.mozilla.org/mozilla-central/source/layout/tools/reftest/README.txt |
| michael@0 | 32 | |
| michael@0 | 33 | Example: |
| michael@0 | 34 | // |reftest| skip-if(!xulRuntime.shell) -- does not always dismiss alert |
| michael@0 | 35 | |
| michael@0 | 36 | <fineprint> Either // or /* */ style comments may be used. The entire |
| michael@0 | 37 | comment must appear in the first 512 bytes of the file. The control |
| michael@0 | 38 | string must be in its own comment block. </fineprint> |
| michael@0 | 39 | |
| michael@0 | 40 | When adding such comments to individual files is not feasible (e.g., for |
| michael@0 | 41 | imported tests), reftest manifest entries can be added to jstests.list |
| michael@0 | 42 | instead. Combining in-file comments with entries in this manifest file for |
| michael@0 | 43 | the same files is not supported (the one from the manifest file will be |
| michael@0 | 44 | used). Only the following two forms are supported: |
| michael@0 | 45 | <failure-type> include <relative_path> |
| michael@0 | 46 | <failure-type> script <relative_path> |
| michael@0 | 47 | The <type> "include" indicates that <failure-type> should apply to all test |
| michael@0 | 48 | cases within a directory. A statement for a nested directory or script |
| michael@0 | 49 | overrides one for an enclosing directory. |
| michael@0 | 50 | |
| michael@0 | 51 | Running tests |
| michael@0 | 52 | ------------- |
| michael@0 | 53 | See |
| michael@0 | 54 | https://developer.mozilla.org/en-US/docs/SpiderMonkey/Running_Automated_JavaScript_Tests |
