Skip to content

Commit 182f216

Browse files
committedAug 25, 2019
docs(readme): update testing section
1 parent 011bf32 commit 182f216

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed
 

‎docs/README.rst

+26-11
Original file line numberDiff line numberDiff line change
@@ -130,27 +130,42 @@ Testing
130130

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

133-
``kitchen converge``
134-
^^^^^^^^^^^^^^^^^^^^
133+
Requirements
134+
^^^^^^^^^^^^
135+
136+
* Ruby
137+
* Docker
138+
139+
.. code-block:: bash
140+
141+
$ gem install bundler
142+
$ bundle install
143+
$ bin/kitchen test [platform]
144+
145+
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
146+
e.g. ``debian-9-2019-2-py3``.
147+
148+
``bin/kitchen converge``
149+
^^^^^^^^^^^^^^^^^^^^^^^^
135150

136-
Creates the docker instance and runs the ``template`` main state, ready for testing.
151+
Creates the docker instance and runs the ``nginx`` main state, ready for testing.
137152

138-
``kitchen verify``
139-
^^^^^^^^^^^^^^^^^^
153+
``bin/kitchen verify``
154+
^^^^^^^^^^^^^^^^^^^^^^
140155

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

143-
``kitchen destroy``
144-
^^^^^^^^^^^^^^^^^^^
158+
``bin/kitchen destroy``
159+
^^^^^^^^^^^^^^^^^^^^^^^
145160

146161
Removes the docker instance.
147162

148-
``kitchen test``
149-
^^^^^^^^^^^^^^^^
163+
``bin/kitchen test``
164+
^^^^^^^^^^^^^^^^^^^^
150165

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

153-
``kitchen login``
154-
^^^^^^^^^^^^^^^^^
168+
``bin/kitchen login``
169+
^^^^^^^^^^^^^^^^^^^^^
155170

156171
Gives you SSH access to the instance for manual testing.

0 commit comments

Comments
 (0)
Please sign in to comment.