sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/cmd/branchprotector/request_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 main

import (
	"reflect"
	"testing"

	branchprotection "sigs.k8s.io/prow/pkg/config"
	"sigs.k8s.io/prow/pkg/github"
)

func TestMakeBool(t *testing.T) {
	yes := true
	no := false
	cases := []struct {
		input    *bool
		expected bool
	}{
		{
			input:    nil,
			expected: false,
		},
		{
			input:    &no,
			expected: false,
		},
		{
			input:    &yes,
			expected: true,
		},
	}
	for _, tc := range cases {
		if actual := makeBool(tc.input); actual != tc.expected {
			t.Errorf("%v: actual %v != expected %t", tc.input, actual, tc.expected)
		}
	}
}

func TestMakeReviews(t *testing.T) {
	zero := 0
	three := 3
	one := 1
	yes := true
	cases := []struct {
		name     string
		input    *branchprotection.ReviewPolicy
		expected *github.RequiredPullRequestReviewsRequest
	}{
		{
			name: "nil returns nil",
		},
		{
			name: "nil apporvals returns nil",
			input: &branchprotection.ReviewPolicy{
				Approvals: nil,
			},
		},
		{
			name: "0 approvals set",
			input: &branchprotection.ReviewPolicy{
				Approvals: &zero,
			},
			expected: &github.RequiredPullRequestReviewsRequest{
				RequiredApprovingReviewCount: 0,
			},
		},
		{
			name: "approvals set",
			input: &branchprotection.ReviewPolicy{
				Approvals: &three,
			},
			expected: &github.RequiredPullRequestReviewsRequest{
				RequiredApprovingReviewCount: 3,
			},
		},
		{
			name: "set all",
			input: &branchprotection.ReviewPolicy{
				Approvals:     &one,
				RequireOwners: &yes,
				DismissStale:  &yes,
				DismissalRestrictions: &branchprotection.DismissalRestrictions{
					Users: []string{"fred", "jane"},
					Teams: []string{"megacorp", "startup"},
				},
				BypassRestrictions: &branchprotection.BypassRestrictions{
					Users: []string{"fred", "jane"},
					Teams: []string{"megacorp", "startup"},
				},
			},
			expected: &github.RequiredPullRequestReviewsRequest{
				RequiredApprovingReviewCount: 1,
				RequireCodeOwnerReviews:      true,
				DismissStaleReviews:          true,
				DismissalRestrictions: github.DismissalRestrictionsRequest{
					Teams: &[]string{"megacorp", "startup"},
					Users: &[]string{"fred", "jane"},
				},
				BypassRestrictions: github.BypassRestrictionsRequest{
					Teams: &[]string{"megacorp", "startup"},
					Users: &[]string{"fred", "jane"},
				},
			},
		},
	}

	for _, tc := range cases {
		actual := makeReviews(tc.input)
		if !reflect.DeepEqual(actual, tc.expected) {
			t.Errorf("%s: actual %v != expected %v", tc.name, actual, tc.expected)
		}
	}
}

func TestMakeRequest(t *testing.T) {
	yes := true
	no := false
	cases := []struct {
		name                    string
		disableAppsRestrictions bool
		policy                  branchprotection.Policy
		expected                github.BranchProtectionRequest
	}{
		{
			name: "Empty works",
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
			},
		},
		{
			name: "teams != nil => apps != nil, users != nil",
			policy: branchprotection.Policy{
				Restrictions: &branchprotection.Restrictions{
					Teams: []string{"hello"},
				},
			},
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
				Restrictions: &github.RestrictionsRequest{
					Apps:  &[]string{},
					Teams: &[]string{"hello"},
					Users: &[]string{},
				},
			},
		},
		{
			name: "users != nil => apps != nil, teams != nil",
			policy: branchprotection.Policy{
				Restrictions: &branchprotection.Restrictions{
					Users: []string{"there"},
				},
			},
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
				Restrictions: &github.RestrictionsRequest{
					Apps:  &[]string{},
					Users: &[]string{"there"},
					Teams: &[]string{},
				},
			},
		},
		{
			name: "apps != nil => users != nil, teams != nil",
			policy: branchprotection.Policy{
				Restrictions: &branchprotection.Restrictions{
					Apps: []string{"friends"},
				},
			},
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
				Restrictions: &github.RestrictionsRequest{
					Apps:  &[]string{"friends"},
					Users: &[]string{},
					Teams: &[]string{},
				},
			},
		},
		{
			name:                    "apps restrictions disabled works",
			disableAppsRestrictions: true,
			policy: branchprotection.Policy{
				Restrictions: &branchprotection.Restrictions{
					Teams: []string{"hello"},
					Users: []string{"there"},
				},
			},
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
				Restrictions: &github.RestrictionsRequest{
					Apps:  nil,
					Teams: &[]string{"hello"},
					Users: &[]string{"there"},
				},
			},
		},
		{
			name: "Strict => Contexts != nil",
			policy: branchprotection.Policy{
				RequiredStatusChecks: &branchprotection.ContextPolicy{
					Strict: &yes,
				},
			},
			expected: github.BranchProtectionRequest{
				EnforceAdmins: &no,
				RequiredStatusChecks: &github.RequiredStatusChecks{
					Strict:   true,
					Contexts: []string{},
				},
			},
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			actual := makeRequest(tc.policy, !tc.disableAppsRestrictions)
			expected := tc.expected
			if !reflect.DeepEqual(actual, expected) {
				t.Errorf("actual %+v != expected %+v", actual, expected)
			}
		})
	}
}