From 4640f13faa899a2de58ef4d835605f53b46550f3 Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Sun, 5 Apr 2020 18:52:28 +0200 Subject: docs: Fix Contributing.md --- docs/markdown/Contributing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/markdown') diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index 5332938..554c3f5 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -174,7 +174,7 @@ contents of an additional file into the CI log on failure. Projects needed by unit tests are in the `test cases/unit` subdirectory. They are not run as part of `./run_project_tests.py`. -#### Configuring project tests +### Configuring project tests The (optional) `test.json` file, in the root of a test case, is used for configuring the test. All of the following root entries in the `test.json` @@ -213,13 +213,13 @@ Exanple `test.json`: } ``` -##### env +#### env The `env` key contains a dictionary which specifies additional environment variables to be set during the configure step of the test. `@ROOT@` is replaced with the absolute path of the source directory. -##### installed +#### installed The `installed` dict contains a list of dicts, describing which files are expected to be installed. Each dict contains the following keys: @@ -277,7 +277,7 @@ the platform matches. The following values for `platform` are currently supporte | `cygwin` | Matches when the platform is cygwin | | `!cygwin` | Not `cygwin` | -##### matrix +#### matrix The `matrix` section can be used to define a test matrix to run project tests with different meson options. @@ -318,7 +318,7 @@ The above example will produce the following matrix entries: - `opt1=qwert` - `opt1=qwert opt2=true` -##### do_not_set_opts +#### do_not_set_opts Currently supported values are: - `prefix` -- cgit v1.1 From 4a1f1977435c7153d97652984aa783c2cbd1e803 Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Sun, 5 Apr 2020 19:03:06 +0200 Subject: tests: Add support for specifying tool requirements Adds the `tools` section to `tests.json` to specify requirements for the tools in the environment. All tests that fail at least one tool requirements check are skipped. --- docs/markdown/Contributing.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs/markdown') diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md index 554c3f5..8a24e0b 100644 --- a/docs/markdown/Contributing.md +++ b/docs/markdown/Contributing.md @@ -209,6 +209,9 @@ Exanple `test.json`: { "opt1": "qwert", "opt2": "false" }, { "opt1": "bad" } ] + }, + "tools": { + "cmake": ">=3.11" } } ``` @@ -324,6 +327,13 @@ Currently supported values are: - `prefix` - `libdir` +#### tools + +This section specifies a list of tool requirements in a simple key-value format. +If a tool is specified, it has to be present in the environment, and the version +requirement must be fulfilled match. Otherwise, the entire test is skipped +(including every element in the test matrix). + ### Skipping integration tests Meson uses several continuous integration testing systems that have slightly -- cgit v1.1