tests: frontend/dockerfile: add dockerfile lint tests for WCOW

A number of integration tests were initially skipped on Windows, waiting for their platform-specific translations. See #4485. This commit enables all the dockerfile linter tests that had been skipped before. Some of the tests did not need any platform specific change since the lint warning were being generated before actual image pull. WIP: there is one test `testInvalidDefaultArgInFrom` that needs revisiting. Signed-off-by: Anthony Nandaa <[email protected]>
moby · Aug 8, 2024 · e4830ca · e4830ca
1 parent 78f24da
commit e4830ca
Show file tree

Hide file tree

Showing 3 changed files with 145 additions and 42 deletions.
diff --git a/frontend/dockerfile/dockerfile_lint_test.go b/frontend/dockerfile/dockerfile_lint_test.go
@@ -780,12 +780,28 @@ COPY Dockerfile .
 		BuildErrLocation:  2,
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 ARG MY_OS=linux
 ARG MY_ARCH=amd64
 FROM --platform=linux/${MYARCH} busybox
 COPY Dockerfile .
-	`)
+	`,
+		`
+ARG MY_OS=windows
+ARG MY_ARCH=amd64
+FROM --platform=windows/${MYARCH} nanoserver
+COPY Dockerfile .
+	`,
+	))
+
+	osStr := integration.UnixOrWindows("linux", "windows")
+	streamBuildErr := fmt.Sprintf(
+		"failed to solve: failed to parse platform %s/${MYARCH}: \"\" is an invalid component of \"%s/\": platform specifier component must match \"^[A-Za-z0-9_-]+$\": invalid argument (did you mean MY_ARCH?)",
+		osStr, osStr)
+	unmarshalBuildErr := fmt.Sprintf(
+		"failed to parse platform %s/${MYARCH}: \"\" is an invalid component of \"%s/\": platform specifier component must match \"^[A-Za-z0-9_-]+$\": invalid argument (did you mean MY_ARCH?)",
+		osStr, osStr)
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -798,16 +814,23 @@ COPY Dockerfile .
 				Line:        4,
 			},
 		},
-		StreamBuildErr:    "failed to solve: failed to parse platform linux/${MYARCH}: \"\" is an invalid component of \"linux/\": platform specifier component must match \"^[A-Za-z0-9_-]+$\": invalid argument (did you mean MY_ARCH?)",
-		UnmarshalBuildErr: "failed to parse platform linux/${MYARCH}: \"\" is an invalid component of \"linux/\": platform specifier component must match \"^[A-Za-z0-9_-]+$\": invalid argument (did you mean MY_ARCH?)",
+		StreamBuildErr:    streamBuildErr,
+		UnmarshalBuildErr: unmarshalBuildErr,
 		BuildErrLocation:  4,
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 ARG tag=latest
 FROM busybox:${tag}${version} AS b
 COPY Dockerfile .
-`)
+`,
+		`
+ARG tag=latest
+FROM nanoserver:${tag}${version} AS b
+COPY Dockerfile .
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -860,27 +883,50 @@ COPY Dockerfile${foo} .
 `)
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 FROM alpine AS base
 ARG foo=Dockerfile
 
 FROM base
 COPY $foo .
-`)
+`,
+		`
+FROM nanoserver AS base
+ARG foo=Dockerfile
+
+FROM base
+COPY $foo .
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 FROM alpine
 RUN echo $PATH
-`)
+`,
+		`
+FROM nanoserver
+RUN echo $PATH
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 FROM alpine
 COPY $foo .
 ARG foo=bar
 RUN echo $foo
-`)
+`,
+		`
+FROM nanoserver
+COPY $foo .
+ARG foo=bar
+RUN echo $foo
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -895,13 +941,22 @@ RUN echo $foo
 		},
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 FROM alpine
 ARG DIR_BINARIES=binaries/
 ARG DIR_ASSETS=assets/
 ARG DIR_CONFIG=config/
 COPY $DIR_ASSET .
-	`)
+	`,
+		`
+FROM nanoserver
+ARG DIR_BINARIES=binaries/
+ARG DIR_ASSETS=assets/
+ARG DIR_CONFIG=config/
+COPY $DIR_ASSET .
+	`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -916,10 +971,16 @@ COPY $DIR_ASSET .
 		},
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 FROM alpine
 ENV PATH=$PAHT:/tmp/bin
-		`)
+		`,
+		`
+FROM nanoserver
+ENV PATH=$PAHT:/tmp/bin
+		`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -1108,10 +1169,16 @@ FROM --platform=${TARGETPLATFORM} scratch
 }
 
 func testInvalidDefaultArgInFrom(t *testing.T, sb integration.Sandbox) {
-	dockerfile := []byte(`
+	dockerfile := []byte(integration.UnixOrWindows(
+		`
 ARG VERSION
 FROM busybox:$VERSION
-`)
+`,
+		`
+ARG VERSION
+FROM nanoserver:$VERSION
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
@@ -1122,9 +1189,12 @@ FROM busybox:$VERSION
 				RuleName:    "InvalidDefaultArgInFrom",
 				Description: "Default value for global ARG results in an empty or invalid base image name",
 				URL:         "https://docs.docker.com/go/dockerfile/rule/invalid-default-arg-in-from/",
-				Detail:      "Default value for ARG busybox:$VERSION results in empty or invalid base image name",
-				Line:        3,
-				Level:       1,
+				Detail: fmt.Sprintf(
+					"Default value for ARG %s:$VERSION results in empty or invalid base image name",
+					integration.UnixOrWindows("busybox", "nanoserver"),
+				),
+				Line:  3,
+				Level: 1,
 			},
 		},
 	})
