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

Update README.md

Browse Source
This commit is contained in:
Pim van Pelt
2022-03-22 22:58:38 +01:00
committed by GitHub
parent c37faecd3f
commit df1b1bbbef
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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 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 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 `tests.py`. Besides regular unittests provided by the Python framework, a YAMLTest is a test which
and the second document is a candidate configuration file to test. 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 syntax and semantic
validators and reports back.
The format of the unit test is as follows: The format of the YAMLTest is as follows:
``` ```
test: test:
description: str() description: str()