diff options
Diffstat (limited to 'test')
| -rw-r--r-- | test/scenario_test/README.md | 115 |
1 files changed, 66 insertions, 49 deletions
diff --git a/test/scenario_test/README.md b/test/scenario_test/README.md index a4ab549e..84ab2d71 100644 --- a/test/scenario_test/README.md +++ b/test/scenario_test/README.md @@ -1,15 +1,26 @@ -Scenario Test -======================== +# Scenario Test This page explains how to set up a scenario test environment and run the test. +## Contents + +- [Prerequisites](#prerequisites) +- [Check](#check) +- [Set up dependencies](#set-up-dependencies) +- [Install local source code](#install-local-source-code) +- [Run test](#run-test) +- [Clean up](#clean-up) + ## Prerequisites -Assume you finished setting up [Golang](https://golang.org/doc/install) and [Docker](https://docs.docker.com/installation/ubuntulinux/) on Ubuntu 14.04 Server VM. +Assume you finished setting up [Golang](https://golang.org/doc/install) and +[Docker](https://docs.docker.com/installation/ubuntulinux/) on Ubuntu 14.04 +Server VM. We recommend allocating memory more than 8GB to the VM. Because this scenario test runs a lot of test cases concurrently. -## <a name="section0"> Check +## Check + Please check if Golang and Docker is installed correctly and make sure the $GOPATH is defined. @@ -38,40 +49,43 @@ Server: OS/Arch: linux/amd64 ``` -## <a name="section1"> Set up dependencies +## Set up dependencies + Execute the following commands inside the VM to install the dependencies: 1. Install pip and [pipework](https://github.com/jpetazzo/pipework). -```shell -$ sudo apt-get update -$ sudo apt-get install git python-pip python-dev iputils-arping bridge-utils lv -$ sudo wget https://raw.github.com/jpetazzo/pipework/master/pipework -O /usr/local/bin/pipework -$ sudo chmod 755 /usr/local/bin/pipework -``` + ```shell + $ sudo apt-get update + $ sudo apt-get install git python-pip python-dev iputils-arping bridge-utils lv + $ sudo wget https://raw.github.com/jpetazzo/pipework/master/pipework -O /usr/local/bin/pipework + $ sudo chmod 755 /usr/local/bin/pipework + ``` -2. Get docker images. - Download docker images pertaining to GoBGP testing. +1. Get docker images. -```shell -$ sudo docker pull golang:1.7 -$ sudo docker pull osrg/gobgp -$ sudo docker pull osrg/quagga -$ sudo docker pull osrg/quagga:v1.0 -$ sudo docker pull osrg/exabgp -``` + Download docker images pertaining to GoBGP testing. -3. Clone GoBGP and install python libraries. + ```shell + $ sudo docker pull golang:1.7 + $ sudo docker pull osrg/gobgp + $ sudo docker pull osrg/quagga + $ sudo docker pull osrg/quagga:v1.0 + $ sudo docker pull osrg/exabgp + ``` -```shell -$ mkdir -p $GOPATH/src/github.com/osrg -$ cd $GOPATH/src/github.com/osrg -$ git clone https://github.com/osrg/gobgp.git -$ cd ./gobgp/test -$ sudo pip install -r pip-requires.txt -``` +1. Clone GoBGP and install python libraries. + + ```shell + $ mkdir -p $GOPATH/src/github.com/osrg + $ cd $GOPATH/src/github.com/osrg + $ git clone https://github.com/osrg/gobgp.git + $ cd ./gobgp/test + $ sudo pip install -r pip-requires.txt + ``` + +## Install local source code -## <a name="section2"> Install local source code You need to install local source code into GoBGP docker container. You also need this operation at every modification to the source code. @@ -80,32 +94,35 @@ $ cd $GOPATH/src/github.com/osrg/gobgp $ sudo fab -f ./test/lib/base.py make_gobgp_ctn --set tag=gobgp ``` -## <a name="section3"> Run test +## Run test 1. Run all test. - You can run all scenario tests with run_all_tests.sh. - If all tests passed, you can see "all tests passed successfully" at the end of the test. -```shell -$ cd $GOPATH/src/github.com/osrg/gobgp/test/scenario_test -$ ./run_all_tests.sh -... -OK -all tests passed successfully -``` + You can run all scenario tests with run_all_tests.sh. + If all tests passed, you can see "all tests passed successfully" at the end of the test. -2. Run each test. - You can run scenario tests individually with each test file. - See `test/scenario_test/*.py`, for the individual test files. + ```shell + $ cd $GOPATH/src/github.com/osrg/gobgp/test/scenario_test + $ ./run_all_tests.sh + ... + OK + all tests passed successfully + ``` -```shell -$ cd $GOPATH/src/github.com/osrg/gobgp/test/scenario_test -$ sudo -E PYTHONPATH=$GOBGP/test python <scenario test name>.py -... -OK -``` +1. Run each test. + + You can run scenario tests individually with each test file. + See `test/scenario_test/*.py`, for the individual test files. + + ```shell + $ cd $GOPATH/src/github.com/osrg/gobgp/test/scenario_test + $ sudo -E PYTHONPATH=$GOBGP/test python <scenario test name>.py + ... + OK + ``` + +## Clean up -## <a name="section4"> Clean up A lot of containers, networks temporary files are created during the test. Let's clean up. |