Create testRunStarted before all, not each

Similarly with testRunFinished. I was a bit too quick in b3bfdea. This
fixes #813.

Author: badeball

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+- Total execution time is correctly shown in HTML reports, fixes [#813](https://github.com/badeball/cypress-cucumber-preprocessor/issues/813).
+
 ## v12.1.0
 
 - Start time and execution time is shown in HTML reports, fixes [#798](https://github.com/badeball/cypress-cucumber-preprocessor/issues/798).

features/issues/813.feature

@@ -0,0 +1,32 @@
+# https://github.com/badeball/cypress-cucumber-preprocessor/issues/813
+
+Feature: messages report
+  Scenario: it should only ever contain one 'testRunStarted' and 'testRunFinished'
+    Given additional preprocessor configuration
+      """
+      {
+        "messages": {
+          "enabled": true
+        }
+      }
+      """
+    And a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/e2e/b.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { Given } = require("@badeball/cypress-cucumber-preprocessor");
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes
+    And the messages should only contain a single "testRunStarted" and a single "testRunFinished"

features/json_report.feature

@@ -296,11 +296,11 @@ Feature: JSON formatter
       """
     When I run cypress
     Then it fails
-    And there should be no JSON output
     And the output should contain
       """
       Hook failures can't be represented in JSON reports, thus none is created for cypress/e2e/a.feature.
       """
+    And the JSON report shouldn't contain any specs
 
   Scenario: failing beforeEach hook
     Given a file named "cypress/e2e/a.feature" with:
@@ -322,11 +322,11 @@ Feature: JSON formatter
       """
     When I run cypress
     Then it fails
-    And there should be no JSON output
     And the output should contain
       """
       Hook failures can't be represented in JSON reports, thus none is created for cypress/e2e/a.feature.
       """
+    And the JSON report shouldn't contain any specs
 
   Scenario: failing afterEach hook
     Given a file named "cypress/e2e/a.feature" with:
@@ -348,11 +348,11 @@ Feature: JSON formatter
       """
     When I run cypress
     Then it fails
-    And there should be no JSON output
     And the output should contain
       """
       Hook failures can't be represented in JSON reports, thus none is created for cypress/e2e/a.feature.
       """
+    And the JSON report shouldn't contain any specs
 
   Scenario: failing after hook
     Given a file named "cypress/e2e/a.feature" with:
@@ -374,8 +374,8 @@ Feature: JSON formatter
       """
     When I run cypress
     Then it fails
-    And there should be no JSON output
     And the output should contain
       """
       Hook failures can't be represented in JSON reports, thus none is created for cypress/e2e/a.feature.
       """
+    And the JSON report shouldn't contain any specs

features/step_definitions/json_steps.ts

@@ -169,3 +169,17 @@ Then(
     assert.strictEqual(actualHeight, expectedDimensions.height);
   }
 );
+
+Then("the JSON report shouldn't contain any specs", async function () {
+  const absolutejsonPath = path.join(this.tmpDir, "cucumber-report.json");
+
+  const jsonFile = await fs.readFile(absolutejsonPath);
+
+  const actualJsonOutput = JSON.parse(jsonFile.toString());
+
+  if (actualJsonOutput.length > 0) {
+    throw new Error(
+      `Expected to find zero specs, but found ${actualJsonOutput.length}`
+    );
+  }
+});

features/step_definitions/messsages_steps.ts

@@ -0,0 +1,30 @@
+import { Then } from "@cucumber/cucumber";
+import path from "path";
+import { promises as fs } from "fs";
+
+Then(
+  "the messages should only contain a single {string} and a single {string}",
+  async function (a, b) {
+    const absoluteMessagesPath = path.join(
+      this.tmpDir,
+      "cucumber-messages.ndjson"
+    );
+
+    const messages = (await fs.readFile(absoluteMessagesPath))
+      .toString()
+      .trim()
+      .split("\n")
+      .map((string) => JSON.parse(string));
+
+    const aCount = messages.filter((m) => m[a]).length;
+    const bCount = messages.filter((m) => m[b]).length;
+
+    if (aCount !== 1) {
+      throw new Error(`Expected to find a single "${a}", but found ${aCount}`);
+    }
+
+    if (bCount !== 1) {
+      throw new Error(`Expected to find a single "${b}", but found ${bCount}`);
+    }
+  }
+);

lib/add-cucumber-preprocessor-plugin.ts

@@ -41,6 +41,8 @@ import { getTags } from "./environment-helpers";
 
 import { ensureIsAbsolute } from "./helpers";
 
+import { createTimestamp } from "./messages-helpers";
+
 /**
  * Work-around for the fact that some Cypress versions pre v10 were missing this property in their types.
  */
@@ -84,12 +86,26 @@ export async function beforeRunHandler(config: Cypress.PluginConfigOptions) {
   );
 
   await fs.rm(messagesPath, { force: true });
+
+  const testRunStarted: messages.Envelope = {
+    testRunStarted: {
+      timestamp: createTimestamp(),
+    },
+  };
+
+  await fs.mkdir(path.dirname(messagesPath), { recursive: true });
+
+  await fs.writeFile(messagesPath, JSON.stringify(testRunStarted) + "\n");
 }
 
 export async function afterRunHandler(config: Cypress.PluginConfigOptions) {
   const preprocessor = await resolve(config, config.env, "/");
 
-  if (!preprocessor.json.enabled && !preprocessor.html.enabled) {
+  if (
+    !preprocessor.messages.enabled &&
+    !preprocessor.json.enabled &&
+    !preprocessor.html.enabled
+  ) {
     return;
   }
 
@@ -104,6 +120,22 @@ export async function afterRunHandler(config: Cypress.PluginConfigOptions) {
     return;
   }
 
+  if (preprocessor.messages.enabled) {
+    const testRunFinished: messages.Envelope = {
+      testRunFinished: {
+        /**
+         * We're missing a "success" attribute here, but cucumber-js doesn't output it, so I won't.
+         * Mostly because I don't want to look into the semantics of it right now.
+         */
+        timestamp: createTimestamp(),
+      } as messages.TestRunFinished,
+    };
+
+    await fs.writeFile(messagesPath, JSON.stringify(testRunFinished) + "\n", {
+      flag: "a",
+    });
+  }
+
   if (preprocessor.json.enabled) {
     const jsonPath = ensureIsAbsolute(
       config.projectRoot,
@@ -213,8 +245,6 @@ export async function afterSpecHandler(
       )
     );
   } else {
-    await fs.mkdir(path.dirname(messagesPath), { recursive: true });
-
     await fs.writeFile(
       messagesPath,
       currentSpecMessages.map((message) => JSON.stringify(message)).join("\n") +

lib/create-tests.ts

@@ -33,6 +33,8 @@ import { notNull } from "./type-guards";
 
 import { looksLikeOptions, tagToCypressOptions } from "./tag-parser";
 
+import { createTimestamp, duration } from "./messages-helpers";
+
 declare global {
   namespace globalThis {
     var __cypress_cucumber_preprocessor_dont_use_this: true | undefined;
@@ -115,34 +117,6 @@ function collectExampleIds(examples: readonly messages.Examples[]) {
     .reduce((acum, el) => acum.concat(el), []);
 }
 
-type StrictTimestamp = {
-  seconds: number;
-  nanos: number;
-};
-
-function createTimestamp(): StrictTimestamp {
-  const now = new Date().getTime();
-
-  const seconds = Math.floor(now / 1000);
-
-  const nanos = (now - seconds * 1000) * 1000000;
-
-  return {
-    seconds,
-    nanos,
-  };
-}
-
-function duration(
-  start: StrictTimestamp,
-  end: StrictTimestamp
-): StrictTimestamp {
-  return {
-    seconds: end.seconds - start.seconds,
-    nanos: end.nanos - start.nanos,
-  };
-}
-
 function minIndent(content: string) {
   const match = content.match(/^[ \t]*(?=\S)/gm);
 
@@ -677,12 +651,6 @@ export default function createTests(
     });
   }
 
-  messages.push({
-    testRunStarted: {
-      timestamp: createTimestamp(),
-    },
-  });
-
   const tagsInDocument = collectTagNamesFromGherkinDocument(gherkinDocument);
 
   const testFilter =
@@ -836,16 +804,6 @@ export default function createTests(
   });
 
   after(function () {
-    messages.push({
-      testRunFinished: {
-        /**
-         * We're missing a "success" attribute here, but cucumber-js doesn't output it, so I won't.
-         * Mostly because I don't want to look into the semantics of it right now.
-         */
-        timestamp: createTimestamp(),
-      } as messages.TestRunFinished,
-    });
-
     if (messagesEnabled) {
       cy.task(TASK_APPEND_MESSAGES, messages, { log: false });
     }

lib/messages-helpers.ts

@@ -0,0 +1,27 @@
+export type StrictTimestamp = {
+  seconds: number;
+  nanos: number;
+};
+
+export function createTimestamp(): StrictTimestamp {
+  const now = new Date().getTime();
+
+  const seconds = Math.floor(now / 1000);
+
+  const nanos = (now - seconds * 1000) * 1000000;
+
+  return {
+    seconds,
+    nanos,
+  };
+}
+
+export function duration(
+  start: StrictTimestamp,
+  end: StrictTimestamp
+): StrictTimestamp {
+  return {
+    seconds: end.seconds - start.seconds,
+    nanos: end.nanos - start.nanos,
+  };
+}