# Test documentation

### Test parsing
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
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).

_Example:_\
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`