docker/buildx
1
0
Fork 0
mirror of https://gitea.com/Lydanne/buildx.git synced 2025-07-19 01:38:03 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

avoid import to testing helpers outside of tests

Browse Source 
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
This commit is contained in:
Tonis Tiigi
2025-04-08 00:01:12 -07:00
parent 8f9c25e8b0
commit 29614f9734
8 changed files with 183 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
util/gitutil/credentials_test.go Normal file
View File

@@ -0,0 +1,45 @@
package gitutil
import "testing"
func TestStripCredentials(t *testing.T) {
cases := []struct {
name string
url string
want string
}{
{
name: "non-blank Password",
url: "https://user:password@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Password",
url: "https://user@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Username",
url: "https://:password@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Username, blank Password",
url: "https://host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "invalid URL",
url: "1https://foo.com",
want: "1https://foo.com",
},
}
for _, tt := range cases {
tt := tt
t.Run(tt.name, func(t *testing.T) {
if g, w := stripCredentials(tt.url), tt.want; g != w {
t.Fatalf("got: %q\nwant: %q", g, w)
}
})
}
}

21
util/gitutil/testutil.go → util/gitutil/gittestutil/testutil.go
View File

@@ -1,14 +1,15 @@
package gitutil
package gittestutil
import (
"os"
"strings"
"testing"
"github.com/docker/buildx/util/gitutil"
"github.com/stretchr/testify/require"
)
func GitInit(c *Git, tb testing.TB) {
func GitInit(c *gitutil.Git, tb testing.TB) {
tb.Helper()
out, err := fakeGit(c, "init")
require.NoError(tb, err)
@@ -18,41 +19,41 @@ func GitInit(c *Git, tb testing.TB) {
_, _ = fakeGit(c, "branch", "-D", "master")
}
func GitCommit(c *Git, tb testing.TB, msg string) {
func GitCommit(c *gitutil.Git, tb testing.TB, msg string) {
tb.Helper()
out, err := fakeGit(c, "commit", "--allow-empty", "-m", msg)
require.NoError(tb, err)
require.Contains(tb, out, "main", msg)
}
func GitTag(c *Git, tb testing.TB, tag string) {
func GitTag(c *gitutil.Git, tb testing.TB, tag string) {
tb.Helper()
out, err := fakeGit(c, "tag", tag)
require.NoError(tb, err)
require.Empty(tb, out)
}
func GitCheckoutBranch(c *Git, tb testing.TB, name string) {
func GitCheckoutBranch(c *gitutil.Git, tb testing.TB, name string) {
tb.Helper()
out, err := fakeGit(c, "checkout", "-b", name)
require.NoError(tb, err)
require.Empty(tb, out)
}
func GitAdd(c *Git, tb testing.TB, files ...string) {
func GitAdd(c *gitutil.Git, tb testing.TB, files ...string) {
tb.Helper()
args := append([]string{"add"}, files...)
_, err := fakeGit(c, args...)
require.NoError(tb, err)
}
func GitSetRemote(c *Git, tb testing.TB, name string, url string) {
func GitSetRemote(c *gitutil.Git, tb testing.TB, name string, url string) {
tb.Helper()
_, err := fakeGit(c, "remote", "add", name, url)
require.NoError(tb, err)
}
func GitSetMainUpstream(c *Git, tb testing.TB, remote, target string) {
func GitSetMainUpstream(c *gitutil.Git, tb testing.TB, remote, target string) {
tb.Helper()
_, err := fakeGit(c, "fetch", "--depth", "1", remote, target)
require.NoError(tb, err)
@@ -73,7 +74,7 @@ func Mktmp(tb testing.TB) string {
return folder
}
func fakeGit(c *Git, args ...string) (string, error) {
func fakeGit(c *gitutil.Git, args ...string) (string, error) {
allArgs := []string{
"-c", "user.name=buildx",
"-c", "user.email=buildx@docker.com",
@@ -82,7 +83,7 @@ func fakeGit(c *Git, args ...string) (string, error) {
"-c", "log.showSignature=false",
}
allArgs = append(allArgs, args...)
return c.clean(c.run(allArgs...))
return c.Run(allArgs...)
}
func IsAmbiguousArgument(err error) bool {

7
util/gitutil/testutilserve.go → util/gitutil/gittestutil/testutilserve.go
View File

@@ -1,4 +1,4 @@
package gitutil
package gittestutil
import (
"context"
@@ -7,6 +7,7 @@ import (
"net/http"
"testing"
"github.com/docker/buildx/util/gitutil"
"github.com/pkg/errors"
"github.com/stretchr/testify/require"
)
@@ -23,7 +24,7 @@ func WithAccessToken(token string) GitServeOpt {
}
}
func GitServeHTTP(c *Git, t testing.TB, opts ...GitServeOpt) (url string) {
func GitServeHTTP(c *gitutil.Git, t testing.TB, opts ...GitServeOpt) (url string) {
t.Helper()
gitUpdateServerInfo(c, t)
ctx, cancel := context.WithCancelCause(context.TODO())
@@ -91,7 +92,7 @@ func GitServeHTTP(c *Git, t testing.TB, opts ...GitServeOpt) (url string) {
return fmt.Sprintf("http://%s/%s", addr, name)
}
func gitUpdateServerInfo(c *Git, tb testing.TB) {
func gitUpdateServerInfo(c *gitutil.Git, tb testing.TB) {
tb.Helper()
_, err := fakeGit(c, "update-server-info")
require.NoError(tb, err)

14
util/gitutil/gitutil.go
View File

@@ -57,17 +57,17 @@ func New(opts ...Option) (*Git, error) {
}
func (c *Git) IsInsideWorkTree() bool {
out, err := c.clean(c.run("rev-parse", "--is-inside-work-tree"))
out, err := c.Run("rev-parse", "--is-inside-work-tree")
return out == "true" && err == nil
}
func (c *Git) IsDirty() bool {
out, err := c.run("status", "--porcelain", "--ignored")
out, err := c.Run("status", "--porcelain", "--ignored")
return strings.TrimSpace(out) != "" || err != nil
}
func (c *Git) RootDir() (string, error) {
root, err := c.clean(c.run("rev-parse", "--show-toplevel"))
root, err := c.Run("rev-parse", "--show-toplevel")
if err != nil {
return "", err
}
@@ -127,6 +127,10 @@ func (c *Git) Tag() (string, error) {
return tag, err
}
func (c *Git) Run(args ...string) (string, error) {
return c.clean(c.run(args...))
}
func (c *Git) run(args ...string) (string, error) {
var extraArgs = []string{
"-c", "log.showSignature=false",
@@ -161,7 +165,7 @@ func (c *Git) clean(out string, err error) (string, error) {
}
func (c *Git) currentRemote() (string, error) {
symref, err := c.clean(c.run("symbolic-ref", "-q", "HEAD"))
symref, err := c.Run("symbolic-ref", "-q", "HEAD")
if err != nil {
return "", err
}
@@ -169,7 +173,7 @@ func (c *Git) currentRemote() (string, error) {
return "", nil
}
// git for-each-ref --format='%(upstream:remotename)'
remote, err := c.clean(c.run("for-each-ref", "--format=%(upstream:remotename)", symref))
remote, err := c.Run("for-each-ref", "--format=%(upstream:remotename)", symref)
if err != nil {
return "", err
}

132
util/gitutil/gitutil_test.go
View File

@@ -1,32 +1,34 @@
package gitutil
package gitutil_test
import (
"testing"
"github.com/docker/buildx/util/gitutil"
"github.com/docker/buildx/util/gitutil/gittestutil"
"github.com/stretchr/testify/require"
)
func TestGit(t *testing.T) {
c, err := New()
c, err := gitutil.New()
require.NoError(t, err)
out, err := c.run("status")
out, err := c.Run("status")
require.NoError(t, err)
require.NotEmpty(t, out)
out, err = c.clean(c.run("not-exist"))
out, err = c.Run("not-exist")
require.Error(t, err)
require.Empty(t, out)
require.Equal(t, "git: 'not-exist' is not a git command. See 'git --help'.", err.Error())
}
func TestGitFullCommit(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
GitCommit(c, t, "bar")
gittestutil.GitInit(c, t)
gittestutil.GitCommit(c, t, "bar")
out, err := c.FullCommit()
require.NoError(t, err)
@@ -34,12 +36,12 @@ func TestGitFullCommit(t *testing.T) {
}
func TestGitShortCommit(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
GitCommit(c, t, "bar")
gittestutil.GitInit(c, t)
gittestutil.GitCommit(c, t, "bar")
out, err := c.ShortCommit()
require.NoError(t, err)
@@ -47,59 +49,59 @@ func TestGitShortCommit(t *testing.T) {
}
func TestGitFullCommitErr(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
gittestutil.GitInit(c, t)
_, err = c.FullCommit()
require.Error(t, err)
require.True(t, IsUnknownRevision(err))
require.False(t, IsAmbiguousArgument(err))
require.True(t, gitutil.IsUnknownRevision(err))
require.False(t, gittestutil.IsAmbiguousArgument(err))
}
func TestGitShortCommitErr(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
gittestutil.GitInit(c, t)
_, err = c.ShortCommit()
require.Error(t, err)
require.True(t, IsUnknownRevision(err))
require.False(t, IsAmbiguousArgument(err))
require.True(t, gitutil.IsUnknownRevision(err))
require.False(t, gittestutil.IsAmbiguousArgument(err))
}
func TestGitTagsPointsAt(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
GitCommit(c, t, "bar")
GitTag(c, t, "v0.8.0")
GitCommit(c, t, "foo")
GitTag(c, t, "v0.9.0")
gittestutil.GitInit(c, t)
gittestutil.GitCommit(c, t, "bar")
gittestutil.GitTag(c, t, "v0.8.0")
gittestutil.GitCommit(c, t, "foo")
gittestutil.GitTag(c, t, "v0.9.0")
out, err := c.clean(c.run("tag", "--points-at", "HEAD", "--sort", "-version:creatordate"))
out, err := c.Run("tag", "--points-at", "HEAD", "--sort", "-version:creatordate")
require.NoError(t, err)
require.Equal(t, "v0.9.0", out)
}
func TestGitDescribeTags(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
GitCommit(c, t, "bar")
GitTag(c, t, "v0.8.0")
GitCommit(c, t, "foo")
GitTag(c, t, "v0.9.0")
gittestutil.GitInit(c, t)
gittestutil.GitCommit(c, t, "bar")
gittestutil.GitTag(c, t, "v0.8.0")
gittestutil.GitCommit(c, t, "foo")
gittestutil.GitTag(c, t, "v0.9.0")
out, err := c.clean(c.run("describe", "--tags", "--abbrev=0"))
out, err := c.Run("describe", "--tags", "--abbrev=0")
require.NoError(t, err)
require.Equal(t, "v0.9.0", out)
}
@@ -200,16 +202,16 @@ func TestGitRemoteURL(t *testing.T) {
for _, tt := range cases {
tt := tt
t.Run(tt.name, func(t *testing.T) {
Mktmp(t)
c, err := New()
gittestutil.Mktmp(t)
c, err := gitutil.New()
require.NoError(t, err)
GitInit(c, t)
GitCommit(c, t, "initial commit")
gittestutil.GitInit(c, t)
gittestutil.GitCommit(c, t, "initial commit")
for _, r := range tt.remotes {
GitSetRemote(c, t, r.name, r.url)
gittestutil.GitSetRemote(c, t, r.name, r.url)
if r.tracking != "" {
GitSetMainUpstream(c, t, r.name, r.tracking)
gittestutil.GitSetMainUpstream(c, t, r.name, r.tracking)
}
}
@@ -223,45 +225,3 @@ func TestGitRemoteURL(t *testing.T) {
})
}
}
func TestStripCredentials(t *testing.T) {
cases := []struct {
name string
url string
want string
}{
{
name: "non-blank Password",
url: "https://user:password@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Password",
url: "https://user@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Username",
url: "https://:password@host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "blank Username, blank Password",
url: "https://host.tld/this:that",
want: "https://host.tld/this:that",
},
{
name: "invalid URL",
url: "1https://foo.com",
want: "1https://foo.com",
},
}
for _, tt := range cases {
tt := tt
t.Run(tt.name, func(t *testing.T) {
if g, w := stripCredentials(tt.url), tt.want; g != w {
t.Fatalf("got: %q\nwant: %q", g, w)
}
})
}
}