hs-test: separate infra from tests

- most functions and vars now start with a capital letter:
  needed to access them outside the package that declares
  them
- updated README.md
- very minor changes in MAKEFILE

Type: test

Change-Id: I4b5a194f08f09d59e372e57da6451fbb5a1de4da
Signed-off-by: Adrian Villin <avillin@cisco.com>

1 files changed, 0 insertions, 380 deletions

diff --git a/extras/hs-test/container.go b/extras/hs-test/container.go
deleted file mode 100644
index 97b71b5385f..00000000000
--- a/extras/hs-test/container.go
+++ /dev/null
@@ -1,380 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"os"
-	"os/exec"
-	"strings"
-	"text/template"
-	"time"
-
-	"github.com/edwarnicke/exechelper"
-	. "github.com/onsi/ginkgo/v2"
-)
-
-const (
-	logDir    string = "/tmp/hs-test/"
-	volumeDir string = "/volumes"
-)
-
-var (
-	workDir, _ = os.Getwd()
-)
-
-type Volume struct {
-	hostDir          string
-	containerDir     string
-	isDefaultWorkDir bool
-}
-
-type Container struct {
-	suite            *HstSuite
-	isOptional       bool
-	runDetached      bool
-	name             string
-	image            string
-	extraRunningArgs string
-	volumes          map[string]Volume
-	envVars          map[string]string
-	vppInstance      *VppInstance
-	allocatedCpus    []int
-}
-
-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")
-		return nil, err
-	}
-
-	var container = new(Container)
-	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)
-	} else {
-		container.image = "hs-test/vpp"
-	}
-
-	if args, ok := yamlInput["extra-args"]; ok {
-		container.extraRunningArgs = args.(string)
-	} else {
-		container.extraRunningArgs = ""
-	}
-
-	if isOptional, ok := yamlInput["is-optional"]; ok {
-		container.isOptional = isOptional.(bool)
-	} else {
-		container.isOptional = false
-	}
-
-	if runDetached, ok := yamlInput["run-detached"]; ok {
-		container.runDetached = runDetached.(bool)
-	} else {
-		container.runDetached = true
-	}
-
-	if _, ok := yamlInput["volumes"]; ok {
-		workingVolumeDir := logDir + suite.getCurrentTestName() + volumeDir
-		workDirReplacer := strings.NewReplacer("$HST_DIR", workDir)
-		volDirReplacer := strings.NewReplacer("$HST_VOLUME_DIR", workingVolumeDir)
-		for _, volu := range yamlInput["volumes"].([]interface{}) {
-			volumeMap := volu.(ContainerConfig)
-			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)
-		}
-	}
-
-	if _, ok := yamlInput["vars"]; ok {
-		for _, envVar := range yamlInput["vars"].([]interface{}) {
-			envVarMap := envVar.(ContainerConfig)
-			name := envVarMap["name"].(string)
-			value := envVarMap["value"].(string)
-			container.addEnvVar(name, value)
-		}
-	}
-	return container, nil
-}
-
-func (c *Container) getWorkDirVolume() (res Volume, exists bool) {
-	for _, v := range c.volumes {
-		if v.isDefaultWorkDir {
-			res = v
-			exists = true
-			return
-		}
-	}
-	return
-}
-
-func (c *Container) getHostWorkDir() (res string) {
-	if v, ok := c.getWorkDirVolume(); ok {
-		res = v.hostDir
-	}
-	return
-}
-
-func (c *Container) getContainerWorkDir() (res string) {
-	if v, ok := c.getWorkDirVolume(); ok {
-		res = v.containerDir
-	}
-	return
-}
-
-func (c *Container) getContainerArguments() string {
-	args := "--ulimit nofile=90000:90000 --cap-add=all --privileged --network host"
-	c.allocateCpus()
-	args += fmt.Sprintf(" --cpuset-cpus=\"%d-%d\"", c.allocatedCpus[0], c.allocatedCpus[len(c.allocatedCpus)-1])
-	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) 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) allocateCpus() {
-	c.suite.startedContainers = append(c.suite.startedContainers, c)
-	c.allocatedCpus = c.suite.AllocateCpus()
-	c.suite.log("Allocated CPUs " + fmt.Sprint(c.allocatedCpus) + " to container " + c.name)
-}
-
-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")
-	}
-
-	cmd := "docker run "
-	if c.runDetached {
-		cmd += " -d"
-	}
-
-	cmd += " " + c.getContainerArguments()
-
-	c.suite.log(cmd)
-	return cmd, nil
-}
-
-func (c *Container) combinedOutput() (string, error) {
-	cmd, err := c.prepareCommand()
-	if err != nil {
-		return "", err
-	}
-
-	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) {
-	var volume Volume
-	volume.hostDir = hostDir
-	volume.containerDir = containerDir
-	volume.isDefaultWorkDir = isDefaultWorkDir
-	c.volumes[hostDir] = volume
-}
-
-func (c *Container) getVolumesAsCliOption() string {
-	cliOption := ""
-
-	if len(c.volumes) > 0 {
-		for _, volume := range c.volumes {
-			cliOption += fmt.Sprintf(" -v %s:%s", volume.hostDir, volume.containerDir)
-		}
-	}
-
-	return cliOption
-}
-
-func (c *Container) addEnvVar(name string, value string) {
-	c.envVars[name] = value
-}
-
-func (c *Container) getEnvVarsAsCliOption() string {
-	cliOption := ""
-	if len(c.envVars) == 0 {
-		return cliOption
-	}
-
-	for name, value := range c.envVars {
-		cliOption += fmt.Sprintf(" -e %s=%s", name, value)
-	}
-	return cliOption
-}
-
-func (c *Container) newVppInstance(cpus []int, additionalConfigs ...Stanza) (*VppInstance, error) {
-	vpp := new(VppInstance)
-	vpp.container = c
-	vpp.cpus = cpus
-	vpp.additionalConfig = append(vpp.additionalConfig, additionalConfigs...)
-	c.vppInstance = vpp
-	return vpp, nil
-}
-
-func (c *Container) copy(sourceFileName string, targetFileName string) error {
-	cmd := exec.Command("docker", "cp", sourceFileName, c.name+":"+targetFileName)
-	return cmd.Run()
-}
-
-func (c *Container) createFile(destFileName string, content string) error {
-	f, err := os.CreateTemp("/tmp", "hst-config"+c.suite.ppid)
-	if err != nil {
-		return err
-	}
-	defer os.Remove(f.Name())
-
-	if _, err := f.Write([]byte(content)); err != nil {
-		return err
-	}
-	if err := f.Close(); err != nil {
-		return err
-	}
-	c.copy(f.Name(), destFileName)
-	return nil
-}
-
-/*
- * Executes in detached mode so that the started application can continue to run
- * without blocking execution of test
- */
-func (c *Container) execServer(command string, arguments ...any) {
-	serverCommand := fmt.Sprintf(command, arguments...)
-	containerExecCommand := "docker exec -d" + c.getEnvVarsAsCliOption() +
-		" " + c.name + " " + serverCommand
-	GinkgoHelper()
-	c.suite.log(containerExecCommand)
-	c.suite.assertNil(exechelper.Run(containerExecCommand))
-}
-
-func (c *Container) exec(command string, arguments ...any) string {
-	cliCommand := fmt.Sprintf(command, arguments...)
-	containerExecCommand := "docker exec" + c.getEnvVarsAsCliOption() +
-		" " + c.name + " " + cliCommand
-	GinkgoHelper()
-	c.suite.log(containerExecCommand)
-	byteOutput, err := exechelper.CombinedOutput(containerExecCommand)
-	c.suite.assertNil(err, fmt.Sprint(err))
-	return string(byteOutput)
-}
-
-func (c *Container) getLogDirPath() string {
-	testId := c.suite.getTestId()
-	testName := c.suite.getCurrentTestName()
-	logDirPath := logDir + testName + "/" + testId + "/"
-
-	cmd := exec.Command("mkdir", "-p", logDirPath)
-	if err := cmd.Run(); err != nil {
-		Fail("mkdir error: " + fmt.Sprint(err))
-	}
-
-	return logDirPath
-}
-
-func (c *Container) saveLogs() {
-	testLogFilePath := c.getLogDirPath() + "container-" + c.name + ".log"
-
-	cmd := exec.Command("docker", "logs", "--details", "-t", c.name)
-	c.suite.log(cmd)
-	output, err := cmd.CombinedOutput()
-	if err != nil {
-		c.suite.log(err)
-	}
-
-	f, err := os.Create(testLogFilePath)
-	if err != nil {
-		Fail("file create error: " + fmt.Sprint(err))
-	}
-	fmt.Fprint(f, string(output))
-	f.Close()
-}
-
-// Outputs logs from docker containers. Set 'maxLines' to 0 to output the full log.
-func (c *Container) log(maxLines int) (string, error) {
-	var cmd string
-	if maxLines == 0 {
-		cmd = "docker logs " + c.name
-	} else {
-		cmd = fmt.Sprintf("docker logs --tail %d %s", maxLines, c.name)
-	}
-
-	c.suite.log(cmd)
-	o, err := exechelper.CombinedOutput(cmd)
-	return string(o), err
-}
-
-func (c *Container) stop() error {
-	if c.vppInstance != nil && c.vppInstance.apiStream != nil {
-		c.vppInstance.saveLogs()
-		c.vppInstance.disconnect()
-	}
-	c.vppInstance = nil
-	c.saveLogs()
-	c.suite.log("docker stop " + c.name + " -t 0")
-	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, err)
-	defer os.Remove(f.Name())
-
-	err = template.Execute(f, values)
-	c.suite.assertNil(err, err)
-
-	err = f.Close()
-	c.suite.assertNil(err, err)
-
-	c.copy(f.Name(), targetConfigName)
-}
-
-func init() {
-	cmd := exec.Command("mkdir", "-p", logDir)
-	if err := cmd.Run(); err != nil {
-		panic(err)
-	}
-}