blob: cf8456dad1952cfe76ffef759aa2386cd4ead278 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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``
|
