add a message to show how much work was done in each MR (#397)

Author: djeebus

pkg/events/check.go

@@ -325,7 +325,11 @@ func (ce *CheckEvent) Process(ctx context.Context) error {
 
 	ce.logger.Info().Msg("Finished")
 
-	comment := ce.vcsNote.BuildComment(ctx, start, ce.pullRequest.SHA, ce.ctr.Config.LabelFilter, ce.ctr.Config.ShowDebugInfo, ce.ctr.Config.Identifier)
+	comment := ce.vcsNote.BuildComment(
+		ctx, start, ce.pullRequest.SHA, ce.ctr.Config.LabelFilter,
+		ce.ctr.Config.ShowDebugInfo, ce.ctr.Config.Identifier,
+		len(ce.addedAppsSet), int(ce.appsSent),
+	)
 
 	if err = ce.ctr.VcsClient.UpdateMessage(ctx, ce.vcsNote, comment); err != nil {
 		return errors.Wrap(err, "failed to push comment")

pkg/msg/message.go

@@ -127,7 +127,10 @@ func init() {
 	hostname, _ = os.Hostname()
 }
 
-func (m *Message) buildFooter(start time.Time, commitSHA, labelFilter string, showDebugInfo bool) string {
+func (m *Message) buildFooter(
+	start time.Time, commitSHA, labelFilter string, showDebugInfo bool,
+	appsChecked, totalChecked int,
+) string {
 	if !showDebugInfo {
 		return fmt.Sprintf("<small> _Done. CommitSHA: %s_ <small>\n", commitSHA)
 	}
@@ -138,11 +141,15 @@ func (m *Message) buildFooter(start time.Time, commitSHA, labelFilter string, sh
 	}
 	duration := time.Since(start)
 
-	return fmt.Sprintf("<small> _Done: Pod: %s, Dur: %v, SHA: %s%s_ <small>\n", hostname, duration, pkg.GitCommit, envStr)
+	return fmt.Sprintf("<small> _Done: Pod: %s, Dur: %v, SHA: %s%s_ <small>, Apps Checked: %d, Total Checks: %d\n",
+		hostname, duration.Round(time.Second), pkg.GitCommit, envStr, appsChecked, totalChecked)
 }
 
 // BuildComment iterates the map of all apps in this message, building a final comment from their current state
-func (m *Message) BuildComment(ctx context.Context, start time.Time, commitSHA, labelFilter string, showDebugInfo bool, identifier string) string {
+func (m *Message) BuildComment(
+	ctx context.Context, start time.Time, commitSHA, labelFilter string, showDebugInfo bool, identifier string,
+	appsChecked, totalChecked int,
+) string {
 	_, span := tracer.Start(ctx, "buildComment")
 	defer span.End()
 
@@ -203,7 +210,7 @@ func (m *Message) BuildComment(ctx context.Context, start time.Time, commitSHA,
 		sb.WriteString("No changes")
 	}
 
-	footer := m.buildFooter(start, commitSHA, labelFilter, showDebugInfo)
+	footer := m.buildFooter(start, commitSHA, labelFilter, showDebugInfo, appsChecked, totalChecked)
 	sb.WriteString(fmt.Sprintf("\n\n%s", footer))
 
 	return sb.String()

pkg/msg/message_test.go

@@ -31,7 +31,7 @@ func TestBuildComment(t *testing.T) {
 	}
 	m := NewMessage("message", 1, 2, fakeEmojiable{":test:"})
 	m.apps = appResults
-	comment := m.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier")
+	comment := m.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier", 1, 2)
 	assert.Equal(t, `# Kubechecks test-identifier Report
 <details>
 <summary>
@@ -79,7 +79,7 @@ func TestBuildComment_SkipUnchanged(t *testing.T) {
 
 	m := NewMessage("message", 1, 2, fakeEmojiable{":test:"})
 	m.apps = appResults
-	comment := m.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier")
+	comment := m.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier", 1, 2)
 	assert.Equal(t, `# Kubechecks test-identifier Report
 <details>
 <summary>
@@ -183,7 +183,7 @@ func TestMultipleItemsWithNewlines(t *testing.T) {
 		Summary: "summary-2",
 		Details: "detail-2",
 	})
-	result := message.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier")
+	result := message.BuildComment(context.TODO(), time.Now(), "commit-sha", "label-filter", false, "test-identifier", 1, 2)
 
 	// header rows need double newlines before and after
 	index := 0