[Bitbucket Server] Implements the GetMe method #128
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,9 @@ | ||
| package bitbucketclient | ||
|
|
||
| type Client interface { | ||
| GetMe() (*BitbucketUser, error) | ||
| } | ||
|
|
||
| type BitbucketClient struct { | ||
| ClientConfiguration | ||
| } |
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,96 @@ | ||
| package bitbucketclient | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // TODO: This will be changed to create the main structs when modularized | ||
| type Link struct { | ||
| Href string `json:"href"` | ||
| } | ||
|
|
||
| type BitbucketUser struct { | ||
| AccountID int `json:"id"` | ||
| Username string `json:"name"` | ||
| Links struct { | ||
| Self []Link `json:"self"` | ||
| } `json:"links"` | ||
| } | ||
|
|
||
| type BitbucketServerClient struct { | ||
| BitbucketClient | ||
| } | ||
|
|
||
| func newServerClient(config ClientConfiguration) Client { | ||
| return &BitbucketServerClient{ | ||
| BitbucketClient: BitbucketClient{ | ||
| ClientConfiguration: ClientConfiguration{ | ||
| SelfHostedURL: config.SelfHostedURL, | ||
| SelfHostedAPIURL: config.SelfHostedAPIURL, | ||
| APIClient: config.APIClient, | ||
| OAuthClient: config.OAuthClient, | ||
| LogError: config.LogError, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (c *BitbucketServerClient) getWhoAmI() (string, error) { | ||
| requestURL := fmt.Sprintf("%s/plugins/servlet/applinks/whoami", c.SelfHostedURL) | ||
|
|
||
| req, err := http.NewRequest("GET", requestURL, nil) | ||
| if err != nil { | ||
| return "", errors.Wrap(err, "unable to create request for getting whoami identity") | ||
| } | ||
|
|
||
| resp, err := c.OAuthClient.Do(req) | ||
| if err != nil { | ||
| return "", errors.Wrap(err, "failed to make the request for getting whoami identity") | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != 200 { | ||
| return "", errors.Errorf("who am i returned non-200 status code: %d", resp.StatusCode) | ||
| } | ||
|
|
||
| user, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| return "", errors.Wrap(err, "failed to make the request for getting whoami identity") | ||
| } | ||
|
|
||
| return string(user), nil | ||
| } | ||
|
|
||
| func (c *BitbucketServerClient) GetMe() (*BitbucketUser, error) { | ||
| username, err := c.getWhoAmI() | ||
| if err != nil { | ||
| c.LogError("failed to get whoami identity", "error", err.Error()) | ||
| return nil, err | ||
| } | ||
|
|
||
| resp, err := c.APIClient.DefaultApi.GetUser(username) | ||
| if err != nil { | ||
| c.LogError("failed to get user from bitbucket server", "error", err.Error()) | ||
| return nil, err | ||
| } | ||
|
|
||
| jsonData, err := json.Marshal(resp.Values) | ||
| if err != nil { | ||
| c.LogError("failed to marshaling user from bitbucket server", "error", err.Error()) | ||
| return nil, err | ||
| } | ||
|
|
||
| var user BitbucketUser | ||
| err = json.Unmarshal(jsonData, &user) | ||
| if err != nil { | ||
| c.LogError("failed to parse user from bitbucket server", "error", err.Error()) | ||
| return nil, err | ||
| } | ||
|
|
||
| return &user, nil | ||
| } | ||
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,52 @@ | ||
| package bitbucketclient | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| bitbucketv1 "github.com/gfleury/go-bitbucket-v1" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| type MockAPIClient struct { | ||
| mock.Mock | ||
| } | ||
|
|
||
| func (m *MockAPIClient) GetUser(_ string) (*bitbucketv1.APIResponse, error) { | ||
| args := m.Called() | ||
| return args.Get(0).(*bitbucketv1.APIResponse), args.Error(1) | ||
| } | ||
|
|
||
| func TestGetWhoAmI(t *testing.T) { | ||
| t.Run("successfully get who am i from oauth", func(t *testing.T) { | ||
| ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| _, err := w.Write([]byte("testuser")) | ||
| if err != nil { | ||
| t.Fatalf("Failed to write response: %v", err) | ||
| } | ||
| })) | ||
| defer ts.Close() | ||
|
|
||
| client := newServerClient(ClientConfiguration{SelfHostedURL: ts.URL, OAuthClient: ts.Client()}).(*BitbucketServerClient) | ||
|
|
||
| username, err := client.getWhoAmI() | ||
|
|
||
| assert.Nil(t, err) | ||
| assert.Equal(t, "testuser", username) | ||
| }) | ||
|
|
||
| t.Run("return error when the status code is different than 200", func(t *testing.T) { | ||
| ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusBadRequest) | ||
| })) | ||
| defer ts.Close() | ||
|
|
||
| client := newServerClient(ClientConfiguration{SelfHostedURL: ts.URL, OAuthClient: ts.Client()}).(*BitbucketServerClient) | ||
|
|
||
| _, err := client.getWhoAmI() | ||
| assert.Error(t, err) | ||
| }) | ||
| } |
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,24 @@ | ||
| package bitbucketclient | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| bitbucketv1 "github.com/gfleury/go-bitbucket-v1" | ||
| ) | ||
|
|
||
| type ClientConfiguration struct { | ||
| SelfHostedURL string | ||
| SelfHostedAPIURL string | ||
|
Comment on lines
+11
to
+12
There was a problem hiding this comment. I've been thinking that this |
||
| APIClient *bitbucketv1.APIClient | ||
| OAuthClient *http.Client | ||
|
|
||
| LogError func(msg string, keyValuePairs ...interface{}) | ||
| } | ||
|
|
||
| func GetBitbucketClient(clientType string, config ClientConfiguration) (Client, error) { | ||
| if clientType == "server" { | ||
| return newServerClient(config), nil | ||
| } | ||
| return nil, fmt.Errorf("wrong client passed") | ||
| } | ||
|
Comment on lines
+19
to
+24
There was a problem hiding this comment. Just an idea, but I'm thinking having two different functions for creating the two clients may be more Go-idiomatic. So having a |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So we would make this function capitalized/exported if we want to expose it