Skip to content

Commit 7aa7df8

Browse files
authored
Merge pull request #109 from myii/docs/add-testing-section
docs(readme): add testing section based on `postgres-formula`
2 parents ad62c85 + c309d5f commit 7aa7df8

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/README.rst

+30
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,33 @@ dependency on ``template.service.clean`` via include list.
103103
This state will remove the template package and has a depency on
104104
``template.config.clean`` via include list.
105105

106+
Testing
107+
-------
108+
109+
Linux testing is done with ``kitchen-salt``.
110+
111+
``kitchen converge``
112+
^^^^^^^^^^^^^^^^^^^^
113+
114+
Creates the docker instance and runs the ``template`` main state, ready for testing.
115+
116+
``kitchen verify``
117+
^^^^^^^^^^^^^^^^^^
118+
119+
Runs the ``inspec`` tests on the actual instance.
120+
121+
``kitchen destroy``
122+
^^^^^^^^^^^^^^^^^^^
123+
124+
Removes the docker instance.
125+
126+
``kitchen test``
127+
^^^^^^^^^^^^^^^^
128+
129+
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
130+
131+
``kitchen login``
132+
^^^^^^^^^^^^^^^^^
133+
134+
Gives you SSH access to the instance for manual testing.
135+

0 commit comments

Comments
 (0)