summaryrefslogtreecommitdiff
path: root/tests/test_rules/README.md
diff options
context:
space:
mode:
authorOliver Reiche <oliver.reiche@huawei.com>2023-01-25 19:01:44 +0100
committerOliver Reiche <oliver.reiche@huawei.com>2023-01-26 13:30:53 +0100
commit859ecb6b4b9845006c14a20da21f5ec8c4fb085e (patch)
treea94072963ba017a51dc767f147fd6f8aa7fcb19d /tests/test_rules/README.md
parent3979ba259fe932c408844c5b43a9fdf77067230d (diff)
downloadrules-cc-859ecb6b4b9845006c14a20da21f5ec8c4fb085e.tar.gz
Test creating libraries from CMake project
Diffstat (limited to 'tests/test_rules/README.md')
-rw-r--r--tests/test_rules/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/tests/test_rules/README.md b/tests/test_rules/README.md
index 8ed8f91..5a1baed 100644
--- a/tests/test_rules/README.md
+++ b/tests/test_rules/README.md
@@ -7,11 +7,13 @@ should fail or succeed. After processing all targets, additional assertions
## Setup
-The test rules expect to find the following two bindings:
+The test rules expect to find the following three bindings:
- `[["@", "test-rules", "", "tree"]]`, which contains a single tree artifact
with the rules to test.
- `[["@", "test-just", "", ""]]`, which contains a single executable artifact
that is the JustBuild binary to use for the tests.
+ - `[["@", "test-libs", "", "tree"]]`, which contains a single tree artifact
+ that holds the file trees of external libraries.
## Rule `["test_rules", "test_case"]`
@@ -20,6 +22,7 @@ Define a test case for rule tests.
| Field | Description |
| ----- | ----------- |
| `"name"` | Name of the test (multiple entries are joined). |
+| `"libs"` | Paths to external libraries' trees provided by the `"test-libs"` repository. From within a test cases, the library's tree can be accessed via `["@", "<libname>", "", "tree"]`. |
| `"targets"` | Target names to build and install. Each target name is prefixed by `"+"` or `"-"`, indicating if the build should fail or not. Targets that build successfully will be installed to a directory named identical to the target name (without the prefix). |
| `"asserts"` | List of commands to execute after all targets were processed. To access artifacts from installed targets, use the corresponding target name as prefix dir (e.g., target `"+foo"` installs to `"./foo/"`). |
| `"data"` | The directory that contains the project with the targets to test. |