empty ProgressPrinter impl and test

Author: davidjgoss

javascript/src/ProgressPrinter.spec.ts

@@ -0,0 +1,103 @@
+import fs from 'node:fs'
+import * as path from 'node:path'
+import { Writable } from 'node:stream'
+import { pipeline } from 'node:stream/promises'
+
+import { NdjsonToMessageStream } from '@cucumber/message-streams'
+import { Envelope, TestStepResultStatus } from '@cucumber/messages'
+import { expect } from 'chai'
+import { globbySync } from 'globby'
+
+import { ProgressPrinter } from './ProgressPrinter.js'
+import { CUCUMBER_THEME } from './theme.js'
+import type { Options } from './types.js'
+
+describe('ProgressPrinter', async () => {
+  const ndjsonFiles = globbySync(`*.ndjson`, {
+    cwd: path.join(import.meta.dirname, '..', '..', 'testdata', 'src'),
+    absolute: true,
+  })
+
+  const variants: ReadonlyArray<{ name: string; options: Options }> = [
+    {
+      name: 'cucumber',
+      options: {
+        attachments: true,
+        featuresAndRules: true,
+        theme: CUCUMBER_THEME,
+      },
+    },
+    {
+      name: 'plain',
+      options: {
+        attachments: true,
+        featuresAndRules: true,
+        theme: {
+          status: {
+            icon: {
+              [TestStepResultStatus.AMBIGUOUS]: '✘',
+              [TestStepResultStatus.FAILED]: '✘',
+              [TestStepResultStatus.PASSED]: '✔',
+              [TestStepResultStatus.PENDING]: '■',
+              [TestStepResultStatus.SKIPPED]: '↷',
+              [TestStepResultStatus.UNDEFINED]: '■',
+              [TestStepResultStatus.UNKNOWN]: ' ',
+            },
+          },
+        },
+      },
+    },
+  ]
+
+  // just enough so Node.js internals consider it a color-supporting stream
+  const fakeStream = {
+    _writableState: {},
+    isTTY: true,
+    getColorDepth: () => 3,
+  } as unknown as NodeJS.WritableStream
+
+  for (const { name, options } of variants) {
+    describe(name, () => {
+      for (const ndjsonFile of ndjsonFiles) {
+        const [suiteName] = path.basename(ndjsonFile).split('.')
+
+        it(suiteName, async () => {
+          let content = ''
+          const printer = new ProgressPrinter(
+            fakeStream,
+            (chunk) => {
+              content += chunk
+            },
+            {
+              attachments: true,
+              featuresAndRules: true,
+              theme: CUCUMBER_THEME,
+              ...options,
+            }
+          )
+
+          await pipeline(
+            fs.createReadStream(ndjsonFile, { encoding: 'utf-8' }),
+            new NdjsonToMessageStream(),
+            new Writable({
+              objectMode: true,
+              write(envelope: Envelope, _: BufferEncoding, callback) {
+                printer.update(envelope)
+                callback()
+              },
+            })
+          )
+
+          const expectedOutput = fs.readFileSync(
+            ndjsonFile.replace('.ndjson', `.${name}.progress.log`),
+            {
+              encoding: 'utf-8',
+            }
+          )
+
+          expect(content).to.eq(expectedOutput)
+        })
+      }
+    })
+  }
+})

javascript/src/ProgressPrinter.ts

@@ -0,0 +1,29 @@
+import { Envelope, TestRunFinished } from '@cucumber/messages'
+import { Query } from '@cucumber/query'
+
+import type { Options } from './types.js'
+
+export class ProgressPrinter {
+  private readonly println: (content?: string) => void
+  private readonly query: Query = new Query()
+
+  constructor(
+    private readonly stream: NodeJS.WritableStream,
+    private readonly print: (content: string) => void,
+    private readonly options: Required<Options>
+  ) {
+    this.println = (content: string = '') => this.print(`${content}\n`)
+  }
+
+  update(message: Envelope) {
+    this.query.update(message)
+
+    if (message.testRunFinished) {
+      this.handleTestRunFinished(message.testRunFinished)
+    }
+  }
+
+  private handleTestRunFinished(testRunFinished: TestRunFinished) {
+    this.println('Progress!')
+  }
+}