dilim/buildkit
1
0 Fork 0
mirror of https://github.com/moby/buildkit.git synced 2026-11-06 05:16:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
buildkit/frontend/dockerfile/dfgitutil/git_ref_test.go
T
Tonis Tiigi a6f84979d6 provenance: include git subdir in configSource 
Preserve the git context subdirectory in SLSA configSource while keeping
resolved materials scoped to the fetched repository ref.

Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2026-04-24 18:55:07 -07:00

505 lines
13 KiB
Go
Raw Permalink Blame History

package dfgitutil
import (
"fmt"
"testing"
"github.com/stretchr/testify/require"
)
func TestParseGitRef(t *testing.T) {
cases := []struct {
ref string
expected *GitRef
err string
}{
{
ref: "https://example.com/",
expected: nil,
},
{
ref: "https://example.com/foo",
expected: nil,
},
{
ref: "https://example.com/foo.git",
expected: &GitRef{
Remote: "https://example.com/foo.git",
ShortName: "foo",
},
},
{
ref: "https://example.com/foo.git#deadbeef",
expected: &GitRef{
Remote: "https://example.com/foo.git",
ShortName: "foo",
Ref: "deadbeef",
},
},
{
ref: "https://example.com/foo.git#release/1.2",
expected: &GitRef{
Remote: "https://example.com/foo.git",
ShortName: "foo",
Ref: "release/1.2",
},
},
{
ref: "https://example.com/foo.git/",
expected: nil,
},
{
ref: "https://example.com/foo.git.bar",
expected: nil,
},
{
ref: "git://example.com/foo",
expected: &GitRef{
Remote: "git://example.com/foo",
ShortName: "foo",
UnencryptedTCP: true,
},
},
{
ref: "github.com/moby/buildkit",
expected: &GitRef{
Remote: "github.com/moby/buildkit",
ShortName: "buildkit",
IndistinguishableFromLocal: true,
},
},
{
ref: "github.com/moby/buildkit#master",
expected: &GitRef{
Remote: "github.com/moby/buildkit",
ShortName: "buildkit",
IndistinguishableFromLocal: true,
Ref: "master",
},
},
{
ref: "custom.xyz/moby/buildkit.git",
expected: nil,
},
{
ref: "https://github.com/moby/buildkit",
expected: nil,
},
{
ref: "https://github.com/moby/buildkit.git",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
},
},
{
ref: "https://foo:bar@github.com/moby/buildkit.git",
expected: &GitRef{
Remote: "https://foo:bar@github.com/moby/buildkit.git",
ShortName: "buildkit",
},
},
{
ref: "git@github.com:moby/buildkit",
expected: &GitRef{
Remote: "git@github.com:moby/buildkit",
ShortName: "buildkit",
},
},
{
ref: "git@github.com:moby/buildkit.git",
expected: &GitRef{
Remote: "git@github.com:moby/buildkit.git",
ShortName: "buildkit",
},
},
{
ref: "git@bitbucket.org:atlassianlabs/atlassian-docker.git",
expected: &GitRef{
Remote: "git@bitbucket.org:atlassianlabs/atlassian-docker.git",
ShortName: "atlassian-docker",
},
},
{
ref: "https://github.com/foo/bar.git#baz/qux:quux/quuz",
expected: &GitRef{
Remote: "https://github.com/foo/bar.git",
ShortName: "bar",
Ref: "baz/qux",
SubDir: "quux/quuz",
},
},
{
ref: "http://github.com/docker/docker.git:#branch",
expected: nil,
},
{
ref: "https://github.com/docker/docker.git#:myfolder",
expected: &GitRef{
Remote: "https://github.com/docker/docker.git",
ShortName: "docker",
SubDir: "myfolder",
},
},
{
ref: "./.git",
expected: nil,
},
{
ref: ".git",
expected: nil,
},
{
ref: "https://github.com/docker/docker.git?ref=v1.0.0&subdir=/subdir",
expected: &GitRef{
Remote: "https://github.com/docker/docker.git",
ShortName: "docker",
Ref: "v1.0.0",
SubDir: "/subdir",
},
},
{
ref: "https://github.com/moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
Ref: "v1.0.0",
SubDir: "/subdir",
},
},
{
ref: "https://github.com/moby/buildkit.git?tag=v1.0.0",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
Ref: "refs/tags/v1.0.0",
},
},
{
ref: "github.com/moby/buildkit?tag=v1.0.0",
expected: &GitRef{
Remote: "github.com/moby/buildkit",
ShortName: "buildkit",
Ref: "refs/tags/v1.0.0",
IndistinguishableFromLocal: true,
},
},
{
ref: "https://github.com/moby/buildkit.git?branch=v1.0",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
Ref: "refs/heads/v1.0",
},
},
{
ref: "https://github.com/moby/buildkit.git?ref=v1.0.0#v1.2.3",
err: "ref conflicts",
},
{
ref: "https://github.com/moby/buildkit.git?ref=v1.0.0&tag=v1.2.3",
err: "ref conflicts",
},
{
// TODO: consider allowing this, when the tag actually exists on the branch
ref: "https://github.com/moby/buildkit.git?tag=v1.0.0&branch=v1.0",
err: "branch conflicts with tag",
},
{
ref: "git@github.com:moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: &GitRef{
Remote: "git@github.com:moby/buildkit.git",
ShortName: "buildkit",
Ref: "v1.0.0",
SubDir: "/subdir",
},
},
{
ref: "https://github.com/moby/buildkit.git?mtime=commit",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
MTime: "commit",
},
},
{
ref: "https://github.com/moby/buildkit.git?mtime=checkout",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
MTime: "checkout",
},
},
{
ref: "https://github.com/moby/buildkit.git?mtime=invalid",
err: "invalid mtime value",
},
{
ref: "https://github.com/moby/buildkit.git?fetch-by-commit=true&checksum=deadbeef#refs/heads/branch",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
Ref: "refs/heads/branch",
Checksum: "deadbeef",
FetchByCommit: true,
},
},
{
ref: "https://github.com/moby/buildkit.git?fetch-by-commit&checksum=deadbeef",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
Checksum: "deadbeef",
FetchByCommit: true,
},
},
{
ref: "https://github.com/moby/buildkit.git?fetch-by-commit=false",
expected: &GitRef{
Remote: "https://github.com/moby/buildkit.git",
ShortName: "buildkit",
},
},
{
ref: "https://github.com/moby/buildkit.git?fetch-by-commit=invalid",
err: "invalid fetch-by-commit value",
},
{
ref: "https://github.com/moby/buildkit.git?invalid=123",
err: "unexpected query \"invalid\"",
},
}
for i, tt := range cases {
t.Run(fmt.Sprintf("case%d", i+1), func(t *testing.T) {
got, _, err := ParseGitRef(tt.ref)
if tt.expected == nil {
require.Nil(t, got)
require.Error(t, err)
if tt.err != "" {
require.ErrorContains(t, err, tt.err)
}
} else {
require.NoError(t, err)
require.Equal(t, tt.expected, got)
}
})
}
}
func TestFragmentFormat(t *testing.T) {
cases := []struct {
ref string
expected string
ok bool
}{
{
ref: "https://example.com/",
expected: "https://example.com/",
ok: false,
},
{
ref: "https://example.com/foo.git",
expected: "https://example.com/foo.git",
ok: true,
},
{
ref: "https://example.com/foo.git#deadbeef",
expected: "https://example.com/foo.git#deadbeef",
ok: true,
},
{
ref: "https://example.com/foo.git#release/1.2",
expected: "https://example.com/foo.git#release/1.2",
ok: true,
},
{
ref: "https://example.com/foo.git/",
expected: "https://example.com/foo.git/",
ok: false,
},
{
ref: "https://example.com/foo.git.bar",
expected: "https://example.com/foo.git.bar",
ok: false,
},
{
ref: "git://example.com/foo",
expected: "git://example.com/foo",
ok: true,
},
{
ref: "github.com/moby/buildkit",
expected: "github.com/moby/buildkit",
ok: true,
},
{
ref: "github.com/moby/buildkit#master",
expected: "github.com/moby/buildkit#master",
ok: true,
},
{
ref: "custom.xyz/moby/buildkit.git",
expected: "custom.xyz/moby/buildkit.git",
ok: false,
},
{
ref: "https://github.com/moby/buildkit",
expected: "https://github.com/moby/buildkit",
ok: false,
},
{
ref: "https://github.com/moby/buildkit.git",
expected: "https://github.com/moby/buildkit.git",
ok: true,
},
{
ref: "https://foo:bar@github.com/moby/buildkit.git",
expected: "https://foo:bar@github.com/moby/buildkit.git",
ok: true,
},
{
ref: "git@github.com:moby/buildkit",
expected: "git@github.com:moby/buildkit",
ok: true,
},
{
ref: "git@github.com:moby/buildkit.git",
expected: "git@github.com:moby/buildkit.git",
ok: true,
},
{
ref: "git@bitbucket.org:atlassianlabs/atlassian-docker.git",
expected: "git@bitbucket.org:atlassianlabs/atlassian-docker.git",
ok: true,
},
{
ref: "https://github.com/foo/bar.git#baz/qux:quux/quuz",
expected: "https://github.com/foo/bar.git#baz/qux",
ok: true,
},
{
ref: "http://github.com/docker/docker.git:#branch",
expected: "http://github.com/docker/docker.git:#branch",
ok: false,
},
{
ref: "https://github.com/docker/docker.git#:myfolder",
expected: "https://github.com/docker/docker.git",
ok: true,
},
{
ref: "./.git",
expected: "./.git",
ok: false,
},
{
ref: ".git",
expected: ".git",
ok: false,
},
{
ref: "https://github.com/docker/docker.git?ref=v1.0.0&subdir=/subdir",
expected: "https://github.com/docker/docker.git#v1.0.0",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: "https://github.com/moby/buildkit.git#v1.0.0",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?tag=v1.0.0",
expected: "https://github.com/moby/buildkit.git#refs/tags/v1.0.0",
ok: true,
},
{
ref: "github.com/moby/buildkit?tag=v1.0.0",
expected: "github.com/moby/buildkit#refs/tags/v1.0.0",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?branch=v1.0",
expected: "https://github.com/moby/buildkit.git#refs/heads/v1.0",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?ref=v1.0.0#v1.2.3",
expected: "https://github.com/moby/buildkit.git?ref=v1.0.0#v1.2.3",
ok: false,
},
{
ref: "https://github.com/moby/buildkit.git?ref=v1.0.0&tag=v1.2.3",
expected: "https://github.com/moby/buildkit.git?ref=v1.0.0&tag=v1.2.3",
ok: false,
},
{
ref: "https://github.com/moby/buildkit.git?tag=v1.0.0&branch=v1.0",
expected: "https://github.com/moby/buildkit.git?tag=v1.0.0&branch=v1.0",
ok: false,
},
{
ref: "git@github.com:moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: "git@github.com:moby/buildkit.git#v1.0.0",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?invalid=123",
expected: "https://github.com/moby/buildkit.git?invalid=123",
ok: false,
},
}
for i, tt := range cases {
t.Run(fmt.Sprintf("case%d", i+1), func(t *testing.T) {
got, ok := FragmentFormat(tt.ref, false)
require.Equal(t, tt.expected, got)
require.Equal(t, tt.ok, ok)
})
}
}
func TestFragmentFormatWithSubdir(t *testing.T) {
cases := []struct {
ref string
expected string
ok bool
}{
{
ref: "https://github.com/foo/bar.git#baz/qux:quux/quuz",
expected: "https://github.com/foo/bar.git#baz/qux:quux/quuz",
ok: true,
},
{
ref: "https://github.com/docker/docker.git#:myfolder",
expected: "https://github.com/docker/docker.git#:myfolder",
ok: true,
},
{
ref: "https://github.com/docker/docker.git?ref=v1.0.0&subdir=/subdir",
expected: "https://github.com/docker/docker.git#v1.0.0:subdir",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: "https://github.com/moby/buildkit.git#v1.0.0:subdir",
ok: true,
},
{
ref: "git@github.com:moby/buildkit.git?subdir=/subdir#v1.0.0",
expected: "git@github.com:moby/buildkit.git#v1.0.0:subdir",
ok: true,
},
{
ref: "https://github.com/moby/buildkit.git",
expected: "https://github.com/moby/buildkit.git",
ok: true,
},
}
for i, tt := range cases {
t.Run(fmt.Sprintf("case%d", i+1), func(t *testing.T) {
got, ok := FragmentFormat(tt.ref, true)
require.Equal(t, tt.expected, got)
require.Equal(t, tt.ok, ok)
})
}
}
Reference in new issue View Git Blame Copy Permalink