diff options
author | 2018-02-28 15:47:27 +0100 | |
---|---|---|
committer | 2018-03-01 14:59:10 +0100 | |
commit | e2bdf848d6d798d54f94f8e3a9e130910159f1d9 (patch) | |
tree | 2a9d49fb7557cbde763bf841fc633c1c5be53a31 /validation-scripts/README.md | |
parent | 6027a1ad84f129cf9f8996b3020849ec1461085b (diff) |
Import ICE tests from vvp/validation-scripts
Change-Id: Ia5de2787792dcc61d85f297a3262a80faa1f6d56
Issue-ID: VNFSDK-39
Signed-off-by: Mickael JEZEQUEL <mickael.jezequel@orange.com>
Diffstat (limited to 'validation-scripts/README.md')
-rw-r--r-- | validation-scripts/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/validation-scripts/README.md b/validation-scripts/README.md new file mode 100644 index 0000000..cf8456d --- /dev/null +++ b/validation-scripts/README.md @@ -0,0 +1,46 @@ +# ice-heat-validation + +This project contains a ``pytest`` tool that automatically checks Heat Templates +are adhering to the AT&T Domain 2.0 Heat Template Guidelines. + +# Installation + +This software is not platform dependent and can be run in a Windows, Unix or +OS X environment. + +### Satisfy Dependencies + +In addition to python, this project requires the following packages: + + - ``pytest`` + - ``PyYAML`` + - ``pytest-tap`` + + These can be installed using pip (assuming pip is installed) with the command: + +``$ pip install -r requirements.txt`` + +# Use + +Clone this project. + +To validate Heat templates just run this the command under the folder ``ice_validator``: + +``$ pytest --tap-stream --template-directory=<Directory>`` + +where ``<Directory>`` is the absolute path to the folder containing the Heat +Templates to be verified. + + +# Self-Test Suite + +The ``ice_validator`` includes an extensive self-test suite. It is a +**requirement** for any additions or changes to the test suite to +successfully and cleanly complete a tox run. Simply run ``tox`` from +the project root as: + +``$ tox`` + +You can also run it under the folder ``ice_validator``: + +``$ pytest --self-test`` |