diff options
| -rw-r--r-- | docs/files/ICE.rst | 64 | ||||
| -rw-r--r-- | docs/files/ice-report.png | bin | 0 -> 43266 bytes | |||
| -rw-r--r-- | docs/index.rst | 10 |
3 files changed, 74 insertions, 0 deletions
diff --git a/docs/files/ICE.rst b/docs/files/ICE.rst new file mode 100644 index 0000000..a3ba77e --- /dev/null +++ b/docs/files/ICE.rst @@ -0,0 +1,64 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Orange Labs. + +ICE validation scripts +====================== + +The ICE validation scripts are based on the python ``pytest`` tool. +These scripts check that the Heat Templates are compliant with the ONAP Heat Template Guidelines. + +Installation +------------ + +This software is not platform dependent and can be run in a Windows, Unix or +OS X environment. + +- Install python 2.7 or python 3 +- Install pip + +In addition to python, this project requires the following packages: + +- pytest +- PyYAML + +Depending on the desired output format, you should add the following optional packages: + +- pytest-tap +- pytest-html + +These can be installed using pip (assuming pip is installed) with the command: + +``$ pip install pytest PyYAML pytest-tap pytest-html`` + +Usage +----- + +Retrieve the ICE scripts, by cloning the sources: + +``$ git clone https://git.onap.org/vnfsdk/ice`` + +Go into the ice_validator directory: + +``$ cd ice/validation-scripts/ice_validator`` + +The Heat templates validation may generate different ouput format (plain, tap, html): + +- plain format + +``$ pytest --template-directory=<Directory>`` + +- tap format + +``$ pytest --tap-stream --template-directory=<Directory>`` + +- html format + +``$ pytest --html=/path/to/report.html --template-directory=<Directory>`` + +NB: ``<Directory>`` is the absolute path of the folder containing the Heat +Templates to be verified. + +.. image:: ./ice-report.png + +Figure 1: example of html report generated by ICE scripts diff --git a/docs/files/ice-report.png b/docs/files/ice-report.png Binary files differnew file mode 100644 index 0000000..74f6e98 --- /dev/null +++ b/docs/files/ice-report.png diff --git a/docs/index.rst b/docs/index.rst index a16fd09..af04833 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -137,3 +137,13 @@ VNF Certification Testing Framework - Dovetail :titlesonly: files/Dovetail + +ICE tools for HEAT validation +----------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + files/ICE + |
