Add a function to get a commit information from its SHA (#11)

Author: vitaliil-jfrog

README.md

@@ -24,7 +24,8 @@ Currently supported providers are: [GitHub](#github), [Bitbucket Server](#bitbuc
   - [Delete Webhook](#delete-webhook)
   - [Set Commit Status](#set-commit-status)
   - [Create Pull Request](#create-pull-request)
-  - [Latest Commit Hash](#get-latest-commit-hash)
+  - [Get Latest Commit](#get-latest-commit)
+  - [Get Commit By SHA](#get-commit-by-sha)
   - [Add Public SSH Key](#add-public-ssh-key)
   - [Get Repository Info](#get-repository-info)
 - [Webhook Parser](#webhook-parser)
@@ -251,7 +252,7 @@ description := "Pull request description"
 err := client.CreatePullRequest(ctx, owner, repository, sourceBranch, targetBranch, title, description string)
 ```
 
-#### Get Latest Commit Hash
+#### Get Latest Commit
 
 ```go
 // Go context
@@ -263,8 +264,24 @@ repository := "jfrog-cli"
 // VCS branch
 branch := "dev"
 
-// SHA-1 hash of the latest commit
-commitHash, err := client.GetLatestCommitHash(ctx, owner, repository, branch)
+// Commit information of the latest commit
+commitInfo, err := client.GetLatestCommit(ctx, owner, repository, branch)
+```
+
+#### Get Commit By SHA
+
+```go
+// Go context
+ctx := context.Background()
+// Organization or username
+owner := "jfrog"
+// VCS repository
+repository := "jfrog-cli"
+// SHA-1 hash of the commit
+sha := "abcdef0123abcdef4567abcdef8987abcdef6543"
+
+// Commit information of requested commit
+commitInfo, err := client.GetCommitBySha(ctx, owner, repository, sha)
 ```
 
 #### Add Public SSH Key

vcsclient/bitbucketcloud.go

@@ -274,19 +274,7 @@ func (client *BitbucketCloudClient) GetLatestCommit(ctx context.Context, owner,
 	}
 	if len(parsedCommits.Values) > 0 {
 		latestCommit := parsedCommits.Values[0]
-		parents := make([]string, len(latestCommit.Parents))
-		for i, p := range latestCommit.Parents {
-			parents[i] = p.Hash
-		}
-		return CommitInfo{
-			Hash:          latestCommit.Hash,
-			AuthorName:    latestCommit.Author.User.DisplayName,
-			CommitterName: "", // not provided
-			Url:           latestCommit.Links.Self.Href,
-			Timestamp:     latestCommit.Date.UTC().Unix(),
-			Message:       latestCommit.Message,
-			ParentHashes:  parents,
-		}, nil
+		return mapBitbucketCloudCommitToCommitInfo(latestCommit), nil
 	}
 	return CommitInfo{}, nil
 }
@@ -327,6 +315,33 @@ func (client *BitbucketCloudClient) GetRepositoryInfo(ctx context.Context, owner
 	return RepositoryInfo{CloneInfo: info}, nil
 }
 
+func (client *BitbucketCloudClient) GetCommitBySha(ctx context.Context, owner, repository, sha string) (CommitInfo, error) {
+	err := validateParametersNotBlank(map[string]string{
+		"owner":      owner,
+		"repository": repository,
+		"sha":        sha,
+	})
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	bitbucketClient := client.buildBitbucketCloudClient(ctx)
+	options := &bitbucket.CommitsOptions{
+		Owner:    owner,
+		RepoSlug: repository,
+		Revision: sha,
+	}
+	commit, err := bitbucketClient.Repositories.Commits.GetCommit(options)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+	parsedCommit, err := extractCommitDetailsFromResponse(commit)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+	return mapBitbucketCloudCommitToCommitInfo(parsedCommit), nil
+}
+
 func extractCommitFromResponse(commits interface{}) (*commitResponse, error) {
 	var res commitResponse
 	b, err := json.Marshal(commits)
@@ -340,6 +355,19 @@ func extractCommitFromResponse(commits interface{}) (*commitResponse, error) {
 	return &res, nil
 }
 
+func extractCommitDetailsFromResponse(commit interface{}) (commitDetails, error) {
+	var res commitDetails
+	b, err := json.Marshal(commit)
+	if err != nil {
+		return commitDetails{}, err
+	}
+	err = json.Unmarshal(b, &res)
+	if err != nil {
+		return commitDetails{}, err
+	}
+	return res, nil
+}
+
 type commitResponse struct {
 	Values []commitDetails `json:"values"`
 }
@@ -412,3 +440,19 @@ func getDownloadLink(repo *bitbucket.Repository, branch string) (string, error)
 	}
 	return htmlLink + "/get/" + branch + ".tar.gz", err
 }
+
+func mapBitbucketCloudCommitToCommitInfo(parsedCommit commitDetails) CommitInfo {
+	parents := make([]string, len(parsedCommit.Parents))
+	for i, p := range parsedCommit.Parents {
+		parents[i] = p.Hash
+	}
+	return CommitInfo{
+		Hash:          parsedCommit.Hash,
+		AuthorName:    parsedCommit.Author.User.DisplayName,
+		CommitterName: "", // not provided
+		Url:           parsedCommit.Links.Self.Href,
+		Timestamp:     parsedCommit.Date.UTC().Unix(),
+		Message:       parsedCommit.Message,
+		ParentHashes:  parents,
+	}
+}

vcsclient/bitbucketcloud_test.go

@@ -232,6 +232,46 @@ func TestBitbucketCloud_AddSshKeyToRepositoryNotFound(t *testing.T) {
 	require.EqualError(t, err, "404 Not Found")
 }
 
+func TestBitbucketCloud_GetCommitBySha(t *testing.T) {
+	ctx := context.Background()
+	sha := "f62ea5359e7af59880b4a5e23e0ce6c1b32b5d3c"
+	response, err := os.ReadFile(filepath.Join("testdata", "bitbucketcloud", "commit_single_response.json"))
+	assert.NoError(t, err)
+
+	client, cleanUp := createServerAndClient(t, vcsutils.BitbucketCloud, true, response,
+		fmt.Sprintf("/repositories/%s/%s/commit/%s", owner, repo1, sha), createBitbucketCloudHandler)
+	defer cleanUp()
+
+	result, err := client.GetCommitBySha(ctx, owner, repo1, sha)
+
+	require.NoError(t, err)
+	assert.Equal(t, CommitInfo{
+		Hash:          sha,
+		AuthorName:    "user",
+		CommitterName: "",
+		Url:           "https://api.bitbucket.org/2.0/repositories/user2/setup-jfrog-cli/commit/f62ea5359e7af59880b4a5e23e0ce6c1b32b5d3c",
+		Timestamp:     1591030449,
+		Message:       "Update image name\n",
+		ParentHashes:  []string{"f62ea5359e7af59880b4a5e23e0ce6c1b32b5d3c"},
+	}, result)
+}
+
+func TestBitbucketCloud_GetCommitByShaNotFound(t *testing.T) {
+	ctx := context.Background()
+	sha := "062ea5359e7af59880b4a5e23e0ce6c1b32b5d3c"
+	response := []byte(`<!DOCTYPE html><html lang="en"></html>`)
+
+	client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.BitbucketCloud, true, response,
+		fmt.Sprintf("/repositories/%s/%s/commit/%s", owner, repo1, sha),
+		http.StatusNotFound,
+		createBitbucketCloudHandler)
+	defer cleanUp()
+
+	result, err := client.GetCommitBySha(ctx, owner, repo1, sha)
+	require.EqualError(t, err, "404 Not Found")
+	assert.Empty(t, result)
+}
+
 func createBitbucketCloudWithBodyHandler(t *testing.T, expectedUri string, response []byte, expectedRequestBody []byte,
 	expectedStatusCode int, expectedHttpMethod string) http.HandlerFunc {
 	return func(writer http.ResponseWriter, request *http.Request) {

vcsclient/bitbucketserver.go

@@ -309,19 +309,7 @@ func (client *BitbucketServerClient) GetLatestCommit(ctx context.Context, owner,
 	}
 	if len(commits) > 0 {
 		latestCommit := commits[0]
-		parents := make([]string, len(latestCommit.Parents))
-		for i, p := range latestCommit.Parents {
-			parents[i] = p.ID
-		}
-		return CommitInfo{
-			Hash:          latestCommit.ID,
-			AuthorName:    latestCommit.Author.Name,
-			CommitterName: latestCommit.Committer.Name,
-			Url:           "", // URL not provided
-			Timestamp:     latestCommit.CommitterTimestamp,
-			Message:       latestCommit.Message,
-			ParentHashes:  parents,
-		}, nil
+		return mapBitbucketServerCommitToCommitInfo(latestCommit), nil
 	}
 	return CommitInfo{}, nil
 }
@@ -367,6 +355,33 @@ func (client *BitbucketServerClient) GetRepositoryInfo(ctx context.Context, owne
 	return RepositoryInfo{CloneInfo: info}, nil
 }
 
+func (client BitbucketServerClient) GetCommitBySha(ctx context.Context, owner, repository, sha string) (CommitInfo, error) {
+	err := validateParametersNotBlank(map[string]string{
+		"owner":      owner,
+		"repository": repository,
+		"sha":        sha,
+	})
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	bitbucketClient, err := client.buildBitbucketClient(ctx)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	apiResponse, err := bitbucketClient.GetCommit(owner, repository, sha, nil)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+	commit := bitbucketv1.Commit{}
+	err = unmarshalApiResponseValues(apiResponse, &commit)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+	return mapBitbucketServerCommitToCommitInfo(commit), nil
+}
+
 // Get all projects for which the authenticated user has the PROJECT_VIEW permission
 func (client *BitbucketServerClient) listProjects(bitbucketClient *bitbucketv1.DefaultApiService) ([]string, error) {
 	var apiResponse *bitbucketv1.APIResponse
@@ -439,3 +454,19 @@ func getBitbucketServerWebhookEvents(webhookEvents ...vcsutils.WebhookEvent) []s
 	}
 	return events
 }
+
+func mapBitbucketServerCommitToCommitInfo(commit bitbucketv1.Commit) CommitInfo {
+	parents := make([]string, len(commit.Parents))
+	for i, p := range commit.Parents {
+		parents[i] = p.ID
+	}
+	return CommitInfo{
+		Hash:          commit.ID,
+		AuthorName:    commit.Author.Name,
+		CommitterName: commit.Committer.Name,
+		Url:           "", // URL not provided
+		Timestamp:     commit.CommitterTimestamp,
+		Message:       commit.Message,
+		ParentHashes:  parents,
+	}
+}

vcsclient/bitbucketserver_test.go

@@ -293,6 +293,55 @@ func TestBitbucketServer_GetRepositoryInfo(t *testing.T) {
 	})
 }
 
+func TestBitbucketServer_GetCommitBySha(t *testing.T) {
+	ctx := context.Background()
+	sha := "abcdef0123abcdef4567abcdef8987abcdef6543"
+	response, err := os.ReadFile(filepath.Join("testdata", "bitbucketserver", "commit_single_response.json"))
+	assert.NoError(t, err)
+
+	client, cleanUp := createServerAndClient(t, vcsutils.BitbucketServer, false, response,
+		fmt.Sprintf("/api/1.0/projects/%s/repos/%s/commits/%s", owner, repo1, sha),
+		createBitbucketServerHandler)
+	defer cleanUp()
+
+	result, err := client.GetCommitBySha(ctx, owner, repo1, sha)
+
+	require.NoError(t, err)
+	assert.Equal(t, CommitInfo{
+		Hash:          sha,
+		AuthorName:    "charlie",
+		CommitterName: "mark",
+		Url:           "",
+		Timestamp:     1636089306104,
+		Message:       "WIP on feature 1",
+		ParentHashes:  []string{"bbcdef0123abcdef4567abcdef8987abcdef6543"},
+	}, result)
+}
+
+func TestBitbucketServer_GetCommitByShaNotFound(t *testing.T) {
+	ctx := context.Background()
+	sha := "bbcdef0123abcdef4567abcdef8987abcdef6543"
+	response := []byte(`{
+		"errors": [
+        	{
+            	"context": null,
+            	"exceptionName": "com.atlassian.bitbucket.project.NoSuchProjectException",
+            	"message": "Project unknown does not exist."
+        	}
+    	]
+	}`)
+	client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.BitbucketServer, false, response,
+		fmt.Sprintf("/api/1.0/projects/%s/repos/%s/commits/%s", owner, repo1, sha),
+		http.StatusNotFound, createBitbucketServerHandler)
+	defer cleanUp()
+
+	result, err := client.GetCommitBySha(ctx, owner, repo1, sha)
+
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "Status: 404 Not Found")
+	assert.Empty(t, result)
+}
+
 func createBitbucketServerHandler(t *testing.T, expectedUri string, response []byte, expectedStatusCode int) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(expectedStatusCode)

vcsclient/github.go

@@ -240,20 +240,7 @@ func (client *GitHubClient) GetLatestCommit(ctx context.Context, owner, reposito
 	}
 	if len(commits) > 0 {
 		latestCommit := commits[0]
-		parents := make([]string, len(latestCommit.Parents))
-		for i, c := range latestCommit.Parents {
-			parents[i] = c.GetSHA()
-		}
-		details := latestCommit.GetCommit()
-		return CommitInfo{
-			Hash:          latestCommit.GetSHA(),
-			AuthorName:    details.GetAuthor().GetName(),
-			CommitterName: details.GetCommitter().GetName(),
-			Url:           latestCommit.GetURL(),
-			Timestamp:     details.GetCommitter().GetDate().UTC().Unix(),
-			Message:       details.GetMessage(),
-			ParentHashes:  parents,
-		}, nil
+		return mapGitHubCommitToCommitInfo(latestCommit), nil
 	}
 	return CommitInfo{}, nil
 }
@@ -276,6 +263,29 @@ func (client *GitHubClient) GetRepositoryInfo(ctx context.Context, owner, reposi
 	return RepositoryInfo{CloneInfo: CloneInfo{HTTP: repo.GetCloneURL(), SSH: repo.GetSSHURL()}}, nil
 }
 
+func (client *GitHubClient) GetCommitBySha(ctx context.Context, owner, repository, sha string) (CommitInfo, error) {
+	err := validateParametersNotBlank(map[string]string{
+		"owner":      owner,
+		"repository": repository,
+		"sha":        sha,
+	})
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	ghClient, err := client.buildGithubClient(ctx)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	commit, _, err := ghClient.Repositories.GetCommit(ctx, owner, repository, sha, nil)
+	if err != nil {
+		return CommitInfo{}, err
+	}
+
+	return mapGitHubCommitToCommitInfo(commit), nil
+}
+
 func createGitHubHook(token, payloadUrl string, webhookEvents ...vcsutils.WebhookEvent) *github.Hook {
 	return &github.Hook{
 		Events: getGitHubWebhookEvents(webhookEvents...),
@@ -314,3 +324,20 @@ func getGitHubCommitState(commitState CommitStatus) string {
 	}
 	return ""
 }
+
+func mapGitHubCommitToCommitInfo(commit *github.RepositoryCommit) CommitInfo {
+	parents := make([]string, len(commit.Parents))
+	for i, c := range commit.Parents {
+		parents[i] = c.GetSHA()
+	}
+	details := commit.GetCommit()
+	return CommitInfo{
+		Hash:          commit.GetSHA(),
+		AuthorName:    details.GetAuthor().GetName(),
+		CommitterName: details.GetCommitter().GetName(),
+		Url:           commit.GetURL(),
+		Timestamp:     details.GetCommitter().GetDate().UTC().Unix(),
+		Message:       details.GetMessage(),
+		ParentHashes:  parents,
+	}
+}