diff options
| author |   Loys Ollivier <lollivier@baylibre.com> | 2017-10-05 16:02:19 +0200 |
|---|---|---|
| committer | Loys Ollivier <lollivier@baylibre.com> | 2017-10-05 16:02:19 +0200 |
| commit | 0c7d5b17c5431b77fcc6ab7ec4c040620397bfae (patch) | |
| tree | f98c7b744ab53df3e282f251a358915e6fbe0d99 /doc/test-documentation.md | |
| parent | 52dde34b4c54acabfe0a9a3f77b6869bc144f003 (diff) | |
Provide a short test documentation
Add a test documentation to point to the skeleton test.
Explain how to add new tests and generate new build jobs
including them.
Change-Id: Iec11c053850136a373b1da97fa0ce8445fe114f7
Signed-off-by: Loys Ollivier <lollivier@baylibre.com>
Diffstat (limited to 'doc/test-documentation.md')
| -rw-r--r-- | doc/test-documentation.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/test-documentation.md b/doc/test-documentation.md new file mode 100644 index 0000000..4ad5688 --- /dev/null +++ b/doc/test-documentation.md @@ -0,0 +1,20 @@ +# Test documentation + +### Test parsing +All the tests templates within <releng-scripts>/templates/tests/ are parsed by the tools +can be added to a test plan. + +### Add test definition +Just create a new jinja2 template file within the tests folder containing the tests definitions.\ +A test example is provided in the doc/ folder pointing to the remote +test definition repository: [https://git.automotivelinux.org/src/qa-testdefinitions/tree/](qa-testdefinitions). + +### Generate test plans +Use the create-jobs.py script to generate test plans. Just use the `--test` parameter with the +test name or `--test all` to run all tests. + +### Examples +Add new test definition:\ +`$ cp doc/test_remote_scripts.jinja2 templates/tests/`\ +Generate test job from the new test definition:\ +`$ ./utils/create-jobs.py raspberrypi3 --test test_remote_scripts` |