Skip to content

Commit

Permalink
builder: modernize TestCheckoutGit
Browse files Browse the repository at this point in the history 
Make the test more debuggable by logging all git command output and
running each table-driven test case as a subtest.

Signed-off-by: Cory Snider <csnider@mirantis.com>
  • Loading branch information
@corhere
corhere committed Oct 13, 2022
1 parent c964641 commit 8816c3c
Showing 1 changed file with 56 additions and 88 deletions.
144 changes: 56 additions & 88 deletions builder/remotecontext/git/gitutils_test.go
View file
Expand Up @@ -2,7 +2,6 @@ package git // import "github.com/docker/docker/builder/remotecontext/git"

import (
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
"net/url"
Expand Down Expand Up @@ -171,9 +170,7 @@ func gitGetConfig(name string) string {
}

func TestCheckoutGit(t *testing.T) {
root, err := ioutil.TempDir("", "docker-build-git-checkout")
assert.NilError(t, err)
defer os.RemoveAll(root)
root := t.TempDir()

autocrlf := gitGetConfig("core.autocrlf")
if !(autocrlf == "true" || autocrlf == "false" ||
Expand All @@ -185,88 +182,57 @@ func TestCheckoutGit(t *testing.T) {
eol = "\r\n"
}

gitDir := filepath.Join(root, "repo")
_, err = git("init", gitDir)
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "config", "user.email", "test@docker.com")
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "config", "user.name", "Docker test")
assert.NilError(t, err)
must := func(out []byte, err error) {
t.Helper()
if len(out) > 0 {
t.Logf("%s", out)
}
assert.NilError(t, err)
}

err = ioutil.WriteFile(filepath.Join(gitDir, "Dockerfile"), []byte("FROM scratch"), 0644)
assert.NilError(t, err)
gitDir := filepath.Join(root, "repo")
must(git("-c", "init.defaultBranch=master", "init", gitDir))
must(gitWithinDir(gitDir, "config", "user.email", "test@docker.com"))
must(gitWithinDir(gitDir, "config", "user.name", "Docker test"))
assert.NilError(t, os.WriteFile(filepath.Join(gitDir, "Dockerfile"), []byte("FROM scratch"), 0644))

subDir := filepath.Join(gitDir, "subdir")
assert.NilError(t, os.Mkdir(subDir, 0755))

err = ioutil.WriteFile(filepath.Join(subDir, "Dockerfile"), []byte("FROM scratch\nEXPOSE 5000"), 0644)
assert.NilError(t, err)
assert.NilError(t, os.WriteFile(filepath.Join(subDir, "Dockerfile"), []byte("FROM scratch\nEXPOSE 5000"), 0644))

if runtime.GOOS != "windows" {
if err = os.Symlink("../subdir", filepath.Join(gitDir, "parentlink")); err != nil {
t.Fatal(err)
}

if err = os.Symlink("/subdir", filepath.Join(gitDir, "absolutelink")); err != nil {
t.Fatal(err)
}
assert.NilError(t, os.Symlink("../subdir", filepath.Join(gitDir, "parentlink")))
assert.NilError(t, os.Symlink("/subdir", filepath.Join(gitDir, "absolutelink")))
}

_, err = gitWithinDir(gitDir, "add", "-A")
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "commit", "-am", "First commit")
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "checkout", "-b", "test")
assert.NilError(t, err)

err = ioutil.WriteFile(filepath.Join(gitDir, "Dockerfile"), []byte("FROM scratch\nEXPOSE 3000"), 0644)
assert.NilError(t, err)
must(gitWithinDir(gitDir, "add", "-A"))
must(gitWithinDir(gitDir, "commit", "-am", "First commit"))
must(gitWithinDir(gitDir, "checkout", "-b", "test"))

err = ioutil.WriteFile(filepath.Join(subDir, "Dockerfile"), []byte("FROM busybox\nEXPOSE 5000"), 0644)
assert.NilError(t, err)
assert.NilError(t, os.WriteFile(filepath.Join(gitDir, "Dockerfile"), []byte("FROM scratch\nEXPOSE 3000"), 0644))
assert.NilError(t, os.WriteFile(filepath.Join(subDir, "Dockerfile"), []byte("FROM busybox\nEXPOSE 5000"), 0644))

