test(e2e): build scenarios — the 'Built' family inlines its models

TestBuildDependsOn, Subset, DependentImage, SubDependencies,
LongOutputLine, DependentImageWithProfile, Escaped, Tags and Secrets
become scenarios: models inline (the long-line Dockerfile generated
with strings.Repeat instead of 34 copy-pasted lines), image names
project-scoped with Defer cleanup, and the secrets build asserts
ImageExists on top of the Dockerfile's own diff checks.

Kept legacy: TestLocalComposeBuild (DOCKER_BUILDKIT=0/1 matrix over a
shared fixture with fixed names and host port), the buildx-builder
family (SSH, platforms, privileged, entitlements, builder, TLS) which
provisions builders and dind daemons, and TestBuildImageDependencies
(classic/bake matrix). Their fixtures under build-test/ stay; the
single-purpose subdirectories are removed.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

pkg/e2e/build_test.go

@@ -202,40 +202,33 @@ func TestBuildSecrets(t *testing.T) {
 	if runtime.GOOS == "windows" {
 		t.Skip("skipping test on windows")
 	}
-	c := NewParallelCLI(t)
-
-	t.Run("build with secrets", func(t *testing.T) {
-		// ensure local test run does not reuse previously build image
-		c.RunDockerOrExitError(t, "rmi", "build-test-secret")
-
-		cmd := c.NewDockerComposeCmd(t, "--project-directory", "fixtures/build-test/secrets", "build")
-
-		res := icmd.RunCmd(cmd, func(cmd *icmd.Cmd) {
-			cmd.Env = append(cmd.Env, "SOME_SECRET=bar")
-		})
-
-		res.Assert(t, icmd.Success)
-	})
+	// the Dockerfile diffs each mounted secret against its expected value, so
+	// a successful build proves file, environment and .env secrets all reached
+	// the build.
+	s := NewScenario(t, "build secrets from a file, the environment and the .env must reach the build")
+	image := s.Project() + "-secret"
+	s.Env("SECRET_IMAGE="+image).
+		Defer(DockerCmd("image", "rm", "-f", image).MayFail()).
+		Step("build verifies each secret's content in-Dockerfile",
+			ComposeCmd("build").WithEnv("SOME_SECRET=bar"),
+			ImageExists(image))
 }
 
 func TestBuildTags(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Run("build with tags", func(t *testing.T) {
-		// ensure local test run does not reuse previously build image
-		c.RunDockerOrExitError(t, "rmi", "build-test-tags")
-
-		c.RunDockerComposeCmd(t, "--project-directory", "./fixtures/build-test/tags", "build", "--no-cache")
-
-		res := c.RunDockerCmd(t, "image", "inspect", "build-test-tags")
-		expectedOutput := `"RepoTags": [
-            "docker/build-test-tags:1.0.0",
-            "build-test-tags:latest",
-            "other-image-name:v1.0.0"
-        ],
-`
-		res.Assert(t, icmd.Expected{Out: expectedOutput})
-	})
+	s := NewScenario(t, "build must apply every declared tag alongside the service image name")
+	image := s.Project() + "-tags"
+	s.Env("TAG_IMAGE="+image).
+		Defer(
+			DockerCmd("image", "rm", "-f", image).MayFail(),
+			DockerCmd("image", "rm", "-f", "docker/"+image+":1.0.0").MayFail(),
+			DockerCmd("image", "rm", "-f", image+"-other:v1.0.0").MayFail()).
+		Step("build tags the image under every name",
+			ComposeCmd("build", "--no-cache")).
+		Step("the image carries the three tags",
+			DockerCmd("image", "inspect", image),
+			OutputContains("docker/"+image+":1.0.0"),
+			OutputContains(image+":latest"),
+			OutputContains(image+"-other:v1.0.0"))
 }
 
 func TestBuildImageDependencies(t *testing.T) {
@@ -537,87 +530,69 @@ func TestBuildEntitlements(t *testing.T) {
 }
 
 func TestBuildDependsOn(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-dependencies/compose-depends_on.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-dependencies/compose-depends_on.yaml", "--progress=plain", "up", "test2")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "test1 Built"))
+	s := NewScenario(t, "up must build a pull_policy: build dependency before starting its dependent")
+	s.Defer(DockerCmd("image", "rm", "-f", s.Project()+"-test1").MayFail()).
+		Step("up on the dependent reports the dependency's build",
+			ComposeCmd("--progress=plain", "up", "test2"),
+			OutputContains("test1 Built"))
 }
 
 func TestBuildSubset(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/subset/compose.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/subset/compose.yaml", "build", "main")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "main Built"))
+	s := NewScenario(t, "build scoped to a service must build that service")
+	s.Defer(DockerCmd("image", "rm", "-f", s.Project()+"-main").MayFail()).
+		Step("build main reports it built",
+			ComposeCmd("build", "main"),
+			OutputContains("main Built"))
 }
 
 func TestBuildDependentImage(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/dependencies/compose.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/dependencies/compose.yaml", "build", "firstbuild")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "firstbuild Built"))
-
-	res = c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/dependencies/compose.yaml", "build", "secondbuild")
-	out = res.Combined()
-	assert.Check(t, strings.Contains(out, "secondbuild Built"))
+	s := NewScenario(t, "each service using another service's image as build context must build on demand")
+	s.Defer(
+		DockerCmd("image", "rm", "-f", s.Project()+"-firstbuild").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-secondbuild").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-dep1").MayFail()).
+		Step("the first dependent builds",
+			ComposeCmd("build", "firstbuild"),
+			OutputContains("firstbuild Built")).
+		Step("the second dependent builds too",
+			ComposeCmd("build", "secondbuild"),
+			OutputContains("secondbuild Built"))
 }
 
 func TestBuildSubDependencies(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/sub-dependencies/compose.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/sub-dependencies/compose.yaml", "build", "main")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "main Built"))
-
-	res = c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/sub-dependencies/compose.yaml", "up", "--build", "main")
-	out = res.Combined()
-	assert.Check(t, strings.Contains(out, "main Built"))
+	s := NewScenario(t, "a chain of service build contexts must resolve transitively, for build and up --build alike")
+	s.Defer(
+		DockerCmd("image", "rm", "-f", s.Project()+"-main").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-dep1").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-dep2").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-subdep1").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-subdep2").MayFail()).
+		Step("build resolves the whole context chain",
+			ComposeCmd("build", "main"),
+			OutputContains("main Built")).
+		Step("up --build resolves it the same way",
+			ComposeCmd("up", "--build", "main"),
+			OutputContains("main Built"))
 }
 
 func TestBuildLongOutputLine(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/long-output-line/compose.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/long-output-line/compose.yaml", "build", "long-line")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "long-line Built"))
-
-	res = c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/long-output-line/compose.yaml", "up", "--build", "long-line")
-	out = res.Combined()
-	assert.Check(t, strings.Contains(out, "long-line Built"))
+	s := NewScenario(t, "a build flooding the progress writer with warnings must still complete and report")
+	s.
+		Defer(DockerCmd("image", "rm", "-f", s.Project()+"-long-line").MayFail()).
+		Step("build survives the warning flood",
+			ComposeCmd("build", "long-line"),
+			OutputContains("long-line Built")).
+		Step("up --build does too",
+			ComposeCmd("up", "--build", "long-line"),
+			OutputContains("long-line Built"))
 }
 
 func TestBuildDependentImageWithProfile(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	t.Cleanup(func() {
-		c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/profiles/compose.yaml", "down", "--rmi=local")
-	})
-
-	res := c.RunDockerComposeCmd(t, "-f", "fixtures/build-test/profiles/compose.yaml", "build", "secret-build-test")
-	out := res.Combined()
-	assert.Check(t, strings.Contains(out, "secret-build-test Built"))
+	s := NewScenario(t, "build targeting a profiled service must activate its profile and mount its build secret")
+	s.Defer(DockerCmd("image", "rm", "-f", s.Project()+"-secret-build-test").MayFail()).
+		Step("build reports the profiled service built",
+			ComposeCmd("build", "secret-build-test"),
+			OutputContains("secret-build-test Built"))
 }
 
 func TestBuildTLS(t *testing.T) {
@@ -662,16 +637,18 @@ func TestBuildTLS(t *testing.T) {
 }
 
 func TestBuildEscaped(t *testing.T) {
-	c := NewParallelCLI(t)
-
-	res := c.RunDockerComposeCmd(t, "--project-directory", "./fixtures/build-test/escaped", "build", "--no-cache", "foo")
-	res.Assert(t, icmd.Expected{Out: "foo is ${bar}"})
-
-	res = c.RunDockerComposeCmd(t, "--project-directory", "./fixtures/build-test/escaped", "build", "--no-cache", "echo")
-	res.Assert(t, icmd.Success)
-
-	res = c.RunDockerComposeCmd(t, "--project-directory", "./fixtures/build-test/escaped", "build", "--no-cache", "arg")
-	res.Assert(t, icmd.Success)
+	s := NewScenario(t, "a $$ escape in the model must reach the build literally, in args, heredocs and inline dockerfiles")
+	s.Defer(
+		DockerCmd("image", "rm", "-f", s.Project()+"-foo").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-echo").MayFail(),
+		DockerCmd("image", "rm", "-f", s.Project()+"-arg").MayFail()).
+		Step("the escaped build arg reaches the Dockerfile literally",
+			ComposeCmd("build", "--no-cache", "foo"),
+			OutputContains("foo is ${bar}")).
+		Step("a heredoc with command substitution builds",
+			ComposeCmd("build", "--no-cache", "echo")).
+		Step("an escaped variable in an inline dockerfile builds",
+			ComposeCmd("build", "--no-cache", "arg"))
 }
 
 // TestUpBuildUnchangedContext locks the invariant that rebuilding an

pkg/e2e/fixtures/build-test/escaped/Dockerfile

@@ -1,17 +0,0 @@
-#   Copyright 2020 Docker Compose CLI 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.
-
-FROM alpine
-ARG foo
-RUN echo foo is $foo

pkg/e2e/fixtures/build-test/profiles/Dockerfile

@@ -1,19 +0,0 @@
-#   Copyright 2020 Docker Compose CLI 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.
-
-
-FROM alpine
-RUN --mount=type=secret,id=test-secret ls -la /run/secrets/; cp /run/secrets/test-secret /tmp
-
-CMD ["cat", "/tmp/test-secret"]

pkg/e2e/fixtures/build-test/profiles/test-secret.txt

@@ -1 +0,0 @@
-SECRET

pkg/e2e/fixtures/build-test/secrets/.env

@@ -1 +0,0 @@
-ANOTHER_SECRET=zot

pkg/e2e/fixtures/build-test/secrets/Dockerfile

@@ -1,30 +0,0 @@
-# syntax=docker/dockerfile:1
-
-
-#   Copyright 2020 Docker Compose CLI 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.
-
-FROM alpine
-
-RUN echo "foo" > /tmp/expected
-RUN --mount=type=secret,id=mysecret cat /run/secrets/mysecret > /tmp/actual
-RUN diff /tmp/expected /tmp/actual
-
-RUN echo "bar" > /tmp/expected
-RUN --mount=type=secret,id=build_secret cat /run/secrets/build_secret > tmp/actual
-RUN diff --ignore-all-space /tmp/expected /tmp/actual
-
-RUN echo "zot" > /tmp/expected
-RUN --mount=type=secret,id=dotenvsecret cat /run/secrets/dotenvsecret > tmp/actual
-RUN diff --ignore-all-space /tmp/expected /tmp/actual

pkg/e2e/fixtures/build-test/tags/Dockerfile

@@ -1,17 +0,0 @@
-#   Copyright 2020 Docker Compose CLI 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.
-
-FROM nginx:alpine
-
-RUN echo "SUCCESS"

pkg/e2e/fixtures/build-test/tags/compose.yaml

@@ -1,9 +0,0 @@
-services:
-  nginx:
-    image: build-test-tags
-    build:
-      context: .
-      tags:
-        - docker.io/docker/build-test-tags:1.0.0
-        - other-image-name:v1.0.0
-

pkg/e2e/testdata/TestBuildDependentImage/compose.yaml

@@ -23,4 +23,4 @@ services:
     build:
       dockerfile_inline: |
         FROM alpine
-    entrypoint: ["echo", "Hello from dep1"]
+    entrypoint: ["echo", "Hello from dep1"]

pkg/e2e/testdata/TestBuildDependentImageWithProfile/Dockerfile

@@ -0,0 +1,5 @@
+FROM alpine
+RUN --mount=type=secret,id=test-secret ls -la /run/secrets/; cp /run/secrets/test-secret /tmp
+
+CMD ["cat", "/tmp/test-secret"]
+

pkg/e2e/testdata/TestBuildDependentImageWithProfile/compose.yaml

@@ -9,4 +9,4 @@ services:
       context: .
       dockerfile: Dockerfile
       secrets:
-        - test-secret
+        - test-secret

pkg/e2e/testdata/TestBuildDependentImageWithProfile/test-secret.txt

@@ -0,0 +1 @@
+SECRET

pkg/e2e/testdata/TestBuildDependsOn/compose.yaml

@@ -12,4 +12,4 @@ services:
       - test1
     command:
       - echo
-      - "test 2 success"
+      - "test 2 success"

pkg/e2e/testdata/TestBuildEscaped/Dockerfile

@@ -0,0 +1,4 @@
+FROM alpine
+ARG foo
+RUN echo foo is $foo
+

pkg/e2e/testdata/TestBuildLongOutputLine/Dockerfile

@@ -1,18 +1,4 @@
-#   Copyright 2020 Docker Compose CLI 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.
 FROM alpine
-# We generate warnings *on purpose* to bloat the JSON output of bake
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
@@ -46,4 +32,4 @@ ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
 ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
-ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT
+ARG AWS_SECRET_ACCESS_KEY=FAKE_TO_GENERATE_WARNING_OUTPUT

pkg/e2e/testdata/TestBuildSecrets/.env

@@ -0,0 +1 @@
+ANOTHER_SECRET=zot

pkg/e2e/testdata/TestBuildSecrets/Dockerfile

@@ -0,0 +1,14 @@
+FROM alpine
+
+RUN echo "foo" > /tmp/expected
+RUN --mount=type=secret,id=mysecret cat /run/secrets/mysecret > /tmp/actual
+RUN diff /tmp/expected /tmp/actual
+
+RUN echo "bar" > /tmp/expected
+RUN --mount=type=secret,id=build_secret cat /run/secrets/build_secret > tmp/actual
+RUN diff --ignore-all-space /tmp/expected /tmp/actual
+
+RUN echo "zot" > /tmp/expected
+RUN --mount=type=secret,id=dotenvsecret cat /run/secrets/dotenvsecret > tmp/actual
+RUN diff --ignore-all-space /tmp/expected /tmp/actual
+

pkg/e2e/testdata/TestBuildSecrets/compose.yaml

@@ -1,6 +1,6 @@
 services:
   ssh:
-    image: build-test-secret
+    image: ${SECRET_IMAGE}
     build:
       context: .
       secrets:

pkg/e2e/testdata/TestBuildSubDependencies/compose.yaml

@@ -33,4 +33,4 @@ services:
     build:
       dockerfile_inline: |
         FROM alpine
-    entrypoint: ["echo", "Hello from subdep2"]
+    entrypoint: ["echo", "Hello from subdep2"]

pkg/e2e/testdata/TestBuildSubset/compose.yaml

@@ -11,4 +11,4 @@ services:
     build:
       dockerfile_inline: |
         FROM alpine
-    entrypoint: ["echo", "Hello from dep1"]
+    entrypoint: ["echo", "Hello from dep1"]

pkg/e2e/testdata/TestBuildTags/Dockerfile

@@ -0,0 +1,3 @@
+FROM alpine
+RUN echo "SUCCESS"
+

pkg/e2e/testdata/TestBuildTags/compose.yaml

@@ -0,0 +1,8 @@
+services:
+  nginx:
+    image: ${TAG_IMAGE}
+    build:
+      context: .
+      tags:
+        - docker.io/docker/${TAG_IMAGE}:1.0.0
+        - ${TAG_IMAGE}-other:v1.0.0