diff --git a/internal/plugin/reporter/github_pr.go b/internal/plugin/reporter/github_pr.go
index ba4a37d..6633aab 100644
--- a/internal/plugin/reporter/github_pr.go
+++ b/internal/plugin/reporter/github_pr.go
@@ -4,6 +4,7 @@ import (
"bytes"
"fmt"
"io"
+ "sort"
"strings"
"github.com/pkg/errors"
@@ -89,44 +90,47 @@ func (s *GithubPullRequest) createCommentBody(changedLinesWithCoverage domain.So
modules := collectModules(changedLinesWithCoverage)
- bodyLines := []string{
- "## š Code Coverage ā Changed Lines\n",
- "\n",
- "> Coverage is measured **only for the lines this PR changes**, not the whole file or repo.\n",
- "\n",
- }
+ covered := changedLinesWithCoverage.TotalCoveredInstructions()
+ missed := changedLinesWithCoverage.TotalMissedInstructions()
+ linesWithData := changedLinesWithCoverage.TotalLinesWithData()
+ linesWithoutData := changedLinesWithCoverage.TotalLinesWithoutData()
+
+ totalInstructions := covered + missed
+ totalLines := linesWithData + linesWithoutData
+
+ coveredPct := toPercent(safeDiv(float32(covered), float32(totalInstructions), 1))
+ missedPct := toPercent(safeDiv(float32(missed), float32(totalInstructions), 0))
+ withDataPct := toPercent(safeDiv(float32(linesWithData), float32(totalLines), 1))
+ withoutDataPct := toPercent(safeDiv(float32(linesWithoutData), float32(totalLines), 0))
+
+ var b strings.Builder
+
+ b.WriteString("## š”ļø Patch Coverage Report\n\n")
+ b.WriteString("> Scope: **changed lines only** ā the code this PR adds or edits, not whole files or the repo. ")
+ b.WriteString("It answers one thing ā *did your tests run the code you just touched?*\n\n")
if len(modules) > 0 {
- bodyLines = append(bodyLines, fmt.Sprintf("*Modules: %v*\n\n", strings.Join(modules, ", ")))
- }
-
- bodyLines = append(bodyLines, generateSummaryLines(changedLinesWithCoverage, func(linesWithDataCount int, linesWithoutDataCount int, covered int, missed int) []string {
- totalLines := linesWithDataCount + linesWithoutDataCount
- totalInstructions := covered + missed
-
- coveredPct := toPercent(safeDiv(float32(covered), float32(totalInstructions), 1))
- missedPct := toPercent(safeDiv(float32(missed), float32(totalInstructions), 0))
- withDataPct := toPercent(safeDiv(float32(linesWithDataCount), float32(totalLines), 1))
- withoutDataPct := toPercent(safeDiv(float32(linesWithoutDataCount), float32(totalLines), 0))
-
- return []string{
- fmt.Sprintf("### %v Covered Instructions: %.f%% (%d)\n", coverageStatusEmoji(coveredPct), coveredPct, covered),
- "\n",
- "| Metric | Result | What it means |\n",
- "| :-- | :-: | :-- |\n",
- fmt.Sprintf("| š¢ **Covered Instructions** | **%.f%%** (%d) | Changed code your tests executed. Higher is better. |\n", coveredPct, covered),
- fmt.Sprintf("| š“ **Missed Instructions** | %.f%% (%d) | Changed code your tests never ran. Lower is better. |\n", missedPct, missed),
- fmt.Sprintf("| š Lines With Coverage Data | %.f%% (%d) | Changed lines the coverage tool could track. |\n", withDataPct, linesWithDataCount),
- fmt.Sprintf("| āŖ Lines Without Coverage Data | %.f%% (%d) | Changed lines with no data: comments, blanks, declarations. |\n", withoutDataPct, linesWithoutDataCount),
- }
- })...)
+ fmt.Fprintf(&b, "*Modules:* %v\n\n", strings.Join(modules, ", "))
+ }
+
+ fmt.Fprintf(&b, "**Diff coverage:** `%.f%%` %v ā `%d` of `%d` changed instructions covered\n\n",
+ coveredPct, coverageStatusEmoji(coveredPct), covered, totalInstructions)
+
+ b.WriteString("| Metric | Value | |\n")
+ b.WriteString("| :-- | --: | :-- |\n")
+ fmt.Fprintf(&b, "| š¢ Covered instructions | `%d` (%.f%%) | changed code your tests executed |\n", covered, coveredPct)
+ fmt.Fprintf(&b, "| š“ Missed instructions | `%d` (%.f%%) | changed code your tests never ran |\n", missed, missedPct)
+ fmt.Fprintf(&b, "| š Tracked changed lines | `%d` (%.f%%) | lines the coverage tool could measure |\n", linesWithData, withDataPct)
+ fmt.Fprintf(&b, "| āŖ Untracked changed lines | `%d` (%.f%%) | comments, blanks, declarations |\n", linesWithoutData, withoutDataPct)
+ b.WriteString("\n")
+ b.WriteString("**Lines** = the source lines you changed. **Instructions** = the executable units the coverage tool counts inside those lines ā one line can hold several (e.g. JaCoCo bytecode), so the two counts differ.\n\n")
- body := strings.Join(bodyLines, "")
- body += missedInstructionsSection(changedLinesWithCoverage)
- body += "\nš¤ Generated by pull-request-code-coverage ā coverage for changed lines only.\n"
+ b.WriteString(fileCoverageSection(changedLinesWithCoverage))
+ b.WriteString(missedInstructionsSection(changedLinesWithCoverage))
+ b.WriteString("\nš¤ Generated by pull-request-code-coverage ā coverage for changed lines only.\n")
data := map[string]string{
- "body": body,
+ "body": b.String(),
}
dataBytes, marshalErr := s.jsonClient.Marshal(data)
@@ -138,6 +142,107 @@ func (s *GithubPullRequest) createCommentBody(changedLinesWithCoverage domain.So
return bytes.NewBuffer(dataBytes), nil
}
+// fileCoverage holds the aggregated changed-line coverage for a single file.
+type fileCoverage struct {
+ path string
+ covered int
+ missed int
+ linesWithData int
+ linesWithoutData int
+}
+
+// fileCoverageSection renders a per-file breakdown of changed-line coverage,
+// worst-covered files first so the riskiest changes surface at the top.
+func fileCoverageSection(changedLinesWithCoverage domain.SourceLineCoverageReport) string {
+ files := collectFileCoverage(changedLinesWithCoverage)
+
+ if len(files) == 0 {
+ return ""
+ }
+
+ // Files whose only changed lines carry no coverage data (config, docs,
+ // generated, test-only) would just be a wall of "n/a" rows, so keep them
+ // out of the table and summarise the count underneath instead.
+ unmeasured := 0
+
+ var b strings.Builder
+
+ b.WriteString("### Coverage by file\n\n")
+ b.WriteString("| File | Diff coverage | Covered / Missed |\n")
+ b.WriteString("| :-- | :-: | :-: |\n")
+
+ for _, f := range files {
+ instructions := f.covered + f.missed
+
+ if instructions == 0 {
+ unmeasured++
+ continue
+ }
+
+ pct := toPercent(safeDiv(float32(f.covered), float32(instructions), 1))
+ fmt.Fprintf(&b, "| `%v` | %v %.f%% | %d / %d |\n",
+ f.path, coverageStatusEmoji(pct), pct, f.covered, f.missed)
+ }
+
+ b.WriteString("\n")
+
+ if unmeasured > 0 {
+ fmt.Fprintf(&b, "%d changed file(s) with no measurable lines (config, docs, generated, or test-only) omitted.\n\n", unmeasured)
+ }
+
+ return b.String()
+}
+
+// collectFileCoverage aggregates changed-line coverage per file, sorted with the
+// lowest-covered files first (files with no measurable instructions last) so a
+// reviewer sees the riskiest files at the top of the table.
+func collectFileCoverage(changedLinesWithCoverage domain.SourceLineCoverageReport) []fileCoverage {
+ order := []string{}
+ byPath := map[string]*fileCoverage{}
+
+ for _, line := range changedLinesWithCoverage {
+ path := filePath(line.SourceLine)
+
+ fc, ok := byPath[path]
+ if !ok {
+ fc = &fileCoverage{path: path}
+ byPath[path] = fc
+ order = append(order, path)
+ }
+
+ fc.covered += line.CoveredInstructionCount
+ fc.missed += line.MissedInstructionCount
+
+ if line.HasData() {
+ fc.linesWithData++
+ } else {
+ fc.linesWithoutData++
+ }
+ }
+
+ result := make([]fileCoverage, 0, len(order))
+ for _, path := range order {
+ result = append(result, *byPath[path])
+ }
+
+ sort.SliceStable(result, func(i, j int) bool {
+ return fileCoveragePct(result[i]) < fileCoveragePct(result[j])
+ })
+
+ return result
+}
+
+// fileCoveragePct returns a file's changed-line coverage as a sortable value;
+// files with no measurable instructions sort last (returned above 100%).
+func fileCoveragePct(f fileCoverage) float32 {
+ instructions := f.covered + f.missed
+ if instructions == 0 {
+ return 101
+ }
+
+ return toPercent(safeDiv(float32(f.covered), float32(instructions), 1))
+}
+
// missedInstructionsSection renders a collapsible block listing each changed
// line that was not executed by tests. Returns "" when nothing was missed.
func missedInstructionsSection(changedLinesWithCoverage domain.SourceLineCoverageReport) string {
@@ -156,7 +261,7 @@ func missedInstructionsSection(changedLinesWithCoverage domain.SourceLineCoverag
return ""
}
- return fmt.Sprintf("\nš Missed instructions (%d)
\n\n", missedLineCount) +
+ return fmt.Sprintf("\nš Uncovered lines (%d)
\n\n", missedLineCount) +
"```\n" + missedInstructions + "```" + "\nš Missed instructions (5)
-
-` + "```" + `
---- internal/plugin/runner.go:72
-func GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {
---- main.go:10
- err := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)
---- main.go:12
- if err != nil {
---- main.go:13
- log.WithFields(log.Fields{
---- main.go:17
- os.Exit(1)
-` +
- "```" + `
-š Uncovered lines (5)
\n\n```\n--- internal/plugin/runner.go:72\nfunc GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {\n--- main.go:10\n\terr := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)\n--- main.go:12\n\tif err != nil {\n--- main.go:13\n\t\tlog.WithFields(log.Fields{\n--- main.go:17\n\t\tos.Exit(1)\n```\nš Missed instructions (5)
-
-` + "```" + `
---- internal/plugin/runner.go:72
-func GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {
---- main.go:10
- err := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)
---- main.go:12
- if err != nil {
---- main.go:13
- log.WithFields(log.Fields{
---- main.go:17
- os.Exit(1)
-` +
- "```" + `
-š Uncovered lines (5)
\n\n```\n--- internal/plugin/runner.go:72\nfunc GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {\n--- main.go:10\n\terr := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)\n--- main.go:12\n\tif err != nil {\n--- main.go:13\n\t\tlog.WithFields(log.Fields{\n--- main.go:17\n\t\tos.Exit(1)\n```\nš Missed instructions (1)
-
-` + "```" + `
---- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
- System.out.print("Something");
-` +
- "```" + `
-š Uncovered lines (1)
\n\n```\n--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52\n System.out.print(\"Something\");\n```\nš Missed instructions (1)
-
-` + "```" + `
---- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
- System.out.print("Something");
-` +
- "```" + `
-š Uncovered lines (1)
\n\n```\n--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52\n System.out.print(\"Something\");\n```\nš Missed instructions (2)
-
-` + "```" + `
---- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
- System.out.print("Something");
---- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12
- System.out.print("Something2");
-` + "```" + `
-š Uncovered lines (2)
\n\n```\n--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52\n System.out.print(\"Something\");\n--- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12\n System.out.print(\"Something2\");\n```\nš Missed instructions (2)
-
-` + "```" + `
---- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
- System.out.print("Something");
---- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12
- System.out.print("Something2");
-` +
- "```" + `
-š Uncovered lines (2)
\n\n```\n--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52\n System.out.print(\"Something\");\n--- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12\n System.out.print(\"Something2\");\n```\n