_, err = gitWithinDir(gitDir, "add", "-A")
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "commit", "-am", "Branch commit")
assert.NilError(t, err)

_, err = gitWithinDir(gitDir, "checkout", "master")
assert.NilError(t, err)
must(gitWithinDir(gitDir, "add", "-A"))
must(gitWithinDir(gitDir, "commit", "-am", "Branch commit"))
must(gitWithinDir(gitDir, "checkout", "master"))

// set up submodule
subrepoDir := filepath.Join(root, "subrepo")
_, err = git("init", subrepoDir)
assert.NilError(t, err)

_, err = gitWithinDir(subrepoDir, "config", "user.email", "test@docker.com")
assert.NilError(t, err)

_, err = gitWithinDir(subrepoDir, "config", "user.name", "Docker test")
assert.NilError(t, err)
must(git("-c", "init.defaultBranch=master", "init", subrepoDir))
must(gitWithinDir(subrepoDir, "config", "user.email", "test@docker.com"))
must(gitWithinDir(subrepoDir, "config", "user.name", "Docker test"))

err = ioutil.WriteFile(filepath.Join(subrepoDir, "subfile"), []byte("subcontents"), 0644)
assert.NilError(t, err)
assert.NilError(t, os.WriteFile(filepath.Join(subrepoDir, "subfile"), []byte("subcontents"), 0644))

_, err = gitWithinDir(subrepoDir, "add", "-A")
assert.NilError(t, err)

_, err = gitWithinDir(subrepoDir, "commit", "-am", "Subrepo initial")
assert.NilError(t, err)
must(gitWithinDir(subrepoDir, "add", "-A"))
must(gitWithinDir(subrepoDir, "commit", "-am", "Subrepo initial"))

cmd := exec.Command("git", "submodule", "add", subrepoDir, "sub") // this command doesn't work with --work-tree
cmd.Dir = gitDir
assert.NilError(t, cmd.Run())

_, err = gitWithinDir(gitDir, "add", "-A")
assert.NilError(t, err)
must(cmd.CombinedOutput())

_, err = gitWithinDir(gitDir, "commit", "-am", "With submodule")
assert.NilError(t, err)
must(gitWithinDir(gitDir, "add", "-A"))
must(gitWithinDir(gitDir, "commit", "-am", "With submodule"))

type singleCase struct {
frag string
Expand Down Expand Up @@ -300,28 +266,30 @@ func TestCheckoutGit(t *testing.T) {
}

for _, c := range cases {
ref, subdir := getRefAndSubdir(c.frag)
r, err := cloneGitRepo(gitRepo{remote: gitDir, ref: ref, subdir: subdir})

if c.fail {
assert.Check(t, is.ErrorContains(err, ""))
continue
}
assert.NilError(t, err)
defer os.RemoveAll(r)
if c.submodule {
b, err := ioutil.ReadFile(filepath.Join(r, "sub/subfile"))
t.Run(c.frag, func(t *testing.T) {
ref, subdir := getRefAndSubdir(c.frag)
r, err := cloneGitRepo(gitRepo{remote: gitDir, ref: ref, subdir: subdir})

if c.fail {
assert.Check(t, is.ErrorContains(err, ""))
return
}
assert.NilError(t, err)
assert.Check(t, is.Equal("subcontents", string(b)))
} else {
_, err := os.Stat(filepath.Join(r, "sub/subfile"))
assert.Assert(t, is.ErrorContains(err, ""))
assert.Assert(t, os.IsNotExist(err))
}

b, err := ioutil.ReadFile(filepath.Join(r, "Dockerfile"))
assert.NilError(t, err)
assert.Check(t, is.Equal(c.exp, string(b)))
defer os.RemoveAll(r)
if c.submodule {
b, err := os.ReadFile(filepath.Join(r, "sub/subfile"))
assert.NilError(t, err)
assert.Check(t, is.Equal("subcontents", string(b)))
} else {
_, err := os.Stat(filepath.Join(r, "sub/subfile"))
assert.Assert(t, is.ErrorContains(err, ""))
assert.Assert(t, os.IsNotExist(err))
}

b, err := os.ReadFile(filepath.Join(r, "Dockerfile"))
assert.NilError(t, err)
assert.Check(t, is.Equal(c.exp, string(b)))
})
}
}

Expand Down

0 comments on commit 8816c3c

Please sign in to comment.