codeceptjs 2.4.3 → 2.6.2

package/docs/webdriver.md

@@ -53,6 +53,8 @@ exports.config = {
 }
 ```
 
+> ⚠ It is not recommended to use wdio plugin & selenium-standalone when running tests in parallel. Consider **switching to Selenoid** if you need parallel run or using cloud services.
+
 
 ## Configuring WebDriver
 
@@ -104,7 +106,7 @@ path: '/',
 
 > If you face issues connecting to WebDriver, please check that corresponding server is running on a specified port. If host is other than `localhost` or port is other than `4444`, update the configuration.
 
-### Selenium in Docker
+### Selenium in Docker (Selenoid)
 
 Browsers can be executed in Docker containers. This is useful when testing on Continous Integration server.
 We recommend using [Selenoid](https://aerokube.com/selenoid/) to run browsers in container.
@@ -204,7 +206,7 @@ Scenario('login test', (I) => {
 > ▶ Actions like `amOnPage`, `click`, `fillField` are not limited to WebDriver only. They work similarly for all available helpers. [Go to Basics guide to learn them](/basics#writing-tests).
 
 
-An empty test case can be created with `codeceptjs gt` command.
+An empty test case can be created with `npx codeceptjs gt` command.
 
 ```
 npx codeceptjs gt
