Skip to content

Commit

Permalink
docs(readme): add testing section based on postgres-formula
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed May 13, 2019
1 parent 635571b commit c309d5f
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,33 @@ dependency on ``template.service.clean`` via include list.
This state will remove the template package and has a depency on
``template.config.clean`` via include list.

Testing
-------

Linux testing is done with ``kitchen-salt``.

``kitchen converge``
^^^^^^^^^^^^^^^^^^^^

Creates the docker instance and runs the ``template`` main state, ready for testing.

``kitchen verify``
^^^^^^^^^^^^^^^^^^

Runs the ``inspec`` tests on the actual instance.

``kitchen destroy``
^^^^^^^^^^^^^^^^^^^

Removes the docker instance.

``kitchen test``
^^^^^^^^^^^^^^^^

Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.

``kitchen login``
^^^^^^^^^^^^^^^^^

Gives you SSH access to the instance for manual testing.

0 comments on commit c309d5f

Please sign in to comment.