Add vagrant setup for testing VPP device locally

[csit.git] / docs / testing_in_vagrant.rst

diff --git a/docs/testing_in_vagrant.rst b/docs/testing_in_vagrant.rst
new file mode 100644 (file)
index 0000000..60b4cc5
--- /dev/null
+++ b/docs/testing_in_vagrant.rst
@@ -0,0 +1,46 @@
+Running CSIT locally in Vagrant
+-------------------------------
+
+1. Download and install latest virtualbox from `official page <https://www.virtualbox.org/wiki/Downloads>`_
+   To verify the installation, run VBoxManage:
+      - on windows: "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" --version
+      - on nix: VBoxManage --version
+   You should see virtualbox manager version printed, eg: 6.0.0r127566
+
+2. Download and install latest vagrant `from official page <https://www.vagrantup.com/downloads.html>`_
+   To verify the installtion, run:
+      vagrant -v
+   You should see vagrant version printed, eg: Vagrant 2.2.2
+
+3. Install vagrant plugins
+   From command line run:
+      vagrant plugin install vagrant-vbguest
+      vagrant plugin install vagrant-cachier
+
+   If you are behind a proxy, install proxyconf plugin and update proxy
+   settings in Vagrantfile:
+      vagrant plugin install vagrant-proxyconf
+
+4. Start the provisioning:
+      vagrant up --provider virtualbox
+
+Your new VPP Device virtualbox machine will be created and configured.
+Master branch of csit project will be cloned inside virtual machine into
+      /home/vagrant/csit folder.
+Once the process is finished, you can login to the box using:
+      vagrant ssh
+
+From within the box run the tests using:
+      cd /home/vagrant/csit/resources/libraries/bash/entry
+      ./bootstrap_vpp_device.sh csit-vpp-device-master-ubuntu1804-1n-vbox
+
+In case you need to completely rebuild the box and start from scratch,
+run these commands:
+      vagrant destroy -f
+      vagrant up --provider virtualbox
+
+To run only selected tests based on TAGS, export environment variables before
+running the test suite:
+      export GERRIT_EVENT_TYPE="comment-added"
+      export GERRIT_EVENT_COMMENT_TEXT="devicetest memif"
+      ./bootstrap_vpp_device.sh csit-vpp-device-master-ubuntu1804-1n-vbox
\ No newline at end of file