sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/pod-utils/downwardapi/jobspec_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 downwardapi

import (
	"os"
	"reflect"
	"testing"

	prowapi "sigs.k8s.io/prow/pkg/apis/prowjobs/v1"
)

func TestEnvironmentForSpec(t *testing.T) {
	var tests = []struct {
		name     string
		spec     JobSpec
		expected map[string]string
	}{
		{
			name: "periodic job",
			spec: JobSpec{
				Type:      prowapi.PeriodicJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
			},
			expected: map[string]string{
				"CI":          "true",
				"JOB_NAME":    "job-name",
				"BUILD_ID":    "0",
				"PROW_JOB_ID": "prowjob",
				"JOB_TYPE":    "periodic",
				"JOB_SPEC":    `{"type":"periodic","job":"job-name","buildid":"0","prowjobid":"prowjob"}`,
			},
		},
		{
			name: "postsubmit job",
			spec: JobSpec{
				Type:      prowapi.PostsubmitJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
				Refs: &prowapi.Refs{
					Org:     "org-name",
					Repo:    "repo-name",
					BaseRef: "base-ref",
					BaseSHA: "base-sha",
				},
			},
			expected: map[string]string{
				"CI":            "true",
				"JOB_NAME":      "job-name",
				"BUILD_ID":      "0",
				"PROW_JOB_ID":   "prowjob",
				"JOB_TYPE":      "postsubmit",
				"JOB_SPEC":      `{"type":"postsubmit","job":"job-name","buildid":"0","prowjobid":"prowjob","refs":{"org":"org-name","repo":"repo-name","base_ref":"base-ref","base_sha":"base-sha"}}`,
				"REPO_OWNER":    "org-name",
				"REPO_NAME":     "repo-name",
				"PULL_BASE_REF": "base-ref",
				"PULL_BASE_SHA": "base-sha",
				"PULL_REFS":     "base-ref:base-sha",
			},
		},
		{
			name: "batch job",
			spec: JobSpec{
				Type:      prowapi.BatchJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
				Refs: &prowapi.Refs{
					Org:     "org-name",
					Repo:    "repo-name",
					BaseRef: "base-ref",
					BaseSHA: "base-sha",
					Pulls: []prowapi.Pull{{
						Number:  1,
						Author:  "author-name",
						SHA:     "pull-sha",
						HeadRef: "branch-name-1",
					}, {
						Number:  2,
						Author:  "other-author-name",
						SHA:     "second-pull-sha",
						HeadRef: "branch-name-2",
					}},
				},
			},
			expected: map[string]string{
				"CI":            "true",
				"JOB_NAME":      "job-name",
				"BUILD_ID":      "0",
				"PROW_JOB_ID":   "prowjob",
				"JOB_TYPE":      "batch",
				"JOB_SPEC":      `{"type":"batch","job":"job-name","buildid":"0","prowjobid":"prowjob","refs":{"org":"org-name","repo":"repo-name","base_ref":"base-ref","base_sha":"base-sha","pulls":[{"number":1,"author":"author-name","sha":"pull-sha","head_ref":"branch-name-1"},{"number":2,"author":"other-author-name","sha":"second-pull-sha","head_ref":"branch-name-2"}]}}`,
				"REPO_OWNER":    "org-name",
				"REPO_NAME":     "repo-name",
				"PULL_BASE_REF": "base-ref",
				"PULL_BASE_SHA": "base-sha",
				"PULL_REFS":     "base-ref:base-sha,1:pull-sha,2:second-pull-sha",
			},
		},
		{
			name: "presubmit job",
			spec: JobSpec{
				Type:      prowapi.PresubmitJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
				Refs: &prowapi.Refs{
					Org:     "org-name",
					Repo:    "repo-name",
					BaseRef: "base-ref",
					BaseSHA: "base-sha",
					Pulls: []prowapi.Pull{{
						Number:  1,
						Author:  "author-name",
						SHA:     "pull-sha",
						HeadRef: "branch-name",
						Title:   "pull-title",
					}},
				},
			},
			expected: map[string]string{
				"CI":            "true",
				"JOB_NAME":      "job-name",
				"BUILD_ID":      "0",
				"PROW_JOB_ID":   "prowjob",
				"JOB_TYPE":      "presubmit",
				"JOB_SPEC":      `{"type":"presubmit","job":"job-name","buildid":"0","prowjobid":"prowjob","refs":{"org":"org-name","repo":"repo-name","base_ref":"base-ref","base_sha":"base-sha","pulls":[{"number":1,"author":"author-name","sha":"pull-sha","title":"pull-title","head_ref":"branch-name"}]}}`,
				"REPO_OWNER":    "org-name",
				"REPO_NAME":     "repo-name",
				"PULL_BASE_REF": "base-ref",
				"PULL_BASE_SHA": "base-sha",
				"PULL_REFS":     "base-ref:base-sha,1:pull-sha",
				"PULL_HEAD_REF": "branch-name",
				"PULL_NUMBER":   "1",
				"PULL_PULL_SHA": "pull-sha",
				"PULL_TITLE":    "pull-title",
			},
		},
		{
			name: "kubernetes agent",
			spec: JobSpec{
				Type:      prowapi.PeriodicJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
				agent:     prowapi.KubernetesAgent,
			},
			expected: map[string]string{
				"CI":           "true",
				"JOB_NAME":     "job-name",
				"BUILD_ID":     "0",
				"PROW_JOB_ID":  "prowjob",
				"BUILD_NUMBER": "0",
				"JOB_TYPE":     "periodic",
				"JOB_SPEC":     `{"type":"periodic","job":"job-name","buildid":"0","prowjobid":"prowjob"}`,
			},
		},
		{
			name: "jenkins agent",
			spec: JobSpec{
				Type:      prowapi.PeriodicJob,
				Job:       "job-name",
				BuildID:   "0",
				ProwJobID: "prowjob",
				agent:     prowapi.JenkinsAgent,
			},
			expected: map[string]string{
				"CI":          "true",
				"JOB_NAME":    "job-name",
				"BUILD_ID":    "0",
				"PROW_JOB_ID": "prowjob",
				"JOB_TYPE":    "periodic",
				"JOB_SPEC":    `{"type":"periodic","job":"job-name","buildid":"0","prowjobid":"prowjob"}`,
			},
		},
	}

	for _, test := range tests {
		env, err := EnvForSpec(test.spec)
		if err != nil {
			t.Errorf("%s: unexpected error: %v", test.name, err)
		}
		if actual, expected := env, test.expected; !reflect.DeepEqual(actual, expected) {
			t.Errorf("%s: got environment:\n\t%v\n\tbut expected:\n\t%v", test.name, actual, expected)
		}
	}
}

