extras/hs-test/container.go

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