Skip to content
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.

Sign up for GitHub

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

fix: Policy check summary not shown outside of "Show Output" details #2837

Merged
merged 1 commit into from
Dec 20, 2022
+32 −12
Merged

fix: Policy check summary not shown outside of "Show Output" details #2837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions server/events/markdown_renderer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,10 +260,15 @@ $$$
[]command.ProjectResult{
{
PolicyCheckSuccess: &models.PolicyCheckSuccess{
PolicyCheckOutput: "2 tests, 1 passed, 0 warnings, 0 failure, 0 exceptions",
LockURL: "lock-url",
RePlanCmd: "atlantis plan -d path -w workspace",
ApplyCmd: "atlantis apply -d path -w workspace",
// strings.Repeat require to get wrapped result
PolicyCheckOutput: strings.Repeat("line\n", 13) + `Checking plan against the following policies:
test_policy
FAIL - <redacted plan file> - main - WARNING: Null Resource creation is prohibited.

2 tests, 1 passed, 0 warnings, 0 failure, 0 exceptions`,
LockURL: "lock-url",
RePlanCmd: "atlantis plan -d path -w workspace",
ApplyCmd: "atlantis apply -d path -w workspace",
},
Workspace: "workspace",
RepoRelDir: "path",
Expand All @@ -273,7 +278,13 @@ $$$
models.Github,
`Ran Policy Check for project: $projectname$ dir: $path$ workspace: $workspace$

<details><summary>Show Output</summary>

$$$diff
` + strings.Repeat("line\n", 13) + `Checking plan against the following policies:
test_policy
FAIL - <redacted plan file> - main - WARNING: Null Resource creation is prohibited.

2 tests, 1 passed, 0 warnings, 0 failure, 0 exceptions
$$$

Expand All @@ -282,6 +293,8 @@ $$$
* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
* :repeat: To re-run policies **plan** this project again by commenting:
* $atlantis plan -d path -w workspace$
</details>
2 tests, 1 passed, 0 warnings, 0 failure, 0 exceptions
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got this


---
* :fast_forward: To **apply** all unapplied plans from this pull request, comment:
Expand Down
2 changes: 1 addition & 1 deletion server/events/models/models.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ type PolicyCheckSuccess struct {
func (p *PolicyCheckSuccess) Summary() string {
note := ""

r := regexp.MustCompile(`\d+ tests, \d+ passed, \d+ warnings, \d+ failures, \d+ exceptions`)
r := regexp.MustCompile(`\d+ tests?, \d+ passed, \d+ warnings?, \d+ failures?, \d+ exceptions?(, \d skipped)?`)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

output contains plurals. like followings

>  pwd
/Users/krrrr38/dev/src/github.com/open-policy-agent/conftest

> ag exception output | grep failure
output/github_test.go:26:				"0 tests, 0 passed, 0 warnings, 0 failures, 0 exceptions",
output/github_test.go:45:				"2 tests, 0 passed, 1 warning, 1 failure, 0 exceptions",
output/github_test.go:64:				"2 tests, 0 passed, 0 warnings, 1 failure, 0 exceptions",
output/github_test.go:81:				"1 test, 0 passed, 0 warnings, 1 failure, 0 exceptions",
output/standard_test.go:31:				"2 tests, 0 passed, 1 warning, 1 failure, 0 exceptions",
output/standard_test.go:49:				"2 tests, 0 passed, 1 warning, 1 failure, 0 exceptions",
output/standard_test.go:69:				"3 tests, 0 passed, 1 warning, 1 failure, 0 exceptions, 1 skipped",
output/standard_test.go:88:				"2 tests, 0 passed, 1 warning, 1 failure, 0 exceptions, 0 skipped",
output/standard.go:127:	outputText := fmt.Sprintf("%v test%s, %v passed, %v warning%s, %v failure%s, %v exception%s",
output/github.go:87:	outputText := fmt.Sprintf("%v test%s, %v passed, %v warning%s, %v failure%s, %v exception%s",

https://github.com/open-policy-agent/conftest/blob/03626f5bd32becd69b0cf4cd87d441883702a5d2/output/standard.go#L127

if match := r.FindString(p.PolicyCheckOutput); match != "" {
return note + match
}
Expand Down
18 changes: 12 additions & 6 deletions server/events/models/models_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,13 +356,19 @@ func TestAzureDevopsSplitRepoFullName(t *testing.T) {
}

func TestPolicyCheckSuccess_Summary(t *testing.T) {
pcs := models.PolicyCheckSuccess{
PolicyCheckOutput: `WARN - <redacted plan file> - main - example main package

20 tests, 19 passed, 1 warnings, 0 failures, 0 exceptions`,
cases := []string{
"20 tests, 19 passed, 2 warnings, 0 failures, 0 exceptions",
"3 tests, 0 passed, 1 warning, 1 failure, 0 exceptions, 1 skipped",
"1 test, 0 passed, 1 warning, 1 failure, 1 exception",
}
for i, summary := range cases {
t.Run(fmt.Sprintf("summary %d", i), func(t *testing.T) {
pcs := models.PolicyCheckSuccess{
PolicyCheckOutput: `WARN - <redacted plan file> - main - example main package\n` + summary,
}
Equals(t, summary, pcs.Summary())
})
}

Equals(t, "20 tests, 19 passed, 1 warnings, 0 failures, 0 exceptions", pcs.Summary())
}

func TestPullStatus_StatusCount(t *testing.T) {
Expand Down
3 changes: 2 additions & 1 deletion server/events/templates/policy_check_success_wrapped.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@
* :put_litter_in_its_place: To **delete** this plan click [here]({{.LockURL}})
* :repeat: To re-run policies **plan** this project again by commenting:
* `{{.RePlanCmd}}`
</details>{{ template "diverged" . }}
</details>
{{.PolicyCheckSummary}}{{ template "diverged" . }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

renderer parameter contains PolicyCheckSummary by #2452. But template variable is not used, so not shown.

{{- end }}