func TestGetRevisionFromSpec(t *testing.T) {
	var tests = []struct {
		name     string
		spec     JobSpec
		expected string
	}{
		{
			name: "Refs with Pull",
			spec: JobSpec{
				Refs: &prowapi.Refs{
					BaseRef: "master",
					BaseSHA: "deadbeef",
					Pulls: []prowapi.Pull{
						{
							Number: 123,
							SHA:    "abcd1234",
						},
					},
				},
			},
			expected: "abcd1234",
		},
		{
			name: "Refs with BaseSHA",
			spec: JobSpec{
				Refs: &prowapi.Refs{
					BaseRef: "master",
					BaseSHA: "deadbeef",
				},
			},
			expected: "deadbeef",
		},
		{
			name: "Refs with BaseRef",
			spec: JobSpec{
				Refs: &prowapi.Refs{
					BaseRef: "master",
				},
			},
			expected: "master",
		},
		{
			name: "Refs from extra_refs",
			spec: JobSpec{
				ExtraRefs: []prowapi.Refs{
					{
						BaseRef: "master",
					},
				},
			},
			expected: "master",
		},
	}

	for _, test := range tests {
		if actual, expected := GetRevisionFromSpec(&test.spec), test.expected; actual != expected {
			t.Errorf("%s: got revision:%s but expected: %s", test.name, actual, expected)
		}
	}
}

func TestInCI(t *testing.T) {
	os.Setenv("CI", "true")
	if !InCI() {
		t.Error("we expected InCI() to return true, but it returned false")
	}
}