hs-test: manage containers and volumes within test suite

Type: test
Signed-off-by: Maros Ondrejicka <maros.ondrejicka@pantheon.tech>
Change-Id: I614111814af5a99dcaa22c8581ea2d339572ae1c

extras/hs-test/container.go

@@ -6,8 +6,14 @@ import (
 	"github.com/edwarnicke/exechelper"
 )
 
+type Volume struct {
+	name string
+	path string
+}
+
 type Container struct {
 	name    string
+	volumes []*Volume
 }
 
 func (c *Container) run() error {
@@ -19,6 +25,7 @@ func (c *Container) run() error {
 	syncPath := fmt.Sprintf("-v /tmp/%s/sync:/tmp/sync", c.name)
 	cmd := "docker run --cap-add=all -d --privileged --network host --rm "
 	cmd += syncPath
+	cmd += c.getVolumes()
 	cmd += " --name " + c.name + " hs-test/vpp"
 	fmt.Println(cmd)
 	err := exechelper.Run(cmd)
@@ -29,3 +36,22 @@ func (c *Container) run() error {
 	return nil
 }
 
+func (c *Container) addVolume(name string, containerPath string) {
+	c.volumes = append(c.volumes, &Volume{name, containerPath})
+}
+
+func (c *Container) getVolumes() string {
+	dockerOption := ""
+
+	if len(c.volumes) > 0 {
+		for _, volume := range c.volumes {
+			dockerOption += fmt.Sprintf(" -v %s:%s", volume.name, volume.path)
+		}
+	}
+
+	return dockerOption
+}
+
+func (c *Container) stop() error {
+	return exechelper.Run("docker stop " + c.name)
+}

extras/hs-test/framework_test.go

@@ -13,7 +13,7 @@ import (
 type HstSuite struct {
 	suite.Suite
 	teardownSuite func()
-	containers    []string
+	containers    []*Container
 	volumes       []string
 }
 
@@ -56,19 +56,30 @@ func (s *HstSuite) NewContainer(name string) (*Container, error) {
 		return nil, fmt.Errorf("creating container failed: name must not be blank")
 	}
 
-	s.containers = append(s.containers, name)
-
 	container := new(Container)
 	container.name = name
+
+	s.containers = append(s.containers, container)
+
 	return container, nil
 }
 
 func (s *HstSuite) StopContainers() {
-	for _, containerName := range s.containers {
+	for _, container := range s.containers {
-		exechelper.Run("docker stop " + containerName)
+		container.stop()
 	}
 }
 
+func (s *HstSuite) NewVolume(name string) error {
+	err := exechelper.Run(fmt.Sprintf("docker volume create --name=%s", name))
+	if err != nil {
+		return err
+	}
+
+	s.volumes = append(s.volumes, name)
+	return nil
+}
+
 func (s *HstSuite) RemoveVolumes() {
 	for _, volumeName := range s.volumes {
 		exechelper.Run("docker volume rm " + volumeName)

extras/hs-test/vcl_test.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/edwarnicke/exechelper"
 )
 
 func (s *VethsSuite) TestVclEchoQuic() {
@@ -22,67 +21,48 @@ func (s *VethsSuite) TestVclEchoTcp() {
 }
 
 func (s *VethsSuite) testVclEcho(proto string) {
-	t := s.T()
+	serverVolume := "echo-srv-vol"
+	s.NewVolume(serverVolume)
 
-	exechelper.Run("docker volume create --name=echo-srv-vol")
+	clientVolume := "echo-cln-vol"
-	exechelper.Run("docker volume create --name=echo-cln-vol")
+	s.NewVolume(clientVolume)
+
+	srvInstance := "vpp-vcl-test-srv"
+	serverVppContainer, err := s.NewContainer(srvInstance)
+	s.assertNil(err)
+	serverVppContainer.addVolume(serverVolume, "/tmp/Configure2Veths")
+	serverVppContainer.run()
+
+	clnInstance := "vpp-vcl-test-cln"
+	clientVppContainer, err := s.NewContainer(clnInstance)
+	s.assertNil(err)
+	clientVppContainer.addVolume(clientVolume, "/tmp/Configure2Veths")
+	clientVppContainer.run();
 
-	srvInstance := "vpp-echo-srv"
-	clnInstance := "vpp-echo-cln"
 	echoSrv := "echo-srv"
+	serverEchoContainer, err := s.NewContainer(echoSrv)
+	s.assertNil(err)
+	serverEchoContainer.addVolume(serverVolume, "/tmp/" + echoSrv)
+	serverEchoContainer.run()
+
 	echoCln := "echo-cln"
-
+	clientEchoContainer, err := s.NewContainer(echoCln)
-	err := dockerRun(srvInstance, "-v echo-srv-vol:/tmp/Configure2Veths")
+	s.assertNil(err)
-	if err != nil {
+	clientEchoContainer.addVolume(clientVolume, "/tmp/" + echoCln)
-		t.Errorf("%v", err)
+	clientEchoContainer.run()
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + srvInstance) }()
-
-	err = dockerRun(clnInstance, "-v echo-cln-vol:/tmp/Configure2Veths")
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + clnInstance) }()
-
-	err = dockerRun(echoSrv, fmt.Sprintf("-v echo-srv-vol:/tmp/%s", echoSrv))
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + echoSrv) }()
-
-	err = dockerRun(echoCln, fmt.Sprintf("-v echo-cln-vol:/tmp/%s", echoCln))
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + echoCln) }()
 
 	_, err = hstExec("Configure2Veths srv", srvInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("%v", err)
-		return
-	}
 
 	_, err = hstExec("Configure2Veths cln", clnInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("%v", err)
-		return
-	}
 
 	// run server app
 	_, err = hstExec("RunEchoServer "+proto, echoSrv)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("echo server: %v", err)
