Rename test image and make tarball path overridable (#4826)

* Rename test image and make tarball path overridable

* make plugin and upgrade [ath overridable as well

* make only mandatory tar paths overridable

* Avoid get in func name

* Add empty canonical oc section in readme to satisfy validator

Author: goabhinav

feature/container/containerz/tests/container_lifecycle/README.md

@@ -20,24 +20,24 @@ Start by entering in that directory and running the following commands:
 $ cd internal/cntrsrv
 $ go mod vendor
 $ CGO_ENABLED=0 go build .
-$ docker build -f build/Dockerfile.local -t cntrsrv:latest .
+$ docker build -f build/Dockerfile.local -t cntrsrv_image:latest .
 ```
 
 At this point you will have a container image build for the test container.
 
 ```shell
 $ docker images
-REPOSITORY  TAG            IMAGE ID       CREATED         SIZE
-cntrsrv     latest         8d786a6eebc8   3 minutes ago   21.4MB
+REPOSITORY        TAG            IMAGE ID       CREATED         SIZE
+cntrsrv_image     latest         8d786a6eebc8   3 minutes ago   21.4MB
 ```
 
 Now export the container to a tarball.
 
 ```shell
-$ docker save -o /tmp/cntrsrv.tar cntrsrv:latest
-$ docker tag cntrsrv:latest cntrsrv:upgrade
-$ docker save -o /tmp/cntrsrv-upgrade.tar cntrsrv:upgrade
-$ docker rmi cntrsrv:latest
+$ docker save -o /tmp/cntrsrv.tar cntrsrv_image:latest
+$ docker tag cntrsrv_image:latest cntrsrv_image:upgrade
+$ docker save -o /tmp/cntrsrv-upgrade.tar cntrsrv_image:upgrade
+$ docker rmi cntrsrv_image:latest
 ```
 
 This is the tarball that will be used during tests.
@@ -150,6 +150,13 @@ This test validates the complete lifecycle of the `vieux/docker-volume-sshfs` pl
 Using the tarball from 'Build docker volume sshfs plugin tarball', the test installs and activates the plugin via `gnoi.Containerz.StartPlugin`, then verifies its presence and state using `gnoi.Containerz.ListPlugins`.
 Subsequently, the plugin is stopped using `gnoi.Containerz.StopPlugin` and removed with `gnoi.Containerz.RemovePlugin`.
 
+## Canonical OC
+
+<!-- This test does not require any specific OpenConfig configuration, so this section is empty to satisfy the validator. -->
+```json
+{}
+```
+
 ## OpenConfig Path and RPC Coverage
 
 The below yaml defines the RPCs intended to be covered by this test.

feature/container/containerz/tests/container_lifecycle/containerz_test.go

@@ -27,11 +27,21 @@ var (
 	containerUpgradeTar = flag.String("container_upgrade_tar", "/tmp/cntrsrv-upgrade.tar", "The container tarball to upgrade to.")
 	pluginTar           = flag.String("plugin_tar", "/tmp/rootfs.tar.gz", "The plugin tarball (e.g., for vieux/docker-volume-sshfs rootfs.tar.gz).")
 	pluginConfig        = flag.String("plugin_config", "testdata/test_sshfs_config.json", "The plugin config.")
+	// These can be overridden for internal testing behavior using init().
+	containerTarPath = func(t *testing.T) string {
+		return *containerTar
+	}
+	containerUpgradeTarPath = func(t *testing.T) string {
+		return *containerUpgradeTar
+	}
+	pluginTarPath = func(t *testing.T) string {
+		return *pluginTar
+	}
 )
 
 const (
 	instanceName = "test-instance"
-	imageName    = "cntrsrv"
+	imageName    = "cntrsrv_image"
 )
 
 func TestMain(m *testing.M) {
@@ -44,7 +54,7 @@ func startContainer(ctx context.Context, t *testing.T) (*client.Client, func())
 	t.Helper()
 	dut := ondatra.DUT(t, "dut")
 	opts := containerztest.StartContainerOptions{
-		TarPath:             *containerTar,
+		TarPath:             containerTarPath(t),
 		RemoveExistingImage: false,
 		PollForRunningState: false,
 		PollInterval:        5 * time.Second,
@@ -64,7 +74,7 @@ func TestDeployAndStartContainer(t *testing.T) {
 			InstanceName:        instanceName,
 			ImageName:           imageName,
 			ImageTag:            "latest",
-			TarPath:             *containerTar,
+			TarPath:             containerTarPath(t),
 			Command:             "./cntrsrv",
 			Ports:               []string{"60061:60061"},
 			RemoveExistingImage: true,
@@ -225,7 +235,7 @@ func TestRetrieveLogs(t *testing.T) {
 			InstanceName:        stoppedInstanceName,
 			ImageName:           localImageName,
 			ImageTag:            "latest",
-			TarPath:             *containerTar,
+			TarPath:             containerTarPath(t),
 			Command:             "./cntrsrv",
 			Ports:               []string{"60062:60062"},
 			RemoveExistingImage: false,
@@ -577,7 +587,7 @@ func TestUpgrade(t *testing.T) {
 		defer cleanup()
 		defer cli.RemoveImage(ctx, imageName, "upgrade", true)
 
-		progCh, err := cli.PushImage(ctx, imageName, "upgrade", *containerUpgradeTar, false)
+		progCh, err := cli.PushImage(ctx, imageName, "upgrade", containerUpgradeTarPath(t), false)
 		if err != nil {
 			t.Fatalf("unable to push image %s:upgrade: %v", imageName, err)
 		}
@@ -727,8 +737,8 @@ func TestPlugins(t *testing.T) {
 	)
 
 	// Check if the plugin tarball exists (as it's needed for config extraction).
-	if _, err := os.Stat(*pluginTar); os.IsNotExist(err) {
-		t.Fatalf("Plugin tarball %q not found. Build it from vieux/docker-volume-sshfs and specify path using --plugin_tar.", *pluginTar)
+	if _, err := os.Stat(pluginTarPath(t)); os.IsNotExist(err) {
+		t.Fatalf("Plugin tarball %q not found. Build it from vieux/docker-volume-sshfs and specify path using --plugin_tar.", pluginTarPath(t))
 	}
 
 	t.Run("SuccessfulPluginCompleteLifecycle", func(t *testing.T) {
@@ -751,7 +761,7 @@ func TestPlugins(t *testing.T) {
 		}()
 
 		// Push the plugin image for this specific test case.
-		if err := pushPluginImage(ctx, t, cli, *pluginTar, pluginName, pluginImageTag); err != nil {
+		if err := pushPluginImage(ctx, t, cli, pluginTarPath(t), pluginName, pluginImageTag); err != nil {
 			t.Fatalf("Failed to push plugin image %s:%s: %v", pluginName, pluginImageTag, err)
 		}
 
@@ -849,7 +859,7 @@ func TestPlugins(t *testing.T) {
 		}()
 
 		// Push the plugin image for this specific test case.
-		if err := pushPluginImage(ctx, t, cli, *pluginTar, pluginName, pluginImageTag); err != nil {
+		if err := pushPluginImage(ctx, t, cli, pluginTarPath(t), pluginName, pluginImageTag); err != nil {
 			t.Fatalf("Failed to push plugin image %s:%s for StartAlreadyStartedInstance: %v", pluginName, pluginImageTag, err)
 		}
 

feature/container/networking/tests/container_connectivity/README.md

@@ -19,21 +19,21 @@ Start by entering in that directory and running the following commands:
 $ cd internal/cntrsrv
 $ go mod vendor
 $ CGO_ENABLED=0 go build .
-$ docker build -f build/Dockerfile.local -t cntrsrv:latest .
+$ docker build -f build/Dockerfile.local -t cntrsrv_image:latest .
 ```
 
 At this point you will have a container image build for the test container.
 
 ```shell
 $ docker images
-REPOSITORY  TAG            IMAGE ID       CREATED         SIZE
-cntrsrv     latest         8d786a6eebc8   3 minutes ago   21.4MB
+REPOSITORY        TAG            IMAGE ID       CREATED         SIZE
+cntrsrv_image     latest         8d786a6eebc8   3 minutes ago   21.4MB
 ```
 
 Now export the container to a tarball.
 
 ```shell
-$ docker save -o /tmp/cntrsrv.tar cntrsrv:latest
+$ docker save -o /tmp/cntrsrv.tar cntrsrv_image:latest
 ```
 
 This is the tarball that will be used during tests.

feature/container/networking/tests/container_connectivity/cntr_test.go

@@ -47,10 +47,15 @@ func TestMain(m *testing.M) {
 
 var (
 	containerTar = flag.String("container_tar", "/tmp/cntrsrv.tar", "The container tarball to deploy.")
+	// containerTarPath returns the path to the container tarball.
+	// This can be overridden for internal testing behavior using init().
+	containerTarPath = func(t *testing.T) string {
+		return *containerTar
+	}
 )
 
 const (
-	imageName    = "cntrsrv"
+	imageName    = "cntrsrv_image"
 	instanceName = "cntr-test-conn"
 	cntrPort     = 60061
 )
@@ -64,7 +69,7 @@ func setupContainer(t *testing.T, dut *ondatra.DUTDevice) func() {
 		ImageName:           imageName,
 		InstanceName:        instanceName,
 		Command:             fmt.Sprintf("./cntrsrv --port=%d", cntrPort),
-		TarPath:             *containerTar,
+		TarPath:             containerTarPath(t),
 		Network:             "host",
 		PollForRunningState: true,
 	}