feat: Add Summaries to Plan And Apply PR Comments (runatlantis#3889)

server/controllers/events/testdata/test-repos/automerge/exp-output-autoplan.txt

@@ -49,6 +49,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
     * `atlantis plan -d dir2`
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/import-multiple-project/exp-output-autoplan.txt

@@ -69,6 +69,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/import-multiple-project/exp-output-plan-again.txt

@@ -53,6 +53,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 1 with changes, 1 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/modules-yaml/exp-output-autoplan.txt

@@ -63,6 +63,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/policy-checks-multi-projects/exp-output-apply.txt

@@ -19,4 +19,7 @@ workspace = "default"
 ### 2. dir: `dir2` workspace: `default`
 **Apply Failed**: All policies must pass for project before running apply.
 
----
+---
+### Apply Summary
+
+2 projects, 1 successful, 1 failed, 0 errored

server/controllers/events/testdata/test-repos/policy-checks-multi-projects/exp-output-autoplan.txt

@@ -63,6 +63,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/repo-config-file/exp-output-apply.txt

@@ -20,4 +20,7 @@ null_resource.staging[0]: Creation complete after *s [id=*******************]
 Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
 ```
 
----
+---
+### Apply Summary
+
+2 projects, 2 successful, 0 failed, 0 errored

server/controllers/events/testdata/test-repos/repo-config-file/exp-output-autoplan.txt

@@ -49,6 +49,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
     * `atlantis plan -d infrastructure/production`
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/server-side-cfg/exp-output-autoplan.txt

@@ -71,6 +71,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/simple-yaml/exp-output-apply-all.txt

@@ -38,4 +38,7 @@ postapply
 
 </details>
 
----
+---
+### Apply Summary
+
+2 projects, 2 successful, 0 failed, 0 errored

server/controllers/events/testdata/test-repos/simple-yaml/exp-output-autoplan.txt

@@ -70,6 +70,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/simple/exp-output-apply-var-all.txt

@@ -46,4 +46,7 @@ workspace = "new_workspace"
 
 </details>
 
----
+---
+### Apply Summary
+
+2 projects, 2 successful, 0 failed, 0 errored

server/controllers/events/testdata/test-repos/state-rm-multiple-project/exp-output-autoplan.txt

@@ -69,6 +69,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/state-rm-multiple-project/exp-output-plan-again.txt

@@ -69,6 +69,10 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/state-rm-multiple-project/exp-output-plan.txt

@@ -37,6 +37,10 @@ and found no differences, so no changes are needed.
     * `atlantis plan -d dir2`
 
 ---
+### Plan Summary
+
+2 projects, 0 with changes, 2 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/tfvars-yaml/exp-output-autoplan.txt

@@ -67,6 +67,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/workspace-parallel-yaml/exp-output-autoplan-production.txt

@@ -63,6 +63,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/controllers/events/testdata/test-repos/workspace-parallel-yaml/exp-output-autoplan-staging.txt

@@ -63,6 +63,10 @@ Changes to Outputs:
 Plan: 1 to add, 0 to change, 0 to destroy.
 
 ---
+### Plan Summary
+
+2 projects, 2 with changes, 0 with no changes, 0 failed
+
 * :fast_forward: To **apply** all unapplied plans from this pull request, comment:
     * `atlantis apply`
 * :put_litter_in_its_place: To **delete** all plans and locks for the PR, comment:

server/events/apply_command_runner_test.go

@@ -258,7 +258,7 @@ func TestApplyCommandRunner_ExecutionOrder(t *testing.T) {
 			},
 			ExpComment: "Ran Apply for 2 projects:\n\n" +
 				"1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n\n### 1. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### " +
-				"2. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---",
+				"2. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---\n### Apply Summary\n\n2 projects, 1 successful, 0 failed, 1 errored",
 		},
 		{
 			Description: "When first apply fails, the second not will run",
@@ -343,7 +343,7 @@ func TestApplyCommandRunner_ExecutionOrder(t *testing.T) {
 			},
 			ExpComment: "Ran Apply for 2 projects:\n\n" +
 				"1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n\n### 1. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### " +
-				"2. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---",
+				"2. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---\n### Apply Summary\n\n2 projects, 1 successful, 0 failed, 1 errored",
 		},
 		{
 			Description: "When one out of two fails, the following two will not run",
@@ -398,7 +398,7 @@ func TestApplyCommandRunner_ExecutionOrder(t *testing.T) {
 				"1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n\n### 1. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### " +
 				"2. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### " +
 				"3. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---\n### " +
-				"4. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---",
+				"4. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### Apply Summary\n\n4 projects, 3 successful, 0 failed, 1 errored",
 		},
 		{
 			Description: "Don't block when parallel is not set",
@@ -430,7 +430,7 @@ func TestApplyCommandRunner_ExecutionOrder(t *testing.T) {
 			},
 			ExpComment: "Ran Apply for 2 projects:\n\n" +
 				"1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n\n### 1. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---\n### " +
-				"2. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---",
+				"2. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### Apply Summary\n\n2 projects, 1 successful, 0 failed, 1 errored",
 		},
 		{
 			Description: "Don't block when abortOnExcecutionOrderFail is not set",
@@ -460,7 +460,7 @@ func TestApplyCommandRunner_ExecutionOrder(t *testing.T) {
 			},
 			ExpComment: "Ran Apply for 2 projects:\n\n" +
 				"1. dir: `` workspace: ``\n1. dir: `` workspace: ``\n\n### 1. dir: `` workspace: ``\n**Apply Error**\n```\nshabang\n```\n\n---\n### " +
-				"2. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---",
+				"2. dir: `` workspace: ``\n```diff\nGreat success!\n```\n\n---\n### Apply Summary\n\n2 projects, 1 successful, 0 failed, 1 errored",
 		},
 	}
 

server/events/markdown_renderer.go

@@ -93,6 +93,22 @@ type resultData struct {
 	commonData
 }
 
+type planResultData struct {
+	Results []projectResultTmplData
+	commonData
+	NumPlansWithChanges   int
+	NumPlansWithNoChanges int
+	NumPlanFailures       int
+}
+
+type applyResultData struct {
+	Results []projectResultTmplData
+	commonData
+	NumApplySuccesses int
+	NumApplyFailures  int
+	NumApplyErrors    int
+}
+
 type planSuccessData struct {
 	models.PlanSuccess
 	PlanSummary              string
@@ -187,6 +203,11 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 	numPolicyCheckSuccesses := 0
 	numPolicyApprovalSuccesses := 0
 	numVersionSuccesses := 0
+	numPlansWithChanges := 0
+	numPlansWithNoChanges := 0
+	numApplySuccesses := 0
+	numApplyFailures := 0
+	numApplyErrors := 0
 
 	templates := m.markdownTemplates
 
@@ -213,6 +234,11 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 				resultData.Rendered = m.renderTemplateTrimSpace(templates.Lookup("planSuccessUnwrapped"), data)
 			}
 			resultData.NoChanges = result.PlanSuccess.NoChanges()
+			if result.PlanSuccess.NoChanges() {
+				numPlansWithNoChanges++
+			} else {
+				numPlansWithChanges++
+			}
 			numPlanSuccesses++
 		} else if result.PolicyCheckResults != nil && common.Command == policyCheckCommandTitle {
 			policyCheckResults := policyCheckResultsData{
@@ -255,6 +281,7 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 			} else {
 				resultData.Rendered = m.renderTemplateTrimSpace(templates.Lookup("applyUnwrappedSuccess"), struct{ Output string }{output})
 			}
+			numApplySuccesses++
 		} else if result.VersionSuccess != "" {
 			output := strings.TrimSpace(result.VersionSuccess)
 			if m.shouldUseWrappedTmpl(vcsHost, output) {
@@ -289,8 +316,14 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 				tmpl = templates.Lookup("wrappedErr")
 			}
 			resultData.Rendered = m.renderTemplateTrimSpace(tmpl, errData{result.Error.Error(), resultData.Rendered, common})
+			if common.Command == applyCommandTitle {
+				numApplyErrors++
+			}
 		} else if result.Failure != "" {
 			resultData.Rendered = m.renderTemplateTrimSpace(templates.Lookup("failure"), failureData{result.Failure, resultData.Rendered, common})
+			if common.Command == applyCommandTitle {
+				numApplyFailures++
+			}
 		}
 		resultsTmplData = append(resultsTmplData, resultData)
 	}
@@ -324,7 +357,7 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 		tmpl = templates.Lookup("multiProjectPlan")
 	case common.Command == policyCheckCommandTitle:
 		if numPolicyCheckSuccesses == len(results) {
-			tmpl = templates.Lookup("multiProjectPlan")
+			tmpl = templates.Lookup("multiProjectPolicy")
 		} else {
 			tmpl = templates.Lookup("multiProjectPolicyUnsuccessful")
 		}
@@ -350,6 +383,14 @@ func (m *MarkdownRenderer) renderProjectResults(results []command.ProjectResult,
 	default:
 		return fmt.Sprintf("no template matched–this is a bug: command=%s", common.Command)
 	}
+
+	switch {
+	case common.Command == planCommandTitle:
+		numPlanFailures := len(results) - numPlanSuccesses
+		return m.renderTemplateTrimSpace(tmpl, planResultData{resultsTmplData, common, numPlansWithChanges, numPlansWithNoChanges, numPlanFailures})
+	case common.Command == applyCommandTitle:
+		return m.renderTemplateTrimSpace(tmpl, applyResultData{resultsTmplData, common, numApplySuccesses, numApplyFailures, numApplyErrors})
+	}
 	return m.renderTemplateTrimSpace(tmpl, resultData{resultsTmplData, common})
 }