codeceptjs 3.5.4 → 3.5.5

package/lib/command/init.js

@@ -201,7 +201,13 @@ module.exports = function (initPath) {
       // no extra step file for typescript (as it doesn't match TS conventions)
       const stepFile = `./steps_file.${extension}`;
       fs.writeFileSync(path.join(testsPath, stepFile), extension === 'ts' ? defaultActorTs : defaultActor);
-      config.include.I = isTypeScript === true ? './steps_file' : stepFile;
+
+      if (isTypeScript) {
+        config.include = _actorTranslation('./steps_file', config.translation);
+      } else {
+        config.include = _actorTranslation(stepFile, config.translation);
+      }
+
       print(`Steps file created at ${stepFile}`);
 
       let configSource;
@@ -316,7 +322,7 @@ module.exports = function (initPath) {
     };
 
     print('Configure helpers...');
-    inquirer.prompt(helperConfigs).then((helperResult) => {
+    inquirer.prompt(helperConfigs).then(async (helperResult) => {
       if (helperResult.Playwright_browser === 'electron') {
         delete helperResult.Playwright_url;
         delete helperResult.Playwright_show;
@@ -336,12 +342,12 @@ module.exports = function (initPath) {
       });
 
       print('');
-      finish();
+      await finish();
     });
   });
 };
 
-function install(dependencies, verbose) {
+function install(dependencies) {
   let command;
   let args;
 
@@ -374,9 +380,39 @@ function install(dependencies, verbose) {
     ].concat(dependencies);
   }
 
+  if (process.env._INIT_DRY_RUN_INSTALL) {
+    args.push('--dry-run');
+  }
+
   const { status } = spawn.sync(command, args, { stdio: 'inherit' });
   if (status !== 0) {
     throw new Error(`${command} ${args.join(' ')} failed`);
   }
   return true;
 }
+
+function _actorTranslation(stepFile, translationSelected) {
+  let actor;
+
+  for (const translationAvailable of translations) {
+    if (actor) {
+      break;
+    }
+
+    if (translationSelected === translationAvailable) {
+      const nameOfActor = require('../../translations')[translationAvailable].I;
+
+      actor = {
+        [nameOfActor]: stepFile,
+      };
+    }
+  }
+
+  if (!actor) {
+    actor = {
+      I: stepFile,
+    };
+  }
+
+  return actor;
+}

package/lib/command/run-workers.js

