most of non-passing scenarios

Author: davidjgoss

javascript/src/SummaryPrinter.ts

@@ -1,7 +1,25 @@
-import { Envelope, TestRunFinished, TestRunStarted, TestStepResultStatus } from '@cucumber/messages'
+import {
+  Envelope,
+  Location,
+  Pickle,
+  TestRunFinished,
+  TestRunStarted,
+  TestStepResult,
+  TestStepResultStatus,
+} from '@cucumber/messages'
 import { Query } from '@cucumber/query'
 
-import { formatCounts, formatDuration, formatSnippets } from './helpers.js'
+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 {
@@ -25,6 +43,7 @@ export class SummaryPrinter {
   }
 
   private printSummary() {
+    this.printNonPassingScenarios()
     this.printStats()
     this.printSnippets()
   }
@@ -37,6 +56,70 @@ export class SummaryPrinter {
     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; testStepResult: TestStepResult }>
+    >()
+
+    for (const testCaseFinished of this.query.findAllTestCaseFinished()) {
+      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,
+          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, testStepResult }, index) => {
+          const formattedLocation = formatPickleLocation(
+            pickle,
+            location,
+            this.options.theme,
+            this.stream
+          )
+          this.println(
+            indent(`${index + 1}) ${pickle.name} ${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) {

javascript/src/helpers.ts

@@ -29,7 +29,7 @@ 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 DURATION_FORMAT = "m'm' s.S's'"
+
 const STATUS_ORDER: TestStepResultStatus[] = [
   TestStepResultStatus.UNKNOWN,
   TestStepResultStatus.PASSED,
@@ -48,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) {
@@ -340,15 +341,15 @@ export function formatStatusCharacter(
   return new TextBuilder(stream).append(character).build(theme.status?.all?.[status])
 }
 
-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)
+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(
@@ -377,3 +378,14 @@ export function formatCounts(
   }
   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)
+}