disambiguate directory and branch names via --

Author: gabemontero

pkg/generate/git/repository.go

@@ -293,7 +293,7 @@ func (r *repository) Checkout(location string, ref string) error {
 	if r.shallow {
 		return errors.New("cannot checkout ref on shallow clone")
 	}
-	_, _, err := r.git(location, "checkout", ref)
+	_, _, err := r.git(location, "checkout", ref, "--")
 	return err
 }
 

pkg/generate/git/repository_test.go

@@ -1,6 +1,12 @@
 package git
 
 import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
 	"testing"
 	"time"
 )
@@ -147,3 +153,147 @@ type timedCommandOutput struct {
 	stderr string
 	err    error
 }
+
+type testGitRepo struct {
+	Name string
+	Path string
+}
+
+func initializeTestGitRepo(name string) (*testGitRepo, error) {
+	repo := &testGitRepo{Name: name}
+	dir, err := ioutil.TempDir("", "test-"+repo.Name)
+	if err != nil {
+		return repo, err
+	}
+	repo.Path = dir
+	tmpfn := filepath.Join(dir, "initial-file")
+	if err := ioutil.WriteFile(tmpfn, []byte("test"), 0666); err != nil {
+		return repo, fmt.Errorf("unable to create temporary file")
+	}
+	initCmd := exec.Command("git", "init")
+	initCmd.Dir = dir
+	if out, err := initCmd.CombinedOutput(); err != nil {
+		return repo, fmt.Errorf("unable to initialize repository: %q", out)
+	}
+
+	configEmailCmd := exec.Command("git", "config", "user.email", "[email protected]")
+	configEmailCmd.Dir = dir
+	if out, err := configEmailCmd.CombinedOutput(); err != nil {
+		return repo, fmt.Errorf("unable to set git email prefs: %q", out)
+	}
+	configNameCmd := exec.Command("git", "config", "user.name", "Me Myself")
+	configNameCmd.Dir = dir
+	if out, err := configNameCmd.CombinedOutput(); err != nil {
+		return repo, fmt.Errorf("unable to set git name prefs: %q", out)
+	}
+	addCmd := exec.Command("git", "add", "initial-file")
+	addCmd.Dir = dir
+	if out, err := addCmd.CombinedOutput(); err != nil {
+		return repo, fmt.Errorf("unable to add  file: %q", out)
+	}
+	commitCmd := exec.Command("git", "commit", "-a", "-m", "repo create")
+	commitCmd.Dir = dir
+	if out, err := commitCmd.CombinedOutput(); err != nil {
+		return repo, fmt.Errorf("problem committing files %q", out)
+	}
+	return repo, nil
+}
+
+func TestCheckoutWithBranchAndDirWithSameName(t *testing.T) {
+	gitClient := NewRepository()
+	testRepo, err := initializeTestGitRepo("test")
+	defer os.RemoveAll(testRepo.Path)
+	if err != nil {
+		t.Errorf("problem creating test git repo: %v", err)
+	}
+
+	// first, create branch "openshift" off of empty repo
+	brCmd := exec.Command("git", "branch", "openshift")
+	brCmd.Dir = testRepo.Path
+	if out, err := brCmd.CombinedOutput(); err != nil {
+		t.Errorf("problem creating openshift branch: %q", out)
+	}
+
+	// second, switch back to master, create openshift dir with file foo, commit
+	err = gitClient.Checkout(testRepo.Path, "master")
+	if err != nil {
+		t.Errorf("problem switching to master: %v", err)
+	}
+
+	dirname := filepath.Join(testRepo.Path, "openshift")
+	err = os.Mkdir(dirname, 0700)
+	if err != nil {
+		t.Errorf("problem creating openshift dir: %v", err)
+	}
+	filename := filepath.Join(dirname, "foo")
+	_, err = os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_EXCL, 0600)
+	if err != nil {
+		t.Errorf("problem creating file foo: %v", err)
+	}
+
+	addCmd := exec.Command("git", "add", "openshift")
+	addCmd.Dir = testRepo.Path
+	if out, err := addCmd.CombinedOutput(); err != nil {
+		t.Errorf("problem adding files: %q", out)
+	}
+	commitCmd := exec.Command("git", "commit", "-a", "-m", "openshift dir create")
+	commitCmd.Dir = testRepo.Path
+	if out, err := commitCmd.CombinedOutput(); err != nil {
+		t.Errorf("problem committing files %q", out)
+	}
+
+	// validate that after clone, a checkout of openshift results in a branch checkout
+	// and not a dir checkout (since we use "--" on checkout) ...note:  we only see this after a clone; on the initial
+	// repo creation above, vanilla checkout (whithout "--") would still result in the branch getting checked out
+	// vs. the dir
+
+	// create new dir, clone test repo
+	dir, err := ioutil.TempDir("", "newlocation")
+	if err != nil {
+		t.Errorf("%v", err)
+	}
+	defer os.RemoveAll(dir)
+
+	cloneCmd := exec.Command("git", "clone", "file://"+testRepo.Path)
+	cloneCmd.Dir = dir
+	if out, err := cloneCmd.CombinedOutput(); err != nil {
+		t.Errorf("problem cloning test repo: %q", out)
+	}
+
+	newRepoLocation := filepath.Join(dir, filepath.Base(testRepo.Path))
+	// per http://stackoverflow.com/questions/1783405/how-to-check-out-a-remote-git-branch
+	// do a git fetch before git checkout, though this has been unnecessary in local testing
+	fetchCmd := exec.Command("git", "fetch")
+	fetchCmd.Dir = newRepoLocation
+	if out, err := fetchCmd.CombinedOutput(); err != nil {
+		t.Errorf("problem with fetch %q", out)
+	}
+	err = gitClient.Checkout(newRepoLocation, "openshift")
+	if err != nil {
+		vcmd := exec.Command("git", "version")
+		vcmd.Dir = newRepoLocation
+		version := ""
+		if out, err := vcmd.CombinedOutput(); err == nil {
+			version = string(out)
+			t.Logf("git version is %s", version)
+		}
+		bcmd := exec.Command("git", "branch", "-r")
+		bcmd.Dir = newRepoLocation
+		allbranches := ""
+		if out, err := bcmd.CombinedOutput(); err == nil {
+			t.Logf("branches in new repo %q", out)
+			allbranches = string(out)
+		}
+		t.Errorf("problem switching to openshift using version %s from within %s, where all branches are %s: %v", version, newRepoLocation, allbranches, err)
+	}
+
+	statusCmd := exec.Command("git", "status")
+	statusCmd.Dir = newRepoLocation
+	if out, err := statusCmd.CombinedOutput(); err != nil {
+		t.Errorf("unable to run git status %q", out)
+	} else {
+		if !strings.Contains(string(out), "branch openshift") {
+			t.Errorf("expected to be on branch openshift, but instead: %q", out)
+		}
+	}
+}