@@ -39,6 +39,10 @@ module.exports = async function (workerCount, selectedRuns, options) {
   });
 
   try {
+    if (options.verbose) {
+      const getInfo = require('./info');
+      await getInfo();
+    }
     await workers.bootstrapAll();
     await workers.run();
   } catch (err) {

package/lib/command/run.js

@@ -28,6 +28,12 @@ module.exports = async function (test, options) {
     codecept.init(testRoot);
     await codecept.bootstrap();
     codecept.loadTests(test);
+
+    if (options.verbose) {
+      const getInfo = require('./info');
+      await getInfo();
+    }
+
     await codecept.run();
   } catch (err) {
     printError(err);

package/lib/helper/Appium.js

@@ -117,6 +117,43 @@ const vendorPrefix = {
  * }
  * ```
  *
+ * Example Android App using Appiumv2 on BrowserStack:
+ *
+ * ```js
+ * {
+ * helpers: {
+ *   Appium: {
+ *         appiumV2: true,
+ *         host: "hub-cloud.browserstack.com",
+ *         port: 4444,
+ *         user: process.env.BROWSERSTACK_USER,
+ *         key: process.env.BROWSERSTACK_KEY,
+ *         app: `bs://c700ce60cf1gjhgjh3ae8ed9770ghjg5a55b8e022f13c5827cg`,
+ *         browser: '',
+ *         desiredCapabilities: {
+ *             'appPackage': data.packageName,
+ *             'deviceName': process.env.DEVICE || 'Google Pixel 3',
+ *             'platformName': process.env.PLATFORM || 'android',
+ *             'platformVersion': process.env.OS_VERSION || '10.0',
+ *             'automationName': process.env.ENGINE || 'UIAutomator2',
+ *             'newCommandTimeout': 300000,
+ *             'androidDeviceReadyTimeout': 300000,
+ *             'androidInstallTimeout': 90000,
+ *             'appWaitDuration': 300000,
+ *             'autoGrantPermissions': true,
+ *             'gpsEnabled': true,
+ *             'isHeadless': false,
+ *             'noReset': false,
+ *             'noSign': true,
+ *             'bstack:options' : {
+ *                 "appiumVersion" : "2.0.1",
+ *             },
+ *         }
+ *   }
+ * }
+ * }
+ * ```
+ *
  * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md>
  *
  * ## Access From Helpers
@@ -234,7 +271,9 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        if (key !== 'platformName') {
+          _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        }
       } else {
         _convertedCaps[`${key}`] = value;
       }

package/lib/helper/Playwright.js

@@ -482,6 +482,7 @@ class Playwright extends Helper {
         contextOptions.httpCredentials = this.options.basicAuth;
         this.isAuthenticated = true;
       }
+      if (this.options.bypassCSP) contextOptions.bypassCSP = this.options.bypassCSP;
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
       if (this.storageState) contextOptions.storageState = this.storageState;
       if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
@@ -849,8 +850,8 @@ class Playwright extends Helper {
         await this.switchTo(null);
         return frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve());
       }
-      await this.switchTo(locator);
-      this.withinLocator = new Locator(locator);
+      await this.switchTo(frame);
+      this.withinLocator = new Locator(frame);
       return;
     }
 
@@ -2551,14 +2552,17 @@ class Playwright extends Helper {
 
     // iframe by selector
     const els = await this._locate(locator);
-    // assertElementExists(els, locator);
+    if (!els[0]) {
+      throw new Error(`Element ${JSON.stringify(locator)} was not found by text|CSS|XPath`);
+    }
 
     // get content of the first iframe
-    if ((locator.frame && locator.frame === 'iframe') || locator.toLowerCase() === 'iframe') {
+    locator = new Locator(locator, 'css');
+    if ((locator.frame && locator.frame === 'iframe') || locator.value.toLowerCase() === 'iframe') {
       contentFrame = await this.page.frames()[1];
       // get content of the iframe using its name
-    } else if (locator.toLowerCase().includes('name=')) {
-      const frameName = locator.split('=')[1].replace(/"/g, '').replaceAll(/]/g, '');
+    } else if (locator.value.toLowerCase().includes('name=')) {
+      const frameName = locator.value.split('=')[1].replace(/"/g, '').replaceAll(/]/g, '');
       contentFrame = await this.page.frame(frameName);
     }
 
@@ -2566,7 +2570,7 @@ class Playwright extends Helper {
       this.context = contentFrame;
       this.contextLocator = null;
     } else {
-      this.context = els[0];
+      this.context = this.page.frame(this.page.frames()[1].name());
       this.contextLocator = locator;
     }
   }
@@ -3514,7 +3518,10 @@ async function elementSelected(element) {
 
 function isFrameLocator(locator) {
   locator = new Locator(locator);
-  if (locator.isFrame()) return locator.value;
+  if (locator.isFrame()) {
+    const _locator = new Locator(locator.value);
+    return _locator.value;
+  }
   return false;
 }
 

package/lib/helper/Puppeteer.js

@@ -604,8 +604,8 @@ class Puppeteer extends Helper {
         return this.switchTo(null)
           .then(() => frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve()));
       }
-      await this.switchTo(locator);
-      this.withinLocator = new Locator(locator);
+      await this.switchTo(frame);
+      this.withinLocator = new Locator(frame);
       return;
     }
 
@@ -2011,7 +2011,7 @@ class Puppeteer extends Helper {
     assertElementExists(els, locator);
 
     return this.waitForFunction(isElementClickable, [els[0]], waitTimeout).catch(async (e) => {
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`element ${new Locator(locator).toString()} still not clickable after ${waitTimeout || this.options.waitForTimeout / 1000} sec`);
       } else {
         throw e;
@@ -2115,7 +2115,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed:/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -2139,7 +2139,7 @@ class Puppeteer extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, { timeout: waitTimeout }, urlPart).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
         throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -2348,6 +2348,10 @@ async function findElements(matcher, locator) {
   if (locator.react) return findReact(matcher.executionContext(), locator);
   locator = new Locator(locator, 'css');
   if (!locator.isXPath()) return matcher.$$(locator.simplify());
+  // puppeteer version < 19.4.0 is no longer supported. This one is backward support.
+  if (puppeteer.default?.defaultBrowserRevision) {
+    return matcher.$$(`xpath/${locator.value}`);
+  }
   return matcher.$x(locator.value);
 }
 
@@ -2602,7 +2606,10 @@ async function elementSelected(element) {
 
 function isFrameLocator(locator) {
   locator = new Locator(locator);
-  if (locator.isFrame()) return locator.value;
+  if (locator.isFrame()) {
+    const _locator = new Locator(locator);
+    return _locator.value;
+  }
   return false;
 }
 

package/lib/pause.js

@@ -22,6 +22,7 @@ const aiAssistant = new AiAssistant();
 
 /**
  * Pauses test execution and starts interactive shell
+ * @param {Object<string, *>} [passedObject]
  */
 const pause = function (passedObject = {}) {
   if (store.dryRun) return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.4",
+  "version": "3.5.5",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -59,93 +59,93 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.10.0",
-    "@codeceptjs/helper": "^2.0.1",
-    "@cucumber/cucumber-expressions": "^16",
-    "@cucumber/gherkin": "^26",
-    "@cucumber/messages": "^22.0.0",
-    "@xmldom/xmldom": "^0.8.10",
-    "acorn": "^8.10.0",
-    "arrify": "^2.0.1",
-    "axios": "^1.3.3",
-    "chai": "^4.3.6",
-    "chai-deep-match": "^1.2.1",
-    "chalk": "^4.1.2",
-    "commander": "^11.0.0",
-    "cross-spawn": "^7.0.3",
-    "css-to-xpath": "^0.1.0",
-    "envinfo": "^7.8.1",
-    "escape-string-regexp": "^4.0.0",
-    "figures": "^3.2.0",
-    "fn-args": "^4.0.0",
-    "fs-extra": "^8.1.0",
-    "glob": "^6.0.1",
-    "html-minifier": "^4.0.0",
-    "inquirer": "^6.5.2",
-    "joi": "^17.6.0",
-    "js-beautify": "^1.14.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.merge": "^4.6.2",
-    "mkdirp": "^1.0.4",
-    "mocha": "^10.2.0",
-    "ms": "^2.1.3",
-    "openai": "^3.2.1",
-    "ora-classic": "^5.4.2",
-    "parse-function": "^5.6.4",
-    "parse5": "^7.1.2",
-    "promise-retry": "^1.1.1",
-    "resq": "^1.10.2",
-    "sprintf-js": "^1.1.1",
-    "uuid": "^9.0"
+    "@codeceptjs/configure": "0.10.0",
+    "@codeceptjs/helper": "2.0.1",
+    "@cucumber/cucumber-expressions": "16",
+    "@cucumber/gherkin": "26",
+    "@cucumber/messages": "22.0.0",
+    "@xmldom/xmldom": "0.8.10",
+    "acorn": "8.10.0",
+    "arrify": "2.0.1",
+    "axios": "1.3.3",
+    "chai": "4.3.6",
+    "chai-deep-match": "1.2.1",
+    "chalk": "4.1.2",
+    "commander": "11.0.0",
+    "cross-spawn": "7.0.3",
+    "css-to-xpath": "0.1.0",
+    "envinfo": "7.8.1",
+    "escape-string-regexp": "4.0.0",
+    "figures": "3.2.0",
+    "fn-args": "4.0.0",
+    "fs-extra": "8.1.0",
+    "glob": "6.0.1",
+    "html-minifier": "4.0.0",
+    "inquirer": "6.5.2",
+    "joi": "17.6.0",
+    "js-beautify": "1.14.0",
+    "lodash.clonedeep": "4.5.0",
+    "lodash.merge": "4.6.2",
+    "mkdirp": "1.0.4",
+    "mocha": "10.2.0",
+    "ms": "2.1.3",
+    "openai": "3.2.1",
+    "ora-classic": "5.4.2",
+    "parse-function": "5.6.4",
+    "parse5": "7.1.2",
+    "promise-retry": "1.1.1",
+    "resq": "1.10.2",
+    "sprintf-js": "1.1.1",
+    "uuid": "9.0"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.2",
-    "@codeceptjs/mock-request": "^0.3.1",
-    "@faker-js/faker": "^7.6.0",
-    "@pollyjs/adapter-puppeteer": "^6.0.5",
-    "@pollyjs/core": "^5.1.0",
-    "@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.3.0",
+    "@codeceptjs/detox-helper": "1.0.2",
+    "@codeceptjs/mock-request": "0.3.1",
+    "@faker-js/faker": "7.6.0",
+    "@pollyjs/adapter-puppeteer": "6.0.5",
+    "@pollyjs/core": "5.1.0",
+    "@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.3.0",
     "apollo-server-express": "2.25.3",
-    "chai-as-promised": "^7.1.1",
-    "chai-subset": "^1.6.0",
-    "contributor-faces": "^1.0.3",
-    "documentation": "^12.3.0",
-    "dtslint": "^4.1.6",
-    "electron": "^26.1.0",
-    "eslint": "^8.45.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-mocha": "^6.3.0",
-    "expect": "^29.6.2",
-    "express": "^4.17.2",
-    "graphql": "^14.6.0",
-    "husky": "^8.0.1",
-    "inquirer-test": "^2.0.1",
-    "jsdoc": "^3.6.10",
-    "jsdoc-typeof-plugin": "^1.0.0",
-    "json-server": "^0.10.1",
-    "playwright": "^1.35.1",
-    "puppeteer": "^10.4.0",
-    "qrcode-terminal": "^0.12.0",
-    "rosie": "^2.1.0",
-    "runok": "^0.9.2",
-    "sinon": "^15.2.0",
-    "sinon-chai": "^3.7.0",
-    "testcafe": "^3.0.1",
-    "ts-morph": "^3.1.3",
-    "ts-node": "^10.9.1",
-    "tsd-jsdoc": "^2.5.0",
-    "typedoc": "^0.24.8",
-    "typedoc-plugin-markdown": "^3.13.4",
-    "typescript": "^5.1.6",
-    "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^8.3.8",
-    "xml2js": "^0.6.0",
-    "xmldom": "^0.6.0",
+    "chai-as-promised": "7.1.1",
+    "chai-subset": "1.6.0",
+    "contributor-faces": "1.0.3",
+    "documentation": "12.3.0",
+    "dtslint": "4.1.6",
+    "electron": "26.1.0",
+    "eslint": "8.45.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-mocha": "6.3.0",
+    "expect": "29.6.2",
+    "express": "4.17.2",
+    "graphql": "14.6.0",
+    "husky": "8.0.1",
+    "inquirer-test": "2.0.1",
+    "jsdoc": "3.6.10",
+    "jsdoc-typeof-plugin": "1.0.0",
+    "json-server": "0.10.1",
+    "playwright": "1.35.1",
+    "puppeteer": "21.1.1",
+    "qrcode-terminal": "0.12.0",
+    "rosie": "2.1.0",
+    "runok": "0.9.2",
+    "sinon": "15.2.0",
+    "sinon-chai": "3.7.0",
+    "testcafe": "3.0.1",
+    "ts-morph": "19.0.0",
+    "ts-node": "10.9.1",
+    "tsd-jsdoc": "2.5.0",
+    "typedoc": "0.24.8",
+    "typedoc-plugin-markdown": "3.13.4",
+    "typescript": "5.1.6",
+    "wdio-docker-service": "1.5.0",
+    "webdriverio": "8.3.8",
+    "xml2js": "0.6.0",
+    "xmldom": "0.6.0",
     "xpath": "0.0.33"
   },
   "engines": {

package/typings/promiseBasedTypes.d.ts

@@ -2071,6 +2071,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -2100,6 +2102,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -5564,6 +5568,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -5590,6 +5596,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;
@@ -7314,6 +7322,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -7343,6 +7353,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -8596,6 +8608,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -10076,6 +10090,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          *
          *
@@ -10106,6 +10122,8 @@ declare namespace CodeceptJS {
          * ```
          * @param fn - function to be executed in browser context.
          * @param args - to be passed to function.
+         * @returns script return value
+         *
          * ⚠️ returns a _promise_ which is synchronized internally by recorder
          */
         executeAsyncScript(fn: string | ((...params: any[]) => any), ...args: any[]): Promise<any>;