-
Notifications
You must be signed in to change notification settings - Fork 33
Feat/add gitlab mr approval controls #423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Joseph94m
wants to merge
3
commits into
main
Choose a base branch
from
feat/add-gitlab-mr-approval-controls
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/getplumber/plumber/configuration" | ||
| ) | ||
|
|
||
| // applyAccessControls maps the three MR-approval wizard answers onto GitLab | ||
| // config. A field mix-up (wrong parse target, inverted Enabled, or one control | ||
| // writing the other's field) would silently emit a wrong .plumber.yaml from | ||
| // `plumber config init` with no drift guard, since both controls ship disabled. | ||
| // This pins the mapping. | ||
| func TestApplyAccessControls_MRApprovalMapping(t *testing.T) { | ||
| t.Run("min-approvals: enabled with the parsed count", func(t *testing.T) { | ||
| gl := &configuration.ProviderConfig{} | ||
| (&initWizardState{MRApprovalMinEnabled: true, MRApprovalMinCount: "3"}).applyAccessControls(gl, nil) | ||
| c := gl.Controls.MergeRequestApprovalRulesMustRequireMinimumApprovals | ||
| if c == nil || !c.IsEnabled() { | ||
| t.Fatal("min-approvals control should be enabled") | ||
| } | ||
| if c.MinimumRequiredApprovals == nil || *c.MinimumRequiredApprovals != 3 { | ||
| t.Fatalf("MinimumRequiredApprovals = %v, want 3", c.MinimumRequiredApprovals) | ||
| } | ||
| if gl.Controls.MergeRequestApprovalRulesMustCoverAllProtectedBranches != nil { | ||
| t.Fatal("cover-all must stay unset when only min-approvals was chosen (field mix-up)") | ||
| } | ||
| }) | ||
| t.Run("cover-all: enabled, min-approvals untouched", func(t *testing.T) { | ||
| gl := &configuration.ProviderConfig{} | ||
| (&initWizardState{MRApprovalCoverAllEnabled: true}).applyAccessControls(gl, nil) | ||
| if c := gl.Controls.MergeRequestApprovalRulesMustCoverAllProtectedBranches; c == nil || !c.IsEnabled() { | ||
| t.Fatal("cover-all control should be enabled") | ||
| } | ||
| if gl.Controls.MergeRequestApprovalRulesMustRequireMinimumApprovals != nil { | ||
| t.Fatal("min-approvals must stay unset when only cover-all was chosen (field mix-up)") | ||
| } | ||
| }) | ||
| t.Run("neither approval control set when neither chosen", func(t *testing.T) { | ||
| gl := &configuration.ProviderConfig{} | ||
| (&initWizardState{}).applyAccessControls(gl, nil) | ||
| if gl.Controls.MergeRequestApprovalRulesMustRequireMinimumApprovals != nil || gl.Controls.MergeRequestApprovalRulesMustCoverAllProtectedBranches != nil { | ||
| t.Fatal("no approval controls should be set when neither was chosen") | ||
| } | ||
| }) | ||
| // The wizard defaults must come from the embedded shipped default (both ship | ||
| // disabled), so the prompt defaults and the zero-config baseline cannot drift. | ||
| t.Run("defaults sourced from the embedded shipped default", func(t *testing.T) { | ||
| if defaultMRApprovalMinEnabled() { | ||
| t.Error("defaultMRApprovalMinEnabled should be false (ships disabled)") | ||
| } | ||
| if defaultMRApprovalCoverAllEnabled() { | ||
| t.Error("defaultMRApprovalCoverAllEnabled should be false (ships disabled)") | ||
| } | ||
| if got := defaultMRApprovalMinCount(); got < 1 { | ||
| t.Errorf("defaultMRApprovalMinCount = %d, want >= 1 (the shipped minimum)", got) | ||
| } | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/getplumber/plumber/control" | ||
| opaengine "github.com/getplumber/plumber/internal/engine/opa" | ||
| ) | ||
|
|
||
| // TestMRApprovalRulesJSONBlocks locks the results.json detail blocks for the | ||
| // two GitLab merge-request approval-rule controls (ISSUE-502/504). Before the | ||
| // per-control wiring, buildLegacyResult would return ("", nil) and the blocks | ||
| // would be dropped entirely — a dashboard would see the score deficit in | ||
| // plumberScore.codeLosses with no per-control detail. Mirrors the GitHub | ||
| // TestPullRequestTargetHeadCheckoutJSONBlock, the guard for the same bug class. | ||
| func TestMRApprovalRulesJSONBlocks(t *testing.T) { | ||
| result := &control.AnalysisResult{CiValid: true} | ||
|
|
||
| // ISSUE-502: minimum-approvals — one failing rule, keyed on the stable ID. | ||
| minEntry := control.ControlEntry{ | ||
| DisplayName: "MR approval rules must require a minimum number of approvals", | ||
| ControlName: "mergeRequestApprovalRulesMustRequireMinimumApprovals", | ||
| } | ||
| minFindings := []opaengine.Finding{{ | ||
| Code: "ISSUE-502", | ||
| Data: map[string]any{ | ||
| "approvalRuleId": "42", | ||
| "ruleName": "Security", | ||
| "approvalsRequired": 1, | ||
| "minApprovalsRequired": 2, | ||
| }, | ||
| }} | ||
|
|
||
| name, block := buildLegacyResult(minEntry, result, nil, minFindings) | ||
| if name != "mrApprovalRulesMinApprovalsResult" { | ||
| t.Fatalf("502 block name = %q, want mrApprovalRulesMinApprovalsResult (dispatch dropped the block)", name) | ||
| } | ||
| m, ok := block.(map[string]any) | ||
| if !ok { | ||
| t.Fatalf("502 block is %T, want map[string]any", block) | ||
| } | ||
| issues, ok := m["issues"].([]map[string]any) | ||
| if !ok || len(issues) != 1 { | ||
| t.Fatalf("502 issues = %v, want exactly 1 entry", m["issues"]) | ||
| } | ||
| if issues[0]["code"] != "ISSUE-502" { | ||
| t.Errorf("502 issue code = %v, want ISSUE-502", issues[0]["code"]) | ||
| } | ||
| // The rule identity (approvalRuleId) must survive into the issue block, so a | ||
| // platform can group the finding across runs; the renameable name is data. | ||
| if issues[0]["approvalRuleId"] != "42" { | ||
| t.Errorf("502 issue must carry approvalRuleId=42, got %v", issues[0]["approvalRuleId"]) | ||
| } | ||
| if metrics, ok := m["metrics"].(map[string]any); !ok || metrics["rulesBelowMinimum"] != 1 { | ||
| t.Errorf("502 metrics.rulesBelowMinimum = %v, want 1", m["metrics"]) | ||
| } | ||
|
|
||
| // ISSUE-504: cover-all — singleton finding. | ||
| coverEntry := control.ControlEntry{ | ||
| DisplayName: "MR approval rules must cover all protected branches", | ||
| ControlName: "mergeRequestApprovalRulesMustCoverAllProtectedBranches", | ||
| } | ||
| coverFindings := []opaengine.Finding{{ | ||
| Code: "ISSUE-504", | ||
| Data: map[string]any{"totalRules": 2}, | ||
| }} | ||
|
|
||
| name, block = buildLegacyResult(coverEntry, result, nil, coverFindings) | ||
| if name != "mrApprovalRulesCoverAllBranchesResult" { | ||
| t.Fatalf("504 block name = %q, want mrApprovalRulesCoverAllBranchesResult (dispatch dropped the block)", name) | ||
| } | ||
| m, ok = block.(map[string]any) | ||
| if !ok { | ||
| t.Fatalf("504 block is %T, want map[string]any", block) | ||
| } | ||
| if issues, ok := m["issues"].([]map[string]any); !ok || len(issues) != 1 || issues[0]["code"] != "ISSUE-504" { | ||
| t.Fatalf("504 issues = %v, want exactly 1 ISSUE-504 entry", m["issues"]) | ||
| } | ||
| if metrics, ok := m["metrics"].(map[string]any); !ok || metrics["allProtectedBranchesRuleMissing"] != 1 { | ||
| t.Errorf("504 metrics.allProtectedBranchesRuleMissing = %v, want 1", m["metrics"]) | ||
| } | ||
|
|
||
| // A clean run (no findings) still returns a block, with an empty issues list | ||
| // — the control is present and evaluated, not absent. | ||
| if _, clean := buildLegacyResult(minEntry, result, nil, nil); clean == nil { | ||
| t.Errorf("502 clean run returned a nil block; the control must still appear") | ||
| } | ||
| } | ||
|
|
||
| // TestMRApprovalRulesTierCaveatJSON pins the structured Premium/Ultimate caveat | ||
| // stamped onto the approval-rule blocks when the run flagged the ambiguous | ||
| // zero-rules case (GitLab Free returns an empty list). It must attach only to | ||
| // the two approval-rule controls, and only when the run set the flag. | ||
| func TestMRApprovalRulesTierCaveatJSON(t *testing.T) { | ||
| flagged := &control.AnalysisResult{CiValid: true, ApprovalRulesTierCaveat: true} | ||
| approval := control.ControlEntry{ControlName: "mergeRequestApprovalRulesMustCoverAllProtectedBranches"} | ||
|
|
||
| block := _withControlMeta(map[string]any{"issues": []map[string]any{}}, approval, flagged, 0) | ||
| m := block.(map[string]any) | ||
| tc, ok := m["tierCaveat"].(map[string]any) | ||
| if !ok { | ||
| t.Fatalf("expected a tierCaveat on the approval-rule block, got %v", m) | ||
| } | ||
| if tc["reason"] != "no-approval-rules-returned" || tc["requiresTier"] != "premium_or_ultimate" { | ||
| t.Errorf("tierCaveat shape mismatch: %v", tc) | ||
| } | ||
|
|
||
| // A non-approval control must NOT get the caveat, even when the flag is set. | ||
| other := _withControlMeta(map[string]any{}, control.ControlEntry{ControlName: "branchMustBeProtected"}, flagged, 0) | ||
| if _, present := other.(map[string]any)["tierCaveat"]; present { | ||
| t.Errorf("tierCaveat leaked onto a non-approval control") | ||
| } | ||
|
|
||
| // Flag not set (rules were present, or a premium project): no caveat. | ||
| clean := &control.AnalysisResult{CiValid: true} | ||
| if _, present := _withControlMeta(map[string]any{}, approval, clean, 0).(map[string]any)["tierCaveat"]; present { | ||
| t.Errorf("tierCaveat present when the run did not flag it") | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.