sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/plugins/cla/cla_test.go

/*
Copyright 2016 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 cla

import (
	"fmt"
	"reflect"
	"testing"

	"github.com/sirupsen/logrus"

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

func TestCLALabels(t *testing.T) {
	var testcases = []struct {
		name          string
		context       string
		state         string
		statusSHA     string
		issues        []github.Issue
		pullRequests  []github.PullRequest
		labels        []string
		addedLabels   []string
		removedLabels []string
	}{
		{
			name:          "unrecognized status context has no effect",
			context:       "unknown",
			state:         "success",
			addedLabels:   nil,
			removedLabels: nil,
		},
		{
			name:          "EasyCLA status pending has no effect",
			context:       "EasyCLA",
			state:         "pending",
			addedLabels:   nil,
			removedLabels: nil,
		},
		{
			name: "EasyCLA status success does not add/remove labels " +
				"when not the head commit in a PR",
			context:   "EasyCLA",
			state:     "success",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "b"}},
			},
			addedLabels:   nil,
			removedLabels: nil,
		},
		{
			name: "EasyCLA status failure does not add/remove labels " +
				"when not the head commit in a PR",
			context:   "EasyCLA",
			state:     "failure",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{{Name: labels.ClaYes}}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "b"}},
			},
			addedLabels:   nil,
			removedLabels: nil,
		},
		{
			name:      "EasyCLA status on head commit of PR adds the cla-yes label when its state is \"success\"",
			context:   "EasyCLA",
			state:     "success",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "a"}},
			},
			addedLabels:   []string{fmt.Sprintf("/#3:%s", labels.ClaYes)},
			removedLabels: nil,
		},
		{
			name:      "EasyCLA status on head commit of PR does nothing when pending",
			context:   "EasyCLA",
			state:     "pending",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "a"}},
			},
			addedLabels:   nil,
			removedLabels: nil,
		},
		{
			name:      "EasyCLA status success removes \"cncf-cla: no\" label",
			context:   "EasyCLA",
			state:     "success",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{{Name: labels.ClaNo}}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "a"}},
			},
			addedLabels:   []string{fmt.Sprintf("/#3:%s", labels.ClaYes)},
			removedLabels: []string{fmt.Sprintf("/#3:%s", labels.ClaNo)},
		},
		{
			name:      "EasyCLA status failure removes \"cncf-cla: yes\" label",
			context:   "EasyCLA",
			state:     "failure",
			statusSHA: "a",
			issues: []github.Issue{
				{Number: 3, State: "open", Labels: []github.Label{{Name: labels.ClaYes}}},
			},
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "a"}},
			},
			addedLabels:   []string{fmt.Sprintf("/#3:%s", labels.ClaNo)},
			removedLabels: []string{fmt.Sprintf("/#3:%s", labels.ClaYes)},
		},
	}
	for _, tc := range testcases {
		pullRequests := make(map[int]*github.PullRequest)
		for _, pr := range tc.pullRequests {
			pr := pr
			pullRequests[pr.Number] = &pr
		}

		issues := make(map[int]*github.Issue)
		for _, issue := range tc.issues {
			issue := issue
			issues[issue.Number] = &issue
		}

		fc := fakegithub.NewFakeClient()
		fc.PullRequests = pullRequests
		fc.Issues = issues
		fc.IssueComments = make(map[int][]github.IssueComment)
		se := github.StatusEvent{
			Context: tc.context,
			SHA:     tc.statusSHA,
			State:   tc.state,
		}
		if err := handle(fc, logrus.WithField("plugin", pluginName), se); err != nil {
			t.Errorf("For case %s, didn't expect error from cla plugin: %v", tc.name, err)
			continue
		}

		if !reflect.DeepEqual(fc.IssueLabelsAdded, tc.addedLabels) {
			t.Errorf("Expected: %#v, Got %#v in case %s.", tc.addedLabels, fc.IssueLabelsAdded, tc.name)
		}

		if !reflect.DeepEqual(fc.IssueLabelsRemoved, tc.removedLabels) {
			t.Errorf("Expected: %#v, Got %#v in case %s.", tc.removedLabels, fc.IssueLabelsRemoved, tc.name)
		}
	}
}

func TestCheckCLA(t *testing.T) {
	var testcases = []struct {
		name         string
		context      string
		state        string
		issueState   string
		SHA          string
		action       string
		body         string
		pullRequests []github.PullRequest
		hasCLAYes    bool
		hasCLANo     bool

		addedLabel   string
		removedLabel string
	}{
		{
			name:       "ignore non EasyCLA context",
			context:    "random/context",
			state:      "success",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
		},
		{
			name:       "ignore non open PRs",
			context:    "EasyCLA",
			state:      "success",
			issueState: "closed",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
		},
		{
			name:       "ignore non /check-cla comments",
			context:    "EasyCLA",
			state:      "success",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/shrug",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
		},
		{
			name:       "do nothing on when status state is \"pending\"",
			context:    "EasyCLA",
			state:      "pending",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/shrug",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
		},
		{
			name:       "EasyCLA status adds the cla-yes label when its state is \"success\"",
			context:    "EasyCLA",
			state:      "success",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},

			addedLabel: fmt.Sprintf("/#3:%s", labels.ClaYes),
		},
		{
			name:       "EasyCLA status adds the cla-yes label and removes cla-no label when its state is \"success\"",
			context:    "EasyCLA",
			state:      "success",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
			hasCLANo: true,

			addedLabel:   fmt.Sprintf("/#3:%s", labels.ClaYes),
			removedLabel: fmt.Sprintf("/#3:%s", labels.ClaNo),
		},
		{
			name:       "EasyCLA status adds the cla-no label when its state is \"failure\"",
			context:    "EasyCLA",
			state:      "failure",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},

			addedLabel: fmt.Sprintf("/#3:%s", labels.ClaNo),
		},
		{
			name:       "EasyCLA status adds the cla-no label and removes cla-yes label when its state is \"failure\"",
			context:    "EasyCLA",
			state:      "failure",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
			hasCLAYes: true,

			addedLabel:   fmt.Sprintf("/#3:%s", labels.ClaNo),
			removedLabel: fmt.Sprintf("/#3:%s", labels.ClaYes),
		},
		{
			name:       "EasyCLA status retains the cla-yes label and removes cla-no label when its state is \"success\"",
			context:    "EasyCLA",
			state:      "success",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
			hasCLANo:  true,
			hasCLAYes: true,

			removedLabel: fmt.Sprintf("/#3:%s", labels.ClaNo),
		},
		{
			name:       "EasyCLA status retains the cla-no label and removes cla-yes label when its state is \"failure\"",
			context:    "EasyCLA",
			state:      "failure",
			issueState: "open",
			SHA:        "sha",
			action:     "created",
			body:       "/check-cla",
			pullRequests: []github.PullRequest{
				{Number: 3, Head: github.PullRequestBranch{SHA: "sha"}},
			},
			hasCLANo:  true,
			hasCLAYes: true,

			removedLabel: fmt.Sprintf("/#3:%s", labels.ClaYes),
		},
	}
	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			pullRequests := make(map[int]*github.PullRequest)
			for _, pr := range tc.pullRequests {
				pr := pr
				pullRequests[pr.Number] = &pr
			}
			fc := fakegithub.NewFakeClient()
			fc.CreatedStatuses = make(map[string][]github.Status)
			fc.PullRequests = pullRequests
			e := &github.GenericCommentEvent{
				Action:     github.GenericCommentEventAction(tc.action),
				Body:       tc.body,
				Number:     3,
				IssueState: tc.issueState,
			}
			fc.CombinedStatuses = map[string]*github.CombinedStatus{
				tc.SHA: {
					Statuses: []github.Status{
						{State: tc.state, Context: tc.context},
					},
				},
			}
			if tc.hasCLAYes {
				fc.IssueLabelsAdded = append(fc.IssueLabelsAdded, fmt.Sprintf("/#3:%s", labels.ClaYes))
			}
			if tc.hasCLANo {
				fc.IssueLabelsAdded = append(fc.IssueLabelsAdded, fmt.Sprintf("/#3:%s", labels.ClaNo))
			}
			if err := handleComment(fc, logrus.WithField("plugin", pluginName), e); err != nil {
				t.Errorf("For case %s, didn't expect error from cla 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)
			}
		})
	}
}