fix: simplify fully-qualified image names (testcontainers#2846)

* chore: do not prepend an invalid Docker registry Images used in the tests, and in the modules are using a wrong Docker image prefix: docker.io. It's better to ask for "nginx:latest" and let the engine deal with the image references. * fix: committed by mistake * chore: update more tests * fix: image cut * fix: removed too much * fix: removed too much Co-authored-by: Steven Hartland <[email protected]> * chore: pin bash image * chore: extract to constant * chore: reuse constant --------- Co-authored-by: Steven Hartland <[email protected]>
mdelapenya · Oct 23, 2024 · 7ca3d8e · 7ca3d8e
1 parent e945309
commit 7ca3d8e
Show file tree

Hide file tree

Showing 73 changed files with 155 additions and 153 deletions.
diff --git a/container_test.go b/container_test.go
@@ -167,7 +167,7 @@ func Test_BuildImageWithContexts(t *testing.T) {
 				}{
 					{
 						Name: "Dockerfile",
-						Contents: `FROM docker.io/alpine
+						Contents: `FROM alpine
 								CMD ["echo", "this is from the archive"]`,
 					},
 				}
@@ -216,7 +216,7 @@ func Test_BuildImageWithContexts(t *testing.T) {
 					},
 					{
 						Name: "Dockerfile",
-						Contents: `FROM docker.io/alpine
+						Contents: `FROM alpine
 								WORKDIR /app
 								COPY . .
 								CMD ["sh", "./say_hi.sh"]`,
@@ -365,7 +365,7 @@ func Test_GetLogsFromFailedContainer(t *testing.T) {
 	ctx := context.Background()
 	// directDockerHubReference {
 	req := testcontainers.ContainerRequest{
-		Image:      "docker.io/alpine",
+		Image:      "alpine",
 		Cmd:        []string{"echo", "-n", "I was not expecting this"},
 		WaitingFor: wait.ForLog("I was expecting this").WithStartupTimeout(5 * time.Second),
 	}
@@ -392,11 +392,11 @@ func Test_GetLogsFromFailedContainer(t *testing.T) {
 type dockerImageSubstitutor struct{}
 
 func (s dockerImageSubstitutor) Description() string {
-	return "DockerImageSubstitutor (prepends docker.io)"
+	return "DockerImageSubstitutor (prepends registry.hub.docker.com)"
 }
 
 func (s dockerImageSubstitutor) Substitute(image string) (string, error) {
-	return "docker.io/" + image, nil
+	return "registry.hub.docker.com/library/" + image, nil
 }
 
 // }
@@ -455,7 +455,7 @@ func TestImageSubstitutors(t *testing.T) {
 			name:          "Prepend namespace",
 			image:         "alpine",
 			substitutors:  []testcontainers.ImageSubstitutor{dockerImageSubstitutor{}},
-			expectedImage: "docker.io/alpine",
+			expectedImage: "registry.hub.docker.com/library/alpine",
 		},
 		{
 			name:          "Substitution with error",
@@ -554,5 +554,5 @@ func ExampleGenericContainer_withSubstitutors() {
 
 	fmt.Println(dockerContainer.Image)
 
-	// Output: docker.io/alpine:latest
+	// Output: registry.hub.docker.com/library/alpine:latest
 }
diff --git a/docker_files_test.go b/docker_files_test.go
@@ -13,6 +13,8 @@ import (
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
+const testBashImage string = "bash:5.2.26"
+
 func TestCopyFileToContainer(t *testing.T) {
 	ctx, cnl := context.WithTimeout(context.Background(), 30*time.Second)
 	defer cnl()
@@ -30,7 +32,7 @@ func TestCopyFileToContainer(t *testing.T) {
 
 	ctr, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{
-			Image: "docker.io/bash",
+			Image: testBashImage,
 			Files: []testcontainers.ContainerFile{
 				{
 					Reader:            r,
@@ -66,7 +68,7 @@ func TestCopyFileToRunningContainer(t *testing.T) {
 
 	ctr, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{
-			Image: "docker.io/bash:5.2.26",
+			Image: testBashImage,
 			Files: []testcontainers.ContainerFile{
 				{
 					HostFilePath:      waitForPath,
@@ -104,7 +106,7 @@ func TestCopyDirectoryToContainer(t *testing.T) {
 
 	ctr, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{
-			Image: "docker.io/bash",
+			Image: testBashImage,
 			Files: []testcontainers.ContainerFile{
 				{
 					HostFilePath: dataDirectory,
@@ -141,7 +143,7 @@ func TestCopyDirectoryToRunningContainerAsFile(t *testing.T) {
 
 	ctr, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{
-			Image: "docker.io/bash",
+			Image: testBashImage,
 			Files: []testcontainers.ContainerFile{
 				{
 					HostFilePath:      waitForPath,
@@ -183,7 +185,7 @@ func TestCopyDirectoryToRunningContainerAsDir(t *testing.T) {
 
 	ctr, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: testcontainers.ContainerRequest{
-			Image: "docker.io/bash",
+			Image: testBashImage,
 			Files: []testcontainers.ContainerFile{
 				{
 					HostFilePath:      waitForPath,

diff --git a/docker_test.go b/docker_test.go
@@ -29,10 +29,10 @@ import (
 )
 
 const (
-	mysqlImage        = "docker.io/mysql:8.0.36"
-	nginxDelayedImage = "docker.io/menedev/delayed-nginx:1.15.2"
-	nginxImage        = "docker.io/nginx"
-	nginxAlpineImage  = "docker.io/nginx:alpine"
+	mysqlImage        = "mysql:8.0.36"
+	nginxDelayedImage = "menedev/delayed-nginx:1.15.2"
+	nginxImage        = "nginx"
+	nginxAlpineImage  = "nginx:alpine"
 	nginxDefaultPort  = "80/tcp"
 	nginxHighPort     = "8080/tcp"
 	daemonMaxVersion  = "1.41"
@@ -804,8 +804,8 @@ func Test_BuildContainerFromDockerfileWithBuildLog(t *testing.T) {
 
 	temp := strings.Split(string(out), "\n")
 
-	if !regexp.MustCompile(`^Step\s*1/\d+\s*:\s*FROM docker.io/alpine$`).MatchString(temp[0]) {
-		t.Errorf("Expected stdout first line to be %s. Got '%s'.", "Step 1/* : FROM docker.io/alpine", temp[0])
+	if !regexp.MustCompile(`^Step\s*1/\d+\s*:\s*FROM alpine$`).MatchString(temp[0]) {
+		t.Errorf("Expected stdout first line to be %s. Got '%s'.", "Step 1/* : FROM alpine", temp[0])
 	}
 }
 
@@ -878,7 +878,7 @@ func TestCMD(t *testing.T) {
 	ctx := context.Background()
 
 	req := ContainerRequest{
-		Image: "docker.io/alpine",
+		Image: "alpine",
 		WaitingFor: wait.ForAll(
 			wait.ForLog("command override!"),
 		),
@@ -904,7 +904,7 @@ func TestEntrypoint(t *testing.T) {
 	ctx := context.Background()
 
 	req := ContainerRequest{
-		Image: "docker.io/alpine",
+		Image: "alpine",
 		WaitingFor: wait.ForAll(
 			wait.ForLog("entrypoint override!"),
 		),
@@ -930,7 +930,7 @@ func TestWorkingDir(t *testing.T) {
 	ctx := context.Background()
 
 	req := ContainerRequest{
-		Image: "docker.io/alpine",
+		Image: "alpine",
 		WaitingFor: wait.ForAll(
 			wait.ForLog("/var/tmp/test"),
 		),
@@ -950,7 +950,7 @@ func TestWorkingDir(t *testing.T) {
 func ExampleDockerProvider_CreateContainer() {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:        "docker.io/nginx:alpine",
+		Image:        "nginx:alpine",
 		ExposedPorts: []string{"80/tcp"},
 		WaitingFor:   wait.ForHTTP("/").WithStartupTimeout(10 * time.Second),
 	}
@@ -983,7 +983,7 @@ func ExampleDockerProvider_CreateContainer() {
 func ExampleContainer_Host() {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:        "docker.io/nginx:alpine",
+		Image:        "nginx:alpine",
 		ExposedPorts: []string{"80/tcp"},
 		WaitingFor:   wait.ForHTTP("/").WithStartupTimeout(10 * time.Second),
 	}
@@ -1025,7 +1025,7 @@ func ExampleContainer_Host() {
 func ExampleContainer_Start() {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:        "docker.io/nginx:alpine",
+		Image:        "nginx:alpine",
 		ExposedPorts: []string{"80/tcp"},
 		WaitingFor:   wait.ForHTTP("/").WithStartupTimeout(10 * time.Second),
 	}
@@ -1062,7 +1062,7 @@ func ExampleContainer_Start() {
 func ExampleContainer_Stop() {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:        "docker.io/nginx:alpine",
+		Image:        "nginx:alpine",
 		ExposedPorts: []string{"80/tcp"},
 		WaitingFor:   wait.ForHTTP("/").WithStartupTimeout(10 * time.Second),
 	}
@@ -1096,7 +1096,7 @@ func ExampleContainer_Stop() {
 func ExampleContainer_MappedPort() {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:        "docker.io/nginx:alpine",
+		Image:        "nginx:alpine",
 		ExposedPorts: []string{"80/tcp"},
 		WaitingFor:   wait.ForHTTP("/").WithStartupTimeout(10 * time.Second),
 	}
@@ -1147,7 +1147,7 @@ func TestContainerCreationWithVolumeAndFileWritingToIt(t *testing.T) {
 	bashC, err := GenericContainer(ctx, GenericContainerRequest{
 		ProviderType: providerType,
 		ContainerRequest: ContainerRequest{
-			Image: "docker.io/bash",
+			Image: "bash:5.2.26",
 			Files: []ContainerFile{
 				{
 					HostFilePath:      absPath,
@@ -1167,7 +1167,7 @@ func TestContainerCreationWithVolumeAndFileWritingToIt(t *testing.T) {
 func TestContainerWithTmpFs(t *testing.T) {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image: "docker.io/busybox",
+		Image: "busybox",
 		Cmd:   []string{"sleep", "10"},
 		Tmpfs: map[string]string{"/testtmpfs": "rw"},
 	}
@@ -1242,7 +1242,7 @@ func TestContainerNonExistentImage(t *testing.T) {
 		c, err := GenericContainer(ctx, GenericContainerRequest{
 			ProviderType: providerType,
 			ContainerRequest: ContainerRequest{
-				Image:      "docker.io/postgres:12",
+				Image:      "postgres:12",
 				WaitingFor: wait.ForLog("log"),
 			},
 			Started: true,
@@ -1266,7 +1266,7 @@ func TestContainerCustomPlatformImage(t *testing.T) {
 		c, err := GenericContainer(ctx, GenericContainerRequest{
 			ProviderType: providerType,
 			ContainerRequest: ContainerRequest{
-				Image:         "docker.io/redis:latest",
+				Image:         "redis:latest",
 				ImagePlatform: nonExistentPlatform,
 			},
 			Started: false,
@@ -1282,7 +1282,7 @@ func TestContainerCustomPlatformImage(t *testing.T) {
 		c, err := GenericContainer(ctx, GenericContainerRequest{
 			ProviderType: providerType,
 			ContainerRequest: ContainerRequest{
-				Image:         "docker.io/mysql:8.0.36",
+				Image:         "mysql:8.0.36",
 				ImagePlatform: "linux/amd64",
 			},
 			Started: false,
@@ -1817,7 +1817,7 @@ func TestContainerRunningCheckingStatusCode(t *testing.T) {
 func TestContainerWithUserID(t *testing.T) {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:      "docker.io/alpine:latest",
+		Image:      "alpine:latest",
 		User:       "60125",
 		Cmd:        []string{"sh", "-c", "id -u"},
 		WaitingFor: wait.ForExit(),
@@ -1846,7 +1846,7 @@ func TestContainerWithUserID(t *testing.T) {
 func TestContainerWithNoUserID(t *testing.T) {
 	ctx := context.Background()
 	req := ContainerRequest{
-		Image:      "docker.io/alpine:latest",
+		Image:      "alpine:latest",
 		Cmd:        []string{"sh", "-c", "id -u"},
 		WaitingFor: wait.ForExit(),
 	}

diff --git a/docs/features/image_name_substitution.md b/docs/features/image_name_substitution.md
@@ -45,7 +45,7 @@ _Testcontainers for Go_ will automatically apply the prefix to every image that
 _Testcontainers for Go_ will not apply the prefix to:
 
 * non-Hub image names (e.g. where another registry is set)
-* Docker Hub image names where the hub registry is explicitly part of the name (i.e. anything with a `docker.io` or `registry.hub.docker.com` host part)
+* Docker Hub image names where the hub registry is explicitly part of the name (i.e. anything with a `registry.hub.docker.com` host part)
 
 ## Developing a custom function for transforming image names on the fly
 
@@ -68,7 +68,7 @@ You can implement a custom image name substitutor by:
 * implementing the `ImageNameSubstitutor` interface, exposed by the `testcontainers` package.
 * configuring _Testcontainers for Go_ to use your custom implementation, defined at the `ContainerRequest` level.
 
-The following is an example image substitutor implementation prepending the `docker.io/` prefix, used in the tests:
+The following is an example image substitutor implementation prepending the `registry.hub.docker.com/library/` prefix, used in the tests:
 
 <!--codeinclude-->
 [Image Substitutor Interface](../../options.go) inside_block:imageSubstitutor

diff --git a/docs/features/wait/exit.md b/docs/features/wait/exit.md
@@ -9,7 +9,7 @@ The exit wait strategy will check that the container is not in the running state
 
 ```golang
 req := ContainerRequest{
-	Image:      "docker.io/alpine:latest",
+	Image:      "alpine:latest",
 	WaitingFor: wait.ForExit(),
 }
 ```
diff --git a/docs/features/wait/health.md b/docs/features/wait/health.md
@@ -7,7 +7,7 @@ The health wait strategy will check that the container is in the healthy state a
 
 ```golang
 req := ContainerRequest{
-	Image:      "docker.io/alpine:latest",
+	Image:      "alpine:latest",
 	WaitingFor: wait.ForHealthCheck(),
 }
 ```
diff --git a/docs/features/wait/host_port.md b/docs/features/wait/host_port.md
@@ -14,7 +14,7 @@ Variations on the HostPort wait strategy are supported, including:
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/nginx:alpine",
+    Image:        "nginx:alpine",
     ExposedPorts: []string{"80/tcp"},
     WaitingFor:   wait.ForListeningPort("80/tcp"),
 }
@@ -26,7 +26,7 @@ The wait strategy will use the lowest exposed port from the container configurat
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/nginx:alpine",
+    Image:        "nginx:alpine",
     WaitingFor:   wait.ForExposedPort(),
 }
 ```
@@ -35,7 +35,7 @@ Said that, it could be the case that the container request included ports to be
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/nginx:alpine",
+    Image:        "nginx:alpine",
     ExposedPorts: []string{"80/tcp", "9080/tcp"},
     WaitingFor:   wait.ForExposedPort(),
 }
@@ -55,7 +55,7 @@ In this case, the `wait.ForExposedPort.SkipInternalCheck` can be used to skip th
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/nginx:alpine",
+    Image:        "nginx:alpine",
     ExposedPorts: []string{"80/tcp", "9080/tcp"},
     WaitingFor:   wait.ForExposedPort().SkipInternalCheck(),
 }

diff --git a/docs/features/wait/log.md b/docs/features/wait/log.md
@@ -10,7 +10,7 @@ The Log wait strategy will check if a string occurs in the container logs for a
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/mysql:8.0.36",
+    Image:        "mysql:8.0.36",
     ExposedPorts: []string{"3306/tcp", "33060/tcp"},
     Env: map[string]string{
         "MYSQL_ROOT_PASSWORD": "password",
@@ -24,7 +24,7 @@ Using a regular expression:
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/mysql:8.0.36",
+    Image:        "mysql:8.0.36",
     ExposedPorts: []string{"3306/tcp", "33060/tcp"},
     Env: map[string]string{
         "MYSQL_ROOT_PASSWORD": "password",

diff --git a/docs/features/wait/multi.md b/docs/features/wait/multi.md
@@ -9,7 +9,7 @@ Available Options:
 
 ```golang
 req := ContainerRequest{
-    Image:        "docker.io/mysql:8.0.36",
+    Image:        "mysql:8.0.36",
     ExposedPorts: []string{"3306/tcp", "33060/tcp"},
     Env: map[string]string{
         "MYSQL_ROOT_PASSWORD": "password",

diff --git a/docs/modules/artemis.md b/docs/modules/artemis.md
@@ -50,7 +50,7 @@ When starting the Artemis container, you can pass options in a variadic way to c
 #### Image
 
 If you need to set a different Artemis Docker image, you can set a valid Docker image as the second argument in the `Run` function.
-E.g. `Run(context.Background(), "docker.io/apache/activemq-artemis:2.30.0")`.
+E.g. `Run(context.Background(), "apache/activemq-artemis:2.30.0")`.
 
 {% include "../features/common_functional_options.md" %}
 

diff --git a/docs/modules/consul.md b/docs/modules/consul.md
@@ -46,7 +46,7 @@ When starting the Consul container, you can pass options in a variadic way to co
 #### Image
 
 If you need to set a different Consul Docker image, you can set a valid Docker image as the second argument in the `Run` function.
-E.g. `Run(context.Background(), "docker.io/hashicorp/consul:1.15")`.
+E.g. `Run(context.Background(), "hashicorp/consul:1.15")`.
 
 {% include "../features/common_functional_options.md" %}
 

diff --git a/docs/modules/couchbase.md b/docs/modules/couchbase.md
@@ -73,7 +73,7 @@ When starting the Couchbase container, you can pass options in a variadic way to
 #### Image
 
 If you need to set a different Couchbase Docker image, you can set a valid Docker image as the second argument in the `Run` function.
-E.g. `Run(context.Background(), "docker.io/couchbase:6.5.1")`.
+E.g. `Run(context.Background(), "couchbase:6.5.1")`.
 
 You can find the Docker images that are currently tested in this module, for the Enterprise and Community editions, in the following list: