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) getContainerArguments() string {
 125         args := "--cap-add=all --privileged --network host --rm"
 126         args += c.getVolumesAsCliOption()
 127         args += c.getEnvVarsAsCliOption()
 128         args += " --name " + c.name + " " + c.image
 129         return args
 130 }
 131
 132 func (c *Container) create() {
 133         cmd := "docker create " + c.getContainerArguments()
 134         exechelper.Run(cmd)
 135 }
 136
 137 func (c *Container) start() {
 138         cmd := "docker start " + c.name
 139         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() + " " + c.extraRunningArgs
 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.Fprintf(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 }