Report added removed tests (#245)

Ma11hewThomas · web-flow · commit 7b0efe645edb · 2025-11-02T21:07:49.000Z
* add added and removed tests report
diff --git a/README.md b/README.md
@@ -121,6 +121,7 @@ For more advanced usage, there are several inputs available.
     # Reports - Choose as many as you like. Default is false. Choosing none will use default reports.
     summary-report: true
     summary-delta-report: false
+    tests-changed-report: false
     github-report: false
     test-report: false
     test-list-report: false
diff --git a/__tests__/ctrf/helpers.test.ts b/__tests__/ctrf/helpers.test.ts
@@ -111,4 +111,4 @@ describe('stripAnsi', () => {
     // @ts-expect-error Testing runtime error
     expect(() => stripAnsi({})).toThrow(TypeError)
   })
-})
+})
diff --git a/__tests__/ctrf/report-preparation.test.ts b/__tests__/ctrf/report-preparation.test.ts
@@ -491,6 +491,7 @@ function createSingleReportInputs(): Inputs {
     collapseLargeReports: false,
     summaryReport: true, // Only 1 report enabled
     summaryDeltaReport: false,
+    testsChangedReport: false,
     githubReport: false,
     testReport: false,
     testListReport: false,
diff --git a/action.yml b/action.yml
@@ -30,6 +30,11 @@ inputs:
     description: 'Include the summary delta report.'
     required: false
     default: false
+  tests-changed-report:
+    description:
+      'Include the tests changed report showing added and removed tests.'
+    required: false
+    default: false
   github-report:
     description: 'Include the GitHub report.'
     required: false
diff --git a/badges/coverage.svg b/badges/coverage.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 32.18%"><title>Coverage: 32.18%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#555"/><rect x="63" width="53" height="20" fill="#e05d44"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">32.18%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">32.18%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 32.11%"><title>Coverage: 32.11%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#555"/><rect x="63" width="53" height="20" fill="#e05d44"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">32.11%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">32.11%</text></g></svg>
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/reports/tests-changed-table.hbs b/dist/reports/tests-changed-table.hbs
diff --git a/docs/report-showcase.md b/docs/report-showcase.md
@@ -7,6 +7,7 @@ execution.
 
 - [Report Showcase](#report-showcase)
   - [Summary Report](#summary-report)
+  - [Summary Delta Report](#summary-delta-report)
   - [GitHub Report](#github-report)
   - [Test Report](#test-report)
   - [Test List Report](#test-list-report)
@@ -17,6 +18,7 @@ execution.
   - [Failed Folded Report](#failed-folded-report)
   - [Previous Results Report](#previous-results-report)
   - [Insights Report](#insights-report)
+  - [Tests Changed Report](#tests-changed-report)
   - [Slowest Report](#slowest-report)
   - [AI Report](#ai-report)
   - [Skipped Report](#skipped-report)
@@ -80,8 +82,6 @@ Set the `summary-delta-report` input to true in your workflow configuration:
 | --- | --- | --- | --- | --- | --- | --- |
 | **58**&nbsp;&nbsp;&nbsp;&nbsp;*↑2* | **58**&nbsp;&nbsp;&nbsp;&nbsp;*±0* | **0**&nbsp;&nbsp;&nbsp;&nbsp;*±0* | **0**&nbsp;&nbsp;&nbsp;&nbsp;*±0* | **0**&nbsp;&nbsp;&nbsp;&nbsp;*±0* | **0**&nbsp;&nbsp;&nbsp;&nbsp;*±0* | **11.2s**&nbsp;&nbsp;&nbsp;&nbsp;*↓2ms* |
 
-
-
 ## File Report
 
 ### Overview
@@ -711,6 +711,45 @@ Set the `insights-report` input to true in your workflow configuration:
 
 <sub><i>Measured over 2 runs.</i></sub>
 
+## Tests Changed Report
+
+### Overview
+
+Displays tests that have been added or removed compared to a baseline or previous run. This report helps track test suite evolution over time by showing exactly which tests are new and which have been removed. Each test is listed with its name and suite hierarchy, making it easy to identify changes in your test coverage.
+
+Requires previous test results or a baseline for comparison.
+
+### Usage
+
+Set the `tests-changed-report` input to true in your workflow configuration:
+
+```yaml
+- name: Publish Test Report
+  uses: ctrf-io/github-test-reporter@v1
+  with:
+    report-path: './ctrf/*.json'
+    tests-changed-report: true
+  if: always()
+```
+
+---
+
+**3 new tests added, 1 removed**
+
+### Added ➕
+
+| **Name** | **Suite** |
+| --- | --- |
+| should handle async operations correctly | API Tests > Authentication |
+| should validate user input | API Tests > Validation |
+| should cache results properly | Performance Tests |
+
+### Removed ➖
+
+| **Name** | **Suite** |
+| --- | --- |
+| deprecated legacy test | Legacy Suite > Old Tests |
+
 ## Slowest Report
 
 ### Overview
diff --git a/src/core/inputs.ts b/src/core/inputs.ts
@@ -20,6 +20,7 @@ export function getCliInputs(args: Arguments): Inputs {
     collapseLargeReports: false,
     summaryReport: args._.includes('summary'),
     summaryDeltaReport: args._.includes('summary-delta'),
+    testsChangedReport: args._.includes('tests-changed'),
     githubReport: args._.includes('github'),
     testReport: args._.includes('tests'),
     testListReport: args._.includes('test-list'),
@@ -105,6 +106,8 @@ export function getInputs(): Inputs {
     summaryReport: core.getInput('summary-report').toLowerCase() === 'true',
     summaryDeltaReport:
       core.getInput('summary-delta-report').toLowerCase() === 'true',
+    testsChangedReport:
+      core.getInput('tests-changed-report').toLowerCase() === 'true',
     testReport: core.getInput('test-report').toLowerCase() === 'true',
     testListReport: core.getInput('test-list-report').toLowerCase() === 'true',
     failedReport: core.getInput('failed-report').toLowerCase() === 'true',
diff --git a/src/ctrf/core/src/methods/run-insights.ts b/src/ctrf/core/src/methods/run-insights.ts
@@ -11,6 +11,8 @@ export interface SimplifiedTestData {
   name: string
   suite?: string[]
   filePath?: string
+  line?: number
+  tags?: string[]
 }
 
 /**
@@ -720,7 +722,9 @@ function getTestsRemovedSinceBaseline(
   return removedTests.map(test => ({
     name: test.name,
     suite: test.suite,
-    filePath: test.filePath
+    filePath: test.filePath,
+    line: test.line,
+    tags: test.tags
   }))
 }
 
@@ -753,7 +757,9 @@ function getTestsAddedSinceBaseline(
   return addedTests.map(test => ({
     name: test.name,
     suite: test.suite,
-    filePath: test.filePath
+    filePath: test.filePath,
+    line: test.line,
+    tags: test.tags
   }))
 }
 
@@ -864,14 +870,6 @@ export function enrichReportWithInsights(
     baseline
   )
 
-  // Remove testsAdded and testsRemoved as they're not part of the official schema yet
-  if (baselineInsights.extra?.testsAdded) {
-    delete baselineInsights.extra.testsAdded
-  }
-  if (baselineInsights.extra?.testsRemoved) {
-    delete baselineInsights.extra.testsRemoved
-  }
-
   return {
     ...currentReportWithTestInsights,
     insights: baselineInsights
diff --git a/src/ctrf/previous-results.ts b/src/ctrf/previous-results.ts
@@ -16,7 +16,8 @@ export function shouldProcessPreviousResults(inputs: Inputs): boolean {
     inputs.insightsReport ||
     inputs.slowestReport ||
     inputs.fetchPreviousResults ||
-    inputs.summaryDeltaReport
+    inputs.summaryDeltaReport ||
+    inputs.testsChangedReport
   )
 }
 
diff --git a/src/github/core.ts b/src/github/core.ts
@@ -323,6 +323,14 @@ function generateReportByType(
         core.info('No AI analysis to display, skipping ai-report')
       }
       break
+    case 'tests-changed-report':
+      core.info('Adding tests changed report to summary')
+      addViewToSummary(
+        '### Test Changes',
+        BuiltInReports.TestsChangedTable,
+        report
+      )
+      break
     case 'pull-request-report':
       core.info('Adding pull request report to summary')
       addViewToSummary('', BuiltInReports.PullRequest, report)
diff --git a/src/reports/constants.ts b/src/reports/constants.ts
@@ -15,6 +15,7 @@ export const DEFAULT_REPORT_ORDER: string[] = [
   'flaky-rate-report',
   'skipped-report',
   'ai-report',
+  'tests-changed-report',
   'pull-request-report',
   'commit-report',
   'slowest-report',
diff --git a/src/reports/core.ts b/src/reports/core.ts
@@ -6,6 +6,7 @@ const basePath = getBasePath('reports');
 export const BuiltInReports = {
   SummaryTable: join(basePath, 'summary-table.hbs'),
   SummaryDeltaTable: join(basePath, 'summary-delta-table.hbs'),
+  TestsChangedTable: join(basePath, 'tests-changed-table.hbs'),
   TestTable: join(basePath, 'test-table.hbs'),
   TestList: join(basePath, 'test-list.hbs'),
   FailedTable: join(basePath, 'failed-table.hbs'),
diff --git a/src/reports/tests-changed-table.hbs b/src/reports/tests-changed-table.hbs
@@ -0,0 +1,26 @@
+{{#if (or (gt (length report.insights.extra.testsAdded) 0) (gt (length report.insights.extra.testsRemoved) 0))}}
+**{{length report.insights.extra.testsAdded}} test{{#if (gt (length report.insights.extra.testsAdded) 1)}}s{{/if}} added, {{length report.insights.extra.testsRemoved}} removed**
+
+{{#if (gt (length report.insights.extra.testsAdded) 0)}}
+### Added ➕
+
+| **Name** | **Suite** |
+| --- | --- |
+{{#each report.insights.extra.testsAdded}}
+| {{name}} | {{#if suite}}{{join suite " > "}}{{else}}-{{/if}} |
+{{/each}}
+{{/if}}
+
+{{#if (gt (length report.insights.extra.testsRemoved) 0)}}
+### Removed ➖
+
+| **Name** | **Suite** |
+| --- | --- |
+{{#each report.insights.extra.testsRemoved}}
+| {{name}} | {{#if suite}}{{join suite " > "}}{{else}}-{{/if}} |
+{{/each}}
+{{/if}}
+{{else}}
+No changes to tests detected ✨
+{{/if}}
+
diff --git a/src/types/reporter.ts b/src/types/reporter.ts
diff --git a/src/utils/report-utils.ts b/src/utils/report-utils.ts
