codeceptjs 3.5.9-beta.1 → 3.5.9-beta.2

package/docs/internal-api.md

@@ -96,7 +96,117 @@ module.exports = function() {
   });
 }
 ```
+You could get test stats when running with workers
 
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+
+  event.dispatcher.on(event.workers.result, function (result) {
+
+    console.log(result);
+
+  });
+}
+
+// in console log
+FAIL  | 7 passed, 1 failed, 1 skipped   // 2s
+{
+  "tests": {
+  "passed": [
+    {
+      "type": "test",
+      "title": "Assert @C3",
+      "body": "() => { }",
+      "async": 0,
+      "sync": true,
+      "_timeout": 2000,
+      "_slow": 75,
+      "_retries": -1,
+      "timedOut": false,
+      "_currentRetry": 0,
+      "pending": false,
+      "opts": {},
+      "tags": [
+        "@C3"
+      ],
+      "uid": "xe4q1HdqpRrZG5dPe0JG+A",
+      "workerIndex": 3,
+      "retries": -1,
+      "duration": 493,
+      "err": null,
+      "parent": {
+        "title": "My",
+        "ctx": {},
+        "suites": [],
+        "tests": [],
+        "root": false,
+        "pending": false,
+        "_retries": -1,
+        "_beforeEach": [],
+        "_beforeAll": [],
+        "_afterEach": [],
+        "_afterAll": [],
+        "_timeout": 2000,
+        "_slow": 75,
+        "_bail": false,
+        "_onlyTests": [],
+        "_onlySuites": [],
+        "delayed": false
+      },
+      "steps": [
+        {
+          "actor": "I",
+          "name": "amOnPage",
+          "status": "success",
+          "agrs": [
+            "https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST"
+          ],
+          "startedAt": 1698760652610,
+          "startTime": 1698760652611,
+          "endTime": 1698760653098,
+          "finishedAt": 1698760653098,
+          "duration": 488
+        },
+        {
+          "actor": "I",
+          "name": "grabCurrentUrl",
+          "status": "success",
+          "agrs": [],
+          "startedAt": 1698760653098,
+          "startTime": 1698760653098,
+          "endTime": 1698760653099,
+          "finishedAt": 1698760653099,
+          "duration": 1
+        }
+      ]
+    }
+  ],
+    "failed": [],
+    "skipped": []
+}
+}
+```
+
+CodeceptJS also exposes the env var `process.env.RUNS_WITH_WORKERS` when running tests with `run-workers` command so that you could handle the events better in your plugins/helpers
+
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+    // this event would trigger the  `_publishResultsToTestrail` when running `run-workers` command
+  event.dispatcher.on(event.workers.result, async () => {
+    await _publishResultsToTestrail();
+  });
+  
+  // this event would not trigger the  `_publishResultsToTestrail` multiple times when running `run-workers` command
+  event.dispatcher.on(event.all.result, async () => {
+      // when running `run` command, this env var is undefined
+    if (!process.env.RUNS_WITH_WORKERS) await _publishResultsToTestrail();
+  });
+}
+```
 Available events:
 
 * `event.test.before(test)` - *async* when `Before` hooks from helpers and from test is executed
@@ -119,6 +229,7 @@ Available events:
 * `event.all.result` - when results are printed
 * `event.workers.before` - before spawning workers in parallel run
 * `event.workers.after` - after workers finished in parallel run
+* `event.workers.result` - test results after workers finished in parallel run
 
 
 > *sync* - means that event is fired in the moment of the action happening.

package/docs/plugins.md

@@ -65,12 +65,14 @@ If a session expires automatically logs in again.
 ```js
 // inside a test file
 // use login to inject auto-login function
+Feature('Login');
+
 Before(({ login }) => {
    login('user'); // login using user session
 });
 
