codeceptjs 2.2.0 → 2.2.1

package/lib/helper/WebDriver.js

@@ -15,7 +15,6 @@ const {
   chunkArray,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
-  fileToBase64Zip,
 } = require('../utils');
 const {
   isColorProperty,
@@ -61,15 +60,15 @@ const webRoot = 'body';
  *
  * Example:
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "smartWait": 5000,
- *        "browser": "chrome",
- *        "restart": false,
- *        "windowSize": "maximize",
- *        "timeouts": {
+ *    helpers: {
+ *      WebDriver : {
+ *        smartWait: 5000,
+ *        browser: "chrome",
+ *        restart: false,
+ *        windowSize: "maximize",
+ *        timeouts: {
  *          "script": 60000,
  *          "page load": 10000
  *        }
@@ -83,15 +82,15 @@ const webRoot = 'body';
  *
  * ### Headless Chrome
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "chrome",
- *        "desiredCapabilities": {
- *          "chromeOptions": {
- *            "args": [ "--headless", "--disable-gpu", "--window-size=800,600" ]
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "chrome",
+ *        desiredCapabilities: {
+ *          chromeOptions: {
+ *            args: [ "--headless", "--disable-gpu", "--window-size=800,600" ]
  *          }
  *        }
  *      }
@@ -103,14 +102,14 @@ const webRoot = 'body';
  *
  * Additional configuration params can be used from [IE options](https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/IE/Options.html)
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "internet explorer",
- *        "desiredCapabilities": {
- *          "ieOptions": {
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "internet explorer",
+ *        desiredCapabilities: {
+ *          ieOptions: {
  *            "ie.browserCommandLineSwitches": "-private",
  *            "ie.usePerProcessProxy": true,
  *            "ie.ensureCleanSession": true,
@@ -123,15 +122,18 @@ const webRoot = 'body';
  *
  * ### Selenoid Options
  *
- * ```json
+ * [Selenoid](https://aerokube.com/selenoid/latest/) is a modern way to run Selenium inside Docker containers.
+ * Selenoid is easy to set up and provides more features than original Selenium Server. Use `selenoidOptions` to set Selenoid capabilities
+ *
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "chrome",
- *        "desiredCapabilities": {
- *          "selenoidOptions": {
- *            "enableVNC": true,
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "chrome",
+ *        desiredCapabilities: {
+ *          selenoidOptions: {
+ *            enableVNC: true,
  *          }
  *        }
  *      }
@@ -139,17 +141,17 @@ const webRoot = 'body';
  * }
  * ```
  *
- * ### Connect through proxy
+ * ### Connect Through proxy
  *
  * CodeceptJS also provides flexible options when you want to execute tests to Selenium servers through proxy. You will
  * need to update the `helpers.WebDriver.capabilities.proxy` key.
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
- *             "capabilities": {
- *                 "proxy": {
+ *     helpers: {
+ *         WebDriver: {
+ *             capabilities: {
+ *                 proxy: {
  *                     "proxyType": "manual|pac",
  *                     "proxyAutoconfigUrl": "URL TO PAC FILE",
  *                     "httpProxy": "PROXY SERVER",
@@ -169,10 +171,10 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
- *             "capabilities": {
- *                 "proxy": {
+ *     helpers: {
+ *         WebDriver: {
+ *             capabilities: {
+ *                 proxy: {
  *                     "proxyType": "manual",
  *                     "httpProxy": "http://corporate.proxy:8080",
  *                     "socksUsername": "codeceptjs",
@@ -199,12 +201,12 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers":{
- *         "WebDriver": {
- *             "url": "YOUR_DESIRED_HOST",
- *             "user": "YOUR_BROWSERSTACK_USER",
- *             "key": "YOUR_BROWSERSTACK_KEY",
- *             "capabilities": {
+ *     helpers:{
+ *         WebDriver: {
+ *             url: "YOUR_DESIRED_HOST",
+ *             user: "YOUR_BROWSERSTACK_USER",
+ *             key: "YOUR_BROWSERSTACK_KEY",
+ *             capabilities: {
  *                 "browserName": "chrome",
  *
  *                 // only set this if you're using BrowserStackLocal to test a local domain
@@ -318,8 +320,8 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
+ *     helpers: {
+ *         WebDriver: {
  *             "multiremote": {
  *                 "MyChrome": {
  *                     "desiredCapabilities": {
@@ -852,12 +854,11 @@ class WebDriver extends Helper {
     assertElementExists(res, locator, 'File field');
     const el = usingFirstElement(res);
 
-    // Remote Uplaod (when running Selenium Server)
+    // Remote Upload (when running Selenium Server)
     if (this.options.remoteFileUpload) {
-      const fileCompressed = await fileToBase64Zip(file);
       try {
         this.debugSection('File', 'Uploading file to remote server');
-        file = await this.browser.uploadFile(fileCompressed);
+        file = await this.browser.uploadFile(file);
       } catch (err) {
         throw new Error(`File can't be transferred to remote server. Set \`remoteFileUpload: false\` in config to upload file locally.\n${err.message}`);
       }

package/lib/helper/testcafe/testcafe-utils.js

@@ -9,7 +9,7 @@ const createTestFile = () => {
   assert(global.output_dir, 'global.output_dir must be set');
 
   const testFile = path.join(global.output_dir, `${Date.now()}_test.js`);
-  const testControllerHolderDir = __dirname;
+  const testControllerHolderDir = __dirname.replace(/\\/g, '/');
 
   fs.writeFileSync(
     testFile,
@@ -28,7 +28,8 @@ const mapError = (testcafeError) => {
   if (testcafeError.errMsg) {
     throw new Error(testcafeError.errMsg);
   }
-  throw new Error(`Unknown TestCafe error ${testcafeError.toString()}`);
+  const errorInfo = `${testcafeError.callsite ? JSON.stringify(testcafeError.callsite) : ''} ${testcafeError.apiFnChain || JSON.stringify(testcafeError)}`;
+  throw new Error(`TestCafe Error: ${errorInfo}`);
 };
 
 

package/lib/interfaces/scenarioConfig.js

@@ -58,13 +58,13 @@ class ScenarioConfig {
    * Configures a helper.
    * Helper name can be omitted and values will be applied to first helper.
    */
-  config(helper, obj) {
+  async config(helper, obj) {
     if (!obj) {
       obj = helper;
       helper = 0;
     }
     if (typeof obj === 'function') {
-      obj = obj(this.test);
+      obj = await obj(this.test);
     }
     if (!this.test.config) {
       this.test.config = {};

package/lib/listener/config.js

@@ -1,7 +1,7 @@
 const event = require('../event');
 const container = require('../container');
 const recorder = require('../recorder');
-const { deepMerge, ucfirst } = require('../utils');
+const { deepMerge, deepClone, ucfirst } = require('../utils');
 const { debug } = require('../output');
 /**
  * Enable Helpers to listen to test events
@@ -17,7 +17,7 @@ module.exports = function () {
       function updateHelperConfig(helper, config) {
         const oldConfig = Object.assign({}, helper.options);
         try {
-          helper._setConfig(deepMerge(Object.assign({}, oldConfig), config));
+          helper._setConfig(deepMerge(deepClone(oldConfig), config));
           debug(`[${ucfirst(type)} Config] ${helper.constructor.name} ${JSON.stringify(config)}`);
         } catch (err) {
           recorder.throw(err);

package/lib/plugin/allure.js

@@ -1,6 +1,7 @@
 const event = require('../event');
 const Allure = require('allure-js-commons');
 const logger = require('../output');
+const ansiRegExp = require('../utils').ansiRegExp;
 
 const defaultConfig = {
   outputDir: global.output_dir,
@@ -193,6 +194,8 @@ module.exports = (config) => {
       currentMetaStep.forEach(() => reporter.endStep('failed'));
       currentMetaStep = [];
     }
+
+    err.message = err.message.replace(ansiRegExp(), '');
     reporter.endCase('failed', err);
   });
 

package/lib/step.js

@@ -154,8 +154,11 @@ function detectMetaStep(stack) {
     if (isTest(line) || isBDD(line)) break;
     const fnName = line.match(/^at (\w+)\.(\w+)\s\(/);
     if (!fnName) continue;
-    if (fnName[1] === 'Generator') return; // don't track meta steps inside generators
-    if (fnName[1] === 'recorder') return; // don't track meta steps inside generators
+    if (fnName[1] === 'Generator'
+      || fnName[1] === 'recorder'
+      || fnName[1] === 'Runner'
+    ) { return; } // don't track meta steps inside generators
+
     if (fnName[1] === 'Object') {
       // detect PO name from includes
       for (const name in support) {

package/lib/ui.js

@@ -138,7 +138,7 @@ module.exports = function (suite) {
      * Pending test case.
      */
     context.xScenario = context.Scenario.skip = function (title) {
-      context.Scenario(title, {});
+      return context.Scenario(title, {});
     };
 
     addDataContext(context);

package/lib/utils.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const getFunctionArguments = require('fn-args');
+const deepClone = require('lodash.clonedeep');
 const { convertColorToRGBA, isColorProperty } = require('./colorUtils');
 
 function isObject(item) {
@@ -26,6 +27,8 @@ function deepMerge(target, source) {
 
 module.exports.deepMerge = deepMerge;
 
+module.exports.deepClone = deepClone;
+
 const isGenerator = module.exports.isGenerator = function (fn) {
   return fn.constructor.name === 'GeneratorFunction';
 };
@@ -281,26 +284,6 @@ module.exports.screenshotOutputFolder = function (fileName) {
   return path.join(global.codecept_dir, fileName);
 };
 
-module.exports.fileToBase64Zip = async function (localPath) {
-  const archiver = require('archiver');
-
-  const zipData = [];
-  const source = fs.createReadStream(localPath);
-
-  return new Promise((resolve, reject) => {
-    archiver('zip')
-      .on('error', (e) => { throw new Error(e); })
-      .on('data', data => zipData.push(data))
-      .on('end', () => resolve(Buffer.concat(zipData).toString('base64')))
-      .append(source, { name: path.basename(localPath) })
-      .finalize((err) => {
-        if (err) {
-          reject(err);
-        }
-      });
-  });
-};
-
 module.exports.beautify = function (code) {
   const format = require('js-beautify').js;
   return format(code, { indent_size: 2, space_in_empty_paren: true });
@@ -322,7 +305,7 @@ function joinUrl(baseUrl, url) {
   return shouldAppendBaseUrl(url) ? `${baseUrl}/${trimUrl(url)}` : url;
 }
 
-module.exports.appendBaseUrl = function (baseUrl, oneOrMoreUrls) {
+module.exports.appendBaseUrl = function (baseUrl = '', oneOrMoreUrls) {
   // Remove '/' if it's at the end of baseUrl
   const lastChar = baseUrl.substr(-1);
   if (lastChar === '/') {
@@ -363,3 +346,12 @@ module.exports.replaceValueDeep = function replaceValueDeep(obj, key, value) {
   }
   return obj;
 };
+
+module.exports.ansiRegExp = function ({ onlyFirst = false } = {}) {
+  const pattern = [
+    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+    '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))',
+  ].join('|');
+
+  return new RegExp(pattern, onlyFirst ? undefined : 'g');
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Modern Era Acceptance Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -37,25 +37,27 @@
     "test": "mocha test/unit --recursive && mocha test/runner --recursive"
   },
   "dependencies": {
+    "@codeceptjs/detox-helper": "^1.0.1",
     "allure-js-commons": "^1.3.2",
     "archiver": "^3.0.0",
     "axios": "^0.19.0",
     "chalk": "^1.1.3",
     "commander": "^2.20.0",
     "css-to-xpath": "^0.1.0",
-    "cucumber-expressions": "^6.0.1",
+    "cucumber-expressions": "^6.6.2",
     "escape-string-regexp": "^1.0.3",
     "figures": "^2.0.0",
     "fn-args": "^4.0.0",
     "fs-extra": "^8.0.1",
     "gherkin": "^5.1.0",
     "glob": "^6.0.1",
-    "inquirer": "^6.3.1",
-    "js-beautify": "^1.9.1",
+    "inquirer": "^6.4.1",
+    "js-beautify": "^1.10.0",
+    "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.1",
     "mkdirp": "^0.5.1",
     "mocha": "^4.1.0",
-    "mocha-junit-reporter": "^1.22.0",
+    "mocha-junit-reporter": "^1.23.0",
     "parse-function": "^5.2.10",
     "promise-retry": "^1.1.1",
     "requireg": "^0.1.8",
@@ -66,31 +68,31 @@
     "@pollyjs/adapter-puppeteer": "^2.5.0",
     "@pollyjs/core": "^2.5.0",
     "@types/inquirer": "^0.0.35",
-    "@types/node": "^8.10.48",
-    "@wdio/sauce-service": "^5.8.0",
-    "@wdio/selenium-standalone-service": "^5.8.0",
-    "@wdio/utils": "^5.8.0",
+    "@types/node": "^8.10.49",
+    "@wdio/sauce-service": "^5.10.8",
+    "@wdio/selenium-standalone-service": "^5.9.3",
+    "@wdio/utils": "^5.9.3",
     "chai": "^3.4.1",
     "chai-as-promised": "^5.2.0",
     "co-mocha": "^1.2",
     "documentation": "^8.1.2",
     "eslint": "^4.17.0",
     "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.17.2",
+    "eslint-plugin-import": "^2.18.0",
     "eslint-plugin-mocha": "^5.3.0",
     "faker": "^4.1.0",
     "husky": "^1.2.1",
     "json-server": "^0.10.1",
     "nightmare": "^3.0.2",
     "protractor": "^5.4.1",
-    "puppeteer": "^1.15.0",
+    "puppeteer": "^1.18.1",
     "rosie": "^1.6.0",
     "sinon": "^1.17.2",
     "sinon-chai": "^2.14.0",
     "testcafe": "^1.2.1",
     "typescript": "^2.9.2",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^5.8.0",
+    "webdriverio": "^5.10.9",
     "xmldom": "^0.1.27",
     "xpath": "0.0.27"
   },