llb: update Git to allow normalized property passing

Signed-off-by: Tonis Tiigi <[email protected]>

Author: tonistiigi

client/llb/git_test.go

@@ -0,0 +1,94 @@
+package llb
+
+import (
+	"context"
+	"testing"
+
+	"github.com/moby/buildkit/solver/pb"
+	"github.com/stretchr/testify/require"
+)
+
+func TestGit(t *testing.T) {
+	t.Parallel()
+
+	type tcase struct {
+		name       string
+		st         State
+		identifier string
+		attrs      map[string]string
+	}
+
+	tcases := []tcase{
+		{
+			name:       "refarg",
+			st:         Git("github.com/foo/bar.git", "ref"),
+			identifier: "git://github.com/foo/bar.git#ref",
+			attrs: map[string]string{
+				"git.authheadersecret": "GIT_AUTH_HEADER",
+				"git.authtokensecret":  "GIT_AUTH_TOKEN",
+				"git.fullurl":          "https://github.com/foo/bar.git",
+			},
+		},
+		{
+			name:       "refarg with subdir",
+			st:         Git("github.com/foo/bar.git", "ref:subdir"),
+			identifier: "git://github.com/foo/bar.git#ref:subdir",
+			attrs: map[string]string{
+				"git.authheadersecret": "GIT_AUTH_HEADER",
+				"git.authtokensecret":  "GIT_AUTH_TOKEN",
+				"git.fullurl":          "https://github.com/foo/bar.git",
+			},
+		},
+		{
+			name:       "refarg with subdir func",
+			st:         Git("github.com/foo/bar.git", "ref", GitSubDir("subdir")),
+			identifier: "git://github.com/foo/bar.git#ref:subdir",
+			attrs: map[string]string{
+				"git.authheadersecret": "GIT_AUTH_HEADER",
+				"git.authtokensecret":  "GIT_AUTH_TOKEN",
+				"git.fullurl":          "https://github.com/foo/bar.git",
+			},
+		},
+		{
+			name:       "refarg with override",
+			st:         Git("github.com/foo/bar.git", "ref:dir", GitRef("v1.0")),
+			identifier: "git://github.com/foo/bar.git#v1.0:dir",
+			attrs: map[string]string{
+				"git.authheadersecret": "GIT_AUTH_HEADER",
+				"git.authtokensecret":  "GIT_AUTH_TOKEN",
+				"git.fullurl":          "https://github.com/foo/bar.git",
+			},
+		},
+		{
+			name:       "funcs only",
+			st:         Git("github.com/foo/bar.git", "", GitRef("v1.0"), GitSubDir("dir")),
+			identifier: "git://github.com/foo/bar.git#v1.0:dir",
+			attrs: map[string]string{
+				"git.authheadersecret": "GIT_AUTH_HEADER",
+				"git.authtokensecret":  "GIT_AUTH_TOKEN",
+				"git.fullurl":          "https://github.com/foo/bar.git",
+			},
+		},
+	}
+
+	for _, tc := range tcases {
+		t.Run(tc.name, func(t *testing.T) {
+			st := tc.st
+			def, err := st.Marshal(context.TODO())
+
+			require.NoError(t, err)
+
+			m, arr := parseDef(t, def.Def)
+			require.Equal(t, 2, len(arr))
+
+			dgst, idx := last(t, arr)
+			require.Equal(t, 0, idx)
+			require.Equal(t, m[dgst], arr[0])
+
+			g := arr[0].Op.(*pb.Op_Source).Source
+
+			require.Equal(t, tc.identifier, g.Identifier)
+			require.Equal(t, tc.attrs, g.Attrs)
+		})
+	}
+}

client/llb/source.go

