kola: Add support for injectContainer

Closes: #2952

For quite a while we've been generating a "base image" container
as part of our builds, but it has basically been entirely untested
outside of its processing and use by the ostree stack.

This adds a base framework such that external tests can request
the injection of the container (`.ociarchive`).

Now, we can (and *definitely* should) also pursue "natively" testing
this container image outside of kola, which is very virtual-machine
focused.

However, that will also require a lot of pipeline changes; this
approach allows us to natively "bridge" the worlds of cosa/kola
to test the container image.

Author: cgwalters

docs/kola/external-tests.md

@@ -229,6 +229,12 @@ In the example above, the test would only run if `--tag special` was provided.
 The `additionalDisks` key has the same semantics as the `--add-disk` argument
 to `qemuexec`. It is currently only supported on `qemu-unpriv`.
 
+The `injectContainer` boolean if set will cause the framework to inject
+the ostree base image container into the target system; the path can be
+found in the environment variable `KOLA_OSTREE_OCIARCHIVE`.  This will be
+an `.ociarchive` file that can be e.g. loaded into the containers storage
+via `skopeo copy oci-archive:$KOLA_OSTREE_OCIARCHIVE containers-storage:localhost/os`.
+
 The `minDisk` key takes a size in GB and ensures that an instance type with at
 least the specified amount of primary disk space is used. On QEMU, this is
 equivalent to the `--qemu-size` argument to `qemuexec`. This is currently only

mantle/kola/harness.go

@@ -194,6 +194,9 @@ const (
 	// kolaExtBinDataEnv is an environment variable pointing to the above
 	kolaExtBinDataEnv = "KOLA_EXT_DATA"
 
+	// kolaExtContainerDataEnv includes the path to the ostree base container image in oci-archive format.
+	kolaExtContainerDataEnv = "KOLA_EXT_OSTREE_OCIARCHIVE"
+
 	// kolaExtBinDataName is the name for test dependency data
 	kolaExtBinDataName = "data"
 )
@@ -765,6 +768,7 @@ type externalTestMeta struct {
 	Tags                      string   `json:"tags,omitempty"`
 	RequiredTag               string   `json:"requiredTag,omitempty"`
 	AdditionalDisks           []string `json:"additionalDisks,omitempty"`
+	InjectContainer           bool     `json:"injectContainer,omitempty"`
 	MinMemory                 int      `json:"minMemory,omitempty"`
 	MinDiskSize               int      `json:"minDisk,omitempty"`
 	AdditionalNics            int      `json:"additionalNics,omitempty"`
@@ -925,6 +929,13 @@ Environment=KOLA_TEST_EXE=%s
 Environment=%s=%s
 ExecStart=%s
 `, unitName, testname, base, kolaExtBinDataEnv, destDataDir, remotepath)
+	if targetMeta.InjectContainer {
+		if CosaBuild == nil {
+			return fmt.Errorf("test %v uses injectContainer, but no cosa build found", testname)
+		}
+		ostreeContainer := CosaBuild.Meta.BuildArtifacts.Ostree
+		unit += fmt.Sprintf("Environment=%s=/home/core/%s\n", kolaExtContainerDataEnv, ostreeContainer.Path)
+	}
 	config.AddSystemdUnit(unitName, unit, conf.NoState)
 
 	// Architectures using 64k pages use slightly more memory, ask for more than requested
@@ -944,6 +955,7 @@ ExecStart=%s
 		Tags:          []string{"external"},
 
 		AdditionalDisks:           targetMeta.AdditionalDisks,
+		InjectContainer:           targetMeta.InjectContainer,
 		MinMemory:                 targetMeta.MinMemory,
 		MinDiskSize:               targetMeta.MinDiskSize,
 		AdditionalNics:            targetMeta.AdditionalNics,
@@ -1459,6 +1471,17 @@ func runTest(h *harness.H, t *register.Test, pltfrm string, flight platform.Flig
 		}
 	}
 
+	if t.InjectContainer {
+		if CosaBuild == nil {
+			h.Fatalf("Test %s uses injectContainer, but no cosa build found", t.Name)
+		}
+		ostreeContainer := CosaBuild.Meta.BuildArtifacts.Ostree
+		ostreeContainerPath := filepath.Join(CosaBuild.Dir, ostreeContainer.Path)
+		if err := cluster.DropFile(tcluster.Machines(), ostreeContainerPath); err != nil {
+			h.Fatal(err)
+		}
+	}
+
 	if t.ExternalTest != "" {
 		setupExternalTest(h, t, tcluster)
 		// Collect the journal logs after execution is finished

mantle/kola/register/register.go

@@ -78,6 +78,9 @@ type Test struct {
 	// "5G:mpath,foo,bar"]) -- defaults to none.
 	AdditionalDisks []string
 
+	// InjectContainer will cause the ostree base image to be injected into the target
+	InjectContainer bool
+
 	// Minimum amount of memory in MB required for test.
 	MinMemory int