wip implement summary

davidjgoss · davidjgoss · commit abe487a12881 · 2025-09-21T17:23:22.000+01:00
diff --git a/javascript/package-lock.json b/javascript/package-lock.json
diff --git a/javascript/package.json b/javascript/package.json
@@ -22,7 +22,8 @@
     "prepublishOnly": "tsc --build tsconfig.build.json"
   },
   "dependencies": {
-    "@cucumber/query": "14.3.0"
+    "@cucumber/query": "14.3.0",
+    "luxon": "^3.7.2"
   },
   "peerDependencies": {
     "@cucumber/messages": "*"
@@ -34,6 +35,7 @@
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.30.1",
     "@types/chai": "^5.0.0",
+    "@types/luxon": "^3.7.1",
     "@types/mocha": "^10.0.6",
     "@types/node": "22.18.6",
     "@typescript-eslint/eslint-plugin": "8.44.0",
diff --git a/javascript/src/ProgressPrinter.spec.ts b/javascript/src/ProgressPrinter.spec.ts
@@ -100,4 +100,4 @@ describe('ProgressPrinter', async () => {
       }
     })
   }
-})
+})
diff --git a/javascript/src/SummaryPrinter.spec.ts b/javascript/src/SummaryPrinter.spec.ts
@@ -100,4 +100,4 @@ describe('SummaryPrinter', async () => {
       }
     })
   }
-})
+})
diff --git a/javascript/src/SummaryPrinter.ts b/javascript/src/SummaryPrinter.ts
@@ -1,6 +1,27 @@
-import { Envelope } from '@cucumber/messages'
+import {
+  Envelope,
+  Location,
+  Pickle,
+  TestCaseFinished,
+  TestCaseStarted,
+  TestRunFinished,
+  TestRunStarted,
+  TestStepResult,
+  TestStepResultStatus,
+} from '@cucumber/messages'
 import { Query } from '@cucumber/query'
 
