Merge pull request #252 from n-rodriguez/wip/doc
docs(readme): update testing section
This commit is contained in:
		
						commit
						90f3849b40
					
				@ -130,27 +130,42 @@ Testing
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
``kitchen destroy``
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
``bin/kitchen destroy``
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
Removes the docker instance.
 | 
			
		||||
 | 
			
		||||
``kitchen test``
 | 
			
		||||
^^^^^^^^^^^^^^^^
 | 
			
		||||
``bin/kitchen test``
 | 
			
		||||
^^^^^^^^^^^^^^^^^^^^
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user