diff options
| author |   lollivier <lollivier@baylibre.com> | 2017-10-31 17:37:01 +0100 |
|---|---|---|
| committer | lollivier <lollivier@baylibre.com> | 2017-10-31 17:37:01 +0100 |
| commit | 41c0a685d97c3118d22190b4f658cc7152d30650 (patch) | |
| tree | b11846561fafd6fe69e8208dd36112e46350978f /doc | |
| parent | 848b44f4497613a0fcbae6a02380a9d6670d804f (diff) | |
Update the test documentation
Update the test documentation to specify how to create a job description
including test definitions. And also how to create new test definitions.
Change-Id: I0b496c0ee4a3ca7704d63869a03f0387f641346b
Signed-off-by: lollivier <lollivier@baylibre.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/test-documentation.md | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/doc/test-documentation.md b/doc/test-documentation.md index 4ad5688..e7b568c 100644 --- a/doc/test-documentation.md +++ b/doc/test-documentation.md @@ -1,19 +1,31 @@ # 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. +All the tests templates within [releng-scripts-folder]/templates/tests/ are parsed by the tool and can be added to a test plan. + +### Generate test plans +Use the create-jobs.py script to generate test plans. Use the `--test` parameter with the +test name or `--test all` to run all tests. +To get the list of test names use: ```$ ./utils/create-jobs.py --help``` + +_Example output:_ +``` + --test [{smoke,health-test,yocto-ptest,all} [{smoke,health-test,yocto-ptest,all} ...]] + add these test to the job (default: []) +``` + +_Example command:_ +``` +./utils/create-jobs.py --machine raspberrypi3 --test all +./utils/create-jobs.py --machine raspberrypi3 --test {smoke,health-test} +``` ### Add test definition -Just create a new jinja2 template file within the tests folder containing the tests definitions.\ +To create new tests 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 +_Example:_\ Add new test definition:\ `$ cp doc/test_remote_scripts.jinja2 templates/tests/`\ Generate test job from the new test definition:\ |