extras/hs-test/README.rst

   1 Host stack test framework
   2 =========================
   3
   4 Overview
   5 --------
   6
   7 The goal of the Host stack test framework (**hs-test**) is to ease writing and running end-to-end tests for VPP's Host Stack.
   8 End-to-end tests often want multiple VPP instances, network namespaces, different types of interfaces
   9 and to execute external tools or commands. With such requirements the existing VPP test framework is not sufficient.
  10 For this, ``Go`` was chosen as a high level language, allowing rapid development, with ``Docker`` and ``ip`` being the tools for creating required topology.
  11
  12 Go's package `testing`_ together with `go test`_ command form the base framework upon which the *hs-test* is built and run.
  13
  14 Anatomy of a test case
  15 ----------------------
  16
  17 **Prerequisites**:
  18
  19 * Tests use *hs-test*'s own docker image, so building it before starting tests is a prerequisite. Run ``sudo make`` to do so
  20 * Docker has to be installed and Go has to be in path of both the running user and root
  21 * Root privileges are required to run tests as it uses Linux ``ip`` command for configuring topology
  22
  23 **Action flow when running a test case**:
  24
  25 #. It starts with running ``./test``. This script is basically a wrapper for ``go test`` and accepts its parameters,
  26    for example following runs a specific test: ``./test -run TestNs/TestHttpTps``
  27 #. ``go test`` compiles package ``main`` along with any files with names matching the file pattern ``*_test.go``
  28    and then runs the resulting test binaries
  29 #. The go test framework runs each function matching :ref:`naming convention<test-convention>`. Each of these corresponds to a `test suite`_
  30 #. Testify toolkit's ``suite.Run(t *testing.T, suite TestingSuite)`` function runs the suite and does the following:
  31
  32   #. Suite is initialized. The topology is loaded and configured in this step
  33   #. Test suite runs all the tests attached to it
  34   #. Execute tear-down functions, which currently consists of stopping running containers
  35      and clean-up of test topology
  36
  37 Adding a test case
  38 ------------------
  39
  40 This describes adding a new test case to an existing suite.
  41 For adding a new suite, please see `Modifying the framework`_ below.
  42
  43 #. To write a new test case, create a file whose name ends with ``_test.go`` or pick one that already exists
  44 #. Declare method whose name starts with ``Test`` and specifies its receiver as a pointer to the suite's struct (defined in ``framework_test.go``)
  45 #. Implement test behaviour inside the test method. This typically includes the following:
  46
  47   #. Start docker container(s) as needed. Function ``dockerRun(instance, args string)``
  48      from ``utils.go`` serves this purpose. Alternatively use suite struct's ``NewContainer(name string)`` method to create
  49      an object representing a container and start it with ``run()`` method
  50   #. Execute *hs-test* action(s) inside any of the running containers.
  51      Function ``hstExec`` from ``utils.go`` does this by using ``docker exec`` command to run ``hs-test`` executable.
  52      For starting an VPP instance inside a container, the ``VppInstance`` struct can be used as a forward-looking alternative
  53   #. Run arbitrary commands inside the containers with ``dockerExec(cmd string, instance string)``
  54   #. Run other external tool with one of the preexisting functions in the ``utils.go`` file.
  55      For example, use ``wget`` with ``startWget(..)`` function
  56   #. Use ``exechelper`` or just plain ``exec`` packages to run whatever else
  57   #. ``defer func() { exechelper.Run("docker stop <container-name>) }()`` inside the method body,
  58      to stop the running container(s). It's not necessary to do this if containers were created
  59      with suite's ``NewContainer(..)`` method
  60
  61 **Example test case**
  62
  63 Two docker containers, each with its own VPP instance running. One VPP then pings the other.
  64 This can be put in file ``extras/hs-test/my_test.go`` and run with command ``./test -run TestMySuite``.
  65
  66 ::
  67
  68         package main
  69
  70         import (
  71                 "fmt"
  72                 "github.com/edwarnicke/exechelper"
  73         )
  74
  75         func (s *MySuite) TestMyCase() {
  76                 t := s.T()
  77
  78                 vpp1Instance := "vpp-1"
  79                 vpp2Instance := "vpp-2"
  80
  81                 err := dockerRun(vpp1Instance, "")
  82                 if err != nil {
  83                         t.Errorf("%v", err)
  84                         return
  85                 }
  86                 defer func() { exechelper.Run("docker stop " + vpp1Instance) }()
  87
  88                 err = dockerRun(vpp2Instance, "")
  89                 if err != nil {
  90                         t.Errorf("%v", err)
  91                         return
  92                 }
  93                 defer func() { exechelper.Run("docker stop " + vpp2Instance) }()
  94
  95                 _, err = hstExec("Configure2Veths srv", vpp1Instance)
  96                 if err != nil {
  97                         t.Errorf("%v", err)
  98                         return
  99                 }
 100
 101                 _, err = hstExec("Configure2Veths cln", vpp2Instance)
 102                 if err != nil {
 103                         t.Errorf("%v", err)
 104                         return
 105                 }
 106
 107                 // ping one VPP from the other
 108                 //
 109                 // not using dockerExec because it executes in detached mode
 110                 // and we want to capture output from ping and show it
 111                 command := "docker exec --detach=false vpp-1 vppctl -s /tmp/2veths/var/run/vpp/cli.sock ping 10.10.10.2"
 112                 output, err := exechelper.CombinedOutput(command)
 113                 if err != nil {
 114                         t.Errorf("ping failed: %v", err)
 115                 }
 116                 fmt.Println(string(output))
 117         }
 118
 119 Modifying the framework
 120 -----------------------
 121
 122 **Adding a test suite**
 123
 124 .. _test-convention:
 125
 126 #. Adding a new suite takes place in ``framework_test.go``
 127
 128 #. Make a ``struct`` with at least ``HstSuite`` struct as its member.
 129    HstSuite provides functionality that can be shared for all suites, like starting containers
 130
 131         ::
 132
 133                 type MySuite struct {
 134                         HstSuite
 135                 }
 136
 137 #. Implement SetupSuite method which testify runs before running the tests.
 138    It's important here to call ``setupSuite(s *suite.Suite, topologyName string)`` and assign its result to the suite's ``teardownSuite`` member.
 139    Pass the topology name to the function in the form of file name of one of the *yaml* files in ``topo`` folder.
 140    Without the extension. In this example, *myTopology* corresponds to file ``extras/hs-test/topo/myTopology.yaml``
 141
 142         ::
 143
 144                 func (s *MySuite) SetupSuite() {
 145                         // Add custom setup code here
 146
 147                         s.teardownSuite = setupSuite(&s.Suite, "myTopology")
 148                 }
 149
 150 #. In order for ``go test`` to run this suite, we need to create a normal test function and pass our suite to ``suite.Run``
 151
 152         ::
 153
 154                 func TestMySuite(t *testing.T) {
 155                         var m MySuite
 156                         suite.Run(t, &m)
 157                 }
 158
 159 #. Next step is to add test cases to the suite. For that, see section `Adding a test case`_ above
 160
 161 **Adding a topology element**
 162
 163 Topology configuration exists as ``yaml`` files in the ``extras/hs-test/topo`` folder.
 164 Processing of a file for a particular test suite is started by the ``setupSuite`` function depending on which file's name is passed to it.
 165 Specified file is loaded by ``LoadTopology()`` function and converted into internal data structures which represent various elements of the topology.
 166 After parsing the configuration, ``Configure()`` method loops over array of topology elements and configures them one by one.
 167
 168 These are currently supported types of elements.
 169
 170 * ``netns`` - network namespace
 171 * ``veth`` - veth network interface, optionally with target network namespace or IPv4 address
 172 * ``bridge`` - ethernet bridge to connect created interfaces, optionally with target network namespace
 173 * ``tap`` - tap network interface with IP address
 174
 175 Supporting a new type of topology element requires adding code to recognize the new element type during loading.
 176 And adding code to set up the element in the host system with some Linux tool, such as *ip*. This should be implemented in ``netconfig.go``.
 177
 178 **Communicating between containers**
 179
 180 When two VPP instances or other applications, each in its own Docker container,
 181 want to communicate there are typically two ways this can be done within *hs-test*.
 182
 183 * Network interfaces. Containers are being created with ``-d --network host`` options,
 184   so they are connected with interfaces created in host system
 185 * Shared folders. Containers are being created with ``-v`` option to create shared `volumes`_ between host system and containers
 186   or just between containers
 187
 188 **Adding a hs-test action**
 189
 190 Executing more complex or long running jobs is made easier by *hs-test* actions.
 191 These are functions that compartmentalize configuration and execution together for a specific task.
 192 For example, starting up VPP or running VCL echo client.
 193
 194 The actions are located in ``extras/hs-test/actions.go``. To add one, create a new method that has its receiver as a pointer to ``Actions`` struct.
 195
 196 Run it from test case with ``hstExec(args, instance)`` where ``args`` is the action method's name and ``instance`` is target Docker container's name.
 197 This then executes the ``hs-test`` binary inside of the container and it then runs selected action.
 198 Action is specified by its name as first argument for the binary.
 199
 200 *Note*: When ``hstExec(..)`` runs some action from a test case, the execution of ``hs-test`` inside the container
 201 is asynchronous. The action might take many seconds to finish, while the test case execution context continues to run.
 202 To mitigate this, ``hstExec(..)`` waits pre-defined arbitrary number of seconds for a *sync file* to be written by ``hs-test``
 203 at the end of its run. The test case context and container use Docker volume to share the file.
 204
 205 **Adding an external tool**
 206
 207 If an external program should be executed as part of a test case, it might be useful to wrap its execution in its own function.
 208 These types of functions are placed in the ``utils.go`` file. If the external program is not available by default in Docker image,
 209 add its installation to ``extras/hs-test/Dockerfile.vpp`` in ``apt-get install`` command.
 210 Alternatively copy the executable from host system to the Docker image, similarly how the VPP executables and libraries are being copied.
 211
 212 **Eternal dependencies**
 213
 214 * Linux tools ``ip``, ``brctl``
 215 * Standalone programs ``wget``, ``iperf3`` - since these are downloaded when Docker image is made,
 216   they are reasonably up-to-date automatically
 217 * Programs in Docker images  - see ``envoyproxy/envoy-contrib`` in ``utils.go``
 218 * ``http_server`` - homegrown application that listens on specified address and sends a test file in response
 219 * Non-standard Go libraries - see ``extras/hs-test/go.mod``
 220
 221 Generally, these will be updated on a per-need basis, for example when a bug is discovered
 222 or a new version incompatibility issue occurs.
 223
 224
 225 .. _testing: https://pkg.go.dev/testing
 226 .. _go test: https://pkg.go.dev/cmd/go#hdr-Test_packages
 227 .. _test suite: https://github.com/stretchr/testify#suite-package
 228 .. _volumes: https://docs.docker.com/storage/volumes/
 229