docs: add steps required for testing using Vagrant

Author: dafyddj

docs/README.rst

@@ -68,7 +68,7 @@ Configures OpenVPN GUI (Windows only). Sets global registry settings as describe
 Manages TAP-Windows device adapters (Windows only). Ensures that any devices specified with ``dev_node`` in pillar exist.
 
 ``openvpn.ifconfig_pool_persist``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Installs and configures an ifconfig_pool_persist file. Used to assign host IPs.
 
@@ -85,23 +85,32 @@ See *openvpn/pillar.example*.
 Notes
 -----
 
-This formula does can optionally deploy certificates and keys, but does not generate them. This must be done manually or with another formula.
+This formula can optionally deploy certificates and keys, but does not generate them. This must be done manually or with another formula.
 
 Testing
 -------
 
-Linux testing is done with ``kitchen-salt``.
+Integration testing is done using `Kitchen <https://kitchen.ci/>`_ using the provisioner `kitchen-salt <https://github.com/saltstack/kitchen-salt>`_.
 
 Requirements
 ^^^^^^^^^^^^
 
 * Ruby
 * Docker
 
+When testing platforms other than Linux:
+
+* Vagrant
+* Virtualbox
+
+Setup
+^^^^^
+
 .. code-block:: bash
 
    $ gem install bundler
-   $ bundle install
+   $ bundle install                 # Alternatively,
+   $ bundle install --with=vagrant  # When testing using Vagrant
    $ bin/kitchen test [platform]
 
 Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
@@ -110,17 +119,17 @@ e.g. ``debian-9-2019-2-py3``.
 ``bin/kitchen converge``
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-Creates the docker instance and runs the ``openvpn`` main state, ready for testing.
+Creates the test instance and runs the ``openvpn`` main state, ready for testing.
 
 ``bin/kitchen verify``
 ^^^^^^^^^^^^^^^^^^^^^^
 
-Runs the ``inspec`` tests on the actual instance.
+Runs the ``inspec`` tests on the test instance.
 
 ``bin/kitchen destroy``
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Removes the docker instance.
+Stops and destroys the test instance.
 
 ``bin/kitchen test``
 ^^^^^^^^^^^^^^^^^^^^
@@ -130,4 +139,14 @@ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``veri
 ``bin/kitchen login``
 ^^^^^^^^^^^^^^^^^^^^^
 
-Gives you SSH access to the instance for manual testing.
+Gives you SSH/RDP access to the instance for manual testing.
+
+Note
+^^^^
+When testing using Vagrant you must set the environment variable ``KITCHEN_LOCAL_YAML`` to ``kitchen.vagrant.yml``.  For example:
+
+.. code-block:: bash
+
+   $ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test  # Alternatively,
+   $ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml
+   $ bin/kitchen test