github.com/abayer/test-infra@v0.0.5/prow/external-plugins/needs-rebase/plugin/plugin_test.go

/*
Copyright 2017 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 plugin

import (
	"context"
	"errors"
	"fmt"
	"reflect"
	"sort"
	"testing"
	"time"

	"github.com/shurcooL/githubv4"
	"github.com/sirupsen/logrus"

	"k8s.io/test-infra/prow/github"
	"k8s.io/test-infra/prow/plugins"
)

func testKey(org, repo string, num int) string {
	return fmt.Sprintf("%s/%s#%d", org, repo, num)
}

type fghc struct {
	allPRs []struct {
		PullRequest pullRequest `graphql:"... on PullRequest"`
	}

	initialLabels []github.Label
	mergeable     bool

	// The following are maps are keyed using 'testKey'
	commentCreated, commentDeleted map[string]bool
	labelsAdded, labelsRemoved     map[string][]string
}

func newFakeClient(prs []pullRequest, initialLabels []string, mergeable bool) *fghc {
	f := &fghc{
		mergeable:      mergeable,
		commentCreated: make(map[string]bool),
		commentDeleted: make(map[string]bool),
		labelsAdded:    make(map[string][]string),
		labelsRemoved:  make(map[string][]string),
	}
	for _, pr := range prs {
		s := struct {
			PullRequest pullRequest `graphql:"... on PullRequest"`
		}{pr}
		f.allPRs = append(f.allPRs, s)
	}
	for _, label := range initialLabels {
		f.initialLabels = append(f.initialLabels, github.Label{Name: label})
	}
	return f
}

func (f *fghc) GetIssueLabels(org, repo string, number int) ([]github.Label, error) {
	return f.initialLabels, nil
}

func (f *fghc) CreateComment(org, repo string, number int, comment string) error {
	f.commentCreated[testKey(org, repo, number)] = true
	return nil
}

func (f *fghc) BotName() (string, error) {
	return "k8s-ci-robot", nil
}

func (f *fghc) AddLabel(org, repo string, number int, label string) error {
	key := testKey(org, repo, number)
	f.labelsAdded[key] = append(f.labelsAdded[key], label)
	return nil
}

func (f *fghc) RemoveLabel(org, repo string, number int, label string) error {
	key := testKey(org, repo, number)
	f.labelsRemoved[key] = append(f.labelsRemoved[key], label)
	return nil
}

func (f *fghc) IsMergeable(org, repo string, number int, sha string) (bool, error) {
	return f.mergeable, nil
}

func (f *fghc) DeleteStaleComments(org, repo string, number int, comments []github.IssueComment, isStale func(github.IssueComment) bool) error {
	f.commentDeleted[testKey(org, repo, number)] = true
	return nil
}

func (f *fghc) Query(_ context.Context, q interface{}, _ map[string]interface{}) error {
	query, ok := q.(*searchQuery)
	if !ok {
		return errors.New("invalid query format")
	}
	query.Search.Nodes = f.allPRs
	return nil
}

func (f *fghc) compareExpected(t *testing.T, org, repo string, num int, expectedAdded []string, expectedRemoved []string, expectComment bool, expectDeletion bool) {
	key := testKey(org, repo, num)
	sort.Strings(expectedAdded)
	sort.Strings(expectedRemoved)
	sort.Strings(f.labelsAdded[key])
	sort.Strings(f.labelsRemoved[key])
	if !reflect.DeepEqual(expectedAdded, f.labelsAdded[key]) {
		t.Errorf("Expected the following labels to be added to %s: %q, but got %q.", key, expectedAdded, f.labelsAdded[key])
	}
	if !reflect.DeepEqual(expectedRemoved, f.labelsRemoved[key]) {
		t.Errorf("Expected the following labels to be removed from %s: %q, but got %q.", key, expectedRemoved, f.labelsRemoved[key])
	}
	if expectComment && !f.commentCreated[key] {
		t.Errorf("Expected a comment to be created on %s, but none was.", key)
	} else if !expectComment && f.commentCreated[key] {
		t.Errorf("Unexpected comment on %s.", key)
	}
	if expectDeletion && !f.commentDeleted[key] {
		t.Errorf("Expected a comment to be deleted from %s, but none was.", key)
	} else if !expectDeletion && f.commentDeleted[key] {
		t.Errorf("Unexpected comment deletion on %s.", key)
	}
}

func TestHandleEvent(t *testing.T) {
	oldSleep := sleep
	sleep = func(time.Duration) { return }
	defer func() { sleep = oldSleep }()

	testCases := []struct {
		name string

		mergeable bool
		labels    []string

		expectedAdded   []string
		expectedRemoved []string
		expectComment   bool
		expectDeletion  bool
	}{
		{
			name:      "mergeable no-op",
			mergeable: true,
			labels:    []string{"lgtm", "needs-sig"},
		},
		{
			name:      "unmergeable no-op",
			mergeable: false,
			labels:    []string{"lgtm", "needs-sig", "needs-rebase"},
		},
		{
			name:      "mergeable -> unmergeable",
			mergeable: false,
			labels:    []string{"lgtm", "needs-sig"},

			expectedAdded: []string{"needs-rebase"},
			expectComment: true,
		},
		{
			name:      "unmergeable -> mergeable",
			mergeable: true,
			labels:    []string{"lgtm", "needs-sig", "needs-rebase"},

			expectedRemoved: []string{"needs-rebase"},
			expectDeletion:  true,
		},
	}

	for _, tc := range testCases {
		fake := newFakeClient(nil, tc.labels, tc.mergeable)
		pre := &github.PullRequestEvent{
			Action: github.PullRequestActionSynchronize,
			Repo: github.Repo{
				Name:  "repo",
				Owner: github.User{Login: "org"},
			},
			Number: 5,
		}
		t.Logf("Running test scenario: %q", tc.name)
		if err := HandleEvent(logrus.WithField("plugin", pluginName), fake, pre); err != nil {
			t.Fatalf("Unexpected error handling event: %v.", err)
		}
		fake.compareExpected(t, "org", "repo", 5, tc.expectedAdded, tc.expectedRemoved, tc.expectComment, tc.expectDeletion)
	}
}

func TestHandleAll(t *testing.T) {
	testPRs := []struct {
		labels    []string
		mergeable bool

		expectedAdded, expectedRemoved []string
		expectComment, expectDeletion  bool
	}{
		{
			mergeable: true,
			labels:    []string{"lgtm", "needs-sig"},
		},
		{
			mergeable: false,
			labels:    []string{"lgtm", "needs-sig", "needs-rebase"},
		},
		{
			mergeable: false,
			labels:    []string{"lgtm", "needs-sig"},

			expectedAdded: []string{"needs-rebase"},
			expectComment: true,
		},
		{
			mergeable: true,
			labels:    []string{"lgtm", "needs-sig", "needs-rebase"},

			expectedRemoved: []string{"needs-rebase"},
			expectDeletion:  true,
		},
	}

	prs := []pullRequest{}
	for i, testPR := range testPRs {
		pr := pullRequest{
			Number: githubv4.Int(i),
		}
		if testPR.mergeable {
			pr.Mergeable = githubv4.MergeableStateMergeable
		} else {
			pr.Mergeable = githubv4.MergeableStateConflicting
		}
		for _, label := range testPR.labels {
			s := struct {
				Name githubv4.String
			}{
				Name: githubv4.String(label),
			}
			pr.Labels.Nodes = append(pr.Labels.Nodes, s)
		}
		prs = append(prs, pr)
	}
	fake := newFakeClient(prs, nil, false)
	config := &plugins.Configuration{
		Plugins: map[string][]string{"/": {"lgtm", pluginName}},

		ExternalPlugins: map[string][]plugins.ExternalPlugin{"/": {{Name: pluginName}}},
	}

	if err := HandleAll(logrus.WithField("plugin", pluginName), fake, config); err != nil {
		t.Fatalf("Unexpected error handling all prs: %v.", err)
	}
	for i, pr := range testPRs {
		fake.compareExpected(t, "", "", i, pr.expectedAdded, pr.expectedRemoved, pr.expectComment, pr.expectDeletion)
	}
}