diff options
author | 2017-09-05 11:21:28 -0700 | |
---|---|---|
committer | 2017-09-05 11:48:52 -0700 | |
commit | cc21b8b08b6dbcec577bfb26ff397ac899da8002 (patch) | |
tree | 5d8a26586b0b0aee94002b472dfe995ffcb58fdf /README.md | |
parent | 6755f61e44870ff65de0630a403f7b4ddfea4071 (diff) |
Commit seed code for validation-scripts
This imports the initial seed code for validation scripts.
These files were imported from a tarball with the SHA1SUM
ce2ae49c82546b987c8ad2f68ac43d94b4934818.
From the contents of the tarball, some errant .pyc files were removed,
and a .gitignore file was added. The result matches exactly the contents
of the origin private repository at hash 88c656e.
Change-Id: I97d19b11495e116890ca6577e83037b0934519cc
Issue-Id: VVP-11
Signed-off-by: Michael F. Lamb <mike@datagrok.org>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf8456d --- /dev/null +++ b/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`` |