-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding Logic and Tests for Authorization token to only be used if its…
… provided (#227)
- Loading branch information
1 parent
1035ca1
commit 4dc2025
Showing
7 changed files
with
209 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| package ghcr | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/google/go-github/v62/github" | ||
| "github.com/jarcoal/httpmock" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func setup() { | ||
| httpmock.Activate() | ||
| } | ||
|
|
||
| func teardown() { | ||
| httpmock.DeactivateAndReset() | ||
| } | ||
|
|
||
| func registerCommonResponders() { | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-user-owner", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| return httpmock.NewStringResponse(200, `{"type":"User"}`), nil | ||
| }) | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-org-owner", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| return httpmock.NewStringResponse(200, `{"type":"Organization"}`), nil | ||
| }) | ||
| } | ||
|
|
||
| func registerTagResponders() { | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-user-owner/packages/container/test-repo/versions", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| return httpmock.NewStringResponse(200, `[ | ||
| { | ||
| "name": "sha123", | ||
| "metadata": { | ||
| "container": { | ||
| "tags": ["tag1", "tag2"] | ||
| } | ||
| }, | ||
| "created_at": "2023-07-08T12:34:56Z" | ||
| } | ||
| ]`), nil | ||
| }) | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/orgs/test-org-owner/packages/container/test-repo/versions", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| return httpmock.NewStringResponse(200, `[ | ||
| { | ||
| "name": "sha123", | ||
| "metadata": { | ||
| "container": { | ||
| "tags": ["tag1", "tag2"] | ||
| } | ||
| }, | ||
| "created_at": "2023-07-08T12:34:56Z" | ||
| } | ||
| ]`), nil | ||
| }) | ||
| } | ||
|
|
||
| func TestClient_Tags(t *testing.T) { | ||
| setup() | ||
| defer teardown() | ||
|
|
||
| ctx := context.Background() | ||
| host := "ghcr.io" | ||
|
|
||
| t.Run("successful tags fetch", func(t *testing.T) { | ||
| httpmock.Reset() | ||
| registerCommonResponders() | ||
| registerTagResponders() | ||
|
|
||
| client := New(Options{}) | ||
| client.client = github.NewClient(nil) // Use the default HTTP client | ||
|
|
||
| tags, err := client.Tags(ctx, host, "test-user-owner", "test-repo") | ||
| assert.NoError(t, err) | ||
| assert.Len(t, tags, 2) | ||
| assert.Equal(t, "tag1", tags[0].Tag) | ||
| assert.Equal(t, "tag2", tags[1].Tag) | ||
| }) | ||
|
|
||
| t.Run("failed to fetch owner type", func(t *testing.T) { | ||
| httpmock.Reset() | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-user-owner", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| return httpmock.NewStringResponse(404, `{"message": "Not Found"}`), nil | ||
| }) | ||
|
|
||
| client := New(Options{}) | ||
| client.client = github.NewClient(nil) // Use the default HTTP client | ||
|
|
||
| _, err := client.Tags(ctx, host, "test-user-owner", "test-repo") | ||
| assert.Error(t, err) | ||
| }) | ||
|
|
||
| t.Run("token not set, no authorization header", func(t *testing.T) { | ||
| httpmock.Reset() | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-user-owner", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| if req.Header.Get("Authorization") != "" { | ||
| t.Errorf("expected no Authorization header, got %s", req.Header.Get("Authorization")) | ||
| } | ||
| return httpmock.NewStringResponse(200, `{"type":"User"}`), nil | ||
| }) | ||
| registerTagResponders() | ||
|
|
||
| client := New(Options{}) // No token provided | ||
| client.client = github.NewClient(nil) | ||
|
|
||
| _, err := client.Tags(ctx, host, "test-user-owner", "test-repo") | ||
| assert.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("token set, authorization header sent", func(t *testing.T) { | ||
| token := "test-token" | ||
| httpmock.Reset() | ||
| httpmock.RegisterResponder("GET", "https://api.github.com/users/test-user-owner", | ||
| func(req *http.Request) (*http.Response, error) { | ||
| authHeader := req.Header.Get("Authorization") | ||
| expectedAuthHeader := "Bearer " + token | ||
| if authHeader != expectedAuthHeader { | ||
| t.Errorf("expected Authorization header %s, got %s", expectedAuthHeader, authHeader) | ||
| } | ||
| return httpmock.NewStringResponse(200, `{"type":"User"}`), nil | ||
| }) | ||
|
|
||
| registerTagResponders() | ||
|
|
||
| client := New(Options{Token: token}) | ||
|
|
||
| _, err := client.Tags(ctx, host, "test-user-owner", "test-repo") | ||
| assert.NoError(t, err) | ||
| }) | ||
|
|
||
| t.Run("ownerType returns user", func(t *testing.T) { | ||
| httpmock.Reset() | ||
| registerCommonResponders() | ||
| registerTagResponders() | ||
|
|
||
| client := New(Options{}) | ||
| client.client = github.NewClient(nil) // Use the default HTTP client | ||
|
|
||
| tags, err := client.Tags(ctx, host, "test-user-owner", "test-repo") | ||
| assert.NoError(t, err) | ||
| assert.Len(t, tags, 2) | ||
| assert.Equal(t, "tag1", tags[0].Tag) | ||
| assert.Equal(t, "tag2", tags[1].Tag) | ||
| }) | ||
|
|
||
| t.Run("ownerType returns org", func(t *testing.T) { | ||
| httpmock.Reset() | ||
| registerCommonResponders() | ||
| registerTagResponders() | ||
|
|
||
| client := New(Options{}) | ||
| client.client = github.NewClient(nil) // Use the default HTTP client | ||
|
|
||
| tags, err := client.Tags(ctx, host, "test-org-owner", "test-repo") | ||
| assert.NoError(t, err) | ||
| assert.Len(t, tags, 2) | ||
| assert.Equal(t, "tag1", tags[0].Tag) | ||
| assert.Equal(t, "tag2", tags[1].Tag) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters