ic_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 trigger

import (
	"testing"

	"github.com/sirupsen/logrus"

	"k8s.io/test-infra/prow/config"
	"k8s.io/test-infra/prow/github"
	"k8s.io/test-infra/prow/github/fakegithub"
	"k8s.io/test-infra/prow/kube"
)

type fkc struct {
	started []string
}

func (c *fkc) CreateProwJob(pj kube.ProwJob) (kube.ProwJob, error) {
	c.started = append(c.started, pj.Spec.Context)
	return pj, nil
}

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

		Author        string
		Body          string
		State         string
		IsPR          bool
		Branch        string
		ShouldBuild   bool
		ShouldReport  bool
		HasOkToTest   bool
		IsOkToTest    bool
		StartsExactly string
		Presubmits    map[string][]config.Presubmit
		IssueLabels   []github.Label
	}{
		{
			name: "Not a PR.",

			Author:      "t",
			Body:        "/ok-to-test",
			State:       "open",
			IsPR:        false,
			ShouldBuild: false,
		},
		{
			name: "Closed PR.",

			Author:      "t",
			Body:        "/ok-to-test",
			State:       "closed",
			IsPR:        true,
			ShouldBuild: false,
		},
		{
			name: "Comment by a bot.",

			Author:      "k8s-bot",
			Body:        "/ok-to-test",
			State:       "open",
			IsPR:        true,
			ShouldBuild: false,
		},
		{
			name: "Non-trusted member's ok to test.",

			Author:      "u",
			Body:        "/ok-to-test",
			State:       "open",
			IsPR:        true,
			ShouldBuild: false,
		},
		{
			name: `Non-trusted member after "/ok-to-test".`,

			Author:      "u",
			Body:        "/test all",
			State:       "open",
			IsPR:        true,
			HasOkToTest: true,
			ShouldBuild: true,
		},
		{
			name: "Trusted member's ok to test",

			Author:      "t",
			Body:        "looks great, thanks!\n/ok-to-test",
			State:       "open",
			IsPR:        true,
			ShouldBuild: true,
		},
		{
			name: "Trusted member's ok to test, trailing space.",

			Author:      "t",
			Body:        "looks great, thanks!\n/ok-to-test \r",
			State:       "open",
			IsPR:        true,
			ShouldBuild: true,
		},
		{
			name: "Trusted member's not ok to test.",

			Author:      "t",
			Body:        "not /ok-to-test",
			State:       "open",
			IsPR:        true,
			ShouldBuild: false,
		},
		{
			name: "Trusted member's test this.",

			Author:      "t",
			Body:        "/test all",
			State:       "open",
			IsPR:        true,
			ShouldBuild: true,
		},
		{
			name: "Wrong branch.",

			Author:       "t",
			Body:         "/test all",
			State:        "open",
			IsPR:         true,
			Branch:       "other",
			ShouldBuild:  false,
			ShouldReport: true,
		},
		{
			name: "Retest with one running and one failed",

			Author:        "t",
			Body:          "/retest",
			State:         "open",
			IsPR:          true,
			ShouldBuild:   true,
			StartsExactly: "pull-jib",
		},
		{
			name: "Retest with one running and one failed, trailing space.",

			Author:        "t",
			Body:          "/retest \r",
			State:         "open",
			IsPR:          true,
			ShouldBuild:   true,
			StartsExactly: "pull-jib",
		},
		{
			name: "needs-ok-to-test label is removed when no presubmit runs by default",

			Author:      "t",
			Body:        "/ok-to-test",
			State:       "open",
			IsPR:        true,
			IsOkToTest:  true,
			ShouldBuild: false,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:      "job",
						AlwaysRun: false,
						Context:   "pull-job",
						Trigger:   `/test all`,
					},
					{
						Name:      "jib",
						AlwaysRun: false,
						Context:   "pull-jib",
						Trigger:   `/test jib`,
					},
				},
			},
			IssueLabels: []github.Label{{Name: "needs-ok-to-test"}},
		},
		{
			name:   "Wrong branch w/ SkipReport",
			Author: "t",
			Body:   "/test all",
			Branch: "other",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:       "job",
						AlwaysRun:  true,
						SkipReport: true,
						Context:    "pull-job",
						Trigger:    `/test all`,
						Brancher:   config.Brancher{Branches: []string{"master"}},
					},
				},
			},
		},
		{
			name:   "Retest of run_if_changed job that hasn't run. Changes require job",
			Author: "t",
			Body:   "/retest",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:         "jab",
						RunIfChanged: "CHANGED",
						SkipReport:   true,
						Context:      "pull-jab",
						Trigger:      `/test all`,
					},
				},
			},
			ShouldBuild:   true,
			StartsExactly: "pull-jab",
		},
		{
			name:   "Retest of run_if_changed job that failed. Changes require job",
			Author: "t",
			Body:   "/retest",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:         "jib",
						RunIfChanged: "CHANGED",
						Context:      "pull-jib",
						Trigger:      `/test all`,
					},
				},
			},
			ShouldBuild:   true,
			StartsExactly: "pull-jib",
		},
		{
			name:   "Rerun of run_if_changed job that has passed",
			Author: "t",
			Body:   "/test jub",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:         "jub",
						RunIfChanged: "CHANGED",
						Context:      "pull-jub",
						Trigger:      `/test jub`,
					},
				},
			},
			ShouldBuild:   true,
			StartsExactly: "pull-jub",
		},
		{
			name:   "Retest of run_if_changed job that failed. Changes do not require the job",
			Author: "t",
			Body:   "/retest",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:         "jib",
						RunIfChanged: "CHANGED2",
						Context:      "pull-jib",
						Trigger:      `/test all`,
					},
				},
			},
			ShouldBuild: true,
		},
		{
			name:       "Run if changed job triggered by /ok-to-test",
			Author:     "t",
			Body:       "/ok-to-test",
			State:      "open",
			IsPR:       true,
			IsOkToTest: true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:         "jab",
						RunIfChanged: "CHANGED",
						Context:      "pull-jab",
						Trigger:      `/test all`,
					},
				},
			},
			ShouldBuild:   true,
			StartsExactly: "pull-jab",
			IssueLabels:   []github.Label{{Name: "needs-ok-to-test"}},
		},
		{
			name:   "/test of branch-sharded job",
			Author: "t",
			Body:   "/test jab",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:     "jab",
						Brancher: config.Brancher{Branches: []string{"master"}},
						Context:  "pull-jab",
						Trigger:  `/test jab`,
					},
					{
						Name:     "jab",
						Brancher: config.Brancher{Branches: []string{"release"}},
						Context:  "pull-jab",
						Trigger:  `/test jab`,
					},
				},
			},
			ShouldBuild:   true,
			StartsExactly: "pull-jab",
		},
		{
			name:   "branch-sharded job. no shard matches base branch",
			Author: "t",
			Branch: "branch",
			Body:   "/test jab",
			State:  "open",
			IsPR:   true,
			Presubmits: map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:     "jab",
						Brancher: config.Brancher{Branches: []string{"master"}},
						Context:  "pull-jab",
						Trigger:  `/test jab`,
					},
					{
						Name:     "jab",
						Brancher: config.Brancher{Branches: []string{"release"}},
						Context:  "pull-jab",
						Trigger:  `/test jab`,
					},
				},
			},
			ShouldReport: true,
		},
	}
	for _, tc := range testcases {
		t.Logf("running scenario %q", tc.name)
		if tc.Branch == "" {
			tc.Branch = "master"
		}
		g := &fakegithub.FakeClient{
			CreatedStatuses: map[string][]github.Status{},
			IssueComments:   map[int][]github.IssueComment{},
			OrgMembers:      map[string][]string{"org": {"t"}},
			PullRequests: map[int]*github.PullRequest{
				0: {
					Number: 0,
					Head: github.PullRequestBranch{
						SHA: "cafe",
					},
					Base: github.PullRequestBranch{
						Ref: tc.Branch,
						Repo: github.Repo{
							Owner: github.User{Login: "org"},
							Name:  "repo",
						},
					},
				},
			},
			PullRequestChanges: map[int][]github.PullRequestChange{0: {{Filename: "CHANGED"}}},
			CombinedStatuses: map[string]*github.CombinedStatus{
				"cafe": {
					Statuses: []github.Status{
						{State: "pending", Context: "pull-job"},
						{State: "failure", Context: "pull-jib"},
						{State: "success", Context: "pull-jub"},
					},
				},
			},
		}
		kc := &fkc{}
		c := client{
			GitHubClient: g,
			KubeClient:   kc,
			Config:       &config.Config{},
			Logger:       logrus.WithField("plugin", pluginName),
		}
		presubmits := tc.Presubmits
		if presubmits == nil {
			presubmits = map[string][]config.Presubmit{
				"org/repo": {
					{
						Name:      "job",
						AlwaysRun: true,
						Context:   "pull-job",
						Trigger:   `/test all`,
						Brancher:  config.Brancher{Branches: []string{"master"}},
					},
					{
						Name:      "jib",
						AlwaysRun: false,
						Context:   "pull-jib",
						Trigger:   `/test jib`,
					},
				},
			}
		}
		c.Config.SetPresubmits(presubmits)

		var pr *struct{}
		if tc.IsPR {
			pr = &struct{}{}
		}
		if tc.HasOkToTest {
			g.IssueComments[0] = []github.IssueComment{{
				Body: "/ok-to-test",
				User: github.User{Login: "t"},
			}}
		}
		event := github.IssueCommentEvent{
			Action: github.IssueCommentActionCreated,
			Repo: github.Repo{
				Owner:    github.User{Login: "org"},
				Name:     "repo",
				FullName: "org/repo",
			},
			Comment: github.IssueComment{
				Body: tc.Body,
				User: github.User{Login: tc.Author},
			},
			Issue: github.Issue{
				PullRequest: pr,
				State:       tc.State,
			},
		}
		if len(tc.IssueLabels) > 0 {
			event.Issue.Labels = tc.IssueLabels
		}

		if err := handleIC(c, "kubernetes", event); err != nil {
			t.Fatalf("Didn't expect error: %s", err)
		}
		if len(kc.started) > 0 && !tc.ShouldBuild {
			t.Errorf("Built but should not have: %+v", tc)
		} else if len(kc.started) == 0 && tc.ShouldBuild {
			t.Errorf("Not built but should have: %+v", tc)
		}
		if tc.StartsExactly != "" && (len(kc.started) != 1 || kc.started[0] != tc.StartsExactly) {
			t.Errorf("Didn't build expected context %v, instead built %v", tc.StartsExactly, kc.started)
		}
		if tc.ShouldReport && len(g.CreatedStatuses) == 0 {
			t.Error("Expected report to github")
		} else if !tc.ShouldReport && len(g.CreatedStatuses) > 0 {
			t.Errorf("Expected no reports to github, but got %d", len(g.CreatedStatuses))
		}
		if tc.IsOkToTest {
			if len(g.LabelsRemoved) != 1 {
				t.Errorf("expected a label to be removed")
				continue
			}
			expected := "org/repo#0:needs-ok-to-test"
			if g.LabelsRemoved[0] != expected {
				t.Errorf("expected %q to be removed, got %q", expected, g.LabelsRemoved[0])
			}
		}
	}
}