fix regression in support for detached HEAD state

metalogical · metalogical · commit 3bb6983b3503 · 2020-06-10T11:41:44.000-07:00
for gh pr status
diff --git a/command/pr.go b/command/pr.go
@@ -116,7 +116,7 @@ func prStatus(cmd *cobra.Command, args []string) error {
 	repoOverride, _ := cmd.Flags().GetString("repo")
 	currentPRNumber, currentPRHeadRef, err := prSelectorForCurrentBranch(ctx, baseRepo)
 
-	if err != nil && repoOverride == "" && err.Error() != "git: not on any branch" {
+	if err != nil && repoOverride == "" && err != git.ErrNotOnAnyBranch {
 		return fmt.Errorf("could not query for pull request for current branch: %w", err)
 	}
 
diff --git a/context/context.go b/context/context.go
@@ -207,7 +207,11 @@ func (c *fsContext) Branch() (string, error) {
 	}
 
 	currentBranch, err := git.CurrentBranch()
-	if err != nil {
+	switch err {
+	case nil:
+	case git.ErrNotOnAnyBranch:
+		return "", err
+	default:
 		return "", fmt.Errorf("could not determine current branch: %w", err)
 	}
 
diff --git a/git/git.go b/git/git.go
@@ -13,6 +13,9 @@ import (
 	"github.com/cli/cli/internal/run"
 )
 
+// ErrNotOnAnyBranch indicates that the users is in detached HEAD state
+var ErrNotOnAnyBranch = errors.New("git: not on any branch")
+
 // Ref represents a git commit reference
 type Ref struct {
 	Hash string
@@ -64,7 +67,7 @@ func CurrentBranch() (string, error) {
 	if errors.As(err, &cmdErr) {
 		if cmdErr.Stderr.Len() == 0 {
 			// Detached head
-			return "", errors.New("git: not on any branch")
+			return "", ErrNotOnAnyBranch
 		}
 	}
 
diff --git a/git/git_test.go b/git/git_test.go
@@ -67,9 +67,8 @@ func Test_CurrentBranch_detached_head(t *testing.T) {
 	if err == nil {
 		t.Errorf("expected an error")
 	}
-	expectedError := "git: not on any branch"
-	if err.Error() != expectedError {
-		t.Errorf("got unexpected error: %s instead of %s", err.Error(), expectedError)
+	if err != ErrNotOnAnyBranch {
+		t.Errorf("got unexpected error: %s instead of %s", err, ErrNotOnAnyBranch)
 	}
 	if len(cs.Calls) != 1 {
 		t.Errorf("expected 1 git call, saw %d", len(cs.Calls))

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ func prStatus(cmd *cobra.Command, args []string) error {`
`116`	`116`	`repoOverride, _ := cmd.Flags().GetString("repo")`
`117`	`117`	`currentPRNumber, currentPRHeadRef, err := prSelectorForCurrentBranch(ctx, baseRepo)`
`118`	`118`
`119`		`- if err != nil && repoOverride == "" && err.Error() != "git: not on any branch" {`
	`119`	`+ if err != nil && repoOverride == "" && err != git.ErrNotOnAnyBranch {`
`120`	`120`	`return fmt.Errorf("could not query for pull request for current branch: %w", err)`
`121`	`121`	`}`
`122`	`122`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,11 @@ func (c *fsContext) Branch() (string, error) {`
`207`	`207`	`}`
`208`	`208`
`209`	`209`	`currentBranch, err := git.CurrentBranch()`
`210`		`- if err != nil {`
	`210`	`+ switch err {`
	`211`	`+ case nil:`
	`212`	`+ case git.ErrNotOnAnyBranch:`
	`213`	`+ return "", err`
	`214`	`+ default:`
`211`	`215`	`return "", fmt.Errorf("could not determine current branch: %w", err)`
`212`	`216`	`}`
`213`	`217`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ import (`
`13`	`13`	`"github.com/cli/cli/internal/run"`
`14`	`14`	`)`
`15`	`15`
	`16`	`+// ErrNotOnAnyBranch indicates that the users is in detached HEAD state`
	`17`	`+var ErrNotOnAnyBranch = errors.New("git: not on any branch")`
	`18`	`+`
`16`	`19`	`// Ref represents a git commit reference`
`17`	`20`	`type Ref struct {`
`18`	`21`	`Hash string`
`@@ -64,7 +67,7 @@ func CurrentBranch() (string, error) {`
`64`	`67`	`if errors.As(err, &cmdErr) {`
`65`	`68`	`if cmdErr.Stderr.Len() == 0 {`
`66`	`69`	`// Detached head`
`67`		`- return "", errors.New("git: not on any branch")`
	`70`	`+ return "", ErrNotOnAnyBranch`
`68`	`71`	`}`
`69`	`72`	`}`
`70`	`73`
Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,8 @@ func Test_CurrentBranch_detached_head(t *testing.T) {`
`67`	`67`	`if err == nil {`
`68`	`68`	`t.Errorf("expected an error")`
`69`	`69`	`}`
`70`		`- expectedError := "git: not on any branch"`
`71`		`- if err.Error() != expectedError {`
`72`		`- t.Errorf("got unexpected error: %s instead of %s", err.Error(), expectedError)`
	`70`	`+ if err != ErrNotOnAnyBranch {`
	`71`	`+ t.Errorf("got unexpected error: %s instead of %s", err, ErrNotOnAnyBranch)`
`73`	`72`	`}`
`74`	`73`	`if len(cs.Calls) != 1 {`
`75`	`74`	`t.Errorf("expected 1 git call, saw %d", len(cs.Calls))`