Debian Codegraph @

subprojects/meson-docs/docs/yaml/functions/add_test_setup.yaml

raw
1 name: add_test_setup
2 returns: void
3 description: |
4 Add a custom test setup. This setup can be used to run the tests with a
5 custom setup, for example under Valgrind.
6
7 To use the test setup, run `meson test --setup=*name*` inside the
8 build dir.
9
10 Note that all these options are also available while running the
11 `meson test` script for running tests instead of `ninja test` or
12 `msbuild RUN_TESTS.vcxproj`, etc depending on the backend.
13
14 posargs:
15 name:
16 type: str
17 description: The name of the test setup
18
19 kwargs:
20 env:
21 type: env | list[str] | dict[str]
22 description: |
23 environment variables to set
24 , such as `['NAME1=value1', 'NAME2=value2']`,
25 or an [[@env]] object which allows more sophisticated
26 environment juggling. *(Since 0.52.0)* A dictionary is also accepted.
27
28 exe_wrapper:
29 type: list[str | external_program]
30 description: The command or script followed by the arguments to it
31
32 gdb:
33 type: bool
34 default: false
35 description: If `true`, the tests are also run under `gdb`
36
37 timeout_multiplier:
38 type: int
39 default: 1
40 description: |
41 A number to multiply the test timeout with.
42 *Since 0.57* if timeout_multiplier is `<= 0` the test has infinite duration,
43 in previous versions of Meson the test would fail with a timeout immediately.
44
45 is_default:
46 type: bool
47 since: 0.49.0
48 default: false
49 description: |
50 Set whether this is the default test setup.
51 If `true`, the setup will be used whenever `meson test` is run
52 without the `--setup` option.
53
54 exclude_suites:
55 type: list[str]
56 since: 0.57.0
57 description:
58 A list of test suites that should be excluded when using this setup.
59 Suites specified in the `--suite` option
60 to `meson test` will always run, overriding `add_test_setup` if necessary.