tests: allow running unit tests using podman

Refactor unit test so that podman can be used to run tests when docker is not available. Fixes: #2006 Signed-off-by: Marco Vedovati <[email protected]>
kata-containers · Aug 29, 2019 · ff8d23d · ff8d23d
1 parent af57485
commit ff8d23d
Show file tree

Hide file tree

Showing 4 changed files with 136 additions and 85 deletions.
diff --git a/cli/main_test.go b/cli/main_test.go
@@ -52,6 +52,7 @@ var (
 	testDir       = ""
 	testBundleDir = ""
 	tc            ktu.TestConstraint
+	ctrEngine     = katautils.CtrEngine{}
 )
 
 // testingImpl is a concrete mock RVC implementation used for testing
@@ -87,26 +88,33 @@ func init() {
 	if err != nil {
 		panic(fmt.Sprintf("ERROR: failed to create test directory: %v", err))
 	}
-
 	fmt.Printf("INFO: test directory is %v\n", testDir)
 
-	fmt.Printf("INFO: ensuring docker is running\n")
-	output, err := katautils.RunCommandFull([]string{"docker", "version"}, true)
-	if err != nil {
-		panic(fmt.Sprintf("ERROR: docker daemon is not installed, not running, or not accessible to current user: %v (error %v)",
+	var output string
+	for _, name := range katautils.DockerLikeCtrEngines {
+		fmt.Printf("INFO: checking for container engine: %s\n", name)
+
+		output, err = ctrEngine.Init(name)
+		if err == nil {
+			break
+		}
+	}
+
+	if ctrEngine.Name == "" {
+		panic(fmt.Sprintf("ERROR: Docker-like container engine not accessible to current user: %v (error %v)",
 			output, err))
 	}
 
 	// Do this now to avoid hitting the test timeout value due to
 	// slow network response.
-	fmt.Printf("INFO: ensuring required docker image (%v) is available\n", testDockerImage)
-
+	fmt.Printf("INFO: ensuring required container image (%v) is available\n", testDockerImage)
 	// Only hit the network if the image doesn't exist locally
-	_, err = katautils.RunCommand([]string{"docker", "inspect", "--type=image", testDockerImage})
+	_, err = ctrEngine.Inspect(testDockerImage)
 	if err == nil {
-		fmt.Printf("INFO: docker image %v already exists locally\n", testDockerImage)
+		fmt.Printf("INFO: container image %v already exists locally\n", testDockerImage)
 	} else {
-		_, err = katautils.RunCommand([]string{"docker", "pull", testDockerImage})
+		fmt.Printf("INFO: pulling container image %v\n", testDockerImage)
+		_, err = ctrEngine.Pull(testDockerImage)
 		if err != nil {
 			panic(err)
 		}
@@ -300,38 +308,18 @@ func createRootfs(dir string) error {
 		return err
 	}
 
-	container, err := katautils.RunCommand([]string{"docker", "create", testDockerImage})
-	if err != nil {
-		return err
-	}
-
-	cmd1 := exec.Command("docker", "export", container)
-	cmd2 := exec.Command("tar", "-C", dir, "-xvf", "-")
-
-	cmd1Stdout, err := cmd1.StdoutPipe()
-	if err != nil {
-		return err
-	}
-
-	cmd2.Stdin = cmd1Stdout
-
-	err = cmd2.Start()
-	if err != nil {
-		return err
-	}
-
-	err = cmd1.Run()
+	container, err := ctrEngine.Create(testDockerImage)
 	if err != nil {
 		return err
 	}
 
-	err = cmd2.Wait()
+	err = ctrEngine.GetRootfs(container, dir)
 	if err != nil {
 		return err
 	}
 
 	// Clean up
-	_, err = katautils.RunCommand([]string{"docker", "rm", container})
+	_, err = ctrEngine.Rm(container)
 	if err != nil {
 		return err
 	}

diff --git a/containerd-shim-v2/utils_test.go b/containerd-shim-v2/utils_test.go
@@ -53,6 +53,7 @@ var (
 	testDir       = ""
 	testBundleDir = ""
 	tc            ktu.TestConstraint
+	ctrEngine     = katautils.CtrEngine{}
 )
 
 // testingImpl is a concrete mock RVC implementation used for testing
@@ -72,26 +73,33 @@ func init() {
 	if err != nil {
 		panic(fmt.Sprintf("ERROR: failed to create test directory: %v", err))
 	}
-
 	fmt.Printf("INFO: test directory is %v\n", testDir)
 
-	fmt.Printf("INFO: ensuring docker is running\n")
-	output, err := katautils.RunCommandFull([]string{"docker", "version"}, true)
-	if err != nil {
-		panic(fmt.Sprintf("ERROR: docker daemon is not installed, not running, or not accessible to current user: %v (error %v)",
+	var output string
+	for _, name := range katautils.DockerLikeCtrEngines {
+		fmt.Printf("INFO: checking for container engine: %s\n", name)
+
+		output, err = ctrEngine.Init(name)
+		if err == nil {
+			break
+		}
+	}
+
+	if ctrEngine.Name == "" {
+		panic(fmt.Sprintf("ERROR: Docker-like container engine not accessible to current user: %v (error %v)",
 			output, err))
 	}
 
 	// Do this now to avoid hitting the test timeout value due to
 	// slow network response.
-	fmt.Printf("INFO: ensuring required docker image (%v) is available\n", testDockerImage)
-
+	fmt.Printf("INFO: ensuring required container image (%v) is available\n", testDockerImage)
 	// Only hit the network if the image doesn't exist locally
-	_, err = katautils.RunCommand([]string{"docker", "inspect", "--type=image", testDockerImage})
+	_, err = ctrEngine.Inspect(testDockerImage)
 	if err == nil {
-		fmt.Printf("INFO: docker image %v already exists locally\n", testDockerImage)
+		fmt.Printf("INFO: container image %v already exists locally\n", testDockerImage)
 	} else {
-		_, err = katautils.RunCommand([]string{"docker", "pull", testDockerImage})
+		fmt.Printf("INFO: pulling container image %v\n", testDockerImage)
+		_, err = ctrEngine.Pull(testDockerImage)
 		if err != nil {
 			panic(err)
 		}
@@ -309,38 +317,18 @@ func createRootfs(dir string) error {
 		return err
 	}
 
-	container, err := katautils.RunCommand([]string{"docker", "create", testDockerImage})
-	if err != nil {
-		return err
-	}
-
-	cmd1 := sysExec.Command("docker", "export", container)
-	cmd2 := sysExec.Command("tar", "-C", dir, "-xvf", "-")
-
-	cmd1Stdout, err := cmd1.StdoutPipe()
-	if err != nil {
-		return err
-	}
-
-	cmd2.Stdin = cmd1Stdout
-
-	err = cmd2.Start()
-	if err != nil {
-		return err
-	}
-
-	err = cmd1.Run()
+	container, err := ctrEngine.Create(testDockerImage)
 	if err != nil {
 		return err
 	}
 
-	err = cmd2.Wait()
+	err = ctrEngine.GetRootfs(container, dir)
 	if err != nil {
 		return err
 	}
 
 	// Clean up
-	_, err = katautils.RunCommand([]string{"docker", "rm", container})
+	_, err = ctrEngine.Rm(container)
 	if err != nil {
 		return err
 	}

diff --git a/pkg/katautils/container_engine.go b/pkg/katautils/container_engine.go
@@ -0,0 +1,75 @@
+// Copyright (c) 2019 SUSE LLC
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+package katautils
+
+import (
+	"os/exec"
+)
+
+type CtrEngine struct {
+	Name string
+}
+
+var (
+	DockerLikeCtrEngines = []string{"docker", "podman"}
+)
+
+func (e *CtrEngine) Init(name string) (string, error) {
+	var out string
+	out, err := RunCommandFull([]string{name, "version"}, true)
+	if err != nil {
+		return out, err
+	}
+
+	e.Name = name
+	return out, nil
+}
+
+func (e *CtrEngine) Inspect(image string) (string, error) {
+	// Only hit the network if the image doesn't exist locally
+	return RunCommand([]string{e.Name, "inspect", "--type=image", image})
+}
+
+func (e *CtrEngine) Pull(image string) (string, error) {
+	return RunCommand([]string{e.Name, "pull", image})
+}
+
+func (e *CtrEngine) Create(image string) (string, error) {
+	return RunCommand([]string{e.Name, "create", image})
+}
+
+func (e *CtrEngine) Rm(ctrID string) (string, error) {
+	return RunCommand([]string{e.Name, "rm", ctrID})
+}
+
+func (e *CtrEngine) GetRootfs(ctrID string, dir string) error {
+	cmd1 := exec.Command(e.Name, "export", ctrID)
+	cmd2 := exec.Command("tar", "-C", dir, "-xvf", "-")
+
+	cmd1Stdout, err := cmd1.StdoutPipe()
+	if err != nil {
+		return err
+	}
+
+	cmd2.Stdin = cmd1Stdout
+
+	err = cmd2.Start()
+	if err != nil {
+		return err
+	}
+
+	err = cmd1.Run()
+	if err != nil {
+		return err
+	}
+
+	err = cmd2.Wait()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/pkg/katautils/utils_test.go b/pkg/katautils/utils_test.go
@@ -149,43 +149,43 @@ func realMakeOCIBundle(bundleDir string) error {
 // createRootfs creates a minimal root filesystem below the specified
 // directory.
 func createRootfs(dir string) error {
-	err := os.MkdirAll(dir, testDirMode)
-	if err != nil {
-		return err
-	}
-
-	container, err := RunCommand([]string{"docker", "create", testDockerImage})
-	if err != nil {
-		return err
-	}
+	var (
+		output string
+		err    error
+	)
 
-	cmd1 := exec.Command("docker", "export", container)
-	cmd2 := exec.Command("tar", "-C", dir, "-xvf", "-")
+	ctrEngine := CtrEngine{}
+	for _, name := range DockerLikeCtrEngines {
+		fmt.Printf("INFO: checking for container engine: %s\n", name)
 
-	cmd1Stdout, err := cmd1.StdoutPipe()
-	if err != nil {
-		return err
+		output, err = ctrEngine.Init(name)
+		if err == nil {
+			break
+		}
 	}
 
-	cmd2.Stdin = cmd1Stdout
+	if ctrEngine.Name == "" {
+		panic(fmt.Sprintf("ERROR: Docker-like container engine not accessible to current user: %v (error %v)",
+			output, err))
+	}
 
-	err = cmd2.Start()
+	err = os.MkdirAll(dir, testDirMode)
 	if err != nil {
 		return err
 	}
 
-	err = cmd1.Run()
+	container, err := ctrEngine.Create(testDockerImage)
 	if err != nil {
 		return err
 	}
 
-	err = cmd2.Wait()
+	err = ctrEngine.GetRootfs(container, dir)
 	if err != nil {
 		return err
 	}
 
 	// Clean up
-	_, err = RunCommand([]string{"docker", "rm", container})
+	_, err = ctrEngine.Rm(container)
 	if err != nil {
 		return err
 	}