Debian Codegraph @

js/src/jit-test/etc/wasm/generate-spectests/README.md

raw
1 # generate-spectests
2
3 A tool to generate a combined testsuite for the wasm spec and all proposals.
4
5 This tool tries to be as robust as possible to deal with upstream breakage, while still generating a minimal testsuite for proposals that don't change many tests.
6
7 ## Usage
8
9 NOTE: Running this on its own will generate spec tests but not actually copy them to the jit-test folder or apply patches. If you want to run the whole process for real, use the makefile in the parent folder.
10
11 ```bash
12 # Configure the tests you want
13 vim config.toml
14
15 # Generate the tests
16 # This will create a `repos/` and `tests/` in your working directory
17 cargo run
18 ```
19
20 ## config.toml
21
22 ```toml
23 # (optional) Text to add to a 'directives.txt' file put in 'js/${repo}/harness'
24 harness_directive = ""
25
26 # (optional) Text to add to a 'directives.txt' file put in 'js/${repo}'
27 directive = ""
28
29 # (optional) Tests to include even if they haven't changed with respect to their parent repository
30 included_tests = ["test.wast"]
31
32 # (optional) Tests to exclude
33 excluded_tests = ["test.wast"]
34
35 [[repos]]
36 # Name of the repository
37 name = "sign-extension-ops"
38
39 # Url of the repository
40 url = "https://github.com/WebAssembly/sign-extension-ops"
41
42 # (optional) Name of the repository that is the upstream for this repository.
43 # This repository will attempt to merge with this upstream when generating
44 # tests. The parent repository must be specified before this repository in the
45 # 'config.toml'. If you change this, you must delete the 'repos' directory
46 # before generating tests again.
47 parent = "spec"
48
49 # (optional) Whether to skip merging with upstream, if it exists.
50 skip_merge = "false"
51
52 # (optional) The commit to checkout when generating tests. If not specified,
53 # defaults to the latest 'origin/master'.
54 commit = "df34ea92"
55
56 # (optional) Text to add to a 'directives.txt' file put in 'js/{$repo}'
57 directive = ""
58
59 # (optional) Tests to include even if they haven't changed with respect to their parent repository
60 included_tests = ["test.wast"]
61
62 # (optional) Tests to exclude
63 excluded_tests = ["test.wast"]
64 ```