-// Alternatively log in for one scenario
-Scenario('log me in', ( {I, login} ) => {
+// Alternatively log in for one scenario.
+Scenario('log me in', ( { I, login } ) => {
    login('admin');
    I.see('I am logged in');
 });

package/lib/command/run-multiple.js

@@ -124,7 +124,7 @@ function executeRun(runName, runConfig) {
   if (browserConfig.outputName) {
     outputDir += typeof browserConfig.outputName === 'function' ? browserConfig.outputName() : browserConfig.outputName;
   } else {
-    const hash = crypto.createHash('md5');
+    const hash = crypto.createHash('sha256');
     hash.update(JSON.stringify(browserConfig));
     outputDir += hash.digest('hex');
   }

package/lib/command/run-workers.js

@@ -7,6 +7,11 @@ const Workers = require('../workers');
 module.exports = async function (workerCount, selectedRuns, options) {
   process.env.profile = options.profile;
 
+  const suiteArr = [];
+  const passedTestArr = [];
+  const failedTestArr = [];
+  const skippedTestArr = [];
+
   const { config: testConfig, override = '' } = options;
   const overrideConfigs = tryOrDefault(() => JSON.parse(override), {});
   const by = options.suites ? 'suite' : 'test';
@@ -26,15 +31,36 @@ module.exports = async function (workerCount, selectedRuns, options) {
 
   const workers = new Workers(numberOfWorkers, config);
   workers.overrideConfig(overrideConfigs);
-  workers.on(event.test.failed, (failedTest) => {
-    output.test.failed(failedTest);
+
+  workers.on(event.suite.before, (suite) => {
+    suiteArr.push(suite);
+  });
+
+  workers.on(event.test.failed, (test) => {
+    failedTestArr.push(test);
+    output.test.failed(test);
+  });
+
+  workers.on(event.test.passed, (test) => {
+    passedTestArr.push(test);
+    output.test.passed(test);
   });
 
-  workers.on(event.test.passed, (successTest) => {
-    output.test.passed(successTest);
+  workers.on(event.test.skipped, (test) => {
+    skippedTestArr.push(test);
+    output.test.passed(test);
   });
 
   workers.on(event.all.result, () => {
+    // expose test stats after all workers finished their execution
+    event.dispatcher.emit(event.workers.result, {
+      suites: suiteArr,
+      tests: {
+        passed: passedTestArr,
+        failed: failedTestArr,
+        skipped: skippedTestArr,
+      },
+    });
     workers.printResults();
   });
 

package/lib/command/workers/runTests.js

@@ -132,9 +132,32 @@ function initializeListeners() {
       duration: test.duration || 0,
       err,
       parent,
+      steps: test.steps ? simplifyStepsInTestObject(test.steps, err) : [],
     };
   }
 
+  function simplifyStepsInTestObject(steps, err) {
+    steps = [...steps];
+    const _steps = [];
+
+    for (step of steps) {
+      _steps.push({
+        actor: step.actor,
+        name: step.name,
+        status: step.status,
+        agrs: step.args,
+        startedAt: step.startedAt,
+        startTime: step.startTime,
+        endTime: step.endTime,
+        finishedAt: step.finishedAt,
+        duration: step.duration,
+        err,
+      });
+    }
+
+    return _steps;
+  }
+
   function simplifyStep(step, err = null) {
     step = { ...step };
 

package/lib/event.js

@@ -127,10 +127,12 @@ module.exports = {
    * @inner
    * @property {'workers.before'} before
    * @property {'workers.after'} after
+   * @property {'workers.result'} result
    */
   workers: {
     before: 'workers.before',
     after: 'workers.after',
+    result: 'workers.result',
   },
 
   /**

package/lib/helper/Appium.js

@@ -368,7 +368,7 @@ class Appium extends Webdriver {
       if (context.web) return this.switchToWeb(context.web);
       if (context.webview) return this.switchToWeb(context.webview);
     }
-    return this._switchToContext(context);
+    return this.switchToContext(context);
   }
 
   _withinEnd() {
@@ -423,8 +423,8 @@ class Appium extends Webdriver {
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
     recorder.session.start('iOS-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from iOS session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from iOS session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -465,8 +465,8 @@ class Appium extends Webdriver {
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
     recorder.session.start('Android-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from Android session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from Android session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -834,7 +834,7 @@ class Appium extends Webdriver {
    *
    * @param {*} context the context to switch to
    */
-  async _switchToContext(context) {
+  async switchToContext(context) {
     return this.browser.switchContext(context);
   }
 
@@ -858,11 +858,11 @@ class Appium extends Webdriver {
     this.isWeb = true;
     this.defaultContext = 'body';
 
-    if (context) return this._switchToContext(context);
+    if (context) return this.switchToContext(context);
     const contexts = await this.grabAllContexts();
     this.debugSection('Contexts', contexts.toString());
     for (const idx in contexts) {
-      if (contexts[idx].match(/^WEBVIEW/)) return this._switchToContext(contexts[idx]);
+      if (contexts[idx].match(/^WEBVIEW/)) return this.switchToContext(contexts[idx]);
     }
 
     throw new Error('No WEBVIEW could be guessed, please specify one in params');
@@ -885,8 +885,8 @@ class Appium extends Webdriver {
     this.isWeb = false;
     this.defaultContext = '//*';
 
-    if (context) return this._switchToContext(context);
-    return this._switchToContext('NATIVE_APP');
+    if (context) return this.switchToContext(context);
+    return this.switchToContext('NATIVE_APP');
   }
 
   /**

package/lib/helper/Playwright.js

@@ -94,6 +94,7 @@ const pathSeparator = path.sep;
  * @prop {boolean} [ignoreHTTPSErrors] - Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
  * @prop {boolean} [bypassCSP] - bypass Content Security Policy or CSP
  * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
+ * @prop {object} [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
  */
 const config = {};
 
@@ -141,6 +142,21 @@ const config = {};
  * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
  * * `keepTraceForPassedTests`: - save trace for passed tests
  *
+ * #### HAR Recording Customization
+ *
+ * A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
+ * It contains information about the request and response headers, cookies, content, timings, and more. You can use HAR files to mock network requests in your tests.
+ * HAR will be saved to `output/har`. More info could be found here https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har.
+ *
+ * ```
+ * ...
+ * recordHar: {
+ *     mode: 'minimal', // possible values: 'minimal'|'full'.
+ *     content: 'embed' // possible values:  "omit"|"embed"|"attach".
+ * }
+ * ...
+ *```
+ *
  * #### Example #1: Wait for 0 network connections.
  *
  * ```js
@@ -346,7 +362,7 @@ class Playwright extends Helper {
       ignoreLog: ['warning', 'log'],
       uniqueScreenshotNames: false,
       manualStart: false,
-      getPageTimeout: 0,
+      getPageTimeout: 30000,
       waitForNavigation: 'load',
       restart: false,
       keepCookies: false,
@@ -455,9 +471,10 @@ class Playwright extends Helper {
     }
   }
 
-  async _before() {
+  async _before(test) {
+    this.currentRunningTest = test;
     recorder.retry({
-      retries: 5,
+      retries: process.env.FAILED_STEP_RETRIES || 3,
       when: err => {
         if (!err || typeof (err.message) !== 'string') {
           return false;
@@ -487,6 +504,15 @@ class Playwright extends Helper {
       }
       if (this.options.bypassCSP) contextOptions.bypassCSP = this.options.bypassCSP;
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
+      if (this.options.recordHar) {
+        const harExt = this.options.recordHar.content && this.options.recordHar.content === 'attach' ? 'zip' : 'har';
+        const fileName = `${`${global.output_dir}${path.sep}har${path.sep}${uuidv4()}_${clearString(this.currentRunningTest.title)}`.slice(0, 245)}.${harExt}`;
+        const dir = path.dirname(fileName);
+        if (!fileExists(dir)) fs.mkdirSync(dir);
+        this.options.recordHar.path = fileName;
+        this.currentRunningTest.artifacts.har = fileName;
+        contextOptions.recordHar = this.options.recordHar;
+      }
       if (this.storageState) contextOptions.storageState = this.storageState;
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
       if (this.options.locale) contextOptions.locale = this.options.locale;
@@ -834,6 +860,7 @@ class Playwright extends Helper {
     this.context = null;
     this.frame = null;
     popupStore.clear();
+    if (this.options.recordHar) await this.browserContext.close();
     await this.browser.close();
   }
 
@@ -1089,6 +1116,33 @@ class Playwright extends Helper {
     return this.page.reload({ timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation });
   }
 
+  /**
+   * Replaying from HAR
+   *
+   * ```js
+   *  // Replay API requests from HAR.
+   *  // Either use a matching response from the HAR,
+   *  // or abort the request if nothing matches.
+   *    I.replayFromHar('./output/har/something.har', { url: "*\/**\/api/v1/fruits" });
+   *    I.amOnPage('https://demo.playwright.dev/api-mocking');
+   *    I.see('CodeceptJS');
+   * ```
+   *
+   * @param {string} harFilePath Path to recorded HAR file
+   * @param {object} [opts] [Options for replaying from HAR](https://playwright.dev/docs/api/class-page#page-route-from-har)
+   *
+   * @returns Promise<void>
+   */
+  async replayFromHar(harFilePath, opts) {
+    const file = path.join(global.codecept_dir, harFilePath);
+
+    if (!fileExists(file)) {
+      throw new Error(`File at ${file} cannot be found on local system`);
+    }
+
+    await this.page.routeFromHAR(harFilePath, opts);
+  }
+
   /**
    * {{> scrollPageToTop }}
    */
@@ -1711,8 +1765,15 @@ class Playwright extends Helper {
     const el = els[0];
 
     await highlightActiveElement.call(this, el);
+    let optionToSelect = '';
+
+    try {
+      optionToSelect = await el.locator('option', { hasText: option }).textContent();
+    } catch (e) {
+      optionToSelect = option;
+    }
 
-    if (!Array.isArray(option)) option = [option];
+    if (!Array.isArray(option)) option = [optionToSelect];
 
     await el.selectOption(option);
     return this._waitForAction();
@@ -2062,7 +2123,9 @@ class Playwright extends Helper {
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });
@@ -2262,6 +2325,10 @@ class Playwright extends Helper {
         test.artifacts[`trace_${sessionName}`] = await saveTraceForContext(this.sessionPages[sessionName].context, `${test.title}_${sessionName}.failed`);
       }
     }
+
+    if (this.options.recordHar) {
+      test.artifacts.har = this.currentRunningTest.artifacts.har;
+    }
   }
 
   async _passed(test) {
@@ -2289,6 +2356,10 @@ class Playwright extends Helper {
         await this.browserContext.tracing.stop();
       }
     }
+
+    if (this.options.recordHar) {
+      test.artifacts.har = this.currentRunningTest.artifacts.har;
+    }
   }
 
   /**

package/lib/helper/Puppeteer.js

@@ -297,7 +297,7 @@ class Puppeteer extends Helper {
     this.sessionPages = {};
     this.currentRunningTest = test;
     recorder.retry({
-      retries: 3,
+      retries: process.env.FAILED_STEP_RETRIES || 3,
       when: err => {
         if (!err || typeof (err.message) !== 'string') {
           return false;
@@ -1784,7 +1784,9 @@ class Puppeteer extends Helper {
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });
@@ -1815,7 +1817,9 @@ class Puppeteer extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });

package/lib/helper/WebDriver.js

@@ -1508,7 +1508,9 @@ class WebDriver extends Helper {
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });
@@ -1535,7 +1537,9 @@ class WebDriver extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
+        if (_acutal !== _expected) return false;
       }
       return true;
     });

package/lib/interfaces/gherkin.js

@@ -119,7 +119,14 @@ module.exports = (text, file) => {
             });
           }
           const tags = child.scenario.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
-          const title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
+          let title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
+
+          for (const [key, value] of Object.entries(current)) {
+            if (title.includes(`<${key}>`)) {
+              title = title.replace(JSON.stringify(current), '').replace(`<${key}>`, value);
+            }
+          }
+
           const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
           test.tags = suite.tags.concat(tags);
           test.file = file;

package/lib/interfaces/scenarioConfig.js

@@ -35,6 +35,7 @@ class ScenarioConfig {
    * @returns {this}
    */
   retry(retries) {
+    if (process.env.SCENARIO_ONLY) retries = -retries;
     this.test.retries(retries);
     return this;
   }

package/lib/locator.js

@@ -1,4 +1,4 @@
-const cssToXPath = require('css-to-xpath');
+const cssToXPath = require('convert-cssxpath');
 const { sprintf } = require('sprintf-js');
 
 const { xpathLocator } = require('./utils');
@@ -162,7 +162,7 @@ class Locator {
    */
   toXPath() {
     if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(this.value);
+    if (this.isCSS()) return cssToXPath.convert(this.value);
 
     throw new Error('Can\'t be converted to XPath');
   }

package/lib/plugin/autoLogin.js

@@ -38,12 +38,14 @@ const defaultConfig = {
  * ```js
  * // inside a test file
  * // use login to inject auto-login function
+ * Feature('Login');
+ *
  * Before(({ login }) => {
  *    login('user'); // login using user session
  * });
  *
- * // Alternatively log in for one scenario
- * Scenario('log me in', ( {I, login} ) => {
+ * // Alternatively log in for one scenario.
+ * Scenario('log me in', ( { I, login } ) => {
  *    login('admin');
  *    I.see('I am logged in');
  * });

package/lib/plugin/retryFailedStep.js

@@ -1,5 +1,6 @@
 const event = require('../event');
 const recorder = require('../recorder');
+const container = require('../container');
 
 const defaultConfig = {
   retries: 3,
@@ -98,6 +99,8 @@ module.exports = (config) => {
   config.when = when;
 
   event.dispatcher.on(event.step.started, (step) => {
+    if (container.plugins('tryTo')) return;
+
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return;
@@ -114,6 +117,8 @@ module.exports = (config) => {
 
   event.dispatcher.on(event.test.before, (test) => {
     if (test && test.disableRetryFailedStep) return; // disable retry when a test is not active
+    // this env var is used to set the retries inside _before() block of helpers
+    process.env.FAILED_STEP_RETRIES = config.retries;
     recorder.retry(config);
   });
 };

package/lib/plugin/stepByStepReport.js

@@ -89,8 +89,8 @@ module.exports = function (config) {
   const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output;
 
   event.dispatcher.on(event.test.before, (test) => {
-    const md5hash = crypto.createHash('md5').update(test.file + test.title).digest('hex');
-    dir = path.join(reportDir, `record_${md5hash}`);
+    const sha256hash = crypto.createHash('sha256').update(test.file + test.title).digest('hex');
+    dir = path.join(reportDir, `record_${sha256hash}`);
     mkdirp.sync(dir);
     stepNum = 0;
     error = null;

package/lib/ui.js

@@ -168,6 +168,7 @@ module.exports = function (suite) {
     context.Scenario.only = function (title, opts, fn) {
       const reString = `^${escapeRe(`${suites[0].title}: ${title}`.replace(/( \| {.+})?$/g, ''))}`;
       mocha.grep(new RegExp(reString));
+      process.env.SCENARIO_ONLY = true;
       return addScenario(title, opts, fn);
     };
 

package/lib/workers.js

@@ -359,6 +359,7 @@ class Workers extends EventEmitter {
     this.stats.start = new Date();
     recorder.startUnlessRunning();
     event.dispatcher.emit(event.workers.before);
+    process.env.RUNS_WITH_WORKERS = 'true';
     recorder.add('starting workers', () => {
       for (const worker of this.workers) {
         const workerThread = createWorker(worker);
@@ -492,6 +493,7 @@ class Workers extends EventEmitter {
     }
 
     output.result(this.stats.passes, this.stats.failures, this.stats.pending, ms(this.stats.duration));
+    process.env.RUNS_WITH_WORKERS = 'false';
   }
 }