@@ -1136,7 +1206,7 @@ FROM $IMAGE
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
-			"build-arg:IMAGE": "busybox:latest",
+			"build-arg:IMAGE": integration.UnixOrWindows("busybox:latest", "nanoserver:latest"),
 		},
 		Warnings: []expectedLintWarning{
 			{
@@ -1150,57 +1220,84 @@ FROM $IMAGE
 		},
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 ARG SFX="box:"
 FROM busy${SFX}
-`)
+`,
+		`
+ARG SFX="server:"
+FROM nano${SFX}
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
-			"build-arg:SFX": "box:latest",
+			"build-arg:SFX": integration.UnixOrWindows("box:latest", "server:latest"),
 		},
 		Warnings: []expectedLintWarning{
 			{
 				RuleName:    "InvalidDefaultArgInFrom",
 				Description: "Default value for global ARG results in an empty or invalid base image name",
 				URL:         "https://docs.docker.com/go/dockerfile/rule/invalid-default-arg-in-from/",
-				Detail:      "Default value for ARG busy${SFX} results in empty or invalid base image name",
-				Line:        3,
-				Level:       1,
+				Detail: fmt.Sprintf(
+					"Default value for ARG %s${SFX} results in empty or invalid base image name",
+					integration.UnixOrWindows("busy", "nano"),
+				),
+				Line:  3,
+				Level: 1,
 			},
 		},
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 ARG VERSION="latest"
 FROM busybox:${VERSION}
-`)
+`,
+		`
+ARG VERSION="latest"
+FROM nanoserver:${VERSION}
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
 			"build-arg:VERSION": "latest",
 		},
 	})
 
-	dockerfile = []byte(`
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
 ARG BUSYBOX_VARIANT=""
 FROM busybox:stable${BUSYBOX_VARIANT}
-`)
+`,
+		`
+ARG BUSYBOX_VARIANT=""
+FROM nanoserver:plus${BUSYBOX_VARIANT}
+`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
-			"build-arg:BUSYBOX_VARIANT": "-musl",
+			"build-arg:BUSYBOX_VARIANT": integration.UnixOrWindows("-musl", "-busybox"),
 		},
 	})
 
-	dockerfile = []byte(`
-ARG BUSYBOX_VARIANT
-FROM busybox:stable${BUSYBOX_VARIANT}
-`)
+	dockerfile = []byte(integration.UnixOrWindows(
+		`
+	ARG BUSYBOX_VARIANT
+	FROM busybox:stable${BUSYBOX_VARIANT}
+	`,
+		`
+	ARG BUSYBOX_VARIANT
+	FROM nanoserver:plus${BUSYBOX_VARIANT}
+	`,
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
-			"build-arg:BUSYBOX_VARIANT": "-musl",
+			"build-arg:BUSYBOX_VARIANT": integration.UnixOrWindows("-musl", "-busybox"),
 		},
 	})
 }
@@ -1334,10 +1431,14 @@ func checkProgressStream(t *testing.T, sb integration.Sandbox, lintTest *lintTes
 
 	f := getFrontend(t, sb)
 
+	platformStr := integration.UnixOrWindows(
+		"linux/amd64,linux/arm64",
+		"windows/amd64",
+	)
 	attrs := lintTest.FrontendAttrs
 	if attrs == nil {
 		attrs = map[string]string{
-			"platform": "linux/amd64,linux/arm64",
+			"platform": platformStr,
 		}
 	}
 
@@ -1386,8 +1487,6 @@ func checkLinterWarnings(t *testing.T, sb integration.Sandbox, lintTest *lintTes
 		return lintTest.Warnings[i].Line < lintTest.Warnings[j].Line
 	})
 
-	integration.SkipOnPlatform(t, "windows")
-
 	if lintTest.TmpDir == nil {
 		testfiles := []fstest.Applier{
 			fstest.CreateFile("Dockerfile", lintTest.Dockerfile, 0600),

diff --git a/frontend/dockerfile/dockerfile_test.go b/frontend/dockerfile/dockerfile_test.go
@@ -234,7 +234,7 @@ func init() {
 
 	images := integration.UnixOrWindows(
 		[]string{"busybox:latest", "alpine:latest"},
-		[]string{"nanoserver:latest"})
+		[]string{"nanoserver:latest", "nanoserver:plus", "nanoserver:plus-busybox"})
 	opts = []integration.TestOpt{
 		integration.WithMirroredImages(integration.OfficialImages(images...)),
 		integration.WithMatrix("frontend", frontends),

diff --git a/util/testutil/integration/util_windows.go b/util/testutil/integration/util_windows.go
@@ -16,6 +16,10 @@ var windowsImagesMirrorMap = map[string]string{
 	"nanoserver:latest": "mcr.microsoft.com/windows/nanoserver:ltsc2022",
 	"servercore:latest": "mcr.microsoft.com/windows/servercore:ltsc2022",
 	"busybox:latest":    "registry.k8s.io/e2e-test-images/busybox@sha256:6d854ffad9666d2041b879a1c128c9922d77faced7745ad676639b07111ab650",
+	// nanoserver with extra binaries, like fc.exe
+	// TODO: get a properly approved regitry, placeholder for now
+	"nanoserver:plus":         "docker.io/wintools/nanoserver:ltsc2022",
+	"nanoserver:plus-busybox": "docker.io/wintools/nanoserver:ltsc2022",
 }
 
 // abstracted function to handle pipe dialing on windows.