Add JUnit XML reporter (#38)

Author: davidjgoss

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add JUnit XML reporter ([#38](https://github.com/cucumber/cucumber-node/pull/38))
 
 ## [0.2.0] - 2025-02-20
 ### Added

README.md

@@ -146,6 +146,7 @@ You might even be able to go without any extra dependencies and instead lean on
 Some Cucumber formatters are included as Node.js test reporters:
 
 - HTML `--test-reporter=@cucumber/node/reporters/html --test-reporter-destination=./report.html`
+- JUnit `--test-reporter=@cucumber/node/reporters/junit --test-reporter-destination=./TEST-cucumber.xml`
 - Message `--test-reporter=@cucumber/node/reporters/message --test-reporter-destination=./messages.ndjson`
 
 There are some caveats that apply when using these reporters (but not otherwise):

package-lock.json

@@ -31,6 +31,7 @@
     "@cucumber/cucumber-expressions": "18.0.1",
     "@cucumber/gherkin": "30.0.4",
     "@cucumber/html-formatter": "21.9.0",
+    "@cucumber/junit-xml-formatter": "0.7.1",
     "@cucumber/messages": "27.2.0",
     "@cucumber/tag-expressions": "6.1.2",
     "globby": "^14.1.0",

package.json

@@ -0,0 +1,32 @@
+import { TestEvent } from 'node:test/reporters'
+
+import plugin from '@cucumber/junit-xml-formatter'
+import { Envelope } from '@cucumber/messages'
+
+import { generateEnvelopes } from '../generateEnvelopes.js'
+
+/*
+Signal to the runner that we are listening for messages so it should emit them
+ */
+process.env.CUCUMBER_MESSAGES_LISTENING = 'true'
+
+export default async function* (source: AsyncIterable<TestEvent>): AsyncGenerator<string> {
+  const output: string[] = []
+  let handler: (envelope: Envelope) => void = () => {}
+  plugin.formatter({
+    on(_, newHandler) {
+      handler = newHandler
+    },
+    write: (chunk) => output.push(chunk),
+    options: {},
+  })
+
+  const envelopes = generateEnvelopes(source)
+  for await (const envelope of envelopes) {
+    handler(envelope)
+  }
+
+  for (const chunk of output) {
+    yield chunk
+  }
+}

src/reporters/builtin/junit.ts

@@ -4,58 +4,85 @@ import { makeTestHarness } from '../utils.js'
 import path from 'node:path'
 
 describe('Reporters', () => {
-  it('does not emit messages as diagnostics if no cucumber reporters', async () => {
-    const harness = await makeTestHarness()
-    await harness.writeFile(
-      'features/first.feature',
-      `Feature:
+  describe('spec', () => {
+    it('does not emit messages as diagnostics if no cucumber reporters', async () => {
+      const harness = await makeTestHarness()
+      await harness.writeFile(
+        'features/first.feature',
+        `Feature:
   Scenario:
     Given a step
     `
-    )
-    await harness.writeFile(
-      'features/steps.js',
-      `import { Given } from '@cucumber/node'
+      )
+      await harness.writeFile(
+        'features/steps.js',
+        `import { Given } from '@cucumber/node'
   Given('a step', () => {})
     `
-    )
-    const [output] = await harness.run('spec')
-    const sanitised = stripVTControlCharacters(output.trim())
-    expect(sanitised).not.to.include('@cucumber/messages:')
-  })
+      )
+      const [output] = await harness.run('spec')
+      const sanitised = stripVTControlCharacters(output.trim())
+      expect(sanitised).not.to.include('@cucumber/messages:')
+    })
 
-  it('provides a useful error for an ambiguous step', async () => {
-    const harness = await makeTestHarness()
-    await harness.writeFile(
-      'features/first.feature',
-      `Feature:
+    it('provides a useful error for an ambiguous step', async () => {
+      const harness = await makeTestHarness()
+      await harness.writeFile(
+        'features/first.feature',
+        `Feature:
   Scenario:
     Given a step`
-    )
-    await harness.writeFile(
-      'features/steps.js',
-      `import { Given } from '@cucumber/node'
+      )
+      await harness.writeFile(
+        'features/steps.js',
+        `import { Given } from '@cucumber/node'
 Given('a step', () => {})
 Given('a step', () => {})`
-    )
-    const [output] = await harness.run('spec')
-    const sanitised = stripVTControlCharacters(output.trim())
-    expect(sanitised).to.include(`Multiple matching step definitions found for text "a step":
+      )
+      const [output] = await harness.run('spec')
+      const sanitised = stripVTControlCharacters(output.trim())
+      expect(sanitised).to.include(`Multiple matching step definitions found for text "a step":
   1) ${path.join('features', 'steps.js')}:2:1
   2) ${path.join('features', 'steps.js')}:3:1`)
+    })
+
+    it('provides a useful error for an undefined step', async () => {
+      const harness = await makeTestHarness()
+      await harness.writeFile(
+        'features/first.feature',
+        `Feature:
+  Scenario:
+    Given a step
+    `
+      )
+      const [output] = await harness.run('spec')
+      const sanitised = stripVTControlCharacters(output.trim())
+      expect(sanitised).to.include('No matching step definitions found for text "a step"')
+    })
   })
 
-  it('provides a useful error for an undefined step', async () => {
-    const harness = await makeTestHarness()
-    await harness.writeFile(
-      'features/first.feature',
-      `Feature:
+  describe('junit', () => {
+    it('outputs a junit xml report', async () => {
+      const harness = await makeTestHarness()
+      await harness.writeFile(
+        'features/first.feature',
+        `Feature:
   Scenario:
     Given a step
     `
-    )
-    const [output] = await harness.run('spec')
-    const sanitised = stripVTControlCharacters(output.trim())
-    expect(sanitised).to.include('No matching step definitions found for text "a step"')
+      )
+      await harness.writeFile(
+        'features/steps.js',
+        `import { Given } from '@cucumber/node'
+  Given('a step', () => {})
+    `
+      )
+
+      const [output] = await harness.run('@cucumber/node/reporters/junit')
+
+      expect(output).to.include(
+        '<system-out><![CDATA[Given a step................................................................passed]]></system-out>'
+      )
+    })
   })
 })