saltstack-formulas/nginx-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #252 from n-rodriguez/wip/doc

Browse Source 
docs(readme): update testing section
This commit is contained in:
Nicolas Rodriguez 2019-08-25 21:52:26 +02:00 committed by GitHub
commit 90f3849b40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/README.rst
View File

@ -130,27 +130,42 @@ Testing
Linux testing is done with ``kitchen-salt``. Linux testing is done with ``kitchen-salt``.
``kitchen converge`` Requirements
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^
Creates the docker instance and runs the ``template`` main state, ready for testing. * Ruby
* Docker
``kitchen verify`` .. 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``.
``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the docker instance and runs the ``nginx`` main state, ready for testing.
``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^
Runs the ``inspec`` tests on the actual instance. Runs the ``inspec`` tests on the actual instance.
``kitchen destroy`` ``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Removes the docker instance. Removes the docker instance.
``kitchen test`` ``bin/kitchen test``
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
``kitchen login`` ``bin/kitchen login``
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Gives you SSH access to the instance for manual testing. Gives you SSH access to the instance for manual testing.