@@ -223,7 +225,7 @@ Scenario('open my website', (I) => {
 
 This is just enough to run a test, open a browser, and think what to do next to write a test case.
 
-When you execute such test with `codeceptjs run` command you may see the browser is started
+When you execute such test with `npx codeceptjs run` command you may see the browser is started
 
 ```
 npx codeceptjs run --steps
@@ -264,6 +266,8 @@ Scenario('create todo item', (I) => {
 
 > [▶ Working example of CodeceptJS WebDriver tests](https://github.com/DavertMik/codeceptjs-webdriver-example) for TodoMVC application.
 
+WebDriver helper supports standard [CSS/XPath and text locators](/locators) as well as non-trivial [React locators](/react) and [Shadow DOM](/shadow).
+
 ## Waiting
 
 Web applications do not always respond instantly. That's why WebDriver protocol has methods to wait for changes on a page. CodeceptJS provides such commands prefixed with `wait*` so you could explicitly define what effects we wait for.

package/lib/codecept.js

@@ -6,7 +6,7 @@ const resolve = require('path').resolve;
 
 const container = require('./container');
 const Config = require('./config');
-const event = require('../lib/event');
+const event = require('./event');
 const runHook = require('./hooks');
 const output = require('./output');
 

package/lib/command/definitions.js

@@ -93,8 +93,8 @@ function getPath(originalPath, targetFolderPath, testsPath) {
   if (parsedPath.base.endsWith('.d.ts')) parsedPath.base = parsedPath.base.substring(0, parsedPath.base.length - 5);
   else if (parsedPath.ext === '.ts') parsedPath.base = parsedPath.name;
 
-  if (!parsedPath.dir.startsWith('.')) return path.join(parsedPath.dir, parsedPath.base);
-  const relativePath = path.relative(targetFolderPath, path.join(testsPath, parsedPath.dir, parsedPath.base));
+  if (!parsedPath.dir.startsWith('.')) return path.posix.join(parsedPath.dir, parsedPath.base);
+  const relativePath = path.posix.relative(targetFolderPath, path.posix.join(testsPath, parsedPath.dir, parsedPath.base));
 
   return relativePath.startsWith('.') ? relativePath : `./${relativePath}`;
 }

package/lib/command/generate.js

@@ -26,20 +26,20 @@ module.exports.test = function (genPath) {
   output.print('Creating a new test...');
   output.print('----------------------');
 
-  const defaultExt = config.tests.match(/([^\*/]*?)$/[1])[0] || '_test.js';
+  const defaultExt = config.tests.match(/([^\*/]*?)$/)[1] || '_test.js';
 
   return inquirer.prompt([
     {
       type: 'input',
       name: 'feature',
-      message: 'Feature which is being tested',
+      message: 'Feature which is being tested (ex: account, login, etc)',
     },
     {
       type: 'input',
       message: 'Filename of a test',
       name: 'filename',
       default(answers) {
-        return (answers.feature).replace(' ', '_').toLowerCase() + defaultExt;
+        return (answers.feature).replace(' ', '_') + defaultExt;
       },
     },
   ]).then((result) => {
@@ -60,7 +60,7 @@ module.exports.test = function (genPath) {
     testContent = testContent.replace('{{actor}}', 'I');
 
     if (!safeFileWrite(testFile, testContent)) return;
-    output.success(`Test for ${result.filename} was created in ${testFile}`);
+    output.success(`\nTest for ${result.filename} was created in ${testFile}`);
   });
 };
 

package/lib/command/gherkin/snippets.js

@@ -49,7 +49,7 @@ module.exports = function (genPath, options) {
   });
   output.print(`Loaded ${files.length} files`);
 
-  let newSteps = [];
+  const newSteps = new Map();
 
   const parseSteps = (steps) => {
     const newSteps = [];
@@ -88,9 +88,9 @@ module.exports = function (genPath, options) {
     const ast = parser.parse(fs.readFileSync(file).toString());
     for (const child of ast.feature.children) {
       if (child.type === 'ScenarioOutline') continue; // skip scenario outline
-      newSteps = newSteps.concat(parseSteps(child.steps).map((step) => {
+      parseSteps(child.steps).map((step) => {
         return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) });
-      }));
+      }).map((step) => newSteps.set(`${step.type}(${step})`, step));
     }
   };
 
@@ -106,7 +106,7 @@ module.exports = function (genPath, options) {
     stepFile = fsPath.join(global.codecept_dir, stepFile);
   }
 
-  const snippets = newSteps
+  const snippets = [...newSteps.values()]
     .filter((value, index, self) => self.indexOf(value) === index)
     .map((step) => {
       return `

package/lib/command/init.js

@@ -21,7 +21,7 @@ const defaultConfig = {
   mocha: {},
 };
 
-const helpers = ['WebDriver', 'Puppeteer', 'TestCafe', 'Protractor', 'Nightmare', 'Appium'];
+const helpers = ['WebDriver', 'Puppeteer', 'TestCafe', 'Protractor', 'Nightmare', 'Appium', 'Playwright'];
 const translations = Object.keys(require('../../translations'));
 
 const noTranslation = 'English (no localization)';

package/lib/command/interactive.js

@@ -6,7 +6,9 @@ const event = require('../event');
 const output = require('../output');
 
 module.exports = function (path, options) {
+  // Backward compatibility for --profile
   process.profile = options.profile;
+  process.env.profile = options.profile;
 
   const testsPath = getTestRoot(path);
   const config = getConfig(testsPath);
@@ -33,6 +35,7 @@ module.exports = function (path, options) {
     require('../pause')();
     recorder.add(() => event.emit(event.test.after));
     recorder.add(() => event.emit(event.suite.after, {}));
+    recorder.add(() => event.emit(event.all.result, {}));
     recorder.add(() => codecept.teardown());
   });
 };

package/lib/command/run-multiple.js

@@ -14,7 +14,7 @@ const {
 const runner = path.join(__dirname, '/../../bin/codecept');
 let config;
 const childOpts = {};
-const copyOptions = ['override', 'steps', 'reporter', 'verbose', 'config', 'reporter-options', 'grep', 'fgrep', 'invert', 'debug', 'plugins'];
+const copyOptions = ['override', 'steps', 'reporter', 'verbose', 'config', 'reporter-options', 'grep', 'fgrep', 'invert', 'debug', 'plugins', 'colors'];
 let overrides = {};
 
 // codeceptjs run-multiple smoke:chrome regression:firefox - will launch smoke run in chrome and regression in firefox
@@ -29,7 +29,7 @@ let processesDone;
 
 module.exports = function (selectedRuns, options) {
   // registering options globally to use in config
-  process.profile = options.profile;
+  process.env.profile = options.profile;
   const configFile = options.config;
   let codecept;
 

package/lib/command/run-rerun.js

@@ -7,7 +7,9 @@ const Codecept = require('../rerun');
 
 module.exports = function (test, options) {
   // registering options globally to use in config
+  // Backward compatibility for --profile
   process.profile = options.profile;
+  process.env.profile = options.profile;
   const configFile = options.config;
   let codecept;
 

package/lib/command/run-workers.js

@@ -32,7 +32,7 @@ module.exports = function (workers, options) {
     'Required minimum Node version of 11.7.0 to work with "run-workers"',
   );
 
-  process.profile = options.profile;
+  process.env.profile = options.profile;
 
   const { Worker } = require('worker_threads');
 
@@ -46,6 +46,12 @@ module.exports = function (workers, options) {
     ...overrideConfigs,
   };
 
+  const configRerun = config.rerun || {};
+  let maxReruns = configRerun.maxReruns || 1;
+  if (maxReruns > 1) {
+    maxReruns *= numberOfWorkers;
+  }
+
   const testRoot = getTestRoot(configPath);
 
   const codecept = new Codecept(config, options);
@@ -95,11 +101,12 @@ module.exports = function (workers, options) {
 
       switch (message.event) {
         case event.test.failed:
-          updateFinishedTests(repackTest(message.data));
           output.test.failed(repackTest(message.data));
+          updateFinishedTests(repackTest(message.data), maxReruns);
           break;
-        case event.test.passed: output.test.passed(repackTest(message.data));
-          updateFinishedTests(repackTest(message.data));
+        case event.test.passed:
+          output.test.passed(repackTest(message.data));
+          updateFinishedTests(repackTest(message.data), maxReruns);
           break;
         case event.suite.before: output.suite.started(message.data); break;
         case event.all.after: appendStats(message.data); break;
@@ -223,11 +230,18 @@ function simplifyObject(object) {
     }, {});
 }
 
-const updateFinishedTests = (test) => {
+const updateFinishedTests = (test, maxReruns) => {
   const { id } = test;
   if (finishedTests[id]) {
-    const stats = { passes: 0, failures: -1, tests: 0 };
-    appendStats(stats);
+    if (finishedTests[id].runs <= maxReruns) {
+      finishedTests[id].runs++;
+    }
+    if (test.retries !== -1) {
+      const stats = { passes: 0, failures: -1, tests: 0 };
+      appendStats(stats);
+    }
+  } else {
+    finishedTests[id] = test;
+    finishedTests[id].runs = 1;
   }
-  finishedTests[id] = test;
 };

package/lib/command/run.js

@@ -10,7 +10,9 @@ const Codecept = require('../codecept');
 
 module.exports = function (test, options) {
   // registering options globally to use in config
+  // Backward compatibility for --profile
   process.profile = options.profile;
+  process.env.profile = options.profile;
   const configFile = options.config;
   let codecept;
 

package/lib/command/workers/runTests.js

@@ -80,6 +80,7 @@ function initializeListeners() {
     return {
       id: test.id,
       workerIndex,
+      retries: test._retries,
       title: test.title,
       status: test.status,
       duration: test.duration || 0,

package/lib/container.js

@@ -99,7 +99,7 @@ class Container {
    * Get Mocha instance
    *
    * @api
-   * @returns {Mocha | {}}
+   * @returns { * }
    */
   static mocha() {
     return container.mocha;

package/lib/event.js

@@ -24,6 +24,7 @@ module.exports = {
    * @property {'test.passed'} passed
    * @property {'test.failed'} failed
    * @property {'test.finish'} finished
+   * @property {'test.skipped'} skipped
    */
   test: {
     started: 'test.start', // sync
@@ -32,6 +33,7 @@ module.exports = {
     passed: 'test.passed', // sync
     failed: 'test.failed', // sync
     finished: 'test.finish', // sync
+    skipped: 'test.skipped', // sync
   },
   /**
    * @type {object}

package/lib/helper/MockRequest.js

@@ -57,6 +57,9 @@ let PollyJS;
  */
 class MockRequest extends Helper {
   constructor(config) {
+    console.log('DEPRECATION NOTICE:');
+    console.log('MockRequest helper was moved to a standalone package: https://github.com/codecept-js/mock-request');
+    console.log('Disable MockRequest in config & install @codeceptjs/mock-request package\n');
     super(config);
     this._setConfig(config);
     PollyJS = requireg('@pollyjs/core').Polly;