sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/plugins/invalidcommitmsg/invalidcommitmsg_test.go

/*
Copyright 2019 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package invalidcommitmsg

import (
	"fmt"
	"reflect"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/sirupsen/logrus"

	"sigs.k8s.io/prow/pkg/github"
	"sigs.k8s.io/prow/pkg/github/fakegithub"
)

type fakePruner struct{}

func (fp *fakePruner) PruneComments(shouldPrune func(github.IssueComment) bool) {}

func makeFakePullRequestEvent(action github.PullRequestEventAction, title string) github.PullRequestEvent {
	return github.PullRequestEvent{
		Action: action,
		Number: 3,
		Repo: github.Repo{
			Owner: github.User{
				Login: "k",
			},
			Name: "k",
		},
		PullRequest: github.PullRequest{
			Title: title,
		},
	}
}

var invalidCommitComment = `k/k#3:[Keywords](https://help.github.com/articles/closing-issues-using-keywords) which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

**The list of commits with invalid commit messages**:

- [sha1](https://github.com/k/k/commits/sha1) this is a @mention
- [sha2](https://github.com/k/k/commits/sha2) this @menti-on has a hyphen
- [sha3](https://github.com/k/k/commits/sha3) this @Menti-On has mixed case letters
- [sha4](https://github.com/k/k/commits/sha4) fixes k/k#9999
- [sha5](https://github.com/k/k/commits/sha5) Close k/k#9999
- [sha6](https://github.com/k/k/commits/sha6) resolved k/k#9999

<details>

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md).  If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).
</details>
`

var invalidPRTitleComment = `k/k#3:[Keywords](https://help.github.com/articles/closing-issues-using-keywords) which can automatically close issues and at(@) mentions are not allowed in the title of a Pull Request.

You can edit the title by writing **/retitle <new-title>** in a comment.

