Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API] Add affected files of commits to commit struct #14579

Merged
merged 19 commits into from
Feb 7, 2021
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions integrations/api_repo_git_commits_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ import (
"github.com/stretchr/testify/assert"
)

func compareCommitFiles(t *testing.T, expect []string, files []*api.CommitAffectedFiles) {
var actual []string
for i := range files {
actual = append(actual, files[i].Filename)
}
assert.ElementsMatch(t, expect, actual)
}

func TestAPIReposGitCommits(t *testing.T) {
defer prepareTestEnv(t)()
user := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User)
Expand Down Expand Up @@ -56,10 +64,13 @@ func TestAPIReposGitCommitList(t *testing.T) {
var apiData []api.Commit
DecodeJSON(t, resp, &apiData)

assert.Equal(t, 3, len(apiData))
assert.Equal(t, "69554a64c1e6030f051e5c3f94bfbd773cd6a324", apiData[0].CommitMeta.SHA)
assert.Equal(t, "27566bd5738fc8b4e3fef3c5e72cce608537bd95", apiData[1].CommitMeta.SHA)
assert.Equal(t, "5099b81332712fe655e34e8dd63574f503f61811", apiData[2].CommitMeta.SHA)
assert.Len(t, apiData, 3)
assert.EqualValues(t, "69554a64c1e6030f051e5c3f94bfbd773cd6a324", apiData[0].CommitMeta.SHA)
compareCommitFiles(t, []string{"readme.md"}, apiData[0].Files)
assert.EqualValues(t, "27566bd5738fc8b4e3fef3c5e72cce608537bd95", apiData[1].CommitMeta.SHA)
compareCommitFiles(t, []string{"readme.md"}, apiData[1].Files)
assert.EqualValues(t, "5099b81332712fe655e34e8dd63574f503f61811", apiData[2].CommitMeta.SHA)
compareCommitFiles(t, []string{"readme.md"}, apiData[2].Files)
}

func TestAPIReposGitCommitListPage2Empty(t *testing.T) {
Expand All @@ -76,7 +87,7 @@ func TestAPIReposGitCommitListPage2Empty(t *testing.T) {
var apiData []api.Commit
DecodeJSON(t, resp, &apiData)

assert.Equal(t, 0, len(apiData))
assert.Len(t, apiData, 0)
}

func TestAPIReposGitCommitListDifferentBranch(t *testing.T) {
Expand All @@ -93,6 +104,7 @@ func TestAPIReposGitCommitListDifferentBranch(t *testing.T) {
var apiData []api.Commit
DecodeJSON(t, resp, &apiData)

assert.Equal(t, 1, len(apiData))
assert.Len(t, apiData, 1)
assert.Equal(t, "f27c2b2b03dcab38beaf89b0ab4ff61f6de63441", apiData[0].CommitMeta.SHA)
compareCommitFiles(t, []string{"readme.md"}, apiData[2].Files)
6543 marked this conversation as resolved.
Show resolved Hide resolved
}
15 changes: 15 additions & 0 deletions modules/convert/git_commit.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,20 @@ func ToCommit(repo *models.Repository, commit *git.Commit, userCache map[string]
}
}

// Retrieve files affected by the commit
fileStatus, err := git.GetCommitFileStatus(repo.RepoPath(), commit.ID.String())
if err != nil {
return nil, err
}
affectedFiles := append(fileStatus.Added, fileStatus.Removed...)
affectedFiles = append(affectedFiles, fileStatus.Modified...)
affectedFileList := make([]*api.CommitAffectedFiles, len(affectedFiles))
for i := range affectedFiles {
affectedFileList[i] = &api.CommitAffectedFiles{
Filename: affectedFiles[i],
}
}
zeripath marked this conversation as resolved.
Show resolved Hide resolved

return &api.Commit{
CommitMeta: &api.CommitMeta{
URL: repo.APIURL() + "/git/commits/" + commit.ID.String(),
Expand Down Expand Up @@ -162,5 +176,6 @@ func ToCommit(repo *models.Repository, commit *git.Commit, userCache map[string]
Author: apiAuthor,
Committer: apiCommitter,
Parents: apiParents,
Files: affectedFileList,
}, nil
}
16 changes: 11 additions & 5 deletions modules/structs/repo_commit.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@ type RepoCommit struct {
// Commit contains information generated from a Git commit.
type Commit struct {
*CommitMeta
HTMLURL string `json:"html_url"`
RepoCommit *RepoCommit `json:"commit"`
Author *User `json:"author"`
Committer *User `json:"committer"`
Parents []*CommitMeta `json:"parents"`
HTMLURL string `json:"html_url"`
RepoCommit *RepoCommit `json:"commit"`
Author *User `json:"author"`
Committer *User `json:"committer"`
Parents []*CommitMeta `json:"parents"`
Files []*CommitAffectedFiles `json:"files"`
}

// CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE
Expand All @@ -56,3 +57,8 @@ type CommitDateOptions struct {
// swagger:strfmt date-time
Committer time.Time `json:"committer"`
}

// CommitAffectedFiles store information about files affected by the commit
type CommitAffectedFiles struct {
Filename string `json:"filename"`
}
18 changes: 18 additions & 0 deletions templates/swagger/v1_json.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -11821,6 +11821,13 @@
"format": "date-time",
"x-go-name": "Created"
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/CommitAffectedFiles"
},
"x-go-name": "Files"
},
"html_url": {
"type": "string",
"x-go-name": "HTMLURL"
Expand All @@ -11843,6 +11850,17 @@
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"CommitAffectedFiles": {
"description": "CommitAffectedFiles store information about files affected by the commit",
"type": "object",
"properties": {
"filename": {
"type": "string",
"x-go-name": "Filename"
}
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
"CommitDateOptions": {
"description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
"type": "object",
Expand Down