@@ -249,7 +249,7 @@ const (
 //
 // By default the git repository is cloned with `--depth=1` to reduce the amount of data downloaded.
 // Additionally the ".git" directory is removed after the clone, you can keep ith with the [KeepGitDir] [GitOption].
-func Git(url, ref string, opts ...GitOption) State {
+func Git(url, fragment string, opts ...GitOption) State {
 	remote, err := gitutil.ParseURL(url)
 	if errors.Is(err, gitutil.ErrUnknownProtocol) {
 		url = "https://" + url
@@ -259,6 +259,20 @@ func Git(url, ref string, opts ...GitOption) State {
 		url = remote.Remote
 	}
 
+	gi := &GitInfo{
+		AuthHeaderSecret: GitAuthHeaderKey,
+		AuthTokenSecret:  GitAuthTokenKey,
+	}
+	ref, subdir, ok := strings.Cut(fragment, ":")
+	if ref != "" {
+		GitRef(ref).SetGitOption(gi)
+	}
+	if ok && subdir != "" {
+		GitSubDir(subdir).SetGitOption(gi)
+	}
+	for _, o := range opts {
+		o.SetGitOption(gi)
+	}
 	var id string
 	if err != nil {
 		// If we can't parse the URL, just use the full URL as the ID. The git
@@ -269,18 +283,13 @@ func Git(url, ref string, opts ...GitOption) State {
 		// for different protocols (e.g. https and ssh) that have the same
 		// host/path/fragment combination.
 		id = remote.Host + path.Join("/", remote.Path)
-		if ref != "" {
-			id += "#" + ref
+		if gi.Ref != "" || gi.SubDir != "" {
+			id += "#" + gi.Ref
+			if gi.SubDir != "" {
+				id += ":" + gi.SubDir
+			}
 		}
 	}
-
-	gi := &GitInfo{
-		AuthHeaderSecret: GitAuthHeaderKey,
-		AuthTokenSecret:  GitAuthTokenKey,
-	}
-	for _, o := range opts {
-		o.SetGitOption(gi)
-	}
 	attrs := map[string]string{}
 	if gi.KeepGitDir {
 		attrs[pb.AttrKeepGitDir] = "true"
@@ -352,6 +361,20 @@ type GitInfo struct {
 	KnownSSHHosts    string
 	MountSSHSock     string
 	Checksum         string
+	Ref              string
+	SubDir           string
+}
+
+func GitRef(v string) GitOption {
+	return gitOptionFunc(func(gi *GitInfo) {
+		gi.Ref = v
+	})
+}
+
+func GitSubDir(v string) GitOption {
+	return gitOptionFunc(func(gi *GitInfo) {
+		gi.SubDir = v
+	})
 }
 
 func KeepGitDir() GitOption {

frontend/dockerfile/dockerfile2llb/convert.go

@@ -1513,18 +1513,21 @@ func dispatchCopy(d *dispatchState, cfg copyConfig) error {
 				return errors.New("source can't be a git ref for COPY")
 			}
 			// TODO: print a warning (not an error) if gitRef.UnencryptedTCP is true
-			commit := gitRef.Ref
-			if gitRef.SubDir != "" {
-				commit += ":" + gitRef.SubDir
+			gitOptions := []llb.GitOption{
+				llb.WithCustomName(pgName),
+				llb.GitRef(gitRef.Ref),
 			}
-			gitOptions := []llb.GitOption{llb.WithCustomName(pgName)}
 			if cfg.keepGitDir {
 				gitOptions = append(gitOptions, llb.KeepGitDir())
 			}
 			if cfg.checksum != "" {
 				gitOptions = append(gitOptions, llb.GitChecksum(cfg.checksum))
 			}
-			st := llb.Git(gitRef.Remote, commit, gitOptions...)
+			if gitRef.SubDir != "" {
+				gitOptions = append(gitOptions, llb.GitSubDir(gitRef.SubDir))
+			}
+
+			st := llb.Git(gitRef.Remote, "", gitOptions...)
 			opts := append([]llb.CopyOption{&llb.CopyInfo{
 				Mode:           chopt,
 				CreateDestPath: true,

frontend/dockerui/context.go

@@ -149,12 +149,21 @@ func DetectGitContext(ref string, keepGit bool) (*llb.State, bool) {
 	if g.SubDir != "" {
 		commit += ":" + g.SubDir
 	}
-	gitOpts := []llb.GitOption{WithInternalName("load git source " + ref)}
+	gitOpts := []llb.GitOption{
+		llb.GitRef(commit),
+		WithInternalName("load git source " + ref),
+	}
 	if keepGit {
 		gitOpts = append(gitOpts, llb.KeepGitDir())
 	}
+	if g.SubDir != "" {
+		gitOpts = append(gitOpts, llb.GitSubDir(g.SubDir))
+	}
+	if g.Checksum != "" {
+		gitOpts = append(gitOpts, llb.GitChecksum(g.Checksum))
+	}
 
-	st := llb.Git(g.Remote, commit, gitOpts...)
+	st := llb.Git(g.Remote, "", gitOpts...)
 	return &st, true
 }