README.md

   1 # ice-heat-validation
   2
   3 This project contains a ``pytest`` tool that automatically checks Heat Templates
   4 are adhering to the AT&T Domain 2.0 Heat Template Guidelines.
   5
   6 # Installation
   7
   8 This software is not platform dependent and can be run in a Windows, Unix or
   9 OS X environment.
  10
  11 ### Satisfy Dependencies
  12
  13 In addition to python, this project requires the following packages:
  14
  15  - ``pytest``
  16  - ``PyYAML``
  17  - ``pytest-tap``
  18
  19  These can be installed using pip (assuming pip is installed) with the command:
  20
  21 ``$ pip install -r requirements.txt``
  22
  23 # Use
  24
  25 Clone this project.
  26
  27 To validate Heat templates just run this the command under the folder ``ice_validator``:
  28
  29 ``$ pytest --tap-stream --template-directory=<Directory>``
  30
  31 where ``<Directory>`` is the absolute path to the folder containing the Heat
  32 Templates to be verified.
  33
  34
  35 # Self-Test Suite
  36
  37 The ``ice_validator`` includes an extensive self-test suite. It is a
  38 **requirement** for any additions or changes to the test suite to
  39 successfully and cleanly complete a tox run. Simply run ``tox`` from
  40 the project root as:
  41
  42 ``$ tox``
  43
  44 You can also run it under the folder ``ice_validator``:
  45
  46 ``$ pytest --self-test``