hs-test: use relative paths for docker volumes
[vpp.git] / extras / hs-test / container.go
index 91ca2c2..86f511c 100644 (file)
@@ -5,10 +5,21 @@ import (
        "os"
        "os/exec"
        "strings"
+       "text/template"
+       "time"
 
        "github.com/edwarnicke/exechelper"
 )
 
+const (
+       logDir    string = "/tmp/hs-test/"
+       volumeDir string = "/volumes"
+)
+
+var (
+       workDir, _ = os.Getwd()
+)
+
 type Volume struct {
        hostDir          string
        containerDir     string
@@ -18,6 +29,7 @@ type Volume struct {
 type Container struct {
        suite            *HstSuite
        isOptional       bool
+       runDetached      bool
        name             string
        image            string
        extraRunningArgs string
@@ -26,7 +38,7 @@ type Container struct {
        vppInstance      *VppInstance
 }
 
-func NewContainer(yamlInput ContainerConfig) (*Container, error) {
+func newContainer(suite *HstSuite, yamlInput ContainerConfig) (*Container, error) {
        containerName := yamlInput["name"].(string)
        if len(containerName) == 0 {
                err := fmt.Errorf("container name must not be blank")
@@ -37,6 +49,7 @@ func NewContainer(yamlInput ContainerConfig) (*Container, error) {
        container.volumes = make(map[string]Volume)
        container.envVars = make(map[string]string)
        container.name = containerName
+       container.suite = suite
 
        if image, ok := yamlInput["image"]; ok {
                container.image = image.(string)
@@ -56,20 +69,27 @@ func NewContainer(yamlInput ContainerConfig) (*Container, error) {
                container.isOptional = false
        }
 
+       if runDetached, ok := yamlInput["run-detached"]; ok {
+               container.runDetached = runDetached.(bool)
+       } else {
+               container.runDetached = true
+       }
+
        if _, ok := yamlInput["volumes"]; ok {
-               r := strings.NewReplacer("$HST_DIR", workDir)
+               workingVolumeDir := logDir + container.suite.T().Name() + volumeDir
+               workDirReplacer := strings.NewReplacer("$HST_DIR", workDir)
+               volDirReplacer := strings.NewReplacer("$HST_VOLUME_DIR", workingVolumeDir)
                for _, volu := range yamlInput["volumes"].([]interface{}) {
                        volumeMap := volu.(ContainerConfig)
-                       hostDir := r.Replace(volumeMap["host-dir"].(string))
+                       hostDir := workDirReplacer.Replace(volumeMap["host-dir"].(string))
+                       hostDir = volDirReplacer.Replace(hostDir)
                        containerDir := volumeMap["container-dir"].(string)
                        isDefaultWorkDir := false
 
                        if isDefault, ok := volumeMap["is-default-work-dir"]; ok {
                                isDefaultWorkDir = isDefault.(bool)
                        }
-
                        container.addVolume(hostDir, containerDir, isDefaultWorkDir)
-
                }
        }
 
@@ -95,43 +115,87 @@ func (c *Container) getWorkDirVolume() (res Volume, exists bool) {
        return
 }
 
-func (c *Container) GetHostWorkDir() (res string) {
+func (c *Container) getHostWorkDir() (res string) {
        if v, ok := c.getWorkDirVolume(); ok {
                res = v.hostDir
        }
        return
 }
 
-func (c *Container) GetContainerWorkDir() (res string) {
+func (c *Container) getContainerWorkDir() (res string) {
        if v, ok := c.getWorkDirVolume(); ok {
                res = v.containerDir
        }
        return
 }
 
-func (c *Container) getRunCommand() string {
-       syncPath := fmt.Sprintf(" -v %s:/tmp/sync", c.getSyncPath())
-       cmd := "docker run --cap-add=all -d --privileged --network host --rm"
-       cmd += syncPath
-       cmd += c.getVolumesAsCliOption()
-       cmd += c.getEnvVarsAsCliOption()
-       cmd += " --name " + c.name + " " + c.image + " " + c.extraRunningArgs
-       return cmd
+func (c *Container) getContainerArguments() string {
+       args := "--ulimit nofile=90000:90000 --cap-add=all --privileged --network host --rm"
+       args += c.getVolumesAsCliOption()
+       args += c.getEnvVarsAsCliOption()
+       if *vppSourceFileDir != "" {
+               args += fmt.Sprintf(" -v %s:%s", *vppSourceFileDir, *vppSourceFileDir)
+       }
+       args += " --name " + c.name + " " + c.image
+       args += " " + c.extraRunningArgs
+       return args
 }
 
-func (c *Container) run() error {
+func (c *Container) runWithRetry(cmd string) error {
+       nTries := 5
+       for i := 0; i < nTries; i++ {
+               err := exechelper.Run(cmd)
+               if err == nil {
+                       return nil
+               }
+               time.Sleep(1 * time.Second)
+       }
+       return fmt.Errorf("failed to run container command")
+}
+
+func (c *Container) create() error {
+       cmd := "docker create " + c.getContainerArguments()
+       c.suite.log(cmd)
+       return exechelper.Run(cmd)
+}
+
+func (c *Container) start() error {
+       cmd := "docker start " + c.name
+       c.suite.log(cmd)
+       return c.runWithRetry(cmd)
+}
+
+func (c *Container) prepareCommand() (string, error) {
        if c.name == "" {
-               return fmt.Errorf("run container failed: name is blank")
+               return "", fmt.Errorf("run container failed: name is blank")
+       }
+
+       cmd := "docker run "
+       if c.runDetached {
+               cmd += " -d"
        }
+       cmd += " " + c.getContainerArguments()
 
-       exechelper.Run(fmt.Sprintf("mkdir -p /tmp/%s/sync", c.name))
-       cmd := c.getRunCommand()
-       err := exechelper.Run(cmd)
+       c.suite.log(cmd)
+       return cmd, nil
+}
+
+func (c *Container) combinedOutput() (string, error) {
+       cmd, err := c.prepareCommand()
        if err != nil {
-               return fmt.Errorf("container run failed: %s", err)
+               return "", err
        }
 
-       return nil
+       byteOutput, err := exechelper.CombinedOutput(cmd)
+       return string(byteOutput), err
+}
+
+func (c *Container) run() error {
+       cmd, err := c.prepareCommand()
+       if err != nil {
+               return err
+       }
+       return c.runWithRetry(cmd)
 }
 
 func (c *Container) addVolume(hostDir string, containerDir string, isDefaultWorkDir bool) {
@@ -142,10 +206,6 @@ func (c *Container) addVolume(hostDir string, containerDir string, isDefaultWork
        c.volumes[hostDir] = volume
 }
 
-func (c *Container) getVolumeByHostDir(hostDir string) Volume {
-       return c.volumes[hostDir]
-}
-
 func (c *Container) getVolumesAsCliOption() string {
        cliOption := ""
 
@@ -158,13 +218,6 @@ func (c *Container) getVolumesAsCliOption() string {
        return cliOption
 }
 
-func (c *Container) getWorkDirAsCliOption() string {
-       if _, ok := c.getWorkDirVolume(); ok {
-               return fmt.Sprintf(" --workdir=\"%s\"", c.GetContainerWorkDir())
-       }
-       return ""
-}
-
 func (c *Container) addEnvVar(name string, value string) {
        c.envVars[name] = value
 }
@@ -181,23 +234,12 @@ func (c *Container) getEnvVarsAsCliOption() string {
        return cliOption
 }
 
-func (c *Container) getSyncPath() string {
-       return fmt.Sprintf("/tmp/%s/sync", c.name)
-}
-
-func (c *Container) newVppInstance(additionalConfig ...Stanza) (*VppInstance, error) {
-       vppConfig := new(VppConfig)
-       vppConfig.CliSocketFilePath = defaultCliSocketFilePath
-       if len(additionalConfig) > 0 {
-               vppConfig.additionalConfig = additionalConfig[0]
-       }
-
+func (c *Container) newVppInstance(cpus []int, additionalConfigs ...Stanza) (*VppInstance, error) {
        vpp := new(VppInstance)
        vpp.container = c
-       vpp.config = vppConfig
-
+       vpp.cpus = cpus
+       vpp.additionalConfig = append(vpp.additionalConfig, additionalConfigs...)
        c.vppInstance = vpp
-
        return vpp, nil
 }
 
@@ -227,44 +269,98 @@ func (c *Container) createFile(destFileName string, content string) error {
  * Executes in detached mode so that the started application can continue to run
  * without blocking execution of test
  */
-func (c *Container) execServer(command string) error {
-       return exechelper.Run("docker exec -d" + c.getEnvVarsAsCliOption() + " " + c.name + " " + command)
+func (c *Container) execServer(command string, arguments ...any) {
+       serverCommand := fmt.Sprintf(command, arguments...)
+       containerExecCommand := "docker exec -d" + c.getEnvVarsAsCliOption() +
+               " " + c.name + " " + serverCommand
+       c.suite.T().Helper()
+       c.suite.log(containerExecCommand)
+       c.suite.assertNil(exechelper.Run(containerExecCommand))
 }
 
-func (c *Container) exec(command string) (string, error) {
-       cliCommand := "docker exec" + c.getEnvVarsAsCliOption() + " " + c.name + " " + command
-       byteOutput, err := exechelper.CombinedOutput(cliCommand)
-       return string(byteOutput), err
+func (c *Container) exec(command string, arguments ...any) string {
+       cliCommand := fmt.Sprintf(command, arguments...)
+       containerExecCommand := "docker exec" + c.getEnvVarsAsCliOption() +
+               " " + c.name + " " + cliCommand
+       c.suite.T().Helper()
+       c.suite.log(containerExecCommand)
+       byteOutput, err := exechelper.CombinedOutput(containerExecCommand)
+       c.suite.assertNil(err)
+       return string(byteOutput)
 }
 
-func (c *Container) execAction(args string) (string, error) {
-       syncFile := c.getSyncPath() + "/rc"
-       os.Remove(syncFile)
+func (c *Container) getLogDirPath() string {
+       testId := c.suite.getTestId()
+       testName := c.suite.T().Name()
+       logDirPath := logDir + testName + "/" + testId + "/"
 
-       workDir := c.getWorkDirAsCliOption()
-       cmd := fmt.Sprintf("docker exec -d %s %s hs-test %s",
-               workDir,
-               c.name,
-               args)
-       err := exechelper.Run(cmd)
-       if err != nil {
-               return "", err
+       cmd := exec.Command("mkdir", "-p", logDirPath)
+       if err := cmd.Run(); err != nil {
+               c.suite.T().Fatalf("mkdir error: %v", err)
+       }
+
+       return logDirPath
+}
+
+func (c *Container) saveLogs() {
+       cmd := exec.Command("docker", "inspect", "--format='{{.State.Status}}'", c.name)
+       if output, _ := cmd.CombinedOutput(); !strings.Contains(string(output), "running") {
+               return
        }
-       res, err := waitForSyncFile(syncFile)
+
+       testLogFilePath := c.getLogDirPath() + "container-" + c.name + ".log"
+
+       cmd = exec.Command("docker", "logs", "--details", "-t", c.name)
+       output, err := cmd.CombinedOutput()
        if err != nil {
-               return "", fmt.Errorf("failed to read sync file while executing 'hs-test %s': %v", args, err)
+               c.suite.T().Fatalf("fetching logs error: %v", err)
        }
-       o := res.StdOutput + res.ErrOutput
-       if res.Code != 0 {
-               return o, fmt.Errorf("cmd resulted in non-zero value %d: %s", res.Code, res.Desc)
+
+       f, err := os.Create(testLogFilePath)
+       if err != nil {
+               c.suite.T().Fatalf("file create error: %v", err)
        }
-       return o, err
+       fmt.Fprint(f, string(output))
+       f.Close()
+}
+
+func (c *Container) log() string {
+       cmd := "docker logs " + c.name
+       c.suite.log(cmd)
+       o, err := exechelper.CombinedOutput(cmd)
+       c.suite.assertNil(err)
+       return string(o)
 }
 
 func (c *Container) stop() error {
        if c.vppInstance != nil && c.vppInstance.apiChannel != nil {
+               c.vppInstance.saveLogs()
                c.vppInstance.disconnect()
        }
        c.vppInstance = nil
+       c.saveLogs()
        return exechelper.Run("docker stop " + c.name + " -t 0")
 }
+
+func (c *Container) createConfig(targetConfigName string, templateName string, values any) {
+       template := template.Must(template.ParseFiles(templateName))
+
+       f, err := os.CreateTemp(logDir, "hst-config")
+       c.suite.assertNil(err)
+       defer os.Remove(f.Name())
+
+       err = template.Execute(f, values)
+       c.suite.assertNil(err)
+
+       err = f.Close()
+       c.suite.assertNil(err)
+
+       c.copy(f.Name(), targetConfigName)
+}
+
+func init() {
+       cmd := exec.Command("mkdir", "-p", logDir)
+       if err := cmd.Run(); err != nil {
+               panic(err)
+       }
+}