// Copyright 2023 Harness, Inc. // // 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 protection import ( "context" "reflect" "testing" "github.com/harness/gitness/app/services/codeowners" "github.com/harness/gitness/types" "github.com/harness/gitness/types/enum" ) // nolint:gocognit // it's a unit test func TestDefPullReq_MergeVerify(t *testing.T) { tests := []struct { name string def DefPullReq in MergeVerifyInput expCodes []string expParams [][]any expOut MergeVerifyOutput }{ { name: "empty-with-merge-method", in: MergeVerifyInput{ Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{ DeleteSourceBranch: false, AllowedMethods: nil, }, }, { name: "empty-no-merge-method-specified", in: MergeVerifyInput{}, expOut: MergeVerifyOutput{ DeleteSourceBranch: false, AllowedMethods: enum.MergeMethods, }, }, { name: codePullReqApprovalReqMinCount + "-fail", def: DefPullReq{Approvals: DefApprovals{RequireMinimumCount: 1}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ {ReviewDecision: enum.PullReqReviewDecisionChangeReq, SHA: "abc"}, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqMinCount}, expParams: [][]any{{0, 1}}, expOut: MergeVerifyOutput{MinimumRequiredApprovalsCount: 1}, }, { name: codePullReqApprovalReqMinCount + "-success", def: DefPullReq{Approvals: DefApprovals{RequireMinimumCount: 2}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abc"}, }, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{MinimumRequiredApprovalsCount: 2}, }, { name: codePullReqApprovalReqLatestCommit + "-fail", def: DefPullReq{Approvals: DefApprovals{RequireMinimumCount: 2, RequireLatestCommit: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abd"}, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqMinCountLatest}, expParams: [][]any{{1, 2}}, expOut: MergeVerifyOutput{MinimumRequiredApprovalsCountLatest: 2}, }, { name: codePullReqApprovalReqLatestCommit + "-success", def: DefPullReq{Approvals: DefApprovals{RequireMinimumCount: 2, RequireLatestCommit: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ {ReviewDecision: enum.PullReqReviewDecisionPending, SHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionApproved, SHA: "abc"}, }, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{MinimumRequiredApprovalsCountLatest: 2}, }, { name: codePullReqApprovalReqCodeOwnersNoApproval + "-fail", def: DefPullReq{Approvals: DefApprovals{RequireCodeOwners: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, CodeOwners: &codeowners.Evaluation{ EvaluationEntries: []codeowners.EvaluationEntry{ { Pattern: "app", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionPending, ReviewSHA: "abc"}, }, }, { Pattern: "doc", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, }, }, { Pattern: "data", OwnerEvaluations: []codeowners.OwnerEvaluation{}, }, }, FileSha: "xyz", }, Method: enum.MergeMethodMerge, }, expCodes: []string{ codePullReqApprovalReqCodeOwnersNoApproval, codePullReqApprovalReqCodeOwnersNoApproval, }, expParams: [][]any{{"app"}, {"data"}}, expOut: MergeVerifyOutput{RequiresCodeOwnersApproval: true}, }, { name: codePullReqApprovalReqCodeOwnersNoApproval + "-success", def: DefPullReq{Approvals: DefApprovals{RequireCodeOwners: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, CodeOwners: &codeowners.Evaluation{ EvaluationEntries: []codeowners.EvaluationEntry{ { Pattern: "app", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, }, }, { Pattern: "doc", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, }, }, }, FileSha: "xyz", }, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{RequiresCodeOwnersApproval: true}, }, { name: codePullReqApprovalReqCodeOwnersChangeRequested + "-fail", def: DefPullReq{Approvals: DefApprovals{RequireCodeOwners: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, CodeOwners: &codeowners.Evaluation{ EvaluationEntries: []codeowners.EvaluationEntry{ { Pattern: "app", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionChangeReq, ReviewSHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionPending, ReviewSHA: "abc"}, }, }, { Pattern: "data", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, }, }, }, FileSha: "xyz", }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqCodeOwnersChangeRequested}, expParams: [][]any{{"app"}}, expOut: MergeVerifyOutput{RequiresCodeOwnersApproval: true}, }, { name: codePullReqApprovalReqCodeOwnersNoLatestApproval + "-fail", def: DefPullReq{Approvals: DefApprovals{RequireCodeOwners: true, RequireLatestCommit: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0, SourceSHA: "abc"}, CodeOwners: &codeowners.Evaluation{ EvaluationEntries: []codeowners.EvaluationEntry{ { Pattern: "data", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "old"}, }, }, { Pattern: "app", OwnerEvaluations: []codeowners.OwnerEvaluation{ {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "abc"}, {ReviewDecision: enum.PullReqReviewDecisionApproved, ReviewSHA: "old"}, }, }, }, FileSha: "xyz", }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqCodeOwnersNoLatestApproval}, expParams: [][]any{{"data"}}, expOut: MergeVerifyOutput{RequiresCodeOwnersApprovalLatest: true}, }, { name: codePullReqCommentsReqResolveAll + "-fail", def: DefPullReq{Comments: DefComments{RequireResolveAll: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 6}, Method: enum.MergeMethodMerge, }, expCodes: []string{"pullreq.comments.require_resolve_all"}, expParams: [][]any{{6}}, expOut: MergeVerifyOutput{RequiresCommentResolution: true}, }, { name: codePullReqCommentsReqResolveAll + "-success", def: DefPullReq{Comments: DefComments{RequireResolveAll: true}}, in: MergeVerifyInput{ PullReq: &types.PullReq{UnresolvedCount: 0}, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{RequiresCommentResolution: true}, }, { name: codePullReqStatusChecksReqIdentifiers + "-fail", def: DefPullReq{StatusChecks: DefStatusChecks{RequireIdentifiers: []string{"check1"}}}, in: MergeVerifyInput{ CheckResults: []types.CheckResult{ {Identifier: "check1", Status: enum.CheckStatusFailure}, {Identifier: "check2", Status: enum.CheckStatusSuccess}, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqStatusChecksReqIdentifiers}, expParams: [][]any{{"check1"}}, expOut: MergeVerifyOutput{}, }, { name: codePullReqStatusChecksReqIdentifiers + "-missing", def: DefPullReq{StatusChecks: DefStatusChecks{RequireIdentifiers: []string{"check1"}}}, in: MergeVerifyInput{ CheckResults: []types.CheckResult{ {Identifier: "check2", Status: enum.CheckStatusSuccess}, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqStatusChecksReqIdentifiers}, expParams: [][]any{{"check1"}}, expOut: MergeVerifyOutput{}, }, { name: codePullReqStatusChecksReqIdentifiers + "-success", def: DefPullReq{StatusChecks: DefStatusChecks{RequireIdentifiers: []string{"check1"}}}, in: MergeVerifyInput{ CheckResults: []types.CheckResult{ {Identifier: "check1", Status: enum.CheckStatusSuccess}, {Identifier: "check2", Status: enum.CheckStatusFailure}, }, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{}, }, { name: codePullReqMergeStrategiesAllowed + "-fail", def: DefPullReq{Merge: DefMerge{StrategiesAllowed: []enum.MergeMethod{ enum.MergeMethodRebase, enum.MergeMethodSquash, }}}, in: MergeVerifyInput{ Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqMergeStrategiesAllowed}, expParams: [][]any{{ enum.MergeMethodMerge, []enum.MergeMethod{ enum.MergeMethodRebase, enum.MergeMethodSquash, }}, }, expOut: MergeVerifyOutput{}, }, { name: codePullReqMergeStrategiesAllowed + "-success", def: DefPullReq{Merge: DefMerge{StrategiesAllowed: []enum.MergeMethod{ enum.MergeMethodRebase, enum.MergeMethodSquash, }}}, in: MergeVerifyInput{ Method: enum.MergeMethodSquash, }, expOut: MergeVerifyOutput{}, }, { name: codePullReqMergeDeleteBranch, def: DefPullReq{Merge: DefMerge{DeleteBranch: true}}, in: MergeVerifyInput{ Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{ DeleteSourceBranch: true, AllowedMethods: nil, }, }, { name: codePullReqApprovalReqChangeRequested + "-true", def: DefPullReq{ Approvals: DefApprovals{RequireNoChangeRequest: true}, }, in: MergeVerifyInput{ PullReq: &types.PullReq{SourceSHA: "abc"}, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{RequiresNoChangeRequests: true}, }, { name: codePullReqApprovalReqChangeRequested + "-false", def: DefPullReq{ Approvals: DefApprovals{RequireNoChangeRequest: false}, }, in: MergeVerifyInput{ PullReq: &types.PullReq{SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ {ReviewDecision: enum.PullReqReviewDecisionChangeReq, SHA: "abc"}, }, Method: enum.MergeMethodMerge, }, expOut: MergeVerifyOutput{}, }, { name: codePullReqApprovalReqChangeRequested + "-sameSHA", def: DefPullReq{ Approvals: DefApprovals{RequireNoChangeRequest: true}, }, in: MergeVerifyInput{ PullReq: &types.PullReq{SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ { ReviewDecision: enum.PullReqReviewDecisionChangeReq, Reviewer: types.PrincipalInfo{DisplayName: "John"}, SHA: "abc", }, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqChangeRequested}, expParams: [][]any{{"John"}}, expOut: MergeVerifyOutput{RequiresNoChangeRequests: true}, }, { name: codePullReqApprovalReqChangeRequested + "-diffSHA", def: DefPullReq{ Approvals: DefApprovals{RequireNoChangeRequest: true}, }, in: MergeVerifyInput{ PullReq: &types.PullReq{SourceSHA: "abc"}, Reviewers: []*types.PullReqReviewer{ { ReviewDecision: enum.PullReqReviewDecisionChangeReq, Reviewer: types.PrincipalInfo{DisplayName: "John"}, SHA: "def", }, }, Method: enum.MergeMethodMerge, }, expCodes: []string{codePullReqApprovalReqChangeRequestedOldSHA}, expParams: [][]any{{"John"}}, expOut: MergeVerifyOutput{RequiresNoChangeRequests: true}, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { if err := test.def.Sanitize(); err != nil { t.Errorf("def invalid: %s", err.Error()) return } out, violations, err := test.def.MergeVerify(context.Background(), test.in) if err != nil { t.Errorf("got an error: %s", err.Error()) return } if want, got := test.expOut, out; !reflect.DeepEqual(want, got) { t.Errorf("output mismatch: want=%+v got=%+v", want, got) } inspectBranchViolations(t, test.expCodes, test.expParams, violations) }) } }