Skip to content

Commit cca9348

Browse files
danischmdanischm
committed
Update readme
1 parent 99f97d5 commit cca9348

File tree

1 file changed

+60
-28
lines changed

1 file changed

+60
-28
lines changed

‎README.md

Lines changed: 60 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,54 @@
55

66
A CLI tool to render and execute [Robot Framework](https://robotframework.org/) tests using [Jinja](https://jinja.palletsprojects.com/) templating. Combining Robot's language agnostic syntax with the flexibility of Jinja templating allows dynamically rendering a set of test suites from the desired infrastructure state expressed in YAML syntax.
77

8-
```shell
9-
$ nac-test -h
10-
11-
Usage: nac-test [OPTIONS]
12-
13-
A CLI tool to render and execute Robot Framework tests using Jinja templating.
14-
15-
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
16-
│ * --data -d PATH Path to data YAML files. [env var: NAC_TEST_DATA] [default: None] [required] │
17-
│ * --templates -t DIRECTORY Path to test templates. [env var: NAC_TEST_TEMPLATES] [default: None] [required] │
18-
│ * --output -o DIRECTORY Path to output directory. [env var: NAC_TEST_OUTPUT] [default: None] [required] │
19-
│ --filters -f DIRECTORY Path to Jinja filters. [env var: NAC_TEST_FILTERS] [default: None] │
20-
│ --tests DIRECTORY Path to Jinja tests. [env var: NAC_TEST_TESTS] [default: None] │
21-
│ --include -i TEXT Selects the test cases by tag (include). [env var: NAC_TEST_INCLUDE] │
22-
│ --exclude -e TEXT Selects the test cases by tag (exclude). [env var: NAC_TEST_EXCLUDE] │
23-
│ --render-only Only render tests without executing them. [env var: NAC_TEST_RENDER_ONLY] │
24-
│ --dry-run Dry run flag. See robot dry run mode. [env var: NAC_TEST_DRY_RUN] │
25-
│ --verbosity -v [DEBUG|INFO|WARNING|ERROR|CRITICAL] Verbosity level. [env var: NAC_VALIDATE_VERBOSITY] [default: WARNING] │
26-
│ --version Display version number. │
27-
│ --help Show this message and exit. │
28-
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
8+
```
9+
$ nac-test --help
10+
11+
Usage: nac-test [OPTIONS]
12+
13+
A CLI tool to render and execute Robot Framework tests using Jinja templating.
14+
15+
╭─ Options ────────────────────────────────────────────────────────────────────╮
16+
│ * --data -d PATH Path to data YAML files. │
17+
│ [env var: NAC_TEST_DATA] │
18+
│ [required] │
19+
│ * --templates -t DIRECTORY Path to test templates. │
20+
│ [env var: │
21+
│ NAC_TEST_TEMPLATES] │
22+
│ [required] │
23+
│ * --output -o DIRECTORY Path to output directory. │
24+
│ [env var: │
25+
│ NAC_TEST_OUTPUT] │
26+
│ [required] │
27+
│ --filters -f DIRECTORY Path to Jinja filters. │
28+
│ [env var: │
29+
│ NAC_TEST_FILTERS] │
30+
│ --tests DIRECTORY Path to Jinja tests. │
31+
│ [env var: NAC_TEST_TESTS] │
32+
│ --include -i TEXT Selects the test cases by │
33+
│ tag (include). │
34+
│ [env var: │
35+
│ NAC_TEST_INCLUDE] │
36+
│ --exclude -e TEXT Selects the test cases by │
37+
│ tag (exclude). │
38+
│ [env var: │
39+
│ NAC_TEST_EXCLUDE] │
40+
│ --render-only Only render tests without │
41+
│ executing them. │
42+
│ [env var: │
43+
│ NAC_TEST_RENDER_ONLY] │
44+
│ --dry-run Dry run flag. See robot │
45+
│ dry run mode. │
46+
│ [env var: │
47+
│ NAC_TEST_DRY_RUN] │
48+
│ --verbosity -v [DEBUG|INFO|WARNING|ERR Verbosity level. │
49+
│ OR|CRITICAL] [env var: │
50+
│ NAC_VALIDATE_VERBOSITY] │
51+
│ [default: WARNING] │
52+
│ --version Display version number. │
53+
│ --help Show this message and │
54+
│ exit. │
55+
╰──────────────────────────────────────────────────────────────────────────────╯
2956
```
3057

3158
All data from the YAML files (`--data` option) will first be combined into a single data structure which is then provided as input to the templating process. Each template in the `--templates` path will then be rendered and written to the `--output` path. If the `--templates` path has subfolders, the folder structure will be retained when rendering the templates.
@@ -36,19 +63,24 @@ After all templates have been rendered [Pabot](https://pabot.org/) will execute
3663

3764
Python 3.10+ is required to install `nac-test`. Don't have Python 3.10 or later? See [Python 3 Installation & Setup Guide](https://realpython.com/installing-python/).
3865

39-
`nac-test` can be installed in a virtual environment using `pip`:
66+
`nac-validate` can be installed in a virtual environment using `pip` or `uv`:
4067

41-
```shell
68+
```bash
69+
# Using pip
4270
pip install nac-test
71+
72+
# Using uv (recommended)
73+
uv tools install nac-test
4374
```
4475

45-
The following Robot libraries are installed with `nac-test`:
76+
The following Robot libraries are included with `nac-test`:
4677

47-
- [RESTinstance](https://github.com/asyrjasalo/RESTinstance)
48-
- [Requests](https://github.com/MarketSquare/robotframework-requests)
49-
- [JSONLibrary](https://github.com/robotframework-thailand/robotframework-jsonlibrary)
78+
- [RESTinstance](https://github.com/asyrjasalo/RESTinstance) (≥1.5.2)
79+
- [robotframework-requests](https://github.com/MarketSquare/robotframework-requests) (≥0.9.7)
80+
- [robotframework-jsonlibrary](https://github.com/robotframework-thailand/robotframework-jsonlibrary) (≥0.5)
81+
- [robotframework-pabot](https://pabot.org/) (≥4.3.2) for parallel test execution
5082

51-
Any other libraries can of course be added via `pip`.
83+
Any other libraries can of course be added via `pip` or `uv`.
5284

5385
## Ansible Vault Support
5486

0 commit comments

Comments
 (0)