Js implementation

Author: mpkorstanje

javascript/package-lock.json

@@ -5,6 +5,7 @@ import util from 'node:util'
 
 import { NdjsonToMessageStream } from '@cucumber/message-streams'
 import { Envelope } from '@cucumber/messages'
+import { namingStrategy, NamingStrategyLength } from '@cucumber/query'
 import { expect, use } from 'chai'
 import chaiXml from 'chai-xml'
 import { globbySync } from 'globby'
@@ -22,13 +23,33 @@ describe('Acceptance Tests', async function () {
     absolute: true,
   })
 
-  for (const ndjsonFile of ndjsonFiles) {
+  const testCases = ndjsonFiles.map((ndjsonFile) => {
     const [suiteName] = path.basename(ndjsonFile).split('.')
-    it(suiteName, async () => {
+    return {
+      suiteName,
+      source: ndjsonFile,
+      strategyName: 'default',
+      options: {},
+    }
+  })
+
+  testCases.push({
+    suiteName: 'examples-tables',
+    source: '../testdata/src/examples-tables.ndjson',
+    strategyName: 'custom',
+    options: {
+      suiteName: 'Cucumber Suite',
+      testClassName: 'Cucumber Class',
+      testNamingStrategy: namingStrategy(NamingStrategyLength.LONG),
+    },
+  })
+
+  for (const testCase of testCases) {
+    it(testCase.suiteName + ' -> ' + testCase.strategyName, async () => {
       let emit: (message: Envelope) => void
       let content = ''
       formatter.formatter({
-        options: {},
+        options: testCase.options,
         on(type, handler) {
           emit = handler
         },
@@ -38,7 +59,7 @@ describe('Acceptance Tests', async function () {
       })
 
       await asyncPipeline(
-        fs.createReadStream(ndjsonFile, { encoding: 'utf-8' }),
+        fs.createReadStream(testCase.source, { encoding: 'utf-8' }),
         new NdjsonToMessageStream(),
         new Writable({
           objectMode: true,
@@ -49,9 +70,12 @@ describe('Acceptance Tests', async function () {
         })
       )
 
-      const expectedXml = fs.readFileSync(ndjsonFile.replace('.ndjson', '.xml'), {
-        encoding: 'utf-8',
-      })
+      const expectedXml = fs.readFileSync(
+        testCase.source.replace('.ndjson', '.' + testCase.strategyName + '.xml'),
+        {
+          encoding: 'utf-8',
+        }
+      )
       expect(content).xml.to.be.valid()
       expect(content).xml.to.deep.eq(expectedXml)
     })

javascript/src/index.spec.ts

@@ -1,5 +1,5 @@
 import { Envelope } from '@cucumber/messages'
-import { Query } from '@cucumber/query'
+import { NamingStrategy, Query } from '@cucumber/query'
 import xmlbuilder from 'xmlbuilder'
 
 import { makeReport } from './makeReport.js'
@@ -11,7 +11,11 @@ export default {
     on,
     write,
   }: {
-    options: { suiteName?: string }
+    options: {
+      suiteName?: string
+      testClassName?: string
+      testNamingStrategy?: NamingStrategy
+    }
     on: (type: 'message', handler: (message: Envelope) => void) => void
     write: (content: string) => void
   }) {
@@ -24,7 +28,7 @@ export default {
       query.update(message)
 
       if (message.testRunFinished) {
-        const testSuite = makeReport(query)
+        const testSuite = makeReport(query, options.testClassName, options.testNamingStrategy)
         builder.att('time', testSuite.time)
         builder.att('tests', testSuite.tests)
         builder.att('skipped', testSuite.skipped)

javascript/src/index.ts

@@ -1,5 +1,6 @@
 import { TestCaseStarted, TestStepResultStatus } from '@cucumber/messages'
 import {
+  NamingStrategy,
   namingStrategy,
   NamingStrategyExampleName,
   NamingStrategyFeatureName,
@@ -40,7 +41,11 @@ interface ReportFailure {
   stack?: string
 }
 
-export function makeReport(query: Query, customNamingStrategy: NamingStrategy = NAMING_STRATEGY): ReportSuite {
+export function makeReport(
+    query: Query,
+    testClassName: string | undefined = undefined,
+    customNamingStrategy: NamingStrategy = NAMING_STRATEGY
+): ReportSuite {
   const statuses = query.countMostSevereTestStepResultStatus()
   return {
     time: durationToSeconds(query.findTestRunDuration()),
@@ -51,12 +56,16 @@ export function makeReport(query: Query, customNamingStrategy: NamingStrategy =
       (status) => status !== TestStepResultStatus.PASSED && status !== TestStepResultStatus.SKIPPED
     ),
     errors: 0,
-    testCases: makeTestCases(query, customNamingStrategy),
+    testCases: makeTestCases(query, testClassName, customNamingStrategy),
     timestamp: formatTimestamp(query.findTestRunStarted()),
   }
 }
 
-function makeTestCases(query: Query, namingStrategy: NamingStrategy): ReadonlyArray<ReportTestCase> {
+function makeTestCases(
+  query: Query,
+  testClassName: string | undefined,
+  testNamingStrategy: NamingStrategy
+): ReadonlyArray<ReportTestCase> {
   return query.findAllTestCaseStarted().map((testCaseStarted) => {
     const pickle = ensure(
       query.findPickleBy(testCaseStarted),
@@ -65,8 +74,8 @@ function makeTestCases(query: Query, namingStrategy: NamingStrategy): ReadonlyAr
     const lineage = ensure(query.findLineageBy(pickle), 'Expected to find Lineage by Pickle')
 
     return {
-      classname: lineage.feature?.name ?? pickle.uri,
-      name: NAMING_STRATEGY.reduce(lineage, pickle),
+      classname: testClassName ?? lineage.feature?.name ?? pickle.uri,
+      name: testNamingStrategy.reduce(lineage, pickle),
       time: durationToSeconds(query.findTestCaseDurationBy(testCaseStarted)),
       failure: makeFailure(query, testCaseStarted),
       output: query