Merge pull request cli#11481 from cli/eugene/test-for-release-FetchRefSHA

add test for FetchRefSHA

Author: ejahnGithub

pkg/cmd/release/shared/fetch.go

@@ -136,7 +136,7 @@ type fetchResult struct {
 }
 
 func FetchRefSHA(ctx context.Context, httpClient *http.Client, repo ghrepo.Interface, tagName string) (string, error) {
-	path := fmt.Sprintf("repos/%s/%s/git/refs/tags/%s", repo.RepoOwner(), repo.RepoName(), tagName)
+	path := fmt.Sprintf("repos/%s/%s/git/ref/tags/%s", repo.RepoOwner(), repo.RepoName(), tagName)
 	req, err := http.NewRequestWithContext(ctx, "GET", ghinstance.RESTPrefix(repo.RepoHost())+path, nil)
 	if err != nil {
 		return "", err
@@ -150,7 +150,6 @@ func FetchRefSHA(ctx context.Context, httpClient *http.Client, repo ghrepo.Inter
 
 	if resp.StatusCode == http.StatusNotFound {
 		_, _ = io.Copy(io.Discard, resp.Body)
-		// ErrRefNotFound
 		return "", ErrReleaseNotFound
 	}
 
@@ -163,9 +162,9 @@ func FetchRefSHA(ctx context.Context, httpClient *http.Client, repo ghrepo.Inter
 			SHA string `json:"sha"`
 		} `json:"object"`
 	}
+
 	if err := json.NewDecoder(resp.Body).Decode(&ref); err != nil {
-		// release not found
-		return "", ErrReleaseNotFound
+		return "", fmt.Errorf("failed to parse ref response: %w", err)
 	}
 
 	return ref.Object.SHA, nil
@@ -288,7 +287,7 @@ func StubFetchRelease(t *testing.T, reg *httpmock.Registry, owner, repoName, tag
 }
 
 func StubFetchRefSHA(t *testing.T, reg *httpmock.Registry, owner, repoName, tagName, sha string) {
-	path := fmt.Sprintf("repos/%s/%s/git/refs/tags/%s", owner, repoName, tagName)
+	path := fmt.Sprintf("repos/%s/%s/git/ref/tags/%s", owner, repoName, tagName)
 	reg.Register(
 		httpmock.REST("GET", path),
 		httpmock.StringResponse(fmt.Sprintf(`{"object": {"sha": "%s"}}`, sha)),

pkg/cmd/release/shared/fetch_test.go

@@ -0,0 +1,94 @@
+package shared
+
+import (
+	"context"
+	"net/http"
+	"testing"
+
+	"github.com/cli/go-gh/v2/pkg/api"
+
+	"github.com/cli/cli/v2/internal/ghrepo"
+	"github.com/cli/cli/v2/pkg/httpmock"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestFetchRefSHA(t *testing.T) {
+	tests := []struct {
+		name            string
+		tagName         string
+		responseStatus  int
+		responseBody    string
+		responseMessage string
+		expectedSHA     string
+		errorMessage    string
+	}{
+		{
+			name:           "match (200)",
+			tagName:        "v1.2.3",
+			responseStatus: 200,
+			responseBody:   `{"object": {"sha": "1234567890abcdef1234567890abcdef12345678"}}`,
+			expectedSHA:    "1234567890abcdef1234567890abcdef12345678",
+		},
+		{
+			name:            "non-match (404)",
+			tagName:         "v1.2.3",
+			responseStatus:  404,
+			responseMessage: `Not found`,
+			errorMessage:    "release not found",
+		},
+		{
+			name:            "server error (500)",
+			tagName:         "v1.2.3",
+			responseStatus:  500,
+			responseMessage: `arbitrary error"`,
+			errorMessage:    "HTTP 500: arbitrary error\" (https://api.github.com/repos/owner/repo/git/ref/tags/v1.2.3)",
+		},
+		{
+			name:           "malformed JSON with 200",
+			tagName:        "v1.2.3",
+			responseStatus: 200,
+			responseBody:   `{"object": {"sha":`,
+			errorMessage:   "failed to parse ref response: unexpected EOF",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			fakeHTTP := &httpmock.Registry{}
+			defer fakeHTTP.Verify(t)
+
+			repo, err := ghrepo.FromFullName("owner/repo")
+			require.NoError(t, err)
+
+			path := "repos/owner/repo/git/ref/tags/" + tt.tagName
+			if tt.responseStatus == 404 || tt.responseStatus == 500 {
+				fakeHTTP.Register(
+					httpmock.REST("GET", path),
+					httpmock.JSONErrorResponse(tt.responseStatus, api.HTTPError{
+						StatusCode: tt.responseStatus,
+						Message:    tt.responseMessage,
+					}),
+				)
+			} else {
+				fakeHTTP.Register(
+					httpmock.REST("GET", path),
+					httpmock.StatusStringResponse(tt.responseStatus, tt.responseBody),
+				)
+			}
+
+			httpClient := &http.Client{Transport: fakeHTTP}
+			ctx := context.Background()
+
+			sha, err := FetchRefSHA(ctx, httpClient, repo, tt.tagName)
+
+			if tt.errorMessage != "" {
+				assert.Contains(t, err.Error(), tt.errorMessage)
+				assert.Empty(t, sha)
+			} else {
+				require.NoError(t, err)
+				assert.Equal(t, tt.expectedSHA, sha)
+			}
+		})
+	}
+}