-		return
-	}
 
 	o, err := hstExec("RunEchoClient "+proto, echoCln)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("echo client: %v", err)
-	}
 	fmt.Println(o)
 }
 
@@ -92,99 +72,68 @@ func (s *VethsSuite) TestVclRetryAttach() {
 }
 
 func (s *VethsSuite) testRetryAttach(proto string) {
-	t := s.T()
+	serverVolume := "echo-srv-vol"
+	s.NewVolume(serverVolume)
 
-	exechelper.Run("docker volume create --name=echo-srv-vol")
+	clientVolume := "echo-cln-vol"
-	exechelper.Run("docker volume create --name=echo-cln-vol")
+	s.NewVolume(clientVolume)
 
 	srvInstance := "vpp-vcl-test-srv"
+	serverVppContainer, err := s.NewContainer(srvInstance)
+	s.assertNil(err)
+	serverVppContainer.addVolume(serverVolume, "/tmp/Configure2Veths")
+	serverVppContainer.run()
+
 	clnInstance := "vpp-vcl-test-cln"
+	clientVppContainer, err := s.NewContainer(clnInstance)
+	s.assertNil(err)
+	clientVppContainer.addVolume(clientVolume, "/tmp/Configure2Veths")
+	clientVppContainer.run();
+
 	echoSrv := "echo-srv"
+	serverEchoContainer, err := s.NewContainer(echoSrv)
+	s.assertNil(err)
+	serverEchoContainer.addVolume(serverVolume, "/tmp/" + echoSrv)
+	serverEchoContainer.run()
+
 	echoCln := "echo-cln"
-
+	clientEchoContainer, err := s.NewContainer(echoCln)
-	err := dockerRun(srvInstance, "-v echo-srv-vol:/tmp/Configure2Veths")
+	s.assertNil(err)
-	if err != nil {
+	clientEchoContainer.addVolume(clientVolume, "/tmp/" + echoCln)
-		t.Errorf("%v", err)
+	clientEchoContainer.run()
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + srvInstance) }()
-
-	err = dockerRun(clnInstance, "-v echo-cln-vol:/tmp/Configure2Veths")
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + clnInstance) }()
-
-	err = dockerRun(echoSrv, fmt.Sprintf("-v echo-srv-vol:/tmp/%s", echoSrv))
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + echoSrv) }()
-
-	err = dockerRun(echoCln, fmt.Sprintf("-v echo-cln-vol:/tmp/%s", echoCln))
-	if err != nil {
-		t.Errorf("%v", err)
-		return
-	}
-	defer func() { exechelper.Run("docker stop " + echoCln) }()
 
 	_, err = hstExec("Configure2Veths srv-with-preset-hw-addr", srvInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("%v", err)
-		return
-	}
 
 	_, err = hstExec("Configure2Veths cln", clnInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("%v", err)
-		return
-	}
 
 	_, err = hstExec("RunVclEchoServer "+proto, echoSrv)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("vcl test server: %v", err)
-		return
-	}
 
 	fmt.Println("This whole test case can take around 3 minutes to run. Please be patient.")
 	fmt.Println("... Running first echo client test, before disconnect.")
 	_, err = hstExec("RunVclEchoClient "+proto, echoCln)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("vcl test client: %v", err)
-		return
-	}
 	fmt.Println("... First test ended. Stopping VPP server now.")
 
 	// Stop server-vpp-instance, start it again and then run vcl-test-client once more
 	stopVppCommand := "/bin/bash -c 'ps -C vpp_main -o pid= | xargs kill -9'"
 	_, err = dockerExec(stopVppCommand, srvInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("error while stopping vpp: %v", err)
-		return
-	}
 	time.Sleep(5 * time.Second) // Give parent process time to reap the killed child process
 	stopVppCommand = "/bin/bash -c 'ps -C hs-test -o pid= | xargs kill -9'"
 	_, err = dockerExec(stopVppCommand, srvInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("error while stopping hs-test: %v", err)
-		return
-	}
 	_, err = hstExec("Configure2Veths srv-with-preset-hw-addr", srvInstance)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("%v", err)
-		return
-	}
 
 	fmt.Println("... VPP server is starting again, so waiting for a bit.")
 	time.Sleep(30 * time.Second) // Wait a moment for the re-attachment to happen
 
 	fmt.Println("... Running second echo client test, after disconnect and re-attachment.")
 	_, err = hstExec("RunVclEchoClient "+proto, echoCln)
-	if err != nil {
+	s.assertNil(err)
-		t.Errorf("vcl test client: %v", err)
-	}
 	fmt.Println("Done.")
 }