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.

Sign up for GitHub

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

Fix comment to associated MR when push pipeline #23

Merged
merged 2 commits into from
Apr 11, 2024
Merged

Fix comment to associated MR when push pipeline #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cdee7a
fix: get MR IID when MR number is 0
kitagry Apr 11, 2024
bf399e9
refactor: delete unused method
kitagry Apr 11, 2024
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
18 changes: 18 additions & 0 deletions pkg/notifier/gitlab/comment_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package gitlab

import (
"errors"
"reflect"
"testing"

Expand Down Expand Up @@ -81,6 +82,23 @@ func TestCommentPost(t *testing.T) {
},
ok: false,
},
{
name: "should postForRevision when listMergeRequestIIDs is failed",
config: newFakeConfig(),
createMockGitLabAPI: func(ctrl *gomock.Controller) *gitlabmock.MockAPI {
api := gitlabmock.NewMockAPI(ctrl)
api.EXPECT().ListMergeRequestsByCommit("revision").Return(nil, nil, errors.New("error"))
// PostCommitComment should be called
api.EXPECT().PostCommitComment("revision", &gitlab.PostCommitCommentOptions{Note: gitlab.String(body)}).Return(&gitlab.CommitComment{}, nil, nil)
return api
},
body: body,
opt: PostOptions{
Number: 0,
Revision: "revision",
},
ok: true,
},
}

for _, testCase := range testCases {
Expand Down
32 changes: 0 additions & 32 deletions pkg/notifier/gitlab/commits.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,12 @@ package gitlab

import (
"errors"

gitlab "github.com/xanzy/go-gitlab"
)

// CommitsService handles communication with the commits related
// methods of GitLab API
type CommitsService service

// List lists commits on a repository
func (g *CommitsService) List(revision string) ([]string, error) {
if revision == "" {
return []string{}, errors.New("no revision specified")
}
commits, _, err := g.client.API.ListCommits(
&gitlab.ListCommitsOptions{},
)
if err != nil {
return nil, err
}
s := make([]string, len(commits))
for i, commit := range commits {
s[i] = commit.ID
}
return s, nil
}

func (g *CommitsService) ListMergeRequestIIDsByRevision(revision string) ([]int, error) {
if revision == "" {
return nil, errors.New("no revision specified")
Expand All @@ -43,15 +23,3 @@ func (g *CommitsService) ListMergeRequestIIDsByRevision(revision string) ([]int,
}
return result, nil
}

// lastOne returns the hash of the previous commit of the given commit
func (g *CommitsService) lastOne(commits []string, revision string) (string, error) {
if revision == "" {
return "", errors.New("no revision specified")
}
if len(commits) == 0 {
return "", errors.New("no commits")
}

return commits[1], nil
}
119 changes: 0 additions & 119 deletions pkg/notifier/gitlab/commits_test.go
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions pkg/notifier/gitlab/gen/gitlab.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions pkg/notifier/gitlab/gitlab.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ type API interface {
GetMergeRequest(mergeRequest int, opt *gitlab.GetMergeRequestsOptions, options ...gitlab.RequestOptionFunc) (*gitlab.MergeRequest, *gitlab.Response, error)
UpdateMergeRequest(mergeRequest int, opt *gitlab.UpdateMergeRequestOptions, options ...gitlab.RequestOptionFunc) (*gitlab.MergeRequest, *gitlab.Response, error)
PostCommitComment(sha string, opt *gitlab.PostCommitCommentOptions, options ...gitlab.RequestOptionFunc) (*gitlab.CommitComment, *gitlab.Response, error)
ListCommits(opt *gitlab.ListCommitsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Commit, *gitlab.Response, error)
AddMergeRequestLabels(labels *[]string, mergeRequest int) (gitlab.Labels, error)
RemoveMergeRequestLabels(labels *[]string, mergeRequest int) (gitlab.Labels, error)
ListMergeRequestLabels(mergeRequest int, opt *gitlab.GetMergeRequestsOptions, options ...gitlab.RequestOptionFunc) (gitlab.Labels, error)
Expand Down Expand Up @@ -60,11 +59,6 @@ func (g *GitLab) PostCommitComment(sha string, opt *gitlab.PostCommitCommentOpti
return g.Client.Commits.PostCommitComment(fmt.Sprintf("%s/%s", g.namespace, g.project), sha, opt, options...)
}

// ListCommits is a wrapper of https://godoc.org/github.com/xanzy/go-gitlab#CommitsService.ListCommits
func (g *GitLab) ListCommits(opt *gitlab.ListCommitsOptions, options ...gitlab.RequestOptionFunc) ([]*gitlab.Commit, *gitlab.Response, error) {
return g.Client.Commits.ListCommits(fmt.Sprintf("%s/%s", g.namespace, g.project), opt, options...)
}

// AddMergeRequestLabels adds labels on the merge request.
func (g *GitLab) AddMergeRequestLabels(labels *[]string, mergeRequest int) (gitlab.Labels, error) {
var addLabels gitlab.Labels
Expand Down
11 changes: 0 additions & 11 deletions pkg/notifier/gitlab/notify.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,6 @@ func (g *NotifyService) Notify(param notifier.ParamExec) (int, error) { //nolint
}

_, isApply := parser.(*terraform.ApplyParser)
if isApply {
if !cfg.MR.IsNumber() {
commits, err := g.client.Commits.List(cfg.MR.Revision)
if err != nil {
return result.ExitCode, err
}
lastRevision, _ := g.client.Commits.lastOne(commits, cfg.MR.Revision)
cfg.MR.Revision = lastRevision
}
}

logE := logrus.WithFields(logrus.Fields{
"program": "tfcmt",
})
Expand Down
5 changes: 2 additions & 3 deletions pkg/notifier/gitlab/notify_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,10 @@ func TestNotifyNotify(t *testing.T) { //nolint:maintidx
exitCode: 2,
},
{
name: "apply case",
name: "get MR IID when MR number is 0",
createMockGitLabAPI: func(ctrl *gomock.Controller) *gitlabmock.MockAPI {
api := gitlabmock.NewMockAPI(ctrl)
api.EXPECT().ListCommits(gomock.Any()).Return([]*gitlab.Commit{{ID: "1"}, {ID: "2"}}, nil, nil)
api.EXPECT().ListMergeRequestsByCommit("2").Return([]*gitlab.MergeRequest{{IID: 1}}, nil, nil)
api.EXPECT().ListMergeRequestsByCommit("revision").Return([]*gitlab.MergeRequest{{IID: 1}}, nil, nil)
Comment on lines +237 to +240
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirmed the behavior here.

api.EXPECT().CreateMergeRequestNote(1, gomock.Any()).Return(nil, nil, nil)
return api
},
Expand Down
Loading