ipng/vppcfg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'main' of github.com:pimvanpelt/vppcfg into main

Browse Source
This commit is contained in:
Pim van Pelt
2022-03-23 17:11:46 +00:00
parent 7390322693 613b4a27c7
commit bcc4c8ff05
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -19,7 +19,7 @@ sudo pip3 install pyyaml
sudo pip3 install pyinstaller
## Ensure all unittests pass.
./tests.py -t unittest/*.yaml
./tests.py -d -t unittest/yaml/*.yaml
## Build the tool
pyinstaller vppcfg --onefile
@ -83,10 +83,12 @@ in the configuration file is able to be committed.
It is incredibly important that changes to this codebase, particularly the validators, are well
tested. Unit tests are provided in the `unittests/` directory with a Python test runner in
`tests.py`. A test is a two-document YAML file, the first document describes the unit test
and the second document is a candidate configuration file to test.
`tests.py`. Besides regular unittests provided by the Python framework, a YAMLTest is a test which
reads a two-document YAML file, with the first document describing test metadata, and the second
document being a candidate configuration to test, and it then runs all schema and semantic
validators and reports back.
The format of the unit test is as follows:
The format of the YAMLTest is as follows:
```
test:
description: str()