<details>
When GitHub merges a Pull Request, the title is included in the merge commit. To avoid invalid keywords in the merge commit, please edit the title of the PR.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md).  If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).
</details>
`

func TestHandlePullRequest(t *testing.T) {
	var testcases = []struct {
		name string

		// PR settings
		action                       github.PullRequestEventAction
		commits                      []github.RepositoryCommit
		title                        string
		hasInvalidCommitMessageLabel bool

		// expectations
		addedLabel    string
		removedLabel  string
		addedComments []string
	}{
		{
			name:   "unsupported PR action -> no-op",
			action: github.PullRequestActionLabeled,
		},
		{
			name:   "contains valid message -> no-op",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a valid message"}},
				{SHA: "sha2", Commit: github.GitCommit{Message: "fixing k/k#9999"}},
				{SHA: "sha3", Commit: github.GitCommit{Message: "not a @ mention"}},
				{SHA: "sha4", Commit: github.GitCommit{Message: "escape @\u200bmention with zero width unicode"}},
			},
			hasInvalidCommitMessageLabel: false,
		},
		{
			name:   "msg contains invalid keywords -> add label and comment",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a @mention"}},
				{SHA: "sha2", Commit: github.GitCommit{Message: "this @menti-on has a hyphen"}},
				{SHA: "sha3", Commit: github.GitCommit{Message: "this @Menti-On has mixed case letters"}},
				{SHA: "sha4", Commit: github.GitCommit{Message: "fixes k/k#9999"}},
				{SHA: "sha5", Commit: github.GitCommit{Message: "Close k/k#9999"}},
				{SHA: "sha6", Commit: github.GitCommit{Message: "resolved k/k#9999"}},
				{SHA: "sha7", Commit: github.GitCommit{Message: "this is an email@address and is valid"}},
			},
			hasInvalidCommitMessageLabel: false,

			addedLabel:    fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
			addedComments: []string{invalidCommitComment},
		},
		{
			name:   "msg does not contain invalid keywords but has label -> remove label",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			hasInvalidCommitMessageLabel: true,

			removedLabel: fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
		},
		{
			name:   "contains valid title -> no-op",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			title:                        "valid title",
			hasInvalidCommitMessageLabel: false,
		},
		{
			name:   "contains invalid title with @mention -> add label and comment",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			title:                        "title with @mention",
			hasInvalidCommitMessageLabel: false,
			addedLabel:                   fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
			addedComments:                []string{invalidPRTitleComment},
		},
		{
			name:   "contains invalid title with fixes keyword -> add label and comment",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			title:                        "fixes #9999",
			hasInvalidCommitMessageLabel: false,
			addedLabel:                   fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
			addedComments:                []string{invalidPRTitleComment},
		},
		{
			name:   "contains invalid title and invalid commits -> add label and 2 comments",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a @mention"}},
				{SHA: "sha2", Commit: github.GitCommit{Message: "this @menti-on has a hyphen"}},
				{SHA: "sha3", Commit: github.GitCommit{Message: "this @Menti-On has mixed case letters"}},
				{SHA: "sha4", Commit: github.GitCommit{Message: "fixes k/k#9999"}},
				{SHA: "sha5", Commit: github.GitCommit{Message: "Close k/k#9999"}},
				{SHA: "sha6", Commit: github.GitCommit{Message: "resolved k/k#9999"}},
				{SHA: "sha7", Commit: github.GitCommit{Message: "this is an email@address and is valid"}},
			},
			title:                        "title with @mention",
			hasInvalidCommitMessageLabel: false,
			addedLabel:                   fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
			addedComments:                []string{invalidCommitComment, invalidPRTitleComment},
		},
		{
			name:   "valid commits and invalid title, and has label -> keep label and add comment",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			title:                        "title with @mention",
			hasInvalidCommitMessageLabel: true,
			addedComments:                []string{invalidPRTitleComment},
		},
		{
			name:   "invalid commits and valid title, and has label -> keep label and add comment",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha1", Commit: github.GitCommit{Message: "this is a @mention"}},
				{SHA: "sha2", Commit: github.GitCommit{Message: "this @menti-on has a hyphen"}},
				{SHA: "sha3", Commit: github.GitCommit{Message: "this @Menti-On has mixed case letters"}},
				{SHA: "sha4", Commit: github.GitCommit{Message: "fixes k/k#9999"}},
				{SHA: "sha5", Commit: github.GitCommit{Message: "Close k/k#9999"}},
				{SHA: "sha6", Commit: github.GitCommit{Message: "resolved k/k#9999"}},
				{SHA: "sha7", Commit: github.GitCommit{Message: "this is an email@address and is valid"}},
			},
			title:                        "valid title",
			hasInvalidCommitMessageLabel: true,
			addedComments:                []string{invalidCommitComment},
		},
		{
			name:   "valid title and valid commits, and has label -> remove label",
			action: github.PullRequestActionOpened,
			commits: []github.RepositoryCommit{
				{SHA: "sha", Commit: github.GitCommit{Message: "this is a valid message"}},
			},
			title:                        "valid title",
			hasInvalidCommitMessageLabel: true,
			removedLabel:                 fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel),
		},
	}

	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			title := "fake title"
			if tc.title != "" {
				title = tc.title
			}

			event := makeFakePullRequestEvent(tc.action, title)
			fc := fakegithub.NewFakeClient()
			fc.PullRequests = map[int]*github.PullRequest{event.Number: &event.PullRequest}
			fc.IssueComments = make(map[int][]github.IssueComment)
			fc.CommitMap = map[string][]github.RepositoryCommit{
				"k/k#3": tc.commits,
			}

			if tc.hasInvalidCommitMessageLabel {
				fc.IssueLabelsAdded = append(fc.IssueLabelsAdded, fmt.Sprintf("k/k#3:%s", invalidCommitMsgLabel))
			}
			if err := handle(fc, logrus.WithField("plugin", pluginName), event, &fakePruner{}); err != nil {
				t.Errorf("For case %s, didn't expect error from invalidcommitmsg plugin: %v", tc.name, err)
			}

			ok := tc.addedLabel == ""
			if !ok {
				for _, label := range fc.IssueLabelsAdded {
					if reflect.DeepEqual(tc.addedLabel, label) {
						ok = true
						break
					}
				}
			}
			if !ok {
				t.Errorf("Expected to add: %#v, Got %#v in case %s.", tc.addedLabel, fc.IssueLabelsAdded, tc.name)
			}

			ok = tc.removedLabel == ""
			if !ok {
				for _, label := range fc.IssueLabelsRemoved {
					if reflect.DeepEqual(tc.removedLabel, label) {
						ok = true
						break
					}
				}
			}
			if !ok {
				t.Errorf("Expected to remove: %#v, Got %#v in case %s.", tc.removedLabel, fc.IssueLabelsRemoved, tc.name)
			}

			comments := fc.IssueCommentsAdded
			if len(comments) != len(tc.addedComments) {
				t.Errorf("Expected %v comments, but received %v", len(tc.addedComments), len(comments))
				return
			}

			if diff := cmp.Diff(comments, tc.addedComments); diff != "" {
				t.Errorf("Actual comments differ from expected comments: %s", diff)
			}
		})
	}
}