+import {
+  ensure,
+  ERROR_INDENT_LENGTH,
+  formatCounts,
+  formatDuration,
+  formatNonPassingTitle,
+  formatPickleLocation,
+  formatTestStepResultError,
+  GHERKIN_INDENT_LENGTH,
+  indent,
+} from './helpers.js'
 import type { Options } from './types.js'
 
 export class SummaryPrinter {
@@ -19,7 +40,189 @@ export class SummaryPrinter {
     this.query.update(message)
 
     if (message.testRunFinished) {
-      this.println('Summary!')
+      this.printSummary()
+    }
+  }
+
+  private printSummary() {
+    this.printNonPassingScenarios()
+    this.printStats()
+    this.printSnippets()
+  }
+
+  private printStats() {
+    this.println()
+    this.printGlobalHookCounts()
+    this.printScenarioCounts()
+    this.printStepCounts()
+    this.printDuration()
+  }
+
+  private printNonPassingScenarios() {
+    const theOrder: TestStepResultStatus[] = [
+      TestStepResultStatus.UNKNOWN,
+      TestStepResultStatus.PENDING,
+      TestStepResultStatus.UNDEFINED,
+      TestStepResultStatus.AMBIGUOUS,
+      TestStepResultStatus.FAILED,
+    ]
+
+    const picklesByStatus = new Map<
+      TestStepResultStatus,
+      Array<{
+        pickle: Pickle
+        location: Location | undefined
+        testCaseStarted: TestCaseStarted
+        testCaseFinished: TestCaseFinished
+        testStepResult: TestStepResult
+      }>
+    >()
+
+    for (const testCaseFinished of this.query.findAllTestCaseFinished()) {
+      const testCaseStarted = ensure(
+        this.query.findTestCaseStartedBy(testCaseFinished),
+        'TestCaseStarted must exist for TestCaseFinished'
+      )
+      const pickle = ensure(
+        this.query.findPickleBy(testCaseFinished),
+        'Pickle must exist for TestCaseFinished'
+      )
+      const location = this.query.findLocationOf(pickle)
+      const testStepResult = this.query.findMostSevereTestStepResultBy(testCaseFinished)
+      if (testStepResult) {
+        if (!picklesByStatus.has(testStepResult.status)) {
+          picklesByStatus.set(testStepResult.status, [])
+        }
+        picklesByStatus.get(testStepResult.status)!.push({
+          pickle,
+          location,
+          testCaseStarted,
+          testCaseFinished,
+          testStepResult,
+        })
+      }
+    }
+
+    for (const status of theOrder) {
+      const picklesForThisStatus = picklesByStatus.get(status) ?? []
+      if (picklesForThisStatus.length > 0) {
+        this.println()
+        this.println(formatNonPassingTitle(status, this.options.theme, this.stream))
+        picklesForThisStatus.forEach(
+          ({ pickle, location, testCaseStarted, testStepResult }, index) => {
+            const formattedLocation = formatPickleLocation(
+              pickle,
+              location,
+              this.options.theme,
+              this.stream
+            )
+            const formattedAttempt =
+              testCaseStarted.attempt > 0 ? `, after ${testCaseStarted.attempt + 1} attempts` : ''
+            this.println(
+              indent(
+                `${index + 1}) ${pickle.name}${formattedAttempt} ${formattedLocation}`,
+                GHERKIN_INDENT_LENGTH
+              )
+            )
+            if (status === TestStepResultStatus.FAILED) {
+              const content = formatTestStepResultError(
+                testStepResult,
+                this.options.theme,
+                this.stream
+              )
+              if (content) {
+                this.println(indent(content, GHERKIN_INDENT_LENGTH + ERROR_INDENT_LENGTH + 1))
+                this.println()
+              }
+            }
+          }
+        )
+      }
+    }
+  }
+
+  private printGlobalHookCounts() {
+    const testRunHookFinished = this.query.findAllTestRunHookFinished()
+    if (testRunHookFinished.length === 0) {
+      return
+    }
+
+    const globalHookCountsByStatus = testRunHookFinished
+      .map((testRunHookFinished) => testRunHookFinished.result.status)
+      .reduce(
+        (prev, status) => {
+          return {
+            ...prev,
+            [status]: (prev[status] ?? 0) + 1,
+          }
+        },
+        {} as Partial<Record<TestStepResultStatus, number>>
+      )
+    this.println(formatCounts('hooks', globalHookCountsByStatus, this.options.theme, this.stream))
+  }
+
+  private printScenarioCounts() {
+    const scenarioCountsByStatus = this.query
+      .findAllTestCaseFinished()
+      .map((testCaseFinished) => this.query.findMostSevereTestStepResultBy(testCaseFinished))
+      .map((testStepResult) => testStepResult?.status ?? TestStepResultStatus.PASSED)
+      .reduce(
+        (prev, status) => {
+          return {
+            ...prev,
+            [status]: (prev[status] ?? 0) + 1,
+          }
+        },
+        {} as Partial<Record<TestStepResultStatus, number>>
+      )
+    this.println(formatCounts('scenarios', scenarioCountsByStatus, this.options.theme, this.stream))
+  }
+
+  private printStepCounts() {
+    const stepCountsByStatus = this.query
+      .findAllTestCaseFinished()
+      .flatMap((testCaseFinished) => this.query.findTestStepsFinishedBy(testCaseFinished))
+      .map((testStepFinished) => testStepFinished.testStepResult.status)
+      .reduce(
+        (prev, status) => {
+          return {
+            ...prev,
+            [status]: (prev[status] ?? 0) + 1,
+          }
+        },
+        {} as Partial<Record<TestStepResultStatus, number>>
+      )
+    this.println(formatCounts('steps', stepCountsByStatus, this.options.theme, this.stream))
+  }
+
+  private printDuration() {
+    const testRunStarted = this.query.findTestRunStarted() as TestRunStarted
+    const testRunFinished = this.query.findTestRunFinished() as TestRunFinished
+
+    this.println(formatDuration(testRunStarted.timestamp, testRunFinished.timestamp))
+  }
+
+  private printSnippets() {
+    const snippets = this.query
+      .findAllTestCaseFinished()
+      .map((testCaseFinished) => this.query.findPickleBy(testCaseFinished))
+      .filter((pickle) => !!pickle)
+      .sort((a, b) => {
+        // TODO compare by location too
+        return a?.uri.localeCompare(b?.uri || '') || 0
+      })
+      .flatMap((pickle) => this.query.findSuggestionsBy(pickle))
+      .flatMap((suggestion) => suggestion.snippets)
+      .map((snippet) => snippet.code)
+    const uniqueSnippets = new Set(snippets)
+    if (uniqueSnippets.size > 0) {
+      this.println()
+      this.println('You can implement missing steps with the snippets below:')
+      this.println()
+      for (const snippet of uniqueSnippets) {
+        this.println(snippet)
+        this.println()
+      }
     }
   }
 }
