codeceptjs 3.5.6 → 3.5.7

package/lib/helper/Puppeteer.js

@@ -4,6 +4,7 @@ const fsExtra = require('fs-extra');
 const path = require('path');
 
 const Helper = require('@codeceptjs/helper');
+const { v4: uuidv4 } = require('uuid');
 const Locator = require('../locator');
 const recorder = require('../recorder');
 const store = require('../store');
@@ -19,6 +20,7 @@ const {
   fileExists,
   chunkArray,
   toCamelCase,
+  clearString,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
   getNormalizedKeyAttributeValue,
@@ -57,6 +59,8 @@ const consoleLogStore = new Console();
  * @prop {boolean} [disableScreenshots=false]  - don't save screenshot on failure.
  * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
  * @prop {boolean} [uniqueScreenshotNames=false]  - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [trace=false] - record [tracing information](https://pptr.dev/api/puppeteer.tracing) with screenshots.
+ * @prop {boolean} [keepTraceForPassedTests=false] - save trace for passed tests.
  * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to false.
  * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` is set to false.
  * @prop {number} [waitForAction=100] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
@@ -92,6 +96,14 @@ const config = {};
  *
  * <!-- configuration -->
  *
+ * #### Trace Recording Customization
+ *
+ * Trace recording provides complete information on test execution and includes screenshots, and network requests logged during run.
+ * Traces will be saved to `output/trace`
+ *
+ * * `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
+ * * `keepTraceForPassedTests`: - save trace for passed tests
+ *
  * #### Example #1: Wait for 0 network connections.
  *
  * ```js
@@ -281,8 +293,9 @@ class Puppeteer extends Helper {
     }
   }
 
-  async _before() {
+  async _before(test) {
     this.sessionPages = {};
+    this.currentRunningTest = test;
     recorder.retry({
       retries: 3,
       when: err => {
@@ -647,6 +660,14 @@ class Puppeteer extends Helper {
       }
     }
 
+    if (this.options.trace) {
+      const fileName = `${`${global.output_dir}${path.sep}trace${path.sep}${uuidv4()}_${clearString(this.currentRunningTest.title)}`.slice(0, 245)}.json`;
+      const dir = path.dirname(fileName);
+      if (!fileExists(dir)) fs.mkdirSync(dir);
+      await this.page.tracing.start({ screenshots: true, path: fileName });
+      this.currentRunningTest.artifacts.trace = fileName;
+    }
+
     await this.page.goto(url, { waitUntil: this.options.waitForNavigation });
 
     const performanceTiming = JSON.parse(await this.page.evaluate(() => JSON.stringify(window.performance.timing)));
@@ -682,14 +703,14 @@ class Puppeteer extends Helper {
    * Set headers for all next requests
    *
    * ```js
-   * I.haveRequestHeaders({
+   * I.setPuppeteerRequestHeaders({
    *    'X-Sent-By': 'CodeceptJS',
    * });
    * ```
    *
    * @param {object} customHeaders headers to set
    */
-  async haveRequestHeaders(customHeaders) {
+  async setPuppeteerRequestHeaders(customHeaders) {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
@@ -1898,8 +1919,30 @@ class Puppeteer extends Helper {
     }
   }
 
-  async _failed() {
+  async _failed(test) {
+    await this._withinEnd();
+
+    if (this.options.trace) {
+      await this.page.tracing.stop();
+      const _traceName = this.currentRunningTest.artifacts.trace.replace('.json', '.failed.json');
+      fs.renameSync(this.currentRunningTest.artifacts.trace, _traceName);
+      test.artifacts.trace = _traceName;
+    }
+  }
+
+  async _passed(test) {
     await this._withinEnd();
+
+    if (this.options.trace) {
+      await this.page.tracing.stop();
+      if (this.options.keepTraceForPassedTests) {
+        const _traceName = this.currentRunningTest.artifacts.trace.replace('.json', '.passed.json');
+        fs.renameSync(this.currentRunningTest.artifacts.trace, _traceName);
+        test.artifacts.trace = _traceName;
+      } else {
+        fs.unlinkSync(this.currentRunningTest.artifacts.trace);
+      }
+    }
   }
 
   /**

package/lib/interfaces/gherkin.js

@@ -18,6 +18,11 @@ parser.stopAtFirstError = false;
 
 module.exports = (text, file) => {
   const ast = parser.parse(text);
+  let currentLanguage;
+
+  if (ast.feature) {
+    currentLanguage = getTranslation(ast.feature.language);
+  }
 
   if (!ast.feature) {
     throw new Error(`No 'Features' available in Gherkin '${file}' provided!`);
@@ -96,7 +101,7 @@ module.exports = (text, file) => {
       suite.beforeEach('Before', scenario.injected(async () => runSteps(child.background.steps), suite, 'before'));
       continue;
     }
-    if (child.scenario && child.scenario.keyword === 'Scenario Outline') {
+    if (child.scenario && (currentLanguage ? child.scenario.keyword === currentLanguage.contexts.ScenarioOutline : child.scenario.keyword === 'Scenario Outline')) {
       for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value);
         for (const example of examples.tableBody) {
@@ -141,7 +146,7 @@ function transformTable(table) {
   let str = '';
   for (const id in table.rows) {
     const cells = table.rows[id].cells;
-    str += cells.map(c => c.value).map(c => c.slice(0, 15).padEnd(15)).join(' | ');
+    str += cells.map(c => c.value).map(c => c.padEnd(15)).join(' | ');
     str += '\n';
   }
   return str;
@@ -162,3 +167,17 @@ function addExampleInTable(exampleSteps, placeholders) {
   }
   return steps;
 }
+
+function getTranslation(language) {
+  const translations = Object.keys(require('../../translations'));
+
+  for (const availableTranslation of translations) {
+    if (!language) {
+      break;
+    }
+
+    if (availableTranslation.includes(language)) {
+      return require('../../translations')[availableTranslation];
+    }
+  }
+}

package/lib/output.js

@@ -106,7 +106,7 @@ module.exports = {
     if (!step) return;
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
-      if (step.hasBDDAncestor()) {
+      if (typeof step === 'object' && step.hasBDDAncestor()) {
         return;
       }
     }

package/lib/plugin/autoLogin.js

@@ -9,6 +9,7 @@ const isAsyncFunction = require('../utils').isAsyncFunction;
 
 const defaultUser = {
   fetch: I => I.grabCookie(),
+  check: () => {},
   restore: (I, cookies) => {
     I.amOnPage('/'); // open a page
     I.setCookie(cookies);
@@ -61,7 +62,7 @@ const defaultConfig = {
  * #### How It Works
  *
  * 1. `restore` method is executed. It should open a page and set credentials.
- * 2. `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged in user.
+ * 2. `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args `session`, you could perform the validation using passed session.
  * 3. If `restore` and `check` were not successful, `login` is executed
  * 4. `login` should fill in login form
  * 5. After successful login, `fetch` is executed to save cookies into memory or file.
@@ -212,6 +213,38 @@ const defaultConfig = {
  * })
  * ```
  *
+ * #### Tips: Using session to validate user
+ *
+ * Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch`
+ *
+ * ```js
+ * autoLogin: {
+ *   enabled: true,
+ *   saveToFile: true,
+ *   inject: 'login',
+ *   users: {
+ *     admin: {
+ *       login: async (I) => {  // If you use async function in the autoLogin plugin
+ *          const phrase = await I.grabTextFrom('#phrase')
+ *          I.fillField('username', 'admin'),
+ *          I.fillField('password', 'password')
+ *          I.fillField('phrase', phrase)
+ *       },
+ *       check: (I, session) => {
+ *          // Throwing an error in `check` will make CodeceptJS perform the login step for the user
+ *          if (session.profile.email !== the.email.you.expect@some-mail.com) {
+ *               throw new Error ('Wrong user signed in');
+ *         }
+ *       },
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ```js
+ * Scenario('login', async ( {I, login} ) => {
+ *   await login('admin') // you should use `await`
+ * })
  *
  *
 */
@@ -251,7 +284,12 @@ module.exports = function (config) {
       } else {
         userSession.login(I);
       }
+
       const cookies = await userSession.fetch(I);
+      if (!cookies) {
+        debug('Cannot save user session with empty cookies from auto login\'s fetch method');
+        return;
+      }
       if (config.saveToFile) {
         debug(`Saved user session into file for ${name}`);
         fs.writeFileSync(path.join(global.output_dir, `${name}_session.json`), JSON.stringify(cookies));
@@ -264,10 +302,10 @@ module.exports = function (config) {
     recorder.session.start('check login');
     if (shouldAwait) {
       await userSession.restore(I, cookies);
-      await userSession.check(I);
+      await userSession.check(I, cookies);
     } else {
       userSession.restore(I, cookies);
-      userSession.check(I);
+      userSession.check(I, cookies);
     }
     recorder.session.catch((err) => {
       debug(`Failed auto login for ${name} due to ${err}`);

package/lib/utils.js

@@ -11,7 +11,7 @@ function deepMerge(target, source) {
 }
 
 module.exports.genTestId = (test) => {
-  return require('crypto').createHash('md5').update(test.fullTitle()).digest('base64')
+  return require('crypto').createHash('sha256').update(test.fullTitle()).digest('base64')
     .slice(0, -2);
 };
 

package/lib/workers.js

@@ -94,10 +94,31 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
     });
   }
   const workersToExecute = [];
+
+  const currentOutputFolder = config.output;
+  let currentMochawesomeReportDir;
+  let currentMochaJunitReporterFile;
+
+  if (config.mocha && config.mocha.reporterOptions) {
+    currentMochawesomeReportDir = config.mocha.reporterOptions?.mochawesome.options.reportDir;
+    currentMochaJunitReporterFile = config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile;
+  }
+
   collection.createRuns(selectedRuns, config).forEach((worker) => {
-    const workerName = worker.getOriginalName() || worker.getName();
+    const separator = path.sep;
+    const _config = { ...config };
+    let workerName = worker.name.replace(':', '_');
+    _config.output = `${currentOutputFolder}${separator}${workerName}`;
+    if (config.mocha && config.mocha.reporterOptions) {
+      _config.mocha.reporterOptions.mochawesome.options.reportDir = `${currentMochawesomeReportDir}${separator}${workerName}`;
+
+      const _tempArray = currentMochaJunitReporterFile.split(separator);
+      _tempArray.splice(_tempArray.findIndex(item => item.includes('.xml')), 0, workerName);
+      _config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile = _tempArray.join(separator);
+    }
+    workerName = worker.getOriginalName() || worker.getName();
     const workerConfig = worker.getConfig();
-    workersToExecute.push(getOverridenConfig(workerName, workerConfig, config));
+    workersToExecute.push(getOverridenConfig(workerName, workerConfig, _config));
   });
   const workers = [];
   let index = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.6",
+  "version": "3.5.7",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -43,14 +43,17 @@
     "test:unit": "mocha test/unit --recursive --timeout 10000",
     "test:runner": "mocha test/runner --recursive --timeout 10000",
     "test": "npm run test:unit && npm run test:runner",
-    "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
-    "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
+    "test:appium-quick": "mocha test/helper/AppiumV2_test.js --grep 'quick'",
+    "test:appium-other": "mocha test/helper/AppiumV2_test.js --grep 'second'",
+    "test:ios:appium-quick": "mocha test/helper/AppiumV2_ios_test.js --grep 'quick'",
+    "test:ios:appium-other": "mocha test/helper/AppiumV2_ios_test.js --grep 'second'",
     "test-app:start": "php -S 127.0.0.1:8000 -t test/data/app",
     "test-app:stop": "kill -9 $(lsof -t -i:8000)",
     "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
     "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
     "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
+    "test:unit:expect": "mocha test/helper/Expect_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
     "publish:site": "./runok.js publish:site",
@@ -70,6 +73,11 @@
     "axios": "1.3.3",
     "chai": "4.3.8",
     "chai-deep-match": "1.2.1",
+    "chai-exclude": "^2.1.0",
+    "chai-json-schema": "^1.5.1",
+    "chai-json-schema-ajv": "^5.2.4",
+    "chai-match-pattern": "^1.3.0",
+    "chai-string": "^1.5.0",
     "chalk": "4.1.2",
     "commander": "11.0.0",
     "cross-spawn": "7.0.3",
@@ -82,7 +90,7 @@
     "glob": "6.0.1",
     "html-minifier": "4.0.0",
     "inquirer": "6.5.2",
-    "joi": "17.6.0",
+    "joi": "17.11.0",
     "js-beautify": "1.14.9",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -104,21 +112,22 @@
     "@faker-js/faker": "7.6.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
+    "@types/chai": "^4.3.7",
     "@types/inquirer": "9.0.3",
     "@types/node": "20.4.4",
     "@wdio/sauce-service": "8.3.8",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.16.22",
+    "@wdio/utils": "8.20.3",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
     "chai-subset": "1.6.0",
-    "contributor-faces": "1.0.3",
+    "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
     "dtslint": "4.1.6",
-    "electron": "26.1.0",
-    "eslint": "8.50.0",
+    "electron": "27.0.2",
+    "eslint": "8.53.0",
     "eslint-config-airbnb-base": "15.0.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.29.0",
     "eslint-plugin-mocha": "6.3.0",
     "expect": "29.7.0",
     "express": "4.17.2",
@@ -128,23 +137,23 @@
     "jsdoc": "3.6.10",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.38.1",
+    "playwright": "1.39.0",
     "puppeteer": "21.1.1",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.0",
     "runok": "0.9.3",
-    "sinon": "15.2.0",
+    "sinon": "17.0.1",
     "sinon-chai": "3.7.0",
-    "testcafe": "3.0.1",
+    "testcafe": "3.3.0",
     "ts-morph": "19.0.0",
     "ts-node": "10.9.1",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.24.8",
+    "typedoc": "0.25.3",
     "typedoc-plugin-markdown": "3.13.4",
-    "typescript": "5.1.6",
+    "typescript": "5.2.2",
     "wdio-docker-service": "1.5.0",
     "webdriverio": "8.3.8",
-    "xml2js": "0.6.0",
+    "xml2js": "0.6.2",
     "xmldom": "0.6.0",
     "xpath": "0.0.33"
   },
@@ -153,4 +162,4 @@
     "npm": ">=5.6.0"
   },
   "es6": true
-}
+}

package/translations/de-DE.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ich',
+  contexts: {
+    Feature: 'Funktionalität',
+    Scenario: 'Szenario',
+    ScenarioOutline: 'Szenariogrundriss',
+  },
   actions: {
     amOutsideAngularApp: 'befinde_mich_außerhalb_der_angular_app',
     amInsideAngularApp: 'bedinde_mich_innerhalb_der_angular_app',

package/translations/fr-FR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Fonctionnalité',
     Scenario: 'Scénario',
+    ScenarioOutline: 'Plan du scénario',
     Before: 'Avant',
     After: 'Après',
     BeforeSuite: 'AvantLaSuite',

package/translations/it-IT.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Caratteristica',
     Scenario: 'lo_scenario',
+    ScenarioOutline: 'Schema dello scenario',
     Before: 'Prima',
     After: 'Dopo',
     BeforeSuite: 'Prima_della_suite',

package/translations/ja-JP.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '私は',
+  contexts: {
+    Feature: 'フィーチャ',
+    Scenario: 'シナリオ',
+    ScenarioOutline: 'シナリオアウトライン',
+  },
   actions: {
     amOutsideAngularApp: 'Angularの外に出る',
     amInsideAngularApp: 'Angularの中に入る',

package/translations/pl-PL.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ja',
+  contexts: {
+    Feature: 'Funkcja',
+    Scenario: 'Scenariusz',
+    ScenarioOutline: 'Szablon scenariusza',
+  },
   actions: {
     amOutsideAngularApp: 'jestem_poza_aplikacją_angular',
     amInsideAngularApp: 'jestem_w_aplikacji_angular',

package/translations/pt-BR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Funcionalidade',
     Scenario: 'Cenário',
+    ScenarioOutline: 'Esquema do Cenário',
     Before: 'Antes',
     After: 'Depois',
     BeforeSuite: 'AntesDaSuite',

package/translations/ru-RU.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Цель',
     Scenario: 'Сценарий',
+    ScenarioOutline: 'Структура сценария',
     Before: 'Начало',
     After: 'Конец',
     BeforeSuite: 'Перед_всем',

package/translations/zh-CN.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '场景',
+    ScenarioOutline: '场景大纲',
+  },
   actions: {
     amOutsideAngularApp: '在Angular应用外',
     amInsideAngularApp: '在Angular应用内',

package/translations/zh-TW.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '場景',
+    ScenarioOutline: '場景大綱',
+  },
   actions: {
     amOutsideAngularApp: '在Angular應用外',
     amInsideAngularApp: '在Angular應用內',