sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/plugins/trigger/push_test.go

/*
Copyright 2018 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 (
	"context"
	"testing"

	"github.com/sirupsen/logrus"
	clienttesting "k8s.io/client-go/testing"

	"k8s.io/apimachinery/pkg/api/equality"
	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/diff"
	prowapi "sigs.k8s.io/prow/pkg/apis/prowjobs/v1"
	"sigs.k8s.io/prow/pkg/client/clientset/versioned/fake"
	"sigs.k8s.io/prow/pkg/config"
	"sigs.k8s.io/prow/pkg/github"

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

func TestCreateRefs(t *testing.T) {
	pe := github.PushEvent{
		Ref: "refs/heads/master",
		Repo: github.Repo{
			Owner: github.User{
				Name: "kubernetes",
			},
			Name:    "repo",
			HTMLURL: "https://example.com/kubernetes/repo",
		},
		After:   "abcdef",
		Compare: "https://example.com/kubernetes/repo/compare/abcdee...abcdef",
	}
	expected := prowapi.Refs{
		Org:      "kubernetes",
		Repo:     "repo",
		RepoLink: "https://example.com/kubernetes/repo",
		BaseRef:  "master",
		BaseSHA:  "abcdef",
		BaseLink: "https://example.com/kubernetes/repo/compare/abcdee...abcdef",
	}
	if actual := createRefs(pe); !equality.Semantic.DeepEqual(expected, actual) {
		t.Errorf("diff between expected and actual refs:%s", diff.ObjectReflectDiff(expected, actual))
	}
}

func TestHandlePE(t *testing.T) {
	testCases := []struct {
		name      string
		pe        github.PushEvent
		jobsToRun int
	}{
		{
			name: "branch deleted",
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
				Deleted: true,
			},
			jobsToRun: 0,
		},
		{
			name: "null after sha",
			pe: github.PushEvent{
				After: "0000000000000000000000000000000000000000",
				Ref:   "refs/heads/master",
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
			},
			jobsToRun: 0,
		},
		{
			name: "no matching files",
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Commits: []github.Commit{
					{
						Added: []string{"example.txt"},
					},
				},
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
			},
		},
		{
			name: "one matching file",
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Commits: []github.Commit{
					{
						Added:    []string{"example.txt"},
						Modified: []string{"hack.sh"},
					},
				},
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
			},
			jobsToRun: 1,
		},
		{
			name: "no change matcher",
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Commits: []github.Commit{
					{
						Added: []string{"example.txt"},
					},
				},
				Repo: github.Repo{
					Owner: github.User{Login: "org2"},
					Name:  "repo2",
				},
			},
			jobsToRun: 1,
		},
		{
			name: "branch name with a slash",
			pe: github.PushEvent{
				Ref: "refs/heads/release/v1.14",
				Commits: []github.Commit{
					{
						Added: []string{"hack.sh"},
					},
				},
				Repo: github.Repo{
					Owner: github.User{Login: "org3"},
					Name:  "repo3",
				},
			},
			jobsToRun: 1,
		},
	}
	for _, tc := range testCases {
		g := fakegithub.NewFakeClient()
		fakeProwJobClient := fake.NewSimpleClientset()
		c := Client{
			GitHubClient:  g,
			ProwJobClient: fakeProwJobClient.ProwV1().ProwJobs("prowjobs"),
			Config:        &config.Config{ProwConfig: config.ProwConfig{ProwJobNamespace: "prowjobs"}},
			Logger:        logrus.WithField("plugin", PluginName),
		}
		postsubmits := map[string][]config.Postsubmit{
			"org/repo": {
				{
					JobBase: config.JobBase{
						Name: "pass-butter",
					},
					RegexpChangeMatcher: config.RegexpChangeMatcher{
						RunIfChanged: "\\.sh$",
					},
				},
			},
			"org2/repo2": {
				{
					JobBase: config.JobBase{
						Name: "pass-salt",
					},
				},
			},
			"org3/repo3": {
				{
					JobBase: config.JobBase{
						Name: "pass-pepper",
					},
					Brancher: config.Brancher{
						Branches: []string{"release/v1.14"},
					},
				},
			},
		}
		if err := c.Config.SetPostsubmits(postsubmits); err != nil {
			t.Fatalf("failed to set postsubmits: %v", err)
		}
		err := handlePE(c, tc.pe)
		if err != nil {
			t.Errorf("test %q: handlePE returned unexpected error %v", tc.name, err)
		}
		var numStarted int
		for _, action := range fakeProwJobClient.Fake.Actions() {
			switch action.(type) {
			case clienttesting.CreateActionImpl:
				numStarted++
			}
		}
		if numStarted != tc.jobsToRun {
			t.Errorf("test %q: expected %d jobs to run, got %d", tc.name, tc.jobsToRun, numStarted)
		}
	}
}

func TestHandlePEScheduling(t *testing.T) {
	job := config.JobBase{Name: "job"}
	postsubmits := map[string][]config.Postsubmit{"org/repo": {{JobBase: job}}}

	for _, tc := range []struct {
		name             string
		enableScheduling bool
		pe               github.PushEvent
		wantPJState      prowapi.ProwJobState
	}{
		{
			name: "Create job in triggered state",
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
			},
			wantPJState: prowapi.TriggeredState,
		},
		{
			name:             "Create job in scheduling state",
			enableScheduling: true,
			pe: github.PushEvent{
				Ref: "refs/heads/master",
				Repo: github.Repo{
					Owner: github.User{Login: "org"},
					Name:  "repo",
				},
			},
			wantPJState: prowapi.SchedulingState,
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			ghClient := fakegithub.NewFakeClient()
			fakeProwJobClient := fake.NewSimpleClientset()
			c := Client{
				GitHubClient:  ghClient,
				ProwJobClient: fakeProwJobClient.ProwV1().ProwJobs("prowjobs"),
				Config: &config.Config{ProwConfig: config.ProwConfig{
					ProwJobNamespace: "prowjobs",
					Scheduler:        config.Scheduler{Enabled: tc.enableScheduling},
				}},
				Logger: logrus.WithField("plugin", PluginName),
			}

			c.Config.SetPostsubmits(postsubmits)

			err := handlePE(c, tc.pe)
			if err != nil {
				t.Errorf("test %q: handlePE returned unexpected error %v", tc.name, err)
			}

			pjs, err := c.ProwJobClient.List(context.TODO(), v1.ListOptions{})
			if err != nil {
				t.Fatalf("Couldn't get PJs from the fake client: %s", err)
			}

			if len(pjs.Items) != 1 {
				t.Errorf("Expected 1 job but got %d", len(pjs.Items))
			}

			resultPJ := pjs.Items[0]
			if job.Name != resultPJ.Spec.Job {
				t.Errorf("Expected job %s but got %s", job.Name, resultPJ.Spec.Job)
			}

			if tc.wantPJState != resultPJ.Status.State {
				t.Errorf("Expected state %s but got %s", tc.wantPJState, resultPJ.Status.State)
			}
		})
	}
}