Skip to content

Commit

Permalink
docs(readme): add testing requirements section
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed May 28, 2019
1 parent 8c3ad3c commit 20155bb
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,24 @@ Testing

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

Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.


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

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

``kitchen verify``
^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 20155bb

Please sign in to comment.