dockerfile: promote --parents flag from labs

Signed-off-by: Jonathan A. Sternberg <[email protected]>

Author: jsternberg

docker-bake.hcl

@@ -233,7 +233,7 @@ target "lint" {
   matrix = {
     buildtags = [
       { name = "default", tags = "", target = "golangci-lint" },
-      { name = "labs", tags = "dfrunsecurity dfparents", target = "golangci-lint" },
+      { name = "labs", tags = "dfrunsecurity dfrundevice", target = "golangci-lint" },
       { name = "nydus", tags = "nydus", target = "golangci-lint" },
       { name = "yaml", tags = "", target = "yamllint" },
       { name = "golangci-verify", tags = "", target = "golangci-verify" },

frontend/dockerfile/dockerfile2llb/convert.go

@@ -1645,6 +1645,14 @@ func dispatchCopy(d *dispatchState, cfg copyConfig) error {
 				return errors.Wrap(err, "removing drive letter")
 			}
 
+			for i, requiredPath := range requiredPaths {
+				p, err := system.NormalizePath("/", requiredPath, d.platform.OS, false)
+				if err != nil {
+					return errors.Wrap(err, "removing drive letter")
+				}
+				requiredPaths[i] = p
+			}
+
 			unpack := cfg.isAddCommand
 			if cfg.unpack != nil {
 				unpack = *cfg.unpack

frontend/dockerfile/dockerfile_parents_test.go

@@ -1,5 +1,3 @@
-//go:build dfparents
-
 package dockerfile
 
 import (
@@ -18,6 +16,10 @@ import (
 var parentsTests = integration.TestFuncs(
 	testCopyParents,
 	testCopyRelativeParents,
+	// Duplicate of testCopyRelativeParents but more simplified
+	// so it will run on Windows. Remove when testCopyRelativeParents
+	// works on Windows.
+	testCopyRelativeParentsSimplified,
 	testCopyParentsMissingDirectory,
 )
 
@@ -78,6 +80,7 @@ COPY --parents foo1/foo2/ba* .
 }
 
 func testCopyRelativeParents(t *testing.T, sb integration.Sandbox) {
+	integration.SkipOnPlatform(t, "windows")
 	f := getFrontend(t, sb)
 
 	dockerfile := []byte(`
@@ -182,7 +185,189 @@ eot
 	}
 }
 
+func testCopyRelativeParentsSimplified(t *testing.T, sb integration.Sandbox) {
+	f := getFrontend(t, sb)
+
+	dockerfile := []byte(integration.UnixOrWindows(`
+FROM alpine AS base
+WORKDIR /test
+RUN <<eot
+	set -ex
+	mkdir -p a/b/c/d/e
+	mkdir -p a/b2/c/d/e
+	mkdir -p a/b/c2/d/e
+	mkdir -p a/b/c2/d/e2
+	touch a/b/c/d/foo
+	touch a/b/c/d/e/bay
+	touch a/b2/c/d/e/bar
+	touch a/b/c2/d/e/baz
+	touch a/b/c2/d/e2/baz
+eot
+
+FROM alpine AS middle
+COPY --from=base --parents /test/a/b/./c/d /out/
+RUN <<eot
+	set -ex
+	[ -d /out/c/d/e ]
+	[ -f /out/c/d/foo ]
+	[ ! -d /out/a ]
+	[ ! -d /out/e ]
+eot
+
+FROM alpine AS end
+COPY --from=base --parents /test/a/b/c/d/. /out/
+RUN <<eot
+	set -ex
+	[ -d /out/test/a/b/c/d/e ]
+	[ -f /out/test/a/b/c/d/foo ]
+eot
+
+FROM alpine AS start
+COPY --from=base --parents ./test/a/b/c/d /out/
+RUN <<eot
+	set -ex
+	[ -d /out/test/a/b/c/d/e ]
+	[ -f /out/test/a/b/c/d/foo ]
+eot
+
+FROM alpine AS double
+COPY --from=base --parents /test/a/./b/./c /out/
+RUN <<eot
+	set -ex
+	[ -d /out/b/c/d/e ]
+	[ -f /out/b/c/d/foo ]
+eot
+
+FROM alpine AS wildcard
+COPY --from=base --parents /test/a/./*/c /out/
+RUN <<eot
+	set -ex
+	[ -d /out/b/c/d/e ]
+	[ -f /out/b2/c/d/e/bar ]
+eot
+
+FROM alpine AS doublewildcard
+COPY --from=base --parents /test/a/b*/./c/**/e /out/
+RUN <<eot
+	set -ex
+	[ -d /out/c/d/e ]
+	[ -f /out/c/d/e/bay ] # via b
+	[ -f /out/c/d/e/bar ] # via b2
+eot
+
+FROM alpine AS doubleinputs
+COPY --from=base --parents /test/a/b/c*/./d/**/baz /test/a/b*/./c/**/bar /out/
+RUN <<eot
+	set -ex
+	[ -f /out/d/e/baz ]
+	[ ! -f /out/d/e/bay ]
+	[ -f /out/d/e2/baz ]
+	[ -f /out/c/d/e/bar ] # via b2
+eot
+`, `
+FROM nanoserver:plus AS base
+USER ContainerAdministrator
+WORKDIR /test
+RUN <<eot
+		mkdir a\b\c\d\e
+		mkdir a\b2\c\d\e
+		mkdir a\b\c2\d\e
+		mkdir a\b\c2\d\e2
+		type nul > a\b\c\d\foo
+		type nul > a\b\c\d\e\bay
+		type nul > a\b2\c\d\e\bar
+		type nul > a\b\c2\d\e\baz
+		type nul > a\b\c2\d\e2\baz
+eot
+
+FROM nanoserver:plus AS middle
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/b/./c/d /out/
+RUN <<eot
+	if not exist \out\c\d\e exit 1
+	if not exist \out\c\d\foo exit 1
+	if exist \out\a exit 1
+	if exist \out\e exit 1
+eot
+
+FROM nanoserver:plus AS end
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/b/c/d/. /out/
+RUN <<eot
+	if not exist \out\test\a\b\c\d\e exit 1
+	if not exist \out\test\a\b\c\d\foo exit 1
+eot
+
+FROM nanoserver:plus AS start
+USER ContainerAdministrator
+COPY --from=base --parents ./test/a/b/c/d /out/
+RUN <<eot
+	if not exist \out\test\a\b\c\d\e exit 1
+	if not exist \out\test\a\b\c\d\foo exit 1
+eot
+
+FROM nanoserver:plus AS double
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/./b/./c /out/
+RUN <<eot
+	if not exist \out\b\c\d\e exit 1
+	if not exist \out\b\c\d\foo exit 1
+eot
+
+FROM alpine AS wildcard
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/./*/c /out/
+RUN <<eot
+	if not exist \out\b\c\d\e exit 1
+	if not exist \out\b2\c\d\e\bar exit 1
+eot
+
+FROM alpine AS doublewildcard
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/b*/./c/**/e /out/
+RUN <<eot
+	if not exist \out\c\d\e exit 1
+	if not exist \out\c\d\e\bay exit 1
+	if not exist \out\c\d\e\bar exit 1
+eot
+
+FROM alpine AS doubleinputs
+USER ContainerAdministrator
+COPY --from=base --parents /test/a/b/c*/./d/**/baz /test/a/b*/./c/**/bar /out/
+RUN <<eot
+	if not exist \out\d\e\baz exit 1
+	if exist \out\d\e\bay exit 1
+	if not exist \out\d\e2\baz exit 1
+	if not exist \out\c\d\e\bar exit 1
+eot
+`))
+
+	dir := integration.Tmpdir(
+		t,
+		fstest.CreateFile("Dockerfile", dockerfile, 0600),
+	)
+
+	c, err := client.New(sb.Context(), sb.Address())
+	require.NoError(t, err)
+	defer c.Close()
+
+	for _, target := range []string{"middle", "end", "start", "double", "wildcard", "doublewildcard", "doubleinputs"} {
+		t.Logf("target: %s", target)
+		_, err = f.Solve(sb.Context(), c, client.SolveOpt{
+			FrontendAttrs: map[string]string{
+				"target": target,
+			},
+			LocalMounts: map[string]fsutil.FS{
+				dockerui.DefaultLocalNameDockerfile: dir,
+				dockerui.DefaultLocalNameContext:    dir,
+			},
+		}, nil)
+		require.NoError(t, err)
+	}
+}
+
 func testCopyParentsMissingDirectory(t *testing.T, sb integration.Sandbox) {
+	integration.SkipOnPlatform(t, "windows")
 	f := getFrontend(t, sb)
 
 	dockerfile := []byte(`

frontend/dockerfile/docs/reference.md

@@ -1635,7 +1635,7 @@ The available `[OPTIONS]` are:
 | [`--chown`](#copy---chown---chmod) |                            |
 | [`--chmod`](#copy---chown---chmod) | 1.2                        |
 | [`--link`](#copy---link)           | 1.4                        |
-| [`--parents`](#copy---parents)     | 1.7-labs                   |
+| [`--parents`](#copy---parents)     | 1.20                       |
 | [`--exclude`](#copy---exclude)     | 1.19                       |
 
 The `COPY` instruction copies new files or directories from `<src>` and adds
@@ -1926,17 +1926,14 @@ conditions for cache reuse.
 
 ### COPY --parents
 
-> [!NOTE]
-> Not yet available in stable syntax, use [`docker/dockerfile:1-labs`](#syntax) version.
-
 ```dockerfile
 COPY [--parents[=<boolean>]] <src> ... <dest>
 ```
 
 The `--parents` flag preserves parent directories for `src` entries. This flag defaults to `false`.
 
 ```dockerfile
-# syntax=docker/dockerfile:1-labs
+# syntax=docker/dockerfile:1
 FROM scratch
 
 COPY ./x/a.txt ./y/a.txt /no_parents/
@@ -1956,7 +1953,7 @@ directories after it will be preserved. This may be especially useful copies bet
 with `--from` where the source paths need to be absolute.
 
 ```dockerfile
-# syntax=docker/dockerfile:1-labs
+# syntax=docker/dockerfile:1
 FROM scratch
 
 COPY --parents ./x/./y/*.txt /parents/

frontend/dockerfile/instructions/parse.go

@@ -36,8 +36,6 @@ var (
 	parseRunPostHooks []func(*RunCommand, parseRequest) error
 )
 
-var parentsEnabled = false
-
 func nodeArgs(node *parser.Node) []string {
 	result := []string{}
 	for ; node.Next != nil; node = node.Next {
@@ -313,14 +311,6 @@ func parseSourcesAndDest(req parseRequest, command string) (*SourcesAndDest, err
 	}, nil
 }
 
-func stringValuesFromFlagIfPossible(f *Flag) []string {
-	if f == nil {
-		return nil
-	}
-
-	return f.StringValues
-}
-
 func parseAdd(req parseRequest) (*AddCommand, error) {
 	if len(req.args) < 2 {
 		return nil, errNoDestinationArgument("ADD")
@@ -362,7 +352,7 @@ func parseAdd(req parseRequest) (*AddCommand, error) {
 		Link:            flLink.Value == "true",
 		KeepGitDir:      keepGit,
 		Checksum:        flChecksum.Value,
-		ExcludePatterns: stringValuesFromFlagIfPossible(flExcludes),
+		ExcludePatterns: flExcludes.StringValues,
 		Unpack:          unpack,
 	}, nil
 }
@@ -372,16 +362,12 @@ func parseCopy(req parseRequest) (*CopyCommand, error) {
 		return nil, errNoDestinationArgument("COPY")
 	}
 
-	var flParents *Flag
-	if parentsEnabled {
-		flParents = req.flags.AddBool("parents", false)
-	}
-
 	flChown := req.flags.AddString("chown", "")
 	flFrom := req.flags.AddString("from", "")
 	flChmod := req.flags.AddString("chmod", "")
 	flLink := req.flags.AddBool("link", false)
 	flExcludes := req.flags.AddStrings("exclude")
+	flParents := req.flags.AddBool("parents", false)
 
 	if err := req.flags.Parse(); err != nil {
 		return nil, err
@@ -399,8 +385,8 @@ func parseCopy(req parseRequest) (*CopyCommand, error) {
 		Chown:           flChown.Value,
 		Chmod:           flChmod.Value,
 		Link:            flLink.Value == "true",
-		Parents:         flParents != nil && flParents.Value == "true",
-		ExcludePatterns: stringValuesFromFlagIfPossible(flExcludes),
+		Parents:         flParents.Value == "true",
+		ExcludePatterns: flExcludes.StringValues,
 	}, nil
 }
 

frontend/dockerfile/instructions/parse_parents.go

@@ -1 +1 @@
-dfrunsecurity dfparents dfrundevice
+dfrunsecurity dfrundevice