codeceptjs 2.2.0 → 2.2.1

package/lib/command/gherkin/snippets.js

@@ -8,6 +8,7 @@ const { Parser } = require('gherkin');
 const glob = require('glob');
 const fsPath = require('path');
 const fs = require('fs');
+const escapeStringRegexp = require('escape-string-regexp');
 
 const parser = new Parser();
 parser.stopAtFirstError = false;
@@ -30,7 +31,7 @@ module.exports = function (genPath, options) {
     output.error('No gherkin steps defined in config. Exiting');
     process.exit(1);
   }
-  if (!config.gherkin.features) {
+  if (!options.feature && !config.gherkin.features) {
     output.error('No gherkin features defined in config. Exiting');
     process.exit(1);
   }
@@ -40,7 +41,7 @@ module.exports = function (genPath, options) {
   }
 
   const files = [];
-  glob.sync(config.gherkin.features, { cwd: global.codecept_dir }).forEach((file) => {
+  glob.sync(options.feature || config.gherkin.features, { cwd: options.feature ? '.' : global.codecept_dir }).forEach((file) => {
     if (!fsPath.isAbsolute(file)) {
       file = fsPath.join(global.codecept_dir, file);
     }
@@ -62,11 +63,21 @@ module.exports = function (genPath, options) {
       try {
         matchStep(step.text);
       } catch (err) {
-        let stepLine = step.text
-          .replace(/\"(.*?)\"/g, '{string}')
-          .replace(/(\d+\.\d+)/, '{float}')
-          .replace(/ (\d+) /, ' {int} ');
-        stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location });
+        let stepLine;
+        if (/[{}()/]/.test(step.text)) {
+          stepLine = escapeStringRegexp(step.text)
+            .replace(/\//g, '\\/')
+            .replace(/\"(.*?)\"/g, '"(.*?)"')
+            .replace(/(\d+\\\.\d+)/, '(\\d+\\.\\d+)')
+            .replace(/ (\d+) /, ' (\\d+) ');
+          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: true });
+        } else {
+          stepLine = step.text
+            .replace(/\"(.*?)\"/g, '{string}')
+            .replace(/(\d+\.\d+)/, '{float}')
+            .replace(/ (\d+) /, ' {int} ');
+          stepLine = Object.assign(stepLine, { type: step.keyword.trim(), location: step.location, regexp: false });
+        }
         newSteps.push(stepLine);
       }
     }
@@ -99,7 +110,7 @@ module.exports = function (genPath, options) {
     .filter((value, index, self) => self.indexOf(value) === index)
     .map((step) => {
       return `
-${step.type}('${step}', () => {
+${step.type}(${step.regexp ? '/^' : "'"}${step}${step.regexp ? '$/' : "'"}, () => {
   // From "${step.file}" ${JSON.stringify(step.location)}
   throw new Error('Not implemented yet');
 });`;

package/lib/command/init.js

@@ -4,7 +4,8 @@ const fs = require('fs');
 const path = require('path');
 const { fileExists, beautify } = require('../utils');
 const inquirer = require('inquirer');
-const getTestRoot = require('./utils').getTestRoot;
+const { getTestRoot } = require('./utils');
+const generateDefinitions = require('./definitions');
 const isLocal = require('../utils').installedLocally();
 const mkdirp = require('mkdirp');
 const { inspect } = require('util');
@@ -123,7 +124,7 @@ module.exports = function (initPath) {
     // append file mask to the end of tests
     if (!config.tests.match(/\*(.*?)$/)) {
       config.tests = `${config.tests.replace(/\/+$/, '')}/*_test.js`;
-      console.log(`Adding default test mask: ${config.tests}`);
+      console.print(`Adding default test mask: ${config.tests}`);
     }
 
     if (result.translation !== noTranslation) config.translation = result.translation;
@@ -158,42 +159,48 @@ module.exports = function (initPath) {
         }
         fs.writeFileSync(stepFile, defaultActor);
         config.include.I = result.steps_file;
-        success(`Steps file created at ${stepFile}`);
-      }
-
-      const tsconfig = {
-        compilerOption: {
-          allowJs: true,
-        },
-      };
-      const tsconfigJson = beautify(JSON.stringify(tsconfig));
-      const tsconfigFile = path.join(testsPath, 'tsconfig.json');
-      if (fileExists(tsconfigFile)) {
-        print(`tsconfig.json has already exists at ${tsconfigFile}`);
-      } else {
-        fs.writeFileSync(tsconfigFile, tsconfigJson);
-        success(`TypeScript project configuration file created at ${tsconfigFile}`);
+        print(`Steps file created at ${stepFile}`);
       }
 
       fs.writeFileSync(configFile, beautify(`exports.config = ${inspect(config, false, 4, false)}`), 'utf-8');
-      success(`Config created at ${configFile}`);
+      print(`Config created at ${configFile}`);
 
       if (config.output) {
         if (!fileExists(config.output)) {
           mkdirp.sync(path.join(testsPath, config.output));
-          success(`Directory for temporary output files created at '${config.output}'`);
+          print(`Directory for temporary output files created at '${config.output}'`);
         } else {
           print(`Directory for temporary output files is already created at '${config.output}'`);
         }
       }
-      success('Almost done! Create your first test by executing `npx codeceptjs gt` (generate test) command');
+
+
+      const jsconfig = {
+        compilerOption: {
+          allowJs: true,
+        },
+      };
+      const jsconfigJson = beautify(JSON.stringify(jsconfig));
+      const jsconfigFile = path.join(testsPath, 'jsconfig.json');
+      if (fileExists(jsconfigFile)) {
+        print(`jsconfig.json has already exists at ${jsconfigFile}`);
+      } else {
+        fs.writeFileSync(jsconfigFile, jsconfigJson);
+        print(`Intellisense enabled in ${jsconfigFile}`);
+      }
+
+      generateDefinitions(testsPath, {});
+
+      print('');
+      success(' Almost done! Next step:');
+      success(' Create your first test by executing `npx codeceptjs gt` command ');
 
       if (packages) {
         print('\n--');
         if (isLocal) {
-          print(`Please install dependent packages locally: ${colors.bold(`npm install --save-dev ${packages.join(' ')}`)}`);
+          success(`Please install dependent packages locally: ${colors.bold(`npm install --save-dev ${packages.join(' ')}`)}`);
         } else {
-          print(`Please install dependent packages globally: [sudo] ${colors.bold(`npm install -g ${packages.join(' ')}`)}`);
+          success(`Please install dependent packages globally: [sudo] ${colors.bold(`npm install -g ${packages.join(' ')}`)}`);
         }
       }
     };
@@ -208,6 +215,7 @@ module.exports = function (initPath) {
         config.helpers[helperName][configName] = helperResult[key];
       });
 
+      print('');
       finish();
     });
   });

package/lib/command/utils.js

@@ -11,7 +11,7 @@ module.exports.getConfig = function (configFile) {
   try {
     return require('../config').load(configFile);
   } catch (err) {
-    fail(err.message);
+    fail(err.stack);
   }
 };
 

package/lib/container.js

@@ -161,22 +161,22 @@ function createHelpers(config) {
 }
 
 function createSupportObjects(config) {
-  const objects = container.support = new Proxy({}, {
-    get(target, key) {
-      // configured but not in support object, yet: load the module
-      if (key in config && !(key in target)) target[key] = lazyLoad(key);
-      return target[key];
-    },
-  });
+  const objects = {};
+
+  for (const name in config) {
+    objects[name] = {}; // placeholders
+  }
 
   if (!config.I) {
-    container.support.I = require('./actor')();
+    objects.I = require('./actor')();
 
     if (container.translation.I !== 'I') {
-      container.support[container.translation.I] = container.support.I;
+      objects[container.translation.I] = objects.I;
     }
   }
 
+  container.support = objects;
+
   function lazyLoad(name) {
     let newObj = getSupportObject(config, name);
     try {
@@ -190,6 +190,7 @@ function createSupportObjects(config) {
     }
     return newObj;
   }
+
   const asyncWrapper = function (f) {
     return function () {
       return f.apply(this, arguments).catch((e) => {
@@ -209,7 +210,32 @@ function createSupportObjects(config) {
     });
   });
 
-  return objects;
+  return new Proxy({}, {
+    has(target, key) {
+      return key in config;
+    },
+    ownKeys() {
+      return Reflect.ownKeys(config);
+    },
+    get(target, key) {
+      // configured but not in support object, yet: load the module
+      if (key in objects && !(key in target)) {
+        // load default I
+        if (key in objects && !(key in config)) {
+          return target[key] = objects[key];
+        }
+
+        // load new object
+        const object = lazyLoad(key);
+        // check that object is a real object and not an array
+        if (Object.prototype.toString.call(object) === '[object Object]') {
+          return target[key] = Object.assign(objects[key], object);
+        }
+        target[key] = object;
+      }
+      return target[key];
+    },
+  });
 }
 
 function createPlugins(config, options = {}) {

package/lib/data/dataScenarioConfig.js

@@ -61,6 +61,24 @@ class DataScenarioConfig {
     this.scenarios.forEach(scenario => scenario.tag(tagName));
     return this;
   }
+
+  /**
+     * Pass in additional objects to inject into test
+     * @param {*} obj
+     */
+  inject(obj) {
+    this.scenarios.forEach(scenario => scenario.inject(obj));
+    return this;
+  }
+
+  /**
+     * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
+     * @param {*} dependencies
+     */
+  injectDependencies(dependencies) {
+    this.scenarios.forEach(scenario => scenario.injectDependencies(dependencies));
+    return this;
+  }
 }
 
 module.exports = DataScenarioConfig;

package/lib/helper/Nightmare.js

@@ -81,6 +81,9 @@ class Nightmare extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 

package/lib/helper/Polly.js

@@ -58,7 +58,7 @@ class Polly extends Helper {
 
   // Start mocking network requests/responses
   async _startMocking(title = 'Test') {
-    if (!this.helpers && !this.helpers.Puppeteer) {
+    if (!(this.helpers && this.helpers.Puppeteer)) {
       throw new Error('Puppeteer is the only supported helper right now');
     }
     await this._connectPuppeteer(title);
@@ -67,20 +67,21 @@ class Polly extends Helper {
   // Connect Puppeteer helper to mock future requests.
   async _connectPuppeteer(title) {
     const adapter = require('@pollyjs/adapter-puppeteer');
-
     PollyJS.register(adapter);
+
     const { page } = this.helpers.Puppeteer;
+    if (!page) {
+      throw new Error('Looks like, there is no open tab');
+    }
     await page.setRequestInterception(true);
 
     this.polly = new PollyJS(title, {
+      mode: 'passthrough',
       adapters: ['puppeteer'],
       adapterOptions: {
         puppeteer: { page },
       },
     });
-
-    // By default let pass through all network requests
-    if (this.polly) this.polly.server.any().passthrough();
   }
 
   /**
@@ -90,6 +91,7 @@ class Polly extends Helper {
    * I.mockRequest('GET', '/api/users', 200);
    * I.mockRequest('ANY', '/secretsRoutes/*', 403);
    * I.mockRequest('POST', '/secrets', { secrets: 'fakeSecrets' });
+   * I.mockRequest('GET', '/api/users/1', 404, 'User not found');
    * ```
    *
    * Multiple requests
@@ -97,17 +99,27 @@ class Polly extends Helper {
    * ```js
    * I.mockRequest('GET', ['/secrets', '/v2/secrets'], 403);
    * ```
+   * @param {string} method request method. Can be `GET`, `POST`, `PUT`, etc or `ANY`.
+   * @param {string|array} oneOrMoreUrls url(s) to mock. Can be exact URL, a pattern, or an array of URLs.
+   * @param {number|string|object} dataOrStatusCode status code when number provided. A response body otherwise
+   * @param {string|object} additionalData response body when a status code is set by previous parameter.
+   *
    */
-  async mockRequest(method, oneOrMoreUrls, dataOrStatusCode) {
+  async mockRequest(method, oneOrMoreUrls, dataOrStatusCode, additionalData = null) {
     await this._checkAndStartMocking();
+    const puppeteerConfigUrl = this.helpers.Puppeteer && this.helpers.Puppeteer.options.url;
+
     const handler = this._getRouteHandler(
       method,
       oneOrMoreUrls,
-      this.options.url,
+      this.options.url || puppeteerConfigUrl,
     );
 
     if (typeof dataOrStatusCode === 'number') {
       const statusCode = dataOrStatusCode;
+      if (additionalData) {
+        return handler.intercept((_, res) => res.status(statusCode).send(additionalData));
+      }
       return handler.intercept((_, res) => res.sendStatus(statusCode));
     }
     const data = dataOrStatusCode;
@@ -148,16 +160,18 @@ class Polly extends Helper {
    */
   async stopMocking() {
     if (!this._checkIfMockingStarted()) return;
-
     await this._disconnectPuppeteer();
-    await this.polly.flush();
-    await this.polly.stop();
-    this.polly = undefined;
+
+    const { polly } = this;
+    if (!polly) return;
+    await polly.flush();
+    await polly.stop();
+    delete this.polly;
   }
 
   async _disconnectPuppeteer() {
     const { page } = this.helpers.Puppeteer;
-    await page.setRequestInterception(false);
+    if (page) await page.setRequestInterception(false);
   }
 }
 

package/lib/helper/Puppeteer.js

@@ -57,12 +57,13 @@ const consoleLogStore = new Console();
  * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
  * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
  * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
+ * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
  * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
  * * `userAgent`: (optional) user-agent string.
  * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
- * * `browser`: (optional, default: chrome) - can be changed to `firefox` when using [puppeteer-firefox]((https://codecept.io/helpers/Puppeteer-firefox)).
+ * * `browser`: (optional, default: chrome) - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
  * * `chrome`: (optional) pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
  *
  *
@@ -159,6 +160,7 @@ class Puppeteer extends Helper {
       browser: 'chrome',
       waitForAction: 100,
       waitForTimeout: 1000,
+      pressKeyDelay: 10,
       fullPageScreenshots: false,
       disableScreenshots: false,
       uniqueScreenshotNames: false,
@@ -189,6 +191,9 @@ class Puppeteer extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 
@@ -599,7 +604,7 @@ class Puppeteer extends Helper {
    * {{> scrollPageToTop }}
    */
   scrollPageToTop() {
-    return this.page.evaluate(() => {
+    return this.executeScript(() => {
       window.scrollTo(0, 0);
     });
   }
@@ -608,7 +613,7 @@ class Puppeteer extends Helper {
    * {{> scrollPageToBottom }}
    */
   scrollPageToBottom() {
-    return this.page.evaluate(() => {
+    return this.executeScript(() => {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
@@ -627,20 +632,16 @@ class Puppeteer extends Helper {
       offsetX = locator;
       locator = null;
     }
-    let x = 0;
-    let y = 0;
+
     if (locator) {
       const els = await this._locate(locator);
       assertElementExists(els, locator, 'Element');
       await els[0]._scrollIntoViewIfNeeded();
       const elementCoordinates = await els[0]._clickablePoint();
-      x = elementCoordinates.x;
-      y = elementCoordinates.y;
+      await this.executeScript((x, y) => window.scrollBy(x, y), elementCoordinates.x + offsetX, elementCoordinates.y + offsetY);
+    } else {
+      await this.executeScript((x, y) => window.scrollTo(x, y), offsetX, offsetY);
     }
-
-    await this.page.evaluate((x, y) => {
-      window.scrollTo(x, y);
-    }, x + offsetX, y + offsetY);
     return this._waitForAction();
   }
 
@@ -1086,7 +1087,7 @@ class Puppeteer extends Helper {
     } else if (editable) {
       await this._evaluateHandeInContext(el => el.innerHTML = '', el);
     }
-    await el.type(value.toString(), { delay: 10 });
+    await el.type(value.toString(), { delay: this.options.pressKeyDelay });
     return this._waitForAction();
   }
 
@@ -1107,7 +1108,7 @@ class Puppeteer extends Helper {
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     await els[0].press('End');
-    await els[0].type(value, { delay: 10 });
+    await els[0].type(value, { delay: this.options.pressKeyDelay });
     return this._waitForAction();
   }
 

package/lib/helper/TestCafe.js

@@ -124,6 +124,10 @@ class TestCafe extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      { name: 'browser', message: 'Browser to be used', default: 'chrome' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 
@@ -248,7 +252,7 @@ class TestCafe extends Helper {
   async _withinBegin(locator) {
     const els = await this._locate(locator);
     assertElementExists(els, locator);
-    this.context = els.nth(0);
+    this.context = await els.nth(0);
   }
 
   async _withinEnd() {
@@ -636,7 +640,7 @@ class TestCafe extends Helper {
     const el = await els.nth(0);
 
     return this.t
-      .expect(el.value).eql(value)
+      .expect(await el.value).eql(value)
       .catch(mapError);
   }
 
@@ -780,10 +784,76 @@ class TestCafe extends Helper {
     return ClientFunction(() => document.location.href).with({ boundTestRun: this.t })();
   }
 
+  /**
+   * {{> grabPageScrollPosition }}
+   */
+  async grabPageScrollPosition() {
+    return ClientFunction(() => ({ x: window.pageXOffset, y: window.pageYOffset })).with({ boundTestRun: this.t })();
+  }
+
+  /**
+   * {{> scrollPageToTop }}
+   */
+  scrollPageToTop() {
+    return ClientFunction(() => window.scrollTo(0, 0)).with({ boundTestRun: this.t })().catch(mapError);
+  }
+
+  /**
+   * {{> scrollPageToBottom }}
+   */
+  scrollPageToBottom() {
+    return ClientFunction(() => {
+      const body = document.body;
+      const html = document.documentElement;
+      window.scrollTo(0, Math.max(
+        body.scrollHeight, body.offsetHeight,
+        html.clientHeight, html.scrollHeight, html.offsetHeight,
+      ));
+    }).with({ boundTestRun: this.t })().catch(mapError);
+  }
+
+  /**
+   * {{> scrollTo }}
+   */
+  async scrollTo(locator, offsetX = 0, offsetY = 0) {
+    if (typeof locator === 'number' && typeof offsetX === 'number') {
+      offsetY = offsetX;
+      offsetX = locator;
+      locator = null;
+    }
+
+    const scrollBy = ClientFunction((offset) => {
+      if (window && window.scrollBy && offset) {
+        window.scrollBy(offset.x, offset.y);
+      }
+    }).with({ boundTestRun: this.t });
+
+    if (locator) {
+      const els = await this._locate(locator);
+      assertElementExists(els, locator, 'Element');
+      const el = await els.nth(0);
+      const x = (await el.offsetLeft) + offsetX;
+      const y = (await el.offsetTop) + offsetY;
+
+      return scrollBy({ x, y }).catch(mapError);
+    }
+
+    const x = offsetX;
+    const y = offsetY;
+    return scrollBy({ x, y }).catch(mapError);
+  }
+
   /**
    * {{> switchTo }}
    */
   async switchTo(locator) {
+    if (Number.isInteger(locator)) {
+      throw new Error('Not supported switching to iframe by number');
+    }
+
+    if (!locator) {
+      return this.t.switchToMainWindow();
+    }
     return this.t.switchToIframe(findElements.call(this, this.context, locator));
   }