codeceptjs 3.2.0 → 3.3.0-beta.1

package/lib/helper/Appium.js

@@ -331,6 +331,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
@@ -373,6 +374,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
@@ -393,6 +395,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {*} fn
+   * @return {Promise<any>}
    */
   /* eslint-disable */
   async runInWeb(fn) {
@@ -434,6 +437,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -451,6 +455,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -467,6 +472,7 @@ class Appium extends Webdriver {
    * I.installApp('/path/to/file.apk');
    * ```
    * @param {string} path path to apk file
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -508,6 +514,7 @@ class Appium extends Webdriver {
    * I.seeCurrentActivityIs(".HomeScreenActivity")
    * ```
    * @param {string} currentActivity
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -524,6 +531,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsLocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsLocked() {
@@ -539,6 +548,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsUnlocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsUnlocked() {
@@ -555,6 +566,8 @@ class Appium extends Webdriver {
    * I.seeOrientationIs('LANDSCAPE')
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
    *
    * Appium: support Android and iOS
@@ -586,6 +599,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -609,6 +623,8 @@ class Appium extends Webdriver {
    * let contexts = await I.grabAllContexts();
    * ```
    *
+   * @return {Promise<string[]>}
+   *
    * Appium: support Android and iOS
    */
   async grabAllContexts() {
@@ -623,6 +639,8 @@ class Appium extends Webdriver {
    * let context = await I.grabContext();
    * ```
    *
+   * @return {Promise<string|null>}
+   *
    * Appium: support Android and iOS
    */
   async grabContext() {
@@ -637,6 +655,8 @@ class Appium extends Webdriver {
    * let activity = await I.grabCurrentActivity();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support only Android
    */
   async grabCurrentActivity() {
@@ -653,6 +673,8 @@ class Appium extends Webdriver {
    * let con = await I.grabNetworkConnection();
    * ```
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async grabNetworkConnection() {
@@ -673,6 +695,8 @@ class Appium extends Webdriver {
    * let orientation = await I.grabOrientation();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabOrientation() {
@@ -689,6 +713,8 @@ class Appium extends Webdriver {
    * let settings = await I.grabSettings();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabSettings() {
@@ -720,6 +746,8 @@ class Appium extends Webdriver {
    * I.switchToWeb('WEBVIEW_io.selendroid.testapp');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {string} [context]
    */
   async switchToWeb(context) {
@@ -747,6 +775,7 @@ class Appium extends Webdriver {
    * I.switchToNative('SOME_OTHER_CONTEXT');
    * ```
    * @param {*} context
+   * @return {Promise<void>}
    */
   async switchToNative(context = null) {
     this.isWeb = false;
@@ -763,6 +792,8 @@ class Appium extends Webdriver {
    * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async startActivity(appPackage, appActivity) {
@@ -786,6 +817,8 @@ class Appium extends Webdriver {
    * ```
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async setNetworkConnection(value) {
@@ -801,6 +834,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {object} settings object
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -841,6 +875,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {number} keyValue  Device specific key value
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -859,6 +894,8 @@ class Appium extends Webdriver {
    * I.openNotifications();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async openNotifications() {
@@ -877,6 +914,8 @@ class Appium extends Webdriver {
    * I.makeTouchAction("~buttonStartWebviewCD", 'tap');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support Android and iOS
    */
   async makeTouchAction(locator, action) {
@@ -898,6 +937,8 @@ class Appium extends Webdriver {
    *
    * Shortcut for `makeTouchAction`
    *
+   * @return {Promise<void>}
+   *
    * @param {*} locator
    */
   async tap(locator) {
@@ -918,6 +959,7 @@ class Appium extends Webdriver {
    * @param {number} xoffset
    * @param {number} yoffset
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -934,11 +976,11 @@ class Appium extends Webdriver {
    * Perform a swipe on the screen.
    *
    * ```js
-   * I.performswipe(100,200);
+   * I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
    * ```
    *
-   * @param {number} from
-   * @param {number} to
+   * @param {object} from
+   * @param {object} to
    *
    * Appium: support Android and iOS
    */
@@ -971,6 +1013,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -999,6 +1042,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1025,6 +1069,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1051,6 +1096,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1084,6 +1130,7 @@ class Appium extends Webdriver {
    * @param {number} timeout
    * @param {number} offset
    * @param {number} speed
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1181,6 +1228,10 @@ class Appium extends Webdriver {
    * I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
    * ```
    *
+   * @param {string} path
+   * @param {string} dest
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async pullFile(path, dest) {
@@ -1200,6 +1251,8 @@ class Appium extends Webdriver {
    * I.shakeDevice();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async shakeDevice() {
@@ -1216,6 +1269,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/rotate.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async rotate(x, y, duration, radius, rotation, touchCount) {
@@ -1228,6 +1283,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setImmediateValue.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async setImmediateValue(id, value) {
@@ -1244,6 +1301,8 @@ class Appium extends Webdriver {
    * I.touchId(false); // simulates invalid fingerprint
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    * TODO: not tested
    */
@@ -1260,6 +1319,8 @@ class Appium extends Webdriver {
    * I.closeApp();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async closeApp() {
@@ -1410,6 +1471,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} fileName file name to save.
+   * @return {Promise<void>}
    */
   async saveScreenshot(fileName) {
     return super.saveScreenshot(fileName, false);

package/lib/helper/FileSystem.js

@@ -15,7 +15,17 @@ const { fileEquals } = require('../assert/equal');
  * I.amInPath('test');
  * I.seeFile('codecept.json');
  * I.seeInThisFile('FileSystem');
- * I.dontSeeInThisFile("WebDriverIO");
+ * I.dontSeeInThisFile("WebDriver");
+ * ```
+ *
+ * ## Configuration
+ *
+ * Enable helper in config file:
+ *
+ * ```js
+ * helpers: {
+ *     FileSystem: {},
+ * }
  * ```
  *
  * ## Methods

package/lib/helper/GraphQL.js

@@ -59,6 +59,12 @@ class GraphQL extends Helper {
     }
   }
 
+  static _config() {
+    return [
+      { name: 'endpoint', message: 'Endpoint of API you are going to test', default: 'http://localhost:3000/graphql' },
+    ];
+  }
+
   /**
    * Executes query via axios call
    *
@@ -92,6 +98,11 @@ class GraphQL extends Helper {
       );
       response = err.response;
     }
+
+    if (this.config.onResponse) {
+      await this.config.onResponse(response);
+    }
+
     this.debugSection('Response', JSON.stringify(response.data));
     return response;
   }

package/lib/helper/JSONResponse.js

@@ -0,0 +1,297 @@
+const chai = require('chai');
+const joi = require('joi');
+const chaiDeepMatch = require('chai-deep-match');
+const Helper = require('../helper');
+
+chai.use(chaiDeepMatch);
+
+const { expect } = chai;
+
+/**
+ * This helper allows performing assertions on JSON responses paired with following helpers:
+ *
+ * * REST
+ * * GraphQL
+ * * Playwright
+ *
+ * It can check status codes, response data, response structure.
+ *
+ *
+ * ## Configuration
+ *
+ * * `requestHelper` - a helper which will perform requests. `REST` by default, also `Playwright` or `GraphQL` can be used. Custom helpers must have `onResponse` hook in their config, which will be executed when request is performed.
+ *
+ * ### Examples
+ *
+ * Zero-configuration when paired with REST:
+ *
+ * ```js
+ * // inside codecept.conf.js
+ *{
+ *   helpers: {
+ *     REST: {
+ *       endpoint: 'http://site.com/api',
+ *     },
+ *     JSONResponse: {}
+ *   }
+ *}
+ * ```
+ * Explicitly setting request helper if you use `makeApiRequest` of Playwright to perform requests and not paired REST:
+ *
+ * ```js
+ * // inside codecept.conf.js
+ * // ...
+ *   helpers: {
+ *     Playwright: {
+ *       url: 'https://localhost',
+ *       browser: 'chromium',
+ *     },
+ *     JSONResponse: {
+ *       requestHelper: 'Playwright',
+ *     }
+ *   }
+ * ```
+ * ## Access From Helpers
+ *
+ * If you plan to add custom assertions it is recommended to create a helper that will retrieve response object from JSONResponse:
+ *
+ *
+ * ```js
+ * // inside custom helper
+ * const response = this.helpers.JSONResponse.response;
+ * ```
+ *
+ * ## Methods
+ */
+class JSONResponse extends Helper {
+  constructor(config = {}) {
+    super(config);
+    this.options = {
+      requestHelper: 'REST',
+    };
+    this.options = { ...this.options, ...config };
+  }
+
+  _beforeSuite() {
+    this.response = null;
+    if (!this.helpers[this.options.requestHelper]) {
+      throw new Error(`Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`);
+    }
+    // connect to REST helper
+    this.helpers[this.options.requestHelper].config.onResponse = (response) => {
+      this.response = response;
+    };
+  }
+
+  _before() {
+    this.response = null;
+  }
+
+  static _checkRequirements() {
+    try {
+      require('joi');
+      require('chai');
+    } catch (e) {
+      return ['joi'];
+    }
+  }
+
+  /**
+   * Checks that response code is equal to the provided one
+   *
+   * ```js
+   * I.seeResponseCodeIs(200);
+   * ```
+   *
+   * @param {number} code
+   */
+  seeResponseCodeIs(code) {
+    this._checkResponseReady();
+    expect(this.response.status).to.eql(code, 'Response code is not the same as expected');
+  }
+
+  /**
+   * Checks that response code is not equal to the provided one
+   *
+   * ```js
+   * I.dontSeeResponseCodeIs(500);
+   * ```
+   *
+   * @param {number} code
+   */
+  dontSeeResponseCodeIs(code) {
+    this._checkResponseReady();
+    expect(this.response.status).not.to.eql(code);
+  }
+
+  /**
+   * Checks that the response code is 4xx
+   */
+  seeResponseCodeIsClientError() {
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(400);
+    expect(this.response.status).to.be.lt(500);
+  }
+
+  /**
+   * Checks that the response code is 3xx
+   */
+  seeResponseCodeIsRedirection() {
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(300);
+    expect(this.response.status).to.be.lt(400);
+  }
+
+  /**
+   * Checks that the response code is 5xx
+   */
+  seeResponseCodeIsServerError() {
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(500);
+    expect(this.response.status).to.be.lt(600);
+  }
+
+  /**
+   * Checks that the response code is 2xx
+   * Use it instead of seeResponseCodeIs(200) if server can return 204 instead.
+   *
+   * ```js
+   * I.seeResponseCodeIsSuccessful();
+   * ```
+   */
+  seeResponseCodeIsSuccessful() {
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(200);
+    expect(this.response.status).to.be.lt(300);
+  }
+
+  /**
+   * Checks for deep inclusion of a provided json in a response data.
+   *
+   * ```js
+   * // response.data == { user: { name: 'jon', email: 'jon@doe.com' } }
+   *
+   * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
+   * ```
+   *
+   * @param {object} json
+   */
+  seeResponseContainsJson(json = {}) {
+    this._checkResponseReady();
+    expect(this.response.data).to.deep.match(json);
+  }
+
+  /**
+   * Checks for deep inclusion of a provided json in a response data.
+   *
+   * ```js
+   * // response.data == { data: { user: 1 } }
+   *
+   * I.dontSeeResponseContainsJson({ user: 2 });
+   * ```
+   *
+   * @param {object} json
+   */
+  dontSeeResponseContainsJson(json = {}) {
+    this._checkResponseReady();
+    expect(this.response.data).not.to.deep.match(json);
+  }
+
+  /**
+   * Checks for deep inclusion of a provided json in a response data.
+   *
+   * ```js
+   * // response.data == { user: { name: 'jon', email: 'jon@doe.com' } }
+   *
+   * I.seeResponseContainsKeys(['user']);
+   * ```
+   *
+   * @param {array} keys
+   */
+  seeResponseContainsKeys(keys = []) {
+    this._checkResponseReady();
+    expect(this.response.data).to.include.keys(keys);
+  }
+
+  /**
+   * Executes a callback function passing in `response` object and chai assertions with `expect`
+   * Use it to perform custom checks of response data
+   *
+   * ```js
+   * I.seeResponseValidByCallback({ data, status, expect } => {
+   *   expect(status).to.eql(200);
+   *   expect(data).keys.to.include(['user', 'company']);
+   * });
+   * ```
+   *
+   * @param {function} fn
+   */
+  seeResponseValidByCallback(fn) {
+    this._checkResponseReady();
+    fn({ ...this.response, expect });
+    const body = fn.toString();
+    fn.toString = () => `${body.split('\n')[1]}...`;
+  }
+
+  /**
+   * Checks that response data equals to expected:
+   *
+   * ```js
+   * // response.data is { error: 'Not allowed' }
+   *
+   * I.seeResponseEquals({ error: 'Not allowed' })
+   * ```
+   * @param {object} resp
+   */
+  seeResponseEquals(resp) {
+    this._checkResponseReady();
+    expect(this.response.data).to.deep.equal(resp);
+  }
+
+  /**
+   * Validates JSON structure of response using [joi library](https://joi.dev).
+   * See [joi API](https://joi.dev/api/) for complete reference on usage.
+   *
+   * Use pre-initialized joi instance by passing function callback:
+   *
+   * ```js
+   * // response.data is { name: 'jon', id: 1 }
+   *
+   * I.seeResponseMatchesJsonSchema(joi => {
+   *   return joi.object({
+   *     name: joi.string();
+   *     id: joi.number();
+   *   })
+   * });
+   *
+   * // or pass a valid schema
+   * const joi = require('joi);
+   *
+   * I.seeResponseMatchesJsonSchema(joi.object({
+   *   name: joi.string();
+   *   id: joi.number();
+   * });
+   * ```
+   *
+   * @param {any} fnOrSchema
+   */
+  seeResponseMatchesJsonSchema(fnOrSchema) {
+    this._checkResponseReady();
+    let schema = fnOrSchema;
+    if (typeof fnOrSchema === 'function') {
+      schema = fnOrSchema(joi);
+      const body = fnOrSchema.toString();
+      fnOrSchema.toString = () => `${body.split('\n')[1]}...`;
+    }
+    if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details');
+    if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details');
+    schema.toString = () => schema.describe();
+    joi.assert(this.response.data, schema);
+  }
+
+  _checkResponseReady() {
+    if (!this.response) throw new Error('Response is not available');
+  }
+}
+
+module.exports = JSONResponse;