Calculate and use an implicit integration folder

This is similar to what Cypress does with some of their stuff [1]. More
importantly, it allows Cypress v10-users to continue with hierarchies
they had pre-v10. Fixes #748.

[1] https://docs.cypress.io/guides/references/migration-guide#Generated-Files

Author: badeball

CHANGELOG.md

@@ -4,6 +4,34 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+Breaking changes:
+
+- A minor change to step definitions has been introduced, affecting users of Cypress v10 or higher. When upgrading to v11.0.0 of the processor, users was instructed to [remove certain prefixes](https://github.com/badeball/cypress-cucumber-preprocessor/releases/tag/v11.0.0) from their step definitions. This is no longer required and said prefixes can be re-introduced when upgrading to v12.0.0 of the preprocessor. In other words, if your configuration looks like this
+
+```json
+{
+  "stepDefinitions": [
+    "[filepath].{js,ts}",
+    "cypress/support/step_definitions/**/*.{js,ts}"
+  ]
+}
+```
+
+.. then it should now look like this (notice the addition of `cypress/e2e`)
+
+```json
+{
+  "stepDefinitions": [
+    "cypress/e2e/[filepath].{js,ts}",
+    "cypress/support/step_definitions/**/*.{js,ts}"
+  ]
+}
+```
+
+Note: Step definitions doesn't necessarily have to be put in `cypress/e2e` and alongside your feature files. They can be contained in an entirely separate directory, if desired. This fixes [#748](https://github.com/badeball/cypress-cucumber-preprocessor/issues/748).
+
+Other changes:
+
 - Updated all `@cucumber/*` dependencies.
 
 - Added native support for HTML reports using `@cucumber/html-formatter`, fixes [#780](https://github.com/badeball/cypress-cucumber-preprocessor/issues/780).

docs/step-definitions.md

@@ -5,8 +5,8 @@ Step definitions are resolved using search paths that are configurable through t
 ```json
 {
   "stepDefinitions": [
-    "[filepath]/**/*.{js,ts}",
-    "[filepath].{js,ts}",
+    "cypress/e2e/[filepath]/**/*.{js,ts}",
+    "cypress/e2e/[filepath].{js,ts}",
     "cypress/support/step_definitions/**/*.{js,ts}",
   ]
 }

features/step_definitions/cli_steps.ts

@@ -142,24 +142,6 @@ Then("the output should contain", function (content) {
   );
 });
 
-Then("if pre-v10, the output should contain", function (content) {
-  if (isPre10()) {
-    assert.match(
-      this.lastRun.stdout.replaceAll("\\", "/"),
-      new RegExp(rescape(content))
-    );
-  }
-});
-
-Then("if post-v10, the output should contain", function (content) {
-  if (isPost10()) {
-    assert.match(
-      this.lastRun.stdout.replaceAll("\\", "/"),
-      new RegExp(rescape(content))
-    );
-  }
-});
-
 Then(
   "it should appear to have skipped the scenario {string}",
   function (scenarioName) {

features/undefined_step.feature

@@ -9,7 +9,7 @@ Feature: undefined Steps
       """
     When I run cypress
     Then it fails
-    And if pre-v10, the output should contain
+    And the output should contain
       """
       Step implementation missing for "an undefined step".
 
@@ -27,24 +27,6 @@ Feature: undefined Steps
 
       These patterns matched **no files** containing step definitions. This almost certainly means that you have misconfigured `stepDefinitions`.
       """
-    And if post-v10, the output should contain
-      """
-      Step implementation missing for "an undefined step".
-
-      We tried searching for files containing step definitions using the following search pattern templates:
-
-        - [filepath]/**/*.{js,mjs,ts,tsx}
-        - [filepath].{js,mjs,ts,tsx}
-        - cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}
-
-      These templates resolved to the following search patterns:
-
-        - cypress/e2e/a/**/*.{js,mjs,ts,tsx}
-        - cypress/e2e/a.{js,mjs,ts,tsx}
-        - cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}
-
-      These patterns matched **no files** containing step definitions. This almost certainly means that you have misconfigured `stepDefinitions`.
-      """
 
   Scenario: step definitions exist, but none matching
     Given a file named "cypress/e2e/a.feature" with:
@@ -60,7 +42,7 @@ Feature: undefined Steps
       """
     When I run cypress
     Then it fails
-    And if pre-v10, the output should contain
+    And the output should contain
       """
       Step implementation missing for "an undefined step".
 
@@ -82,25 +64,3 @@ Feature: undefined Steps
 
       However, none of these files contained a step definition matching "an undefined step".
       """
-    And if post-v10, the output should contain
-      """
-      Step implementation missing for "an undefined step".
-
-      We tried searching for files containing step definitions using the following search pattern templates:
-
-        - [filepath]/**/*.{js,mjs,ts,tsx}
-        - [filepath].{js,mjs,ts,tsx}
-        - cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}
-
-      These templates resolved to the following search patterns:
-
-        - cypress/e2e/a/**/*.{js,mjs,ts,tsx}
-        - cypress/e2e/a.{js,mjs,ts,tsx}
-        - cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}
-
-      These patterns matched the following files:
-
-        - cypress/support/step_definitions/steps.js
-
-      However, none of these files contained a step definition matching "an undefined step".
-      """

lib/add-cucumber-preprocessor-plugin.ts

@@ -71,7 +71,7 @@ let currentTestStepStartedId: string;
 let currentSpecMessages: messages.Envelope[];
 
 export async function beforeRunHandler(config: Cypress.PluginConfigOptions) {
-  const preprocessor = await resolve(config, config.env);
+  const preprocessor = await resolve(config, config.env, "/");
 
   if (!preprocessor.messages.enabled) {
     return;
@@ -86,7 +86,7 @@ export async function beforeRunHandler(config: Cypress.PluginConfigOptions) {
 }
 
 export async function afterRunHandler(config: Cypress.PluginConfigOptions) {
-  const preprocessor = await resolve(config, config.env);
+  const preprocessor = await resolve(config, config.env, "/");
 
   if (!preprocessor.json.enabled && !preprocessor.html.enabled) {
     return;
@@ -191,7 +191,7 @@ export async function afterSpecHandler(
   spec: Cypress.Spec,
   results: CypressCommandLine.RunResult
 ) {
-  const preprocessor = await resolve(config, config.env);
+  const preprocessor = await resolve(config, config.env, "/");
 
   const messagesPath = ensureIsAbsolute(
     config.projectRoot,
@@ -231,7 +231,7 @@ export async function afterScreenshotHandler(
   config: Cypress.PluginConfigOptions,
   details: Cypress.ScreenshotDetails
 ) {
-  const preprocessor = await resolve(config, config.env);
+  const preprocessor = await resolve(config, config.env, "/");
 
   if (!preprocessor.messages.enabled || !currentSpecMessages) {
     return details;
@@ -273,7 +273,7 @@ export default async function addCucumberPreprocessorPlugin(
   config: Cypress.PluginConfigOptions,
   options: AddOptions = {}
 ) {
-  const preprocessor = await resolve(config, config.env);
+  const preprocessor = await resolve(config, config.env, "/");
 
   if (!options.omitBeforeRunHandler) {
     on("before:run", () => beforeRunHandler(config));

lib/preprocessor-configuration.test.ts

@@ -16,6 +16,7 @@ describe("resolve()", () => {
     const { stepDefinitions } = await resolve(
       DUMMY_POST10_CONFIG,
       { stepDefinitions: "foo/bar/**" },
+      "/",
       () => null
     );
 
@@ -25,19 +26,29 @@ describe("resolve()", () => {
   it("overriding messages.enabled (1)", async () => {
     const {
       messages: { enabled },
-    } = await resolve(DUMMY_POST10_CONFIG, { messagesEnabled: "" }, () => ({
-      messages: { enabled: true },
-    }));
+    } = await resolve(
+      DUMMY_POST10_CONFIG,
+      { messagesEnabled: "" },
+      "/",
+      () => ({
+        messages: { enabled: true },
+      })
+    );
 
     assert.strictEqual(enabled, true);
   });
 
   it("overriding messages.enabled (2)", async () => {
     const {
       messages: { enabled },
-    } = await resolve(DUMMY_POST10_CONFIG, { messagesEnabled: "true" }, () => ({
-      messages: { enabled: false },
-    }));
+    } = await resolve(
+      DUMMY_POST10_CONFIG,
+      { messagesEnabled: "true" },
+      "/",
+      () => ({
+        messages: { enabled: false },
+      })
+    );
 
     assert.strictEqual(enabled, true);
   });
@@ -48,6 +59,7 @@ describe("resolve()", () => {
     } = await resolve(
       DUMMY_POST10_CONFIG,
       { messagesEnabled: "foobar" },
+      "/",
       () => ({
         messages: { enabled: false },
       })
@@ -59,9 +71,14 @@ describe("resolve()", () => {
   it("overriding messages.enabled (4)", async () => {
     const {
       messages: { enabled },
-    } = await resolve(DUMMY_POST10_CONFIG, { messagesEnabled: true }, () => ({
-      messages: { enabled: false },
-    }));
+    } = await resolve(
+      DUMMY_POST10_CONFIG,
+      { messagesEnabled: true },
+      "/",
+      () => ({
+        messages: { enabled: false },
+      })
+    );
 
     assert.strictEqual(enabled, true);
   });
@@ -72,6 +89,7 @@ describe("resolve()", () => {
     } = await resolve(
       DUMMY_POST10_CONFIG,
       { messagesEnabled: "false" },
+      "/",
       () => ({
         messages: { enabled: true },
       })
@@ -86,6 +104,7 @@ describe("resolve()", () => {
     } = await resolve(
       DUMMY_POST10_CONFIG,
       { messagesEnabled: "false" },
+      "/",
       () => ({
         messages: { enabled: true },
       })
@@ -97,9 +116,14 @@ describe("resolve()", () => {
   it("overriding messages.enabled (7)", async () => {
     const {
       messages: { enabled },
-    } = await resolve(DUMMY_POST10_CONFIG, { messagesEnabled: false }, () => ({
-      messages: { enabled: true },
-    }));
+    } = await resolve(
+      DUMMY_POST10_CONFIG,
+      { messagesEnabled: false },
+      "/",
+      () => ({
+        messages: { enabled: true },
+      })
+    );
 
     assert.strictEqual(enabled, false);
   });

lib/preprocessor-configuration.ts

@@ -365,6 +365,7 @@ export interface IPreprocessorConfiguration {
   };
   readonly filterSpecs?: boolean;
   readonly omitFiltered?: boolean;
+  readonly implicitIntegrationFolder: string;
 }
 
 export interface IEnvironmentOverrides {
@@ -381,23 +382,18 @@ export interface IEnvironmentOverrides {
   omitFiltered?: boolean;
 }
 
-export const DEFAULT_PRE_10_STEP_DEFINITIONS = [
+export const DEFAULT_STEP_DEFINITIONS = [
   "[integration-directory]/[filepath]/**/*.{js,mjs,ts,tsx}",
   "[integration-directory]/[filepath].{js,mjs,ts,tsx}",
   "cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}",
 ];
 
-export const DEFAULT_POST_10_STEP_DEFINITIONS = [
-  "[filepath]/**/*.{js,mjs,ts,tsx}",
-  "[filepath].{js,mjs,ts,tsx}",
-  "cypress/support/step_definitions/**/*.{js,mjs,ts,tsx}",
-];
-
 export class PreprocessorConfiguration implements IPreprocessorConfiguration {
   constructor(
     private explicitValues: Partial<IPreprocessorConfiguration>,
     private environmentOverrides: IEnvironmentOverrides,
-    private cypressConfiguration: ICypressConfiguration
+    private cypressConfiguration: ICypressConfiguration,
+    public implicitIntegrationFolder: string
   ) {}
 
   get stepDefinitions() {
@@ -411,16 +407,17 @@ export class PreprocessorConfiguration implements IPreprocessorConfiguration {
 
     const config = this.cypressConfiguration;
 
-    if ("specPattern" in config) {
-      return DEFAULT_POST_10_STEP_DEFINITIONS;
-    } else {
-      return DEFAULT_PRE_10_STEP_DEFINITIONS.map((pattern) =>
-        pattern.replace(
-          "[integration-directory]",
-          ensureIsRelative(config.projectRoot, config.integrationFolder)
+    return DEFAULT_STEP_DEFINITIONS.map((pattern) =>
+      pattern.replace(
+        "[integration-directory]",
+        ensureIsRelative(
+          config.projectRoot,
+          "integrationFolder" in config
+            ? config.integrationFolder
+            : this.implicitIntegrationFolder
         )
-      );
-    }
+      )
+    );
   }
 
   get messages() {
@@ -503,6 +500,7 @@ export type ConfigurationFileResolver = (
 export async function resolve(
   cypressConfig: ICypressConfiguration,
   environment: Record<string, unknown>,
+  implicitIntegrationFolder: string,
   configurationFileResolver: ConfigurationFileResolver = cosmiconfigResolver
 ) {
   const result = await configurationFileResolver(cypressConfig.projectRoot);
@@ -530,15 +528,17 @@ export async function resolve(
     return new PreprocessorConfiguration(
       config,
       environmentOverrides,
-      cypressConfig
+      cypressConfig,
+      implicitIntegrationFolder
     );
   } else {
     debug("resolved no configuration");
 
     return new PreprocessorConfiguration(
       {},
       environmentOverrides,
-      cypressConfig
+      cypressConfig,
+      implicitIntegrationFolder
     );
   }
 }