Merge pull request #236 from liamchilds/configurable-loc-non-global-steps

feat(getstepdefinitionspaths): configurable nonGlobalStepDefinitions base directory

Author: lgandecki

README.md

@@ -85,8 +85,9 @@ Please make use of [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) t
 
 Option | Default value | Description
 ------------ | ------------- | -------------
-commonPath | `cypress/integration/common` when `nonGlobalStepDefinitions` is true <br> `cypress/support/step_definitions` when `nonGlobalStepDefinitions` is false | Define the path to a folder containing all common step definitions of your tests
-nonGlobalStepDefinitions | false | If true use the Cypress Cucumber Preprocessor Style pattern for placing step definitions files. If false, we will use the "oldschool" (everything is global) Cucumber style
+commonPath | `cypress/integration/common` when `nonGlobalStepDefinitions` is true <br> `cypress/support/step_definitions` when `nonGlobalStepDefinitions` is false <br> `${nonGlobalStepBaseDir}/common` when `nonGlobalStepBaseDir` is defined | Define the path to a folder containing all common step definitions of your tests. When `nonGlobalStepBaseDir` is defined this path is defined from that base location. e.g `${nonGlobalStepBaseDir}/${commonPath}`.
+nonGlobalStepDefinitions | false | If true use the Cypress Cucumber Preprocessor Style pattern for placing step definitions files. If false, we will use the "oldschool" (everything is global) Cucumber style.
+nonGlobalStepBaseDir| undefined | If defined and `nonGlobalStepDefinitions` is also true then step definition searches for folders with the features name will start from the directory provided here. The cwd is already taken into account. e.g `test/step_definitions`.
 stepDefinitions | `cypress/integration` when `nonGlobalStepDefinitions` is true <br> `cypress/support/step_definitions` when `nonGlobalStepDefinitions` is false | Path to the folder containing our step definitions.
 
 ## How to organize the tests

lib/getStepDefinitionsPaths.js

@@ -1,5 +1,6 @@
 const path = require("path");
 const glob = require("glob");
+const process = require("process");
 const { getConfig } = require("./getConfig");
 const stepDefinitionPath = require("./stepDefinitionPath.js");
 const { getStepDefinitionPathsFrom } = require("./getStepDefinitionPathsFrom");
@@ -9,18 +10,27 @@ const getStepDefinitionsPaths = filePath => {
   let paths = [];
   const config = getConfig();
   if (config && config.nonGlobalStepDefinitions) {
-    const nonGlobalPattern = `${getStepDefinitionPathsFrom(
-      filePath
-    )}/**/*.+(js|ts)`;
-
+    let nonGlobalPath = getStepDefinitionPathsFrom(filePath);
     let commonPath = config.commonPath || `${stepDefinitionPath()}/common/`;
 
     if (config.commonPath) {
       commonPath = path.resolve(appRoot, commonPath);
     }
+
+    if (config.nonGlobalStepBaseDir) {
+      const stepBase = `${appRoot}/${config.nonGlobalStepBaseDir}`;
+      nonGlobalPath = nonGlobalPath.replace(stepDefinitionPath(), stepBase);
+      commonPath = `${nonGlobalPath}/${config.commonPath ||
+        `${stepBase}/common/`}`;
+    }
+
+    const nonGlobalPattern = `${nonGlobalPath}/**/*.+(js|ts)`;
+
     const commonDefinitionsPattern = `${commonPath}**/*.+(js|ts)`;
-    paths = paths.concat(glob.sync(nonGlobalPattern));
-    paths = paths.concat(glob.sync(commonDefinitionsPattern));
+    paths = paths.concat(
+      glob.sync(nonGlobalPattern),
+      glob.sync(commonDefinitionsPattern)
+    );
   } else {
     const pattern = `${stepDefinitionPath()}/**/*.+(js|ts)`;
     paths = paths.concat(glob.sync(pattern));

lib/getStepDefinitionsPaths.test.js

@@ -12,6 +12,7 @@ describe("getStepDefinitionsPaths", () => {
   beforeEach(() => {
     jest.resetModules();
     ({ getConfig } = require("./getConfig"));
+    jest.unmock("path");
     jest.mock("./getConfig");
   });
   it("should return the default common folder", () => {
@@ -23,7 +24,6 @@ describe("getStepDefinitionsPaths", () => {
 
     const actual = getStepDefinitionsPaths("/path");
     const expected = "stepDefinitionPath/common/**/*.+(js|ts)";
-
     expect(actual).to.include(expected);
   });
 
@@ -37,7 +37,6 @@ describe("getStepDefinitionsPaths", () => {
       }
     }));
 
-    jest.mock("fs");
     jest.spyOn(process, "cwd").mockImplementation(() => "cwd");
 
     getConfig.mockReturnValue({
@@ -51,4 +50,32 @@ describe("getStepDefinitionsPaths", () => {
     const expected = "./cwd/myPath/**/*.+(js|ts)";
     expect(actual).to.include(expected);
   });
+  it("should return the default non global step definition pattern", () => {
+    getConfig.mockReturnValue({
+      nonGlobalStepDefinitions: true
+    });
+    // eslint-disable-next-line global-require
+    const { getStepDefinitionsPaths } = require("./getStepDefinitionsPaths");
+    const path = "stepDefinitionPath/test.feature";
+    const actual = getStepDefinitionsPaths(path);
+    const expected = "stepDefinitionPath/test/**/*.+(js|ts)";
+
+    expect(actual).to.include(expected);
+  });
+
+  it("should return the overriden non global step definition pattern if nonGlobalStepBaseDir is defined", () => {
+    jest.spyOn(process, "cwd").mockImplementation(() => "cwd");
+    getConfig.mockReturnValue({
+      nonGlobalStepDefinitions: true,
+      nonGlobalStepBaseDir: "nonGlobalStepBaseDir"
+    });
+    // eslint-disable-next-line global-require
+    const { getStepDefinitionsPaths } = require("./getStepDefinitionsPaths");
+    const path = "stepDefinitionPath/test.feature";
+    const actual = getStepDefinitionsPaths(path);
+    const expected = "cwd/nonGlobalStepBaseDir/test/**/*.+(js|ts)";
+
+    expect(actual).to.include(expected);
+    expect(actual).to.not.include("stepDefinitionPath/test/**/*.+(js|ts)");
+  });
 });