diff --git a/javascript/src/helpers.ts b/javascript/src/helpers.ts
@@ -17,7 +17,10 @@ import {
   TestStep,
   TestStepResult,
   TestStepResultStatus,
+  TimeConversion,
+  Timestamp,
 } from '@cucumber/messages'
+import { Interval } from 'luxon'
 
 import { TextBuilder } from './TextBuilder.js'
 import { Theme } from './types.js'
@@ -26,6 +29,16 @@ export const GHERKIN_INDENT_LENGTH = 2
 export const STEP_ARGUMENT_INDENT_LENGTH = 2
 export const ATTACHMENT_INDENT_LENGTH = 4
 export const ERROR_INDENT_LENGTH = 4
+
+const STATUS_ORDER: TestStepResultStatus[] = [
+  TestStepResultStatus.UNKNOWN,
+  TestStepResultStatus.PASSED,
+  TestStepResultStatus.SKIPPED,
+  TestStepResultStatus.PENDING,
+  TestStepResultStatus.UNDEFINED,
+  TestStepResultStatus.AMBIGUOUS,
+  TestStepResultStatus.FAILED,
+]
 const STATUS_CHARACTERS: Record<TestStepResultStatus, string> = {
   [TestStepResultStatus.AMBIGUOUS]: 'A',
   [TestStepResultStatus.FAILED]: 'F',
@@ -35,6 +48,7 @@ const STATUS_CHARACTERS: Record<TestStepResultStatus, string> = {
   [TestStepResultStatus.UNDEFINED]: 'U',
   [TestStepResultStatus.UNKNOWN]: '?',
 } as const
+const DURATION_FORMAT = "m'm' s.S's'"
 
 export function ensure<T>(value: T | undefined, message: string): T {
   if (!value) {
@@ -81,6 +95,7 @@ export function formatPickleTags(pickle: Pickle, theme: Theme, stream: NodeJS.Wr
       .build(theme.tag)
   }
 }
+
 export function formatPickleTitle(
   pickle: Pickle,
   scenario: Scenario,
@@ -325,3 +340,52 @@ export function formatStatusCharacter(
   const character = STATUS_CHARACTERS[status]
   return new TextBuilder(stream).append(character).build(theme.status?.all?.[status])
 }
+
+export function formatNonPassingTitle(
+  status: TestStepResultStatus,
+  theme: Theme,
+  stream: NodeJS.WritableStream
+) {
+  return new TextBuilder(stream)
+    .append(status.charAt(0).toUpperCase() + status.slice(1).toLowerCase())
+    .append(' scenarios:')
+    .build(theme.status?.all?.[status])
+}
+
+export function formatCounts(
+  suffix: string,
+  counts: Partial<Record<TestStepResultStatus, number>>,
+  theme: Theme,
+  stream: NodeJS.WritableStream
+) {
+  const builder = new TextBuilder(stream)
+  const total = Object.values(counts).reduce((prev, curr) => prev + curr, 0)
+  builder.append(`${total} ${suffix}`)
+  if (total > 0) {
+    let first = true
+    builder.append(' (')
+    for (const status of STATUS_ORDER) {
+      const count = counts[status]
+      if (count) {
+        if (!first) {
+          builder.append(', ')
+        }
+        builder.append(`${count} ${status.toLowerCase()}`, theme.status?.all?.[status])
+        first = false
+      }
+    }
+    builder.append(')')
+  }
+  return builder.build()
+}
+
+export function formatDuration(start: Timestamp, finish: Timestamp) {
+  const startMillis = new Date(TimeConversion.timestampToMillisecondsSinceEpoch(start))
+  const finishMillis = new Date(TimeConversion.timestampToMillisecondsSinceEpoch(finish))
+  const duration = Interval.fromDateTimes(startMillis, finishMillis).toDuration([
+    'minutes',
+    'seconds',
+    'milliseconds',
+  ])
+  return duration.toFormat(DURATION_FORMAT)
+}

Original file line number	Diff line number	Diff line change
`@@ -100,4 +100,4 @@ describe('ProgressPrinter', async () => {`
`100`	`100`	`}`
`101`	`101`	`})`
`102`	`102`	`}`
`103`		`-})`
	`103`	`+})`
Original file line number	Diff line number	Diff line change
`@@ -100,4 +100,4 @@ describe('SummaryPrinter', async () => {`
`100`	`100`	`}`
`101`	`101`	`})`
`102`	`102`	`}`
`103`		`-})`
	`103`	`+})`