From aa096eb1cd4b9c76d988d0e8e43211e57fb1c3ce Mon Sep 17 00:00:00 2001
From: Anthony Nandaa <profnandaa@gmail.com>
Date: Wed, 7 Aug 2024 02:57:18 -0700
Subject: [PATCH] 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.

Signed-off-by: Anthony Nandaa <profnandaa@gmail.com>
---
 frontend/dockerfile/dockerfile_lint_test.go | 170 +++++++++++++-------
 frontend/dockerfile/dockerfile_test.go      |   2 +-
 util/testutil/integration/util_windows.go   |   3 +-
 3 files changed, 118 insertions(+), 57 deletions(-)

diff --git a/frontend/dockerfile/dockerfile_lint_test.go b/frontend/dockerfile/dockerfile_lint_test.go
index 308b3ccec135..10f69ea878ed 100644
--- a/frontend/dockerfile/dockerfile_lint_test.go
+++ b/frontend/dockerfile/dockerfile_lint_test.go
@@ -581,12 +581,16 @@ COPY Dockerfile /bar
 `)
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
-FROM alpine
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s
 RUN <<'EOT'
-env
+%s
 EOT
-`)
+`,
+		integration.UnixOrWindows("alpine", "nanoserver"),
+		integration.UnixOrWindows("env", "set"),
+	))
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 }
 
@@ -822,12 +826,24 @@ COPY Dockerfile .
 		BuildErrLocation:  2,
 	})
 
-	dockerfile = []byte(`
-ARG MY_OS=linux
+	osName := integration.UnixOrWindows("linux", "windows")
+	baseImg := integration.UnixOrWindows("busybox", "nanoserver")
+	dockerfile = []byte(fmt.Sprintf(
+		`
+ARG MY_OS=%s
 ARG MY_ARCH=amd64
-FROM --platform=linux/${MYARCH} busybox
+FROM --platform=%s/${MYARCH} %s
 COPY Dockerfile .
-	`)
+	`,
+		osName, osName, baseImg))
+
+	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{
@@ -840,16 +856,18 @@ 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(fmt.Sprintf(
+		`
 ARG tag=latest
-FROM busybox:${tag}${version} AS b
+FROM %s:${tag}${version} AS b
 COPY Dockerfile .
-`)
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -902,27 +920,34 @@ COPY Dockerfile${foo} .
 `)
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
-FROM alpine AS base
+	baseImg := integration.UnixOrWindows("alpine", "nanoserver")
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s AS base
 ARG foo=Dockerfile
 
 FROM base
 COPY $foo .
-`)
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
-FROM alpine
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s
 RUN echo $PATH
-`)
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{Dockerfile: dockerfile})
 
-	dockerfile = []byte(`
-FROM alpine
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s
 COPY $foo .
 ARG foo=bar
 RUN echo $foo
-`)
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -937,13 +962,15 @@ RUN echo $foo
 		},
 	})
 
-	dockerfile = []byte(`
-FROM alpine
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s
 ARG DIR_BINARIES=binaries/
 ARG DIR_ASSETS=assets/
 ARG DIR_CONFIG=config/
 COPY $DIR_ASSET .
-	`)
+	`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -958,10 +985,12 @@ COPY $DIR_ASSET .
 		},
 	})
 
-	dockerfile = []byte(`
-FROM alpine
+	dockerfile = []byte(fmt.Sprintf(
+		`
+FROM %s
 ENV PATH=$PAHT:/tmp/bin
-		`)
+		`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		Warnings: []expectedLintWarning{
@@ -1150,10 +1179,13 @@ FROM --platform=${TARGETPLATFORM} scratch
 }
 
 func testInvalidDefaultArgInFrom(t *testing.T, sb integration.Sandbox) {
-	dockerfile := []byte(`
+	baseImg := integration.UnixOrWindows("busybox", "nanoserver")
+	dockerfile := []byte(fmt.Sprintf(
+		`
 ARG VERSION
-FROM busybox:$VERSION
-`)
+FROM %s:$VERSION
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
@@ -1164,9 +1196,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,
 			},
 		},
 	})
@@ -1178,7 +1213,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{
 			{
@@ -1192,31 +1227,42 @@ 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(fmt.Sprintf(
+		`
 ARG VERSION="latest"
-FROM busybox:${VERSION}
-`)
+FROM %s:${VERSION}
+`,
+		baseImg))
 	checkLinterWarnings(t, sb, &lintTestParams{
 		Dockerfile: dockerfile,
 		FrontendAttrs: map[string]string{
@@ -1224,25 +1270,37 @@ FROM busybox:${VERSION}
 		},
 	})
 
-	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"),
 		},
 	})
 }
@@ -1376,10 +1434,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,
 		}
 	}
 
@@ -1428,8 +1490,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
index 6f8915e01bc1..8d4f25401752 100644
--- a/frontend/dockerfile/dockerfile_test.go
+++ b/frontend/dockerfile/dockerfile_test.go
@@ -236,7 +236,7 @@ func init() {
 
 	images := integration.UnixOrWindows(
 		[]string{"busybox:latest", "alpine:latest"},
-		[]string{"nanoserver:latest", "nanoserver:plus"})
+		[]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
index d0b70dc2227e..65de17da6694 100644
--- a/util/testutil/integration/util_windows.go
+++ b/util/testutil/integration/util_windows.go
@@ -19,7 +19,8 @@ var windowsImagesMirrorMap = map[string]string{
 	// nanoserver with extra binaries, like fc.exe
 	// TODO(profnandaa): get an approved/compliant repo, placeholder for now
 	// see dockerfile here - https://github.com/microsoft/windows-container-tools/pull/178
-	"nanoserver:plus": "docker.io/wintools/nanoserver:ltsc2022",
+	"nanoserver:plus":         "docker.io/wintools/nanoserver:ltsc2022",
+	"nanoserver:plus-busybox": "docker.io/wintools/nanoserver:ltsc2022",
 }
 
 // abstracted function to handle pipe dialing on windows.