extras/hs-test/container.go

   1 package main
   2
   3 import (
   4         "fmt"
   5         "os"
   6         "os/exec"
   7         "strings"
   8
   9         "github.com/edwarnicke/exechelper"
  10 )
  11
  12 const (
  13         logDir string = "/tmp/hs-test/"
  14 )
  15
  16 var (
  17         workDir, _ = os.Getwd()
  18 )
  19
  20 type Volume struct {
  21         hostDir          string
  22         containerDir     string
  23         isDefaultWorkDir bool
  24 }
  25
  26 type Container struct {
  27         suite            *HstSuite
  28         isOptional       bool
  29         name             string
  30         image            string
  31         extraRunningArgs string
  32         volumes          map[string]Volume
  33         envVars          map[string]string
  34         vppInstance      *VppInstance
  35 }
  36
  37 func NewContainer(yamlInput ContainerConfig) (*Container, error) {
  38         containerName := yamlInput["name"].(string)
  39         if len(containerName) == 0 {
  40                 err := fmt.Errorf("container name must not be blank")
  41                 return nil, err
  42         }
  43
  44         var container = new(Container)
  45         container.volumes = make(map[string]Volume)
  46         container.envVars = make(map[string]string)
  47         container.name = containerName
  48
  49         if image, ok := yamlInput["image"]; ok {
  50                 container.image = image.(string)
  51         } else {
  52                 container.image = "hs-test/vpp"
  53         }
  54
  55         if args, ok := yamlInput["extra-args"]; ok {
  56                 container.extraRunningArgs = args.(string)
  57         } else {
  58                 container.extraRunningArgs = ""
  59         }
  60
  61         if isOptional, ok := yamlInput["is-optional"]; ok {
  62                 container.isOptional = isOptional.(bool)
  63         } else {
  64                 container.isOptional = false
  65         }
  66
  67         if _, ok := yamlInput["volumes"]; ok {
  68                 r := strings.NewReplacer("$HST_DIR", workDir)
  69                 for _, volu := range yamlInput["volumes"].([]interface{}) {
  70                         volumeMap := volu.(ContainerConfig)
  71                         hostDir := r.Replace(volumeMap["host-dir"].(string))
  72                         containerDir := volumeMap["container-dir"].(string)
  73                         isDefaultWorkDir := false
  74
  75                         if isDefault, ok := volumeMap["is-default-work-dir"]; ok {
  76                                 isDefaultWorkDir = isDefault.(bool)
  77                         }
  78
  79                         container.addVolume(hostDir, containerDir, isDefaultWorkDir)
  80
  81                 }
  82         }
  83
  84         if _, ok := yamlInput["vars"]; ok {
  85                 for _, envVar := range yamlInput["vars"].([]interface{}) {
  86                         envVarMap := envVar.(ContainerConfig)
  87                         name := envVarMap["name"].(string)
  88                         value := envVarMap["value"].(string)
  89                         container.addEnvVar(name, value)
  90                 }
  91         }
  92         return container, nil
  93 }
  94
  95 func (c *Container) Suite() *HstSuite {
  96         return c.suite
  97 }
  98
  99 func (c *Container) getWorkDirVolume() (res Volume, exists bool) {
 100         for _, v := range c.volumes {
 101                 if v.isDefaultWorkDir {
 102                         res = v
 103                         exists = true
 104                         return
 105                 }
 106         }
 107         return
 108 }
 109
 110 func (c *Container) GetHostWorkDir() (res string) {
 111         if v, ok := c.getWorkDirVolume(); ok {
 112                 res = v.hostDir
 113         }
 114         return
 115 }
 116
 117 func (c *Container) GetContainerWorkDir() (res string) {
 118         if v, ok := c.getWorkDirVolume(); ok {
 119                 res = v.containerDir
 120         }
 121         return
 122 }
 123
 124 func (c *Container) getRunCommand() string {
 125         cmd := "docker run --cap-add=all -d --privileged --network host --rm"
 126         cmd += c.getVolumesAsCliOption()
 127         cmd += c.getEnvVarsAsCliOption()
 128         cmd += " --name " + c.name + " " + c.image + " " + c.extraRunningArgs
 129         return cmd
 130 }
 131
 132 func (c *Container) run() error {
 133         if c.name == "" {
 134                 return fmt.Errorf("run container failed: name is blank")
 135         }
 136
 137         cmd := c.getRunCommand()
 138         err := exechelper.Run(cmd)
 139         if err != nil {
 140                 return fmt.Errorf("container run failed: %s", err)
 141         }
 142
 143         return nil
 144 }
 145
 146 func (c *Container) addVolume(hostDir string, containerDir string, isDefaultWorkDir bool) {
 147         var volume Volume
 148         volume.hostDir = hostDir
 149         volume.containerDir = containerDir
 150         volume.isDefaultWorkDir = isDefaultWorkDir
 151         c.volumes[hostDir] = volume
 152 }
 153
 154 func (c *Container) getVolumesAsCliOption() string {
 155         cliOption := ""
 156
 157         if len(c.volumes) > 0 {
 158                 for _, volume := range c.volumes {
 159                         cliOption += fmt.Sprintf(" -v %s:%s", volume.hostDir, volume.containerDir)
 160                 }
 161         }
 162
 163         return cliOption
 164 }
 165
 166 func (c *Container) addEnvVar(name string, value string) {
 167         c.envVars[name] = value
 168 }
 169
 170 func (c *Container) getEnvVarsAsCliOption() string {
 171         cliOption := ""
 172         if len(c.envVars) == 0 {
 173                 return cliOption
 174         }
 175
 176         for name, value := range c.envVars {
 177                 cliOption += fmt.Sprintf(" -e %s=%s", name, value)
 178         }
 179         return cliOption
 180 }
 181
 182 func (c *Container) newVppInstance(additionalConfig ...Stanza) (*VppInstance, error) {
 183         vpp := new(VppInstance)
 184         vpp.container = c
 185
 186         if len(additionalConfig) > 0 {
 187                 vpp.additionalConfig = additionalConfig[0]
 188         }
 189
 190         c.vppInstance = vpp
 191
 192         return vpp, nil
 193 }
 194
 195 func (c *Container) copy(sourceFileName string, targetFileName string) error {
 196         cmd := exec.Command("docker", "cp", sourceFileName, c.name+":"+targetFileName)
 197         return cmd.Run()
 198 }
 199
 200 func (c *Container) createFile(destFileName string, content string) error {
 201         f, err := os.CreateTemp("/tmp", "hst-config")
 202         if err != nil {
 203                 return err
 204         }
 205         defer os.Remove(f.Name())
 206
 207         if _, err := f.Write([]byte(content)); err != nil {
 208                 return err
 209         }
 210         if err := f.Close(); err != nil {
 211                 return err
 212         }
 213         c.copy(f.Name(), destFileName)
 214         return nil
 215 }
 216
 217 /*
 218  * Executes in detached mode so that the started application can continue to run
 219  * without blocking execution of test
 220  */
 221 func (c *Container) execServer(command string, arguments ...any) {
 222         serverCommand := fmt.Sprintf(command, arguments...)
 223         containerExecCommand := "docker exec -d" + c.getEnvVarsAsCliOption() +
 224                 " " + c.name + " " + serverCommand
 225         c.Suite().T().Helper()
 226         c.Suite().log(containerExecCommand)
 227         c.Suite().assertNil(exechelper.Run(containerExecCommand))
 228 }
 229
 230 func (c *Container) exec(command string, arguments ...any) string {
 231         cliCommand := fmt.Sprintf(command, arguments...)
 232         containerExecCommand := "docker exec" + c.getEnvVarsAsCliOption() +
 233                 " " + c.name + " " + cliCommand
 234         c.Suite().T().Helper()
 235         c.Suite().log(containerExecCommand)
 236         byteOutput, err := exechelper.CombinedOutput(containerExecCommand)
 237         c.Suite().assertNil(err)
 238         return string(byteOutput)
 239 }
 240
 241 func (c *Container) getLogDirPath() string {
 242         testId := c.Suite().getTestId()
 243         testName := c.Suite().T().Name()
 244         logDirPath := logDir + testName + "/" + testId + "/"
 245
 246         cmd := exec.Command("mkdir", "-p", logDirPath)
 247         if err := cmd.Run(); err != nil {
 248                 c.Suite().T().Fatalf("mkdir error: %v", err)
 249         }
 250
 251         return logDirPath
 252 }
 253
 254 func (c *Container) saveLogs() {
 255         cmd := exec.Command("docker", "inspect", "--format='{{.State.Status}}'", c.name)
 256         if output, _ := cmd.CombinedOutput(); !strings.Contains(string(output), "running") {
 257                 return
 258         }
 259
 260         testLogFilePath := c.getLogDirPath() + "container-" + c.name + ".log"
 261
 262         cmd = exec.Command("docker", "logs", "--details", "-t", c.name)
 263         output, err := cmd.CombinedOutput()
 264         if err != nil {
 265                 c.Suite().T().Fatalf("fetching logs error: %v", err)
 266         }
 267
 268         f, err := os.Create(testLogFilePath)
 269         if err != nil {
 270                 c.Suite().T().Fatalf("file create error: %v", err)
 271         }
 272         fmt.Fprintf(f, string(output))
 273         f.Close()
 274 }
 275
 276 func (c *Container) stop() error {
 277         if c.vppInstance != nil && c.vppInstance.apiChannel != nil {
 278                 c.vppInstance.saveLogs()
 279                 c.vppInstance.disconnect()
 280         }
 281         c.vppInstance = nil
 282         c.saveLogs()
 283         return exechelper.Run("docker stop " + c.name + " -t 0")
 284 }