codeceptjs 3.3.7-beta.1 → 3.3.7

package/lib/command/init.js

@@ -62,6 +62,12 @@ module.exports = function (initPath) {
   print(`  Welcome to ${colors.magenta.bold('CodeceptJS')} initialization tool`);
   print('  It will prepare and configure a test environment for you');
   print();
+  print(' Useful links:');
+  print();
+  print('  👉 How to start testing ASAP: https://codecept.io/quickstart/#init');
+  print('  👉 How to select helper: https://codecept.io/basics/#architecture');
+  print('  👉 TypeScript setup: https://codecept.io/typescript/#getting-started');
+  print();
 
   if (!path) {
     print('No test root specified.');
@@ -105,17 +111,32 @@ module.exports = function (initPath) {
       name: 'helper',
       type: 'list',
       choices: helpers,
+      default: 'Playwright',
       message: 'What helpers do you want to use?',
     },
+    {
+      name: 'jsonResponse',
+      type: 'confirm',
+      default: true,
+      message: 'Do you want to use JSONResponse helper for assertions on JSON responses? http://bit.ly/3ASVPy9',
+      when: (answers) => ['GraphQL', 'REST'].includes(answers.helper) === true,
+    },
     {
       name: 'output',
       default: './output',
       message: 'Where should logs, screenshots, and reports to be stored?',
     },
+    {
+      name: 'promise',
+      type: 'confirm',
+      default: false,
+      message: 'Would you prefer to use promise-based typings for all I.* commands? http://bit.ly/3XIMq6n',
+      when: (answers) => answers.typescript,
+    },
     {
       name: 'translation',
       type: 'list',
-      message: 'Do you want localization for tests? (See https://codecept.io/translation/)',
+      message: 'Do you want to enable localization for tests? http://bit.ly/3GNUBbh',
       choices: translations,
     },
   ]).then((result) => {
@@ -134,6 +155,7 @@ module.exports = function (initPath) {
     config.tests = result.tests;
     if (isTypeScript) {
       config.tests = `${config.tests.replace(/\.js$/, `.${extension}`)}`;
+      config.fullPromiseBased = result.promise;
     }
 
     // create a directory tests if it is included in tests path
@@ -147,6 +169,10 @@ module.exports = function (initPath) {
     const helperName = result.helper;
     config.helpers[helperName] = {};
 
+    if (result.jsonResponse === true) {
+      config.helpers.JSONResponse = {};
+    }
+
     let helperConfigs = [];
 
     try {
@@ -168,12 +194,11 @@ module.exports = function (initPath) {
 
     const finish = async () => {
       // create steps file by default
-      if (!isTypeScript) { // no extra step file for typescript (as it doesn't match TS conventions)
-        const stepFile = `./steps_file.${extension}`;
-        fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
-        config.include.I = stepFile;
-        print(`Steps file created at ${stepFile}`);
-      }
+      // no extra step file for typescript (as it doesn't match TS conventions)
+      const stepFile = `./steps_file.${extension}`;
+      fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
+      config.include.I = isTypeScript === true ? './steps_file' : stepFile;
+      print(`Steps file created at ${stepFile}`);
 
       let configSource;
       const hasConfigure = isLocal && !initPath;

package/lib/command/run.js

@@ -8,7 +8,11 @@ module.exports = async function (test, options) {
   // registering options globally to use in config
   // Backward compatibility for --profile
   process.profile = options.profile;
-  process.env.profile = options.profile;
+
+  if (options.profile) {
+    process.env.profile = options.profile;
+  }
+
   const configFile = options.config;
 
   let config = getConfig(configFile);

package/lib/container.js

@@ -42,7 +42,7 @@ class Container {
     };
     this.createMocha();
     container.helpers = createHelpers(config.helpers || {});
-    container.translation = loadTranslation(config.translation || null);
+    container.translation = loadTranslation(config.translation || null, config.vocabularies || []);
     container.support = createSupportObjects(config.include || {});
     container.plugins = createPlugins(config.plugins || {}, opts);
     if (config.gherkin) loadGherkinSteps(config.gherkin.steps || []);
@@ -406,25 +406,25 @@ function getObjectMethods(obj) {
   return methods;
 }
 
-function loadTranslation(translation) {
-  if (!translation) {
-    return new Translation({
-      I: 'I',
-      actions: {},
-    }, false);
+function loadTranslation(locale, vocabularies) {
+  if (!locale) {
+    return Translation.createEmpty();
   }
 
-  let vocabulary;
+  let translation;
+
   // check if it is a known translation
-  if (require('../translations')[translation]) {
-    vocabulary = require('../translations')[translation];
-    return new Translation(vocabulary);
-  } if (fileExists(path.join(global.codecept_dir, translation))) {
+  if (Translation.langs[locale]) {
+    translation = new Translation(Translation.langs[locale]);
+  } else if (fileExists(path.join(global.codecept_dir, locale))) {
     // get from a provided file instead
-    vocabulary = require(path.join(global.codecept_dir, translation));
+    translation = Translation.createDefault();
+    translation.loadVocabulary(locale);
   } else {
-    throw new Error(`Translation option is set in config, but ${translation} is not a translated locale or filename`);
+    translation = Translation.createDefault();
   }
 
-  return new Translation(vocabulary);
+  vocabularies.forEach(v => translation.loadVocabulary(v));
+
+  return translation;
 }

package/lib/helper/Appium.js

@@ -2,7 +2,7 @@ let webdriverio;
 let wdioV4;
 
 const fs = require('fs');
-const axios = require('axios');
+const axios = require('axios').default;
 
 const Webdriver = require('./WebDriver');
 const AssertionFailedError = require('../assert/error');
@@ -13,6 +13,10 @@ const ConnectionRefused = require('./errors/ConnectionRefused');
 
 const mobileRoot = '//*';
 const webRoot = 'body';
+const supportedPlatform = {
+  android: 'Android',
+  iOS: 'iOS',
+};
 
 /**
  *  Appium helper extends [Webriver](http://codecept.io/helpers/WebDriver/) helper.
@@ -131,6 +135,7 @@ class Appium extends Webdriver {
     super(config);
 
     this.isRunning = false;
+    this.axios = axios.create();
 
     webdriverio = require('webdriverio');
     (!webdriverio.VERSION || webdriverio.VERSION.indexOf('4') !== 0) ? wdioV4 = false : wdioV4 = true;
@@ -185,7 +190,7 @@ class Appium extends Webdriver {
     config.capabilities.app = config.app || config.capabilities.app;
     config.capabilities.platformName = config.platform || config.capabilities.platformName;
     config.capabilities.tunnelIdentifier = config.tunnelIdentifier || config.capabilities.tunnelIdentifier; // Adding the code to connect to sauce labs via sauce tunnel
-    config.waitForTimeout /= 1000; // convert to seconds
+    config.waitForTimeoutInSeconds = config.waitForTimeout / 1000; // convert to seconds
 
     // [CodeceptJS compatible] transform host to hostname
     config.hostname = config.host || config.hostname;
@@ -215,8 +220,8 @@ class Appium extends Webdriver {
       name: 'platform',
       message: 'Mobile Platform',
       type: 'list',
-      choices: ['iOS', 'Android'],
-      default: 'Android',
+      choices: ['iOS', supportedPlatform.android],
+      default: supportedPlatform.android,
     }, {
       name: 'device',
       message: 'Device to run tests on',
@@ -427,6 +432,23 @@ class Appium extends Webdriver {
     fn();
   }
 
+  /**
+   * Returns app installation status.
+   *
+   * ```js
+   * I.checkIfAppIsInstalled("com.example.android.apis");
+   * ```
+   *
+   * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<boolean>}
+   *
+   * Appium: support only Android
+   */
+  async checkIfAppIsInstalled(bundleId) {
+    onlyForApps.call(this, supportedPlatform.android);
+    return this.browser.isAppInstalled(bundleId);
+  }
+
   /**
    * Check if an app is installed.
    *
@@ -440,7 +462,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async seeAppIsInstalled(bundleId) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.isAppInstalled(bundleId);
     return truth(`app ${bundleId}`, 'to be installed').assert(res);
   }
@@ -458,7 +480,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async seeAppIsNotInstalled(bundleId) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.isAppInstalled(bundleId);
     return truth(`app ${bundleId}`, 'to be installed').negate(res);
   }
@@ -475,7 +497,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async installApp(path) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     return this.browser.installApp(path);
   }
 
@@ -492,19 +514,35 @@ class Appium extends Webdriver {
    * @param {string} [bundleId] ID of bundle
    */
   async removeApp(appId, bundleId) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
 
     if (wdioV4) {
       return this.browser.removeApp(bundleId);
     }
 
-    return axios({
+    return this.axios({
       method: 'post',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/device/remove_app`,
       data: { appId, bundleId },
     });
   }
 
+  /**
+   * Reset the currently running app for current session.
+   *
+   * ```js
+   * I.resetApp();
+   * ```
+   *
+   */
+  async resetApp() {
+    onlyForApps.call(this);
+    return this.axios({
+      method: 'post',
+      url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/app/reset`,
+    });
+  }
+
   /**
    * Check current activity on an Android device.
    *
@@ -517,7 +555,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async seeCurrentActivityIs(currentActivity) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.getCurrentActivity();
     return truth('current activity', `to be ${currentActivity}`).assert(res === currentActivity);
   }
@@ -534,7 +572,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async seeDeviceIsLocked() {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.isLocked();
     return truth('device', 'to be locked').assert(res);
   }
@@ -551,7 +589,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async seeDeviceIsUnlocked() {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.isLocked();
     return truth('device', 'to be locked').negate(res);
   }
@@ -579,7 +617,7 @@ class Appium extends Webdriver {
       currentOrientation = res;
     }
 
-    const res = await axios({
+    const res = await this.axios({
       method: 'get',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
     });
@@ -606,7 +644,7 @@ class Appium extends Webdriver {
       return this.browser.setOrientation(orientation);
     }
 
-    return axios({
+    return this.axios({
       method: 'post',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
       data: { orientation },
@@ -657,7 +695,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async grabCurrentActivity() {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     return this.browser.getCurrentActivity();
   }
 
@@ -675,7 +713,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async grabNetworkConnection() {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     const res = await this.browser.getNetworkConnection();
     return {
       value: res,
@@ -795,7 +833,7 @@ class Appium extends Webdriver {
    * @return {Promise<void>}
    */
   async startActivity(appPackage, appActivity) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     return this.browser.startActivity(appPackage, appActivity);
   }
 
@@ -820,7 +858,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async setNetworkConnection(value) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     return this.browser.setNetworkConnection(value);
   }
 
@@ -877,7 +915,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async sendDeviceKeyEvent(keyValue) {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     if (wdioV4) {
       return this.browser.sendKeyEvent(keyValue);
     }
@@ -896,7 +934,7 @@ class Appium extends Webdriver {
    * Appium: support only Android
    */
   async openNotifications() {
-    onlyForApps.call(this, 'Android');
+    onlyForApps.call(this, supportedPlatform.android);
     return this.browser.openNotifications();
   }
 
@@ -965,7 +1003,7 @@ class Appium extends Webdriver {
     onlyForApps.call(this);
     const res = await this.browser.$(parseLocator.call(this, locator));
     // if (!res.length) throw new ElementNotFound(locator, 'was not found in UI');
-    return this.performSwipe(await res.getLocation(), { x: await res.getLocation().x + xoffset, y: await res.getLocation().y + yoffset });
+    return this.performSwipe(await res.getLocation(), { x: (await res.getLocation()).x + xoffset, y: (await res.getLocation()).y + yoffset });
   }
   /* eslint-enable */
 
@@ -1148,7 +1186,7 @@ class Appium extends Webdriver {
         direction = 'swipeRight';
         break;
     }
-    timeout = timeout || this.options.waitForTimeout;
+    timeout = timeout || this.options.waitForTimeoutInSeconds;
 
     const errorMsg = `element ("${searchableLocator}") still not visible after ${timeout}seconds`;
     const browser = this.browser;

package/lib/helper/GraphQL.js

@@ -139,9 +139,9 @@ class GraphQL extends Helper {
    * ```
    *
    * @param {String} query
-   * @param {object} variables that may go along with the query
-   * @param {object} options are additional query options
-   * @param {object} headers
+   * @param {object} [variables] that may go along with the query
+   * @param {object} [options] are additional query options
+   * @param {object} [headers]
    * @return Promise<any>
    */
   async sendQuery(query, variables, options = {}, headers = {}) {
@@ -179,9 +179,9 @@ class GraphQL extends Helper {
    * ```
    *
    * @param {String} mutation
-   * @param {object} variables that may go along with the mutation
-   * @param {object} options are additional query options
-   * @param {object} headers
+   * @param {object} [variables] that may go along with the mutation
+   * @param {object} [options] are additional query options
+   * @param {object} [headers]
    * @return Promise<any>
    */
   async sendMutation(mutation, variables, options = {}, headers = {}) {

package/lib/helper/Nightmare.js

@@ -128,7 +128,7 @@ class Nightmare extends Helper {
       this.evaluate_now((by, locator, contextEl) => {
         const res = window.codeceptjs.findAndStoreElement(by, locator, contextEl);
         if (res === null) {
-          throw new Error(`Element ${locator} couldn't be located by ${by}`);
+          throw new Error(`Element ${(new Locator(locator))} couldn't be located by ${by}`);
         }
         return res;
       }, done, by, value, contextEl);
@@ -554,7 +554,7 @@ class Nightmare extends Helper {
    */
   async seeNumberOfElements(locator, num) {
     const elements = await this._locate(locator);
-    return equals(`expected number of elements (${locator}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
+    return equals(`expected number of elements (${(new Locator(locator))}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
   }
 
   /**
@@ -562,7 +562,7 @@ class Nightmare extends Helper {
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
-    return equals(`expected number of visible elements (${locator}) is ${num}, but found ${res}`).assert(res, num);
+    return equals(`expected number of visible elements (${(new Locator(locator))}) is ${num}, but found ${res}`).assert(res, num);
   }
 
   /**
@@ -1168,7 +1168,7 @@ class Nightmare extends Helper {
       height: Math.floor(rect.height),
     };
 
-    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    this.debug(`Screenshot of ${(new Locator(locator))} element has been saved to ${outputFile}`);
     // take the screenshot
     await this.browser.screenshot(outputFile, button_clip);
   }