Add support for external embed test image list

apostasie · apostasie · commit cfb5a1671196 · 2025-06-21T15:41:04.000-07:00
Signed-off-by: apostasie &lt;spam_blackhole@farcloser.world&gt;
diff --git a/pkg/testutil/images.yaml b/pkg/testutil/images.yaml
@@ -0,0 +1,77 @@
+# Current schema (defined in images_linux.go) allows for ref, tag, (index) digest and platform variants.
+# Right now, digest and variants are not used for anything, but they should / could be in the future.
+# Also note that changing the schema should be easy and straight-forward for now, so,
+# this might evolve in the near future.
+alpine:
+  ref: "ghcr.io/stargz-containers/alpine"
+  tag: "3.13-org"
+  digest: "sha256:ec14c7992a97fc11425907e908340c6c3d6ff602f5f13d899e6b7027c9b4133a"
+  variants: ["linux/amd64", "linux/arm64"]
+
+busybox:
+  ref: "ghcr.io/containerd/busybox"
+  tag: "1.36"
+
+docker_auth:
+  ref: "ghcr.io/stargz-containers/cesanta/docker_auth"
+  tag: "1.7-org"
+
+fluentd:
+  ref: "fluentd"
+  tag: "v1.18.0-debian-1.0"
+
+golang:
+  ref: "golang"
+  tag: "1.23.8-bookworm"
+
+kubo:
+  ref: "ghcr.io/stargz-containers/ipfs/kubo"
+  tag: "v0.16.0-org"
+
+mariadb:
+  ref: "ghcr.io/stargz-containers/mariadb"
+  tag: "10.5-org"
+
+nanoserver:
+  ref: "mcr.microsoft.com/windows/nanoserver"
+  tag: "ltsc2022"
+
+nginx:
+  ref: "ghcr.io/stargz-containers/nginx"
+  tag: "1.19-alpine-org"
+
+registry:
+  ref: "ghcr.io/stargz-containers/registry"
+  tag: "2-org"
+
+stargz:
+  ref: "ghcr.io/containerd/stargz-snapshotter"
+  tag: "0.15.1-kind"
+
+wordpress:
+  ref: "ghcr.io/stargz-containers/wordpress"
+  tag: "5.7-org"
+
+fedora_esgz:
+  ref: "ghcr.io/stargz-containers/fedora"
+  tag: "30-esgz"
+
+ffmpeg_soci:
+  ref: "public.ecr.aws/soci-workshop-examples/ffmpeg"
+  tag: "latest"
+
+# Large enough for testing soci index creation
+ubuntu:
+  ref: "public.ecr.aws/docker/library/ubuntu"
+  tag: "23.10"
+
+# Future: images to add or update soon.
+# busybox:1.37.0@sha256:37f7b378a29ceb4c551b1b5582e27747b855bbfaa73fa11914fe0df028dc581f
+# debian:bookworm-slim@sha256:b1211f6d19afd012477bd34fdcabb6b663d680e0f4b0537da6e6b0fd057a3ec3
+# gitlab/gitlab-ee:17.11.0-ee.0@sha256:e0d9d5e0d0068f4b4bac3e15eb48313b5c3bb508425645f421bf2773a964c4ae
+# bitnami/harbor-portal:v2.13.0@sha256:636f39610b359369aeeddd7859cb56274d9a1bc3e467e21d74ea89e1516c1a0c
+# mariadb:11.7.2@sha256:81e893032978c4bf8ad43710b7a979774ed90787fa32d199162148ce28fe3b76
+# nginx:alpine3.21@sha256:65645c7bb6a0661892a8b03b89d0743208a18dd2f3f17a54ef4b76fb8e2f2a10
+# wordpress:6.8.0-php8.4-fpm-alpine@sha256:309b64fa4266d8a3fe6f0973ae3172fec1023c9b18242ccf1dffbff5dc8b81a8
+# Right now, v3 is breaking tests.
+# ghcr.io/distribution/distribution:3.0.0@sha256:4ba3adf47f5c866e9a29288c758c5328ef03396cb8f5f6454463655fa8bc83e2
diff --git a/pkg/testutil/images_linux.go b/pkg/testutil/images_linux.go
@@ -0,0 +1,58 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import (
+	_ "embed"
+	"fmt"
+	"sync"
+
+	"gopkg.in/yaml.v3"
+)
+
+//go:embed images.yaml
+var rawImagesList string
+
+var testImagesOnce sync.Once
+
+type TestImage struct {
+	Ref      string   `yaml:"ref"`
+	Tag      string   `yaml:"tag,omitempty"`
+	Digest   string   `yaml:"digest,omitempty"`
+	Variants []string `yaml:"variants,omitempty"`
+}
+
+var testImages map[string]TestImage
+
+func getImage(key string) string {
+	testImagesOnce.Do(func() {
+		if err := yaml.Unmarshal([]byte(rawImagesList), &testImages); err != nil {
+			fmt.Printf("Error unmarshaling test images YAML file: %v\n", err)
+			panic("testing is broken")
+		}
+	})
+
+	var im TestImage
+	var ok bool
+
+	if im, ok = testImages[key]; !ok {
+		fmt.Printf("Image %s was not found in images list\n", key)
+		panic("testing is broken")
+	}
+
+	return im.Ref + ":" + im.Tag
+}
diff --git a/pkg/testutil/nerdtest/platform/platform_darwin.go b/pkg/testutil/nerdtest/platform/platform_darwin.go
@@ -23,7 +23,6 @@ func DataHome() (string, error) {
 var (
 	// The following are here solely for darwin to compile / lint. They are not used, as the corresponding tests are running only on linux.
 	RegistryImageStable = "registry:2"
-	RegistryImageNext   = "ghcr.io/distribution/distribution:"
 	KuboImage           = "ipfs/kubo:v0.16.0"
 	DockerAuthImage     = "cesanta/docker_auth:1.7"
 )
diff --git a/pkg/testutil/nerdtest/platform/platform_freebsd.go b/pkg/testutil/nerdtest/platform/platform_freebsd.go
@@ -23,7 +23,6 @@ func DataHome() (string, error) {
 var (
 	// The following are here solely for freebsd to compile / lint. They are not used, as the corresponding tests are running only on linux.
 	RegistryImageStable = "registry:2"
-	RegistryImageNext   = "ghcr.io/distribution/distribution:"
 	KuboImage           = "ipfs/kubo:v0.16.0"
 	DockerAuthImage     = "cesanta/docker_auth:1.7"
 )
diff --git a/pkg/testutil/nerdtest/platform/platform_linux.go b/pkg/testutil/nerdtest/platform/platform_linux.go
@@ -27,7 +27,6 @@ func DataHome() (string, error) {
 
 var (
 	RegistryImageStable = testutil.RegistryImageStable
-	RegistryImageNext   = testutil.RegistryImageNext
 	KuboImage           = testutil.KuboImage
 	DockerAuthImage     = testutil.DockerAuthImage
 )
diff --git a/pkg/testutil/nerdtest/platform/platform_windows.go b/pkg/testutil/nerdtest/platform/platform_windows.go
@@ -16,22 +16,12 @@
 
 package platform
 
-import (
-	"fmt"
-)
-
 func DataHome() (string, error) {
 	panic("not supported")
 }
 
-// The following are here solely for windows to compile. They are not used, as the corresponding tests are running only on linux.
-func mirrorOf(s string) string {
-	return fmt.Sprintf("ghcr.io/stargz-containers/%s-org", s)
-}
-
 var (
-	RegistryImageStable = mirrorOf("registry:2")
-	RegistryImageNext   = "ghcr.io/distribution/distribution:"
-	KuboImage           = mirrorOf("ipfs/kubo:v0.16.0")
-	DockerAuthImage     = mirrorOf("cesanta/docker_auth:1.7")
+	RegistryImageStable = "there-is-no-such-test-on-windows"
+	KuboImage           = "there-is-no-such-test-on-windows"
+	DockerAuthImage     = "there-is-no-such-test-on-windows"
 )
diff --git a/pkg/testutil/nerdtest/registry/docker.go b/pkg/testutil/nerdtest/registry/docker.go
@@ -19,7 +19,6 @@ package registry
 import (
 	"fmt"
 	"net"
-	"os"
 	"strconv"
 
 	"gotest.tools/v3/assert"
@@ -71,15 +70,7 @@ func NewDockerRegistry(data test.Data, helpers test.Helpers, currentCA *testca.C
 	// Attach authentication params returns by authenticator
 	args = append(args, auth.Params(data)...)
 
-	// Get the right registry version
 	registryImage := platform.RegistryImageStable
-	up := os.Getenv("DISTRIBUTION_VERSION")
-	if up != "" {
-		if up[0:1] != "v" {
-			up = "v" + up
-		}
-		registryImage = platform.RegistryImageNext + up
-	}
 	args = append(args, registryImage)
 
 	cleanup := func(data test.Data, helpers test.Helpers) {
diff --git a/pkg/testutil/nerdtest/requirements.go b/pkg/testutil/nerdtest/requirements.go
@@ -20,7 +20,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"os"
 	"os/exec"
 	"strings"
 
@@ -277,13 +276,6 @@ var Registry = require.All(
 				// - when we start a large number of registries in subtests, no need to round-trip to ghcr everytime
 				// This of course assumes that the subtests are NOT going to prune / rmi images
 				registryImage := platform.RegistryImageStable
-				up := os.Getenv("DISTRIBUTION_VERSION")
-				if up != "" {
-					if up[0:1] != "v" {
-						up = "v" + up
-					}
-					registryImage = platform.RegistryImageNext + up
-				}
 				helpers.Ensure("pull", "--quiet", registryImage)
 				helpers.Ensure("pull", "--quiet", platform.DockerAuthImage)
 				helpers.Ensure("pull", "--quiet", platform.KuboImage)
diff --git a/pkg/testutil/testregistry/testregistry_linux.go b/pkg/testutil/testregistry/testregistry_linux.go
@@ -57,13 +57,6 @@ type TokenAuthServer struct {
 
 func EnsureImages(base *testutil.Base) {
 	registryImage := platform.RegistryImageStable
-	up := os.Getenv("DISTRIBUTION_VERSION")
-	if up != "" {
-		if up[0:1] != "v" {
-			up = "v" + up
-		}
-		registryImage = platform.RegistryImageNext + up
-	}
 	base.Cmd("pull", "--quiet", registryImage).AssertOK()
 	base.Cmd("pull", "--quiet", platform.DockerAuthImage).AssertOK()
 	base.Cmd("pull", "--quiet", platform.KuboImage).AssertOK()
@@ -285,14 +278,6 @@ func NewRegistry(base *testutil.Base, ca *testca.CA, port int, auth Auth, boundC
 
 	args = append(args, auth.Params(base)...)
 	registryImage := testutil.RegistryImageStable
-
-	up := os.Getenv("DISTRIBUTION_VERSION")
-	if up != "" {
-		if up[0:1] != "v" {
-			up = "v" + up
-		}
-		registryImage = testutil.RegistryImageNext + up
-	}
 	args = append(args, registryImage)
 
 	cleanup := func(err error) {
diff --git a/pkg/testutil/testutil.go b/pkg/testutil/testutil.go
@@ -763,8 +763,3 @@ func RegisterBuildCacheCleanup(t *testing.T) {
 		NewBase(t).Cmd("builder", "prune", "--all", "--force").Run()
 	})
 }
-
-func mirrorOf(s string) string {
-	// plain mirror, NOT stargz-converted images
-	return fmt.Sprintf("ghcr.io/stargz-containers/%s-org", s)
-}
diff --git a/pkg/testutil/testutil_darwin.go b/pkg/testutil/testutil_darwin.go
@@ -28,8 +28,8 @@ const (
 )
 
 var (
-	BusyboxImage     = "ghcr.io/containerd/busybox:1.36"
-	AlpineImage      = mirrorOf("alpine:3.13")
-	NginxAlpineImage = mirrorOf("nginx:1.19-alpine")
-	GolangImage      = mirrorOf("golang:1.18")
+	BusyboxImage     = "there-is-no-test-on-darwin"
+	AlpineImage      = "there-is-no-test-on-darwin"
+	NginxAlpineImage = "there-is-no-test-on-darwin"
+	GolangImage      = "there-is-no-test-on-darwin"
 )
diff --git a/pkg/testutil/testutil_freebsd.go b/pkg/testutil/testutil_freebsd.go
@@ -28,8 +28,8 @@ const (
 )
 
 var (
-	BusyboxImage     = "ghcr.io/containerd/busybox:1.36"
-	AlpineImage      = mirrorOf("alpine:3.13")
-	NginxAlpineImage = mirrorOf("nginx:1.19-alpine")
-	GolangImage      = mirrorOf("golang:1.18")
+	BusyboxImage     = "there-is-no-such-test-on-freebsd"
+	AlpineImage      = "there-is-no-such-test-on-freebsd"
+	NginxAlpineImage = "there-is-no-such-test-on-freebsd"
+	GolangImage      = "there-is-no-such-test-on-freebsd"
 )
diff --git a/pkg/testutil/testutil_linux.go b/pkg/testutil/testutil_linux.go
@@ -17,38 +17,38 @@
 package testutil
 
 var (
-	BusyboxImage                = "ghcr.io/containerd/busybox:1.36"
-	AlpineImage                 = mirrorOf("alpine:3.13")
-	NginxAlpineImage            = mirrorOf("nginx:1.19-alpine")
-	NginxAlpineIndexHTMLSnippet = "<title>Welcome to nginx!</title>"
-	RegistryImageStable         = mirrorOf("registry:2")
-	RegistryImageNext           = "ghcr.io/distribution/distribution:"
-	WordpressImage              = mirrorOf("wordpress:5.7")
-	WordpressIndexHTMLSnippet   = "<title>WordPress &rsaquo; Installation</title>"
-	MariaDBImage                = mirrorOf("mariadb:10.5")
-	DockerAuthImage             = mirrorOf("cesanta/docker_auth:1.7")
-	FluentdImage                = "fluent/fluentd:v1.17.0-debian-1.0"
-	KuboImage                   = mirrorOf("ipfs/kubo:v0.16.0")
-	SystemdImage                = "ghcr.io/containerd/stargz-snapshotter:0.15.1-kind"
-	GolangImage                 = mirrorOf("golang:1.18")
-
-	// Source: https://gist.github.com/cpuguy83/fcf3041e5d8fb1bb5c340915aabeebe0
-	NonDistBlobImage = "ghcr.io/cpuguy83/non-dist-blob:latest"
-	// Foreign layer digest
-	NonDistBlobDigest = "sha256:be691b1535726014cdf3b715ff39361b19e121ca34498a9ceea61ad776b9c215"
+	AlpineImage         = getImage("alpine")
+	BusyboxImage        = getImage("busybox")
+	DockerAuthImage     = getImage("docker_auth")
+	FluentdImage        = getImage("fluentd")
+	GolangImage         = getImage("golang")
+	KuboImage           = getImage("kubo")
+	MariaDBImage        = getImage("mariadb")
+	NginxAlpineImage    = getImage("nginx")
+	RegistryImageStable = getImage("registry")
+	SystemdImage        = getImage("stargz")
+	WordpressImage      = getImage("wordpress")
 
 	CommonImage = AlpineImage
 
+	FedoraESGZImage = getImage("fedora_esgz") // eStargz
+	FfmpegSociImage = getImage("ffmpeg_soci") // SOCI
+	UbuntuImage     = getImage("ubuntu")      // Large enough for testing soci index creation
+)
+
+const (
 	// This error string is expected when attempting to connect to a TCP socket
 	// for a service which actively refuses the connection.
 	// (e.g. attempting to connect using http to an https endpoint).
 	// It should be "connection refused" as per the TCP RFC.
 	// https://www.rfc-editor.org/rfc/rfc793
 	ExpectedConnectionRefusedError = "connection refused"
-)
 
-const (
-	FedoraESGZImage = "ghcr.io/stargz-containers/fedora:30-esgz"            // eStargz
-	FfmpegSociImage = "public.ecr.aws/soci-workshop-examples/ffmpeg:latest" // SOCI
-	UbuntuImage     = "public.ecr.aws/docker/library/ubuntu:23.10"          // Large enough for testing soci index creation
+	NginxAlpineIndexHTMLSnippet = "<title>Welcome to nginx!</title>"
+	WordpressIndexHTMLSnippet   = "<title>WordPress &rsaquo; Installation</title>"
+
+	// Source: https://gist.github.com/cpuguy83/fcf3041e5d8fb1bb5c340915aabeebe0
+	NonDistBlobImage = "ghcr.io/cpuguy83/non-dist-blob:latest@sha256:8859ffb0bb604463fe19f1e606ceda9f4f8f42e095bf78c42458cf6da7b5c7e7"
+	// Foreign layer digest
+	NonDistBlobDigest = "sha256:be691b1535726014cdf3b715ff39361b19e121ca34498a9ceea61ad776b9c215"
 )
diff --git a/pkg/testutil/testutil_windows.go b/pkg/testutil/testutil_windows.go
@@ -53,8 +53,8 @@ const (
 )
 
 var (
-	GolangImage = mirrorOf("fixme-test-using-this-image-is-disabled-on-windows")
-	AlpineImage = mirrorOf("fixme-test-using-this-image-is-disabled-on-windows")
+	GolangImage = "fixme-test-using-this-image-is-disabled-on-windows"
+	AlpineImage = "fixme-test-using-this-image-is-disabled-on-windows"
 
 	hypervContainer     bool
 	hypervSupported     bool

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ func DataHome() (string, error) {`
`23`	`23`	`var (`
`24`	`24`	`// The following are here solely for darwin to compile / lint. They are not used, as the corresponding tests are running only on linux.`
`25`	`25`	`RegistryImageStable = "registry:2"`
`26`		`- RegistryImageNext = "ghcr.io/distribution/distribution:"`
`27`	`26`	`KuboImage = "ipfs/kubo:v0.16.0"`
`28`	`27`	`DockerAuthImage = "cesanta/docker_auth:1.7"`
`29`	`28`	`)`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ func DataHome() (string, error) {`
`27`	`27`
`28`	`28`	`var (`
`29`	`29`	`RegistryImageStable = testutil.RegistryImageStable`
`30`		`- RegistryImageNext = testutil.RegistryImageNext`
`31`	`30`	`KuboImage = testutil.KuboImage`
`32`	`31`	`DockerAuthImage = testutil.DockerAuthImage`
`33`	`32`	`)`
Original file line number	Diff line number	Diff line change
`@@ -763,8 +763,3 @@ func RegisterBuildCacheCleanup(t *testing.T) {`
`763`	`763`	`NewBase(t).Cmd("builder", "prune", "--all", "--force").Run()`
`764`	`764`	`})`
`765`	`765`	`}`
`766`		`-`
`767`		`-func mirrorOf(s string) string {`
`768`		`- // plain mirror, NOT stargz-converted images`
`769`		`- return fmt.Sprintf("ghcr.io/stargz-containers/%s-org", s)`
`770`		`-}`