Merge branch 'codeceptjs:3.x' into patch-1

yoannfleurydev · web-flow · commit e1305b5f6d80 · 2024-06-02T18:38:52.000+02:00
diff --git a/README.md b/README.md
@@ -315,8 +315,8 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
 <a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
-<a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
+<a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
 <a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>
diff --git a/docs/helpers/ExpectHelper.md b/docs/helpers/ExpectHelper.md
@@ -1,8 +1,8 @@
 ---
-permalink: /helpers/Expect
+permalink: /helpers/ExpectHelper
 editLink: false
 sidebar: auto
-title: Expect
+title: ExpectHelper
 ---
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
@@ -20,7 +20,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:
 {
   helpers: {
     Playwright: {...},
-    Expect: {},
+    ExpectHelper: {},
   }
 }
 ```
diff --git a/lib/command/gherkin/init.js b/lib/command/gherkin/init.js
@@ -4,7 +4,7 @@ const mkdirp = require('mkdirp');
 const output = require('../../output');
 const { fileExists } = require('../../utils');
 const {
-  getConfig, getTestRoot, updateConfig, safeFileWrite,
+  getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile,
 } = require('../utils');
 
 const featureFile = `Feature: Business rules
@@ -26,7 +26,17 @@ Given('I have a defined step', () => {
 
 module.exports = function (genPath) {
   const testsPath = getTestRoot(genPath);
+  const configFile = findConfigFile(testsPath);
+
+  if (!configFile) {
+    output.error(
+      "Can't initialize Gherkin. This command must be run in an already initialized project."
+    );
+    process.exit(1);
+  }
+
   const config = getConfig(testsPath);
+  const extension = path.extname(configFile).substring(1);
 
   output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
   output.print('--------------------------');
@@ -53,18 +63,18 @@ module.exports = function (genPath) {
     output.success(`Created ${dir}, place step definitions into it`);
   }
 
-  if (safeFileWrite(path.join(dir, 'steps.js'), stepsFile)) {
-    output.success('Created sample steps file: step_definitions/steps.js');
+  if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
+    output.success(
+      `Created sample steps file: step_definitions/steps.${extension}`
+    );
   }
 
   config.gherkin = {
-    features: './features/*.feature',
-    steps: [
-      './step_definitions/steps.js',
-    ],
+    features: "./features/*.feature",
+    steps: [`./step_definitions/steps.${extension}`],
   };
 
-  updateConfig(testsPath, config);
+  updateConfig(testsPath, config, extension);
 
   output.success('Gherkin setup is done.');
   output.success('Start writing feature files and implement corresponding steps.');
diff --git a/lib/command/utils.js b/lib/command/utils.js
@@ -41,15 +41,15 @@ function fail(msg) {
 
 module.exports.fail = fail;
 
-function updateConfig(testsPath, config, key, extension = 'js') {
+function updateConfig(testsPath, config, extension) {
   const configFile = path.join(testsPath, `codecept.conf.${extension}`);
   if (!fileExists(configFile)) {
-    console.log();
     const msg = `codecept.conf.${extension} config can\'t be updated automatically`;
+    console.log();
     console.log(`${output.colors.bold.red(msg)}`);
-    console.log('Please update it manually:');
+    console.log(`${output.colors.bold.red("Please update it manually:")}`);
     console.log();
-    console.log(`${key}: ${config[key]}`);
+    console.log(config);
     console.log();
     return;
   }
@@ -104,3 +104,14 @@ module.exports.createOutputDir = (config, testRoot) => {
     mkdirp.sync(outputDir);
   }
 };
+
+module.exports.findConfigFile = (testsPath) => {
+  const extensions = ['js', 'ts'];
+  for (const ext of extensions) {
+    const configFile = path.join(testsPath, `codecept.conf.${ext}`);
+    if (fileExists(configFile)) {
+      return configFile;
+    }
+  }
+  return null;
+}
diff --git a/lib/helper/ExpectHelper.js b/lib/helper/ExpectHelper.js
@@ -23,7 +23,7 @@ import('chai').then(chai => {
  *{
  *   helpers: {
  *     Playwright: {...},
- *     Expect: {},
+ *     ExpectHelper: {},
  *   }
  *}
  * ```
diff --git a/test/acceptance/codecept.Playwright.coverage.js b/test/acceptance/codecept.Playwright.coverage.js
@@ -23,7 +23,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: 'test/acceptance/output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: false,
diff --git a/test/acceptance/codecept.Playwright.js b/test/acceptance/codecept.Playwright.js
@@ -23,7 +23,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: 'test/acceptance/output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: false,
diff --git a/test/acceptance/codecept.Playwright.retryTo.js b/test/acceptance/codecept.Playwright.retryTo.js
@@ -23,7 +23,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: 'test/acceptance/output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: false,
diff --git a/test/acceptance/codecept.Puppeteer.js b/test/acceptance/codecept.Puppeteer.js
@@ -19,7 +19,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: './output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: false,
diff --git a/test/acceptance/codecept.Testcafe.js b/test/acceptance/codecept.Testcafe.js
@@ -9,7 +9,7 @@ module.exports.config = {
       url: TestHelper.siteUrl(),
       show: true,
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: false,
diff --git a/test/acceptance/codecept.WebDriver.devtools.coverage.js b/test/acceptance/codecept.WebDriver.devtools.coverage.js
@@ -21,7 +21,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: './output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   mocha: {},
diff --git a/test/acceptance/codecept.WebDriver.devtools.js b/test/acceptance/codecept.WebDriver.devtools.js
@@ -21,7 +21,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: './output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: async () => new Promise(done => {
diff --git a/test/acceptance/codecept.WebDriver.js b/test/acceptance/codecept.WebDriver.js
@@ -21,7 +21,7 @@ module.exports.config = {
       require: '../support/ScreenshotSessionHelper.js',
       outputPath: './output',
     },
-    Expect: {},
+    ExpectHelper: {},
   },
   include: {},
   bootstrap: async () => new Promise(done => {
diff --git a/test/data/sandbox/configs/gherkin/config_js/codecept.conf.init.js b/test/data/sandbox/configs/gherkin/config_js/codecept.conf.init.js
@@ -0,0 +1,16 @@
+/** @type {CodeceptJS.MainConfig} */
+exports.config = {
+  tests: "./*_test.js",
+  output: "./output",
+  helpers: {
+    Playwright: {
+      browser: "chromium",
+      url: "http://localhost",
+      show: true,
+    },
+  },
+  include: {
+    I: "./steps_file.js",
+  },
+  name: "CodeceptJS",
+};
diff --git a/test/data/sandbox/configs/gherkin/config_ts/codecept.conf.init.ts b/test/data/sandbox/configs/gherkin/config_ts/codecept.conf.init.ts
@@ -0,0 +1,15 @@
+export const config: CodeceptJS.MainConfig = {
+  tests: "./*_test.ts",
+  output: "./output",
+  helpers: {
+    Playwright: {
+      browser: "chromium",
+      url: "http://localhost",
+      show: true
+    }
+  },
+  include: {
+    I: "./steps_file"
+  },
+  name: "CodeceptJS"
+}
diff --git a/test/helper/Expect_test.js b/test/helper/Expect_test.js
@@ -5,7 +5,7 @@ import('chai').then(chai => {
   expect = chai.expect;
 });
 
-const ExpectHelper = require('../../lib/helper/Expect');
+const ExpectHelper = require('../../lib/helper/ExpectHelper');
 
 global.codeceptjs = require('../../lib');
 
diff --git a/test/runner/gherkin_test.js b/test/runner/gherkin_test.js
@@ -0,0 +1,93 @@
+const assert = require("assert");
+const path = require("path");
+const fs = require("fs");
+const exec = require("child_process").exec;
+
+const runner = path.join(__dirname, "/../../bin/codecept.js");
+const codecept_dir = path.join(__dirname, "/../data/sandbox/configs/gherkin/");
+
+describe("gherkin bdd commands", () => {
+  describe("bdd:init", () => {
+    let codecept_dir_js = path.join(codecept_dir, "config_js");
+    let codecept_dir_ts = path.join(codecept_dir, "config_ts");
+
+    beforeEach(() => {
+      fs.copyFileSync(
+        path.join(codecept_dir_js, "codecept.conf.init.js"),
+        path.join(codecept_dir_js, "codecept.conf.js")
+      );
+      fs.copyFileSync(
+        path.join(codecept_dir_ts, "codecept.conf.init.ts"),
+        path.join(codecept_dir_ts, "codecept.conf.ts")
+      );
+    });
+
+    afterEach(() => {
+      try {
+        fs.rmSync(path.join(codecept_dir_js, "codecept.conf.js"));
+        fs.rmSync(path.join(codecept_dir_js, "features"), {
+          recursive: true,
+        });
+        fs.rmSync(path.join(codecept_dir_js, "step_definitions"), {
+          recursive: true,
+        });
+      } catch (e) {}
+      try {
+        fs.rmSync(path.join(codecept_dir_ts, "codecept.conf.ts"));
+        fs.rmSync(path.join(codecept_dir_ts, "features"), {
+          recursive: true,
+        });
+        fs.rmSync(path.join(codecept_dir_ts, "step_definitions"), {
+          recursive: true,
+        });
+      } catch (e) {}
+    });
+
+    [
+      {
+        codecept_dir_test: codecept_dir_js,
+        extension: "js",
+      },
+      {
+        codecept_dir_test: codecept_dir_ts,
+        extension: "ts",
+      },
+    ].forEach(({ codecept_dir_test, extension }) => {
+      it(`prepare CodeceptJS to run feature files (codecept.conf.${extension})`, (done) => {
+        exec(`${runner} gherkin:init ${codecept_dir_test}`, (err, stdout) => {
+          let dir = path.join(codecept_dir_test, "features");
+
+          stdout.should.include(
+            "Initializing Gherkin (Cucumber BDD) for CodeceptJS"
+          );
+          stdout.should.include(
+            `Created ${dir}, place your *.feature files in it`
+          );
+          stdout.should.include(
+            "Created sample feature file: features/basic.feature"
+          );
+
+          dir = path.join(codecept_dir_test, "step_definitions");
+          stdout.should.include(
+            `Created ${dir}, place step definitions into it`
+          );
+          stdout.should.include(
+            `Created sample steps file: step_definitions/steps.${extension}`
+          );
+          assert(!err);
+
+          const configResult = fs
+            .readFileSync(
+              path.join(codecept_dir_test, `codecept.conf.${extension}`)
+            )
+            .toString();
+          configResult.should.contain(`features: './features/*.feature'`);
+          configResult.should.contain(
+            `steps: ['./step_definitions/steps.${extension}']`
+          );
+          done();
+        });
+      });
+    });
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`---`
`2`		`-permalink: /helpers/Expect`
	`2`	`+permalink: /helpers/ExpectHelper`
`3`	`3`	`editLink: false`
`4`	`4`	`sidebar: auto`
`5`		`-title: Expect`
	`5`	`+title: ExpectHelper`
`6`	`6`	`---`
`7`	`7`
`8`	`8`	`<!-- Generated by documentation.js. Update this documentation by updating the source code. -->`
`@@ -20,7 +20,7 @@ Zero-configuration when paired with other helpers like REST, Playwright:`
`20`	`20`	`{`
`21`	`21`	`helpers: {`
`22`	`22`	`Playwright: {...},`
`23`		`- Expect: {},`
	`23`	`+ ExpectHelper: {},`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	```