Integration test for Dockerfile --exclude option

This affects the --exclude option in the COPY and ADD commands on Dockerfiles. References moby#4439 Signed-off-by: Leandro Santiago <[email protected]>
leandrosansilva · Feb 8, 2024 · 5c405e2 · 5c405e2
1 parent 697bc26
commit 5c405e2
Showing 1 changed file with 151 additions and 0 deletions.
diff --git a/frontend/dockerfile/dockerfile_test.go b/frontend/dockerfile/dockerfile_test.go
@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"io/fs"
 	"math"
 	"net/http"
 	"net/http/httptest"
@@ -178,6 +179,7 @@ var allTests = integration.TestFuncs(
 	testCopyUnicodePath,
 	testFrontendDeduplicateSources,
 	testDuplicateLayersProvenance,
+	testExcludedFilesOnCopy,
 )
 
 // Tests that depend on the `security.*` entitlements
@@ -230,6 +232,7 @@ func init() {
 
 func TestIntegration(t *testing.T) {
 	integration.Run(t, allTests, opts...)
+
 	integration.Run(t, securityTests, append(append(opts, securityOpts...),
 		integration.WithMatrix("security.insecure", map[string]interface{}{
 			"granted": securityInsecureGranted,
@@ -7281,3 +7284,151 @@ func fixedWriteCloser(wc io.WriteCloser) filesync.FileOutputFunc {
 		return wc, nil
 	}
 }
+
+// See #4439
+func testExcludedFilesOnCopy(t *testing.T, sb integration.Sandbox) {
+	integration.SkipOnPlatform(t, "windows")
+	ctx := sb.Context()
+
+	c, err := client.New(ctx, sb.Address())
+	require.NoError(t, err)
+	defer c.Close()
+
+	dockerfile := []byte(`
+# ignore all the image files
+FROM scratch as builder1
+COPY --exclude=*/*.png --exclude=*/*.jpeg . /1
+
+# ignore all document files
+FROM scratch as builder2
+COPY --exclude=*/*.pdf --exclude=*/*.txt . /2
+
+# ignore all mp3 files
+FROM scratch as builder3
+ADD --exclude=*.mp3 dir3/ /3/
+
+# Ignore everything, keeping only .mpeg files, using src as a wildcard.
+# it's a fake example, just to be sure that src as wildcards work as expected.
+FROM scratch as builder4
+COPY --exclude=*.mp3 --exclude=*.jpeg --exclude=*.png --exclude=*.pdf --exclude=*.txt dir* /4/
+
+# Ignore everything, keeping only txt files.
+# it's a fake example, just to be sure that src as wildcards work as expected.
+FROM scratch as builder5
+ADD --exclude=*.mp* --exclude=*.jpeg --exclude=*.png --exclude=*.pdf dir* /5
+
+# Exclude all files. No idea how it could be useful, but it should not be forbidden.
+FROM scratch as builder6
+ADD --exclude=* dir* /6
+
+FROM scratch
+COPY --from=builder1 / /builder1
+COPY --from=builder2 / /builder2
+COPY --from=builder3 / /builder3
+COPY --from=builder4 / /builder4
+COPY --from=builder5 / /builder5
+COPY --from=builder6 / /builder6
+`)
+
+	f := getFrontend(t, sb)
+
+	dir := integration.Tmpdir(
+		t,
+		fstest.CreateFile(dockerui.DefaultDockerfileName, dockerfile, 0600),
+		fstest.CreateDir("dir1", fs.ModePerm),
+		fstest.CreateDir("dir2", fs.ModePerm),
+		fstest.CreateDir("dir3", fs.ModePerm),
+		fstest.CreateFile("dir1/file-101.png", []byte(`2`), 0600),
+		fstest.CreateFile("dir1/file-102.txt", []byte(`3`), 0600),
+		fstest.CreateFile("dir1/file-103.jpeg", []byte(`4`), 0600),
+		fstest.CreateFile("dir2/file-201.pdf", []byte(`6`), 0600),
+		fstest.CreateFile("dir2/file-202.jpeg", []byte(`7`), 0600),
+		fstest.CreateFile("dir2/file-203.png", []byte(`8`), 0600),
+		fstest.CreateFile("dir3/file-301.mp3", []byte(`9`), 0600),
+		fstest.CreateFile("dir3/file-302.mpeg", []byte(`10`), 0600),
+	)
+
+	destDir := integration.Tmpdir(t)
+
+	_, err = f.Solve(ctx, c, client.SolveOpt{
+		LocalMounts: map[string]fsutil.FS{
+			dockerui.DefaultLocalNameDockerfile: dir,
+			dockerui.DefaultLocalNameContext:    dir,
+		},
+		Exports: []client.ExportEntry{
+			{
+				Type:      client.ExporterLocal,
+				OutputDir: destDir.Name,
+			},
+		},
+	}, nil)
+
+	require.NoError(t, err)
+
+	testCases := []struct {
+		filename        string
+		excluded        bool
+		expectedContent string
+	}{
+		// Files copied with COPY command
+		{filename: "builder1/1/dir1/file-101.png", excluded: true},
+		{filename: "builder1/1/dir1/file-102.txt", excluded: false, expectedContent: `3`},
+		{filename: "builder1/1/dir1/file-103.jpeg", excluded: true},
+		{filename: "builder1/1/dir2/file-201.pdf", excluded: false, expectedContent: `6`},
+		{filename: "builder1/1/dir2/file-202.jpeg", excluded: true},
+		{filename: "builder1/1/dir2/file-203.png", excluded: true},
+		{filename: "builder1/1/dir3/file-301.mp3", excluded: false, expectedContent: `9`},
+		{filename: "builder1/1/dir3/file-302.mpeg", excluded: false, expectedContent: `10`},
+
+		// files copied with COPY command
+		{filename: "builder2/2/dir1/file-101.png", excluded: false, expectedContent: `2`},
+		{filename: "builder2/2/dir1/file-102.txt", excluded: true},
+		{filename: "builder2/2/dir1/file-103.jpeg", excluded: false, expectedContent: `4`},
+		{filename: "builder2/2/dir2/file-201.pdf", excluded: true},
+		{filename: "builder2/2/dir2/file-202.jpeg", excluded: false, expectedContent: `7`},
+		{filename: "builder2/2/dir2/file-203.png", excluded: false, expectedContent: `8`},
+		{filename: "builder2/2/dir3/file-301.mp3", excluded: false, expectedContent: `9`},
+		{filename: "builder2/2/dir3/file-302.mpeg", excluded: false, expectedContent: `10`},
+
+		// Files copied with ADD command
+		{filename: "builder3/3/file-301.mp3", excluded: true},
+		{filename: "builder3/3/file-302.mpeg", excluded: false, expectedContent: `10`},
+
+		// Files copied with COPY wildcard
+		{filename: "builder4/4/file-101.png", excluded: true},
+		{filename: "builder4/4/file-102.txt", excluded: true},
+		{filename: "builder4/4/file-103.jpeg", excluded: true},
+		{filename: "builder4/4/file-201.pdf", excluded: true},
+		{filename: "builder4/4/file-202.jpeg", excluded: true},
+		{filename: "builder4/4/file-203.png", excluded: true},
+		{filename: "builder4/4/file-301.mp3", excluded: true},
+		{filename: "builder4/4/file-301.mp3", excluded: true},
+		{filename: "builder4/4/file-302.mpeg", excluded: false, expectedContent: `10`},
+
+		// Files copied with ADD wildcard
+		{filename: "builder5/5/file-101.png", excluded: true},
+		{filename: "builder5/5/file-102.txt", excluded: false, expectedContent: `3`},
+		{filename: "builder5/5/file-103.jpeg", excluded: true},
+		{filename: "builder5/5/file-201.pdf", excluded: true},
+		{filename: "builder5/5/file-202.jpeg", excluded: true},
+		{filename: "builder5/5/file-203.png", excluded: true},
+		{filename: "builder5/5/file-301.mp3", excluded: true},
+		{filename: "builder5/5/file-301.mp3", excluded: true},
+		{filename: "builder5/5/file-302.mpeg", excluded: true},
+	}
+
+	for _, tc := range testCases {
+		dt, err := os.ReadFile(path.Join(destDir.Name, tc.filename))
+		if tc.excluded {
+			require.NotNilf(t, err, "File %s should not exist: %v", tc.filename, err)
+			continue
+		}
+
+		require.NoErrorf(t, err, "File %s should exist", tc.filename)
+		require.Equalf(t, tc.expectedContent, string(dt), "File %s does not have matched content", tc.filename)
+	}
+
+	items, err := os.ReadDir(path.Join(destDir.Name, `builder6/6`))
+	require.NoError(t, err)
+	require.Empty(t, items)
+}