Create ContainerID wrapper for integration tests

integration-tests/pkg/collector/collector.go

@@ -16,7 +16,7 @@ type Manager interface {
 	Launch() error
 	TearDown() error
 	IsRunning() (bool, error)
-	ContainerID() string
+	ContainerID() executor.ContainerID
 	TestName() string
 }
 

integration-tests/pkg/collector/collector_docker.go

@@ -8,7 +8,6 @@ import (
 	"golang.org/x/exp/maps"
 
 	"github.com/hashicorp/go-multierror"
-	"github.com/stackrox/collector/integration-tests/pkg/common"
 	"github.com/stackrox/collector/integration-tests/pkg/config"
 	"github.com/stackrox/collector/integration-tests/pkg/executor"
 )
@@ -22,7 +21,7 @@ type DockerCollectorManager struct {
 	testName      string
 
 	CollectorOutput string
-	containerID     string
+	containerID     executor.ContainerID
 }
 
 func NewDockerCollectorManager(e executor.Executor, name string) *DockerCollectorManager {
@@ -91,7 +90,7 @@ func (c *DockerCollectorManager) TearDown() error {
 
 		// Check if collector container segfaulted or exited with error
 		exitCode, err := c.executor.ExitCode(executor.ContainerFilter{
-			Name: "collector",
+			Id: executor.ContainerID("collector"),
 		})
 		if err != nil || exitCode != 0 {
 			logsEnd := ""
@@ -145,24 +144,22 @@ func (c *DockerCollectorManager) launchCollector() error {
 	if err != nil {
 		return err
 	}
-	output, err := c.executor.StartContainer(startConfig)
-	c.CollectorOutput = output
+	id, err := c.executor.StartContainer(startConfig)
 	if err != nil {
 		return err
 	}
-	outLines := strings.Split(output, "\n")
-	c.containerID = common.ContainerShortID(string(outLines[len(outLines)-1]))
-	return err
+	c.containerID = id
+	return nil
 }
 
 func (c *DockerCollectorManager) captureLogs(containerName string) (string, error) {
-	return c.executor.CaptureLogs(c.testName, containerName)
+	return c.executor.CaptureLogs(c.testName, executor.ContainerID(containerName))
 }
 
 func (c *DockerCollectorManager) killContainer(name string) error {
-	_, err1 := c.executor.KillContainer(name)
+	_, err1 := c.executor.KillContainer(executor.ContainerID(name))
 	_, err2 := c.executor.RemoveContainer(executor.ContainerFilter{
-		Name: name,
+		Id: executor.ContainerID(name),
 	})
 
 	var result error
@@ -177,11 +174,11 @@ func (c *DockerCollectorManager) killContainer(name string) error {
 }
 
 func (c *DockerCollectorManager) stopContainer(name string) error {
-	_, err := c.executor.StopContainer(name)
+	_, err := c.executor.StopContainer(executor.ContainerID(name))
 	return err
 }
 
-func (c *DockerCollectorManager) ContainerID() string {
+func (c *DockerCollectorManager) ContainerID() executor.ContainerID {
 	return c.containerID
 }
 

integration-tests/pkg/collector/collector_k8s.go

@@ -32,7 +32,7 @@ type K8sCollectorManager struct {
 
 	eventWatcher watch.Interface
 
-	containerID string
+	containerID executor.ContainerID
 	ip          string
 }
 
@@ -165,7 +165,7 @@ func (k *K8sCollectorManager) TearDown() error {
 
 	if !isRunning {
 		exitCode, err := k.executor.ExitCode(executor.ContainerFilter{
-			Name:      "collector",
+			Id:        executor.ContainerID("collector"),
 			Namespace: TEST_NAMESPACE,
 		})
 		if err != nil {
@@ -185,7 +185,7 @@ func (k *K8sCollectorManager) TearDown() error {
 	}
 
 	return k.executor.WaitPodRemoved(executor.ContainerFilter{
-		Name:      "collector",
+		Id:        executor.ContainerID("collector"),
 		Namespace: TEST_NAMESPACE,
 	})
 }
@@ -199,10 +199,10 @@ func (k *K8sCollectorManager) IsRunning() (bool, error) {
 	return *pod.Status.ContainerStatuses[0].Started, nil
 }
 
-func (k *K8sCollectorManager) ContainerID() string {
+func (k *K8sCollectorManager) ContainerID() executor.ContainerID {
 	if k.containerID == "" {
 		cf := executor.ContainerFilter{
-			Name:      "collector",
+			Id:        executor.ContainerID("collector"),
 			Namespace: TEST_NAMESPACE,
 		}
 

integration-tests/pkg/common/container_id.go

@@ -0,0 +1,16 @@
+package common
+
+// ContainerID is an identifier for a container. It can
+// be a container name *OR* a hex ID
+type ContainerID string
+
+// Long returns the whole containerID as a string
+func (c ContainerID) Long() string {
+	return string(c)
+}
+
+// Short returns the first twelve character of a containerID
+// to match the shortened IDs returned by docker.
+func (c ContainerID) Short() string {
+	return string(c)[:12]
+}

integration-tests/pkg/common/utils.go

@@ -15,12 +15,6 @@ import (
 	"k8s.io/utils/strings/slices"
 )
 
-// containerShortID returns the first twelve character of a containerID
-// to match the shortened IDs returned by docker.
-func ContainerShortID(containerID string) string {
-	return containerID[0:12]
-}
-
 // quoteArgs will add quotes around any arguments require it for the shell.
 func QuoteArgs(args []string) []string {
 	quotedArgs := []string{}

integration-tests/pkg/executor/executor.go

@@ -6,8 +6,23 @@ import (
 	"github.com/stackrox/collector/integration-tests/pkg/config"
 )
 
+// ContainerID is an identifier for a container. It can
+// be a container name *OR* a hex ID
+type ContainerID string
+
+// Long returns the whole containerID as a string
+func (c ContainerID) Long() string {
+	return string(c)
+}
+
+// Short returns the first twelve character of a containerID
+// to match the shortened IDs returned by docker.
+func (c ContainerID) Short() string {
+	return string(c)[:12]
+}
+
 type ContainerFilter struct {
-	Name      string
+	Id        ContainerID
 	Namespace string
 }
 
@@ -32,20 +47,20 @@ func (l *ContainerLogs) GetSingleLog() string {
 
 type Executor interface {
 	PullImage(image string) error
-	IsContainerRunning(container string) (bool, error)
+	IsContainerRunning(container ContainerID) (bool, error)
 	ContainerExists(filter ContainerFilter) (bool, error)
 	ExitCode(filter ContainerFilter) (int, error)
-	ExecContainer(containerName string, command []string) (string, error)
-	KillContainer(name string) (string, error)
+	ExecContainer(container ContainerID, command []string) (string, error)
+	KillContainer(container ContainerID) (string, error)
 	RemoveContainer(filter ContainerFilter) (string, error)
-	StopContainer(name string) (string, error)
-	StartContainer(config config.ContainerStartConfig) (string, error)
-	GetContainerHealthCheck(containerID string) (string, error)
-	GetContainerIP(containerID string) (string, error)
-	GetContainerLogs(containerID string) (ContainerLogs, error)
-	CaptureLogs(testName, containerName string) (string, error)
-	GetContainerPort(containerID string) (string, error)
-	IsContainerFoundFiltered(containerID, filter string) (bool, error)
+	StopContainer(container ContainerID) (string, error)
+	StartContainer(config config.ContainerStartConfig) (ContainerID, error)
+	GetContainerHealthCheck(container ContainerID) (string, error)
+	GetContainerIP(container ContainerID) (string, error)
+	GetContainerLogs(container ContainerID) (ContainerLogs, error)
+	CaptureLogs(testName string, container ContainerID) (string, error)
+	GetContainerPort(container ContainerID) (string, error)
+	IsContainerFoundFiltered(container ContainerID, filter string) (bool, error)
 }
 
 type CommandBuilder interface {