codeceptjs 3.6.0-beta.1.ai-healers → 3.6.0

package/README.md

@@ -313,10 +313,10 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/tsuemura"><img src="https://avatars.githubusercontent.com/u/17092259?v=4" title="tsuemura" width="80" height="80"></a>
 <a href="https://github.com/EgorBodnar"><img src="https://avatars.githubusercontent.com/u/63167966?v=4" title="EgorBodnar" width="80" height="80"></a>
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
-<a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
-<a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
+<a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
 <a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
+<a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
 <a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>

package/bin/codecept.js

@@ -272,5 +272,6 @@ program.on('command:*', (cmd) => {
 
 if (process.argv.length <= 2) {
   program.outputHelp();
+} else {
+  program.parse(process.argv);
 }
-program.parse(process.argv);

package/docs/webapi/dontSeeTraffic.mustache

@@ -0,0 +1,13 @@
+Verifies that a certain request is not part of network traffic.
+
+Examples:
+
+```js
+I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
+I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
+```
+
+@param {Object} opts - options when checking the traffic network.
+@param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+@param {string|RegExp} opts.url Expected URL of request in network traffic. Can be a string or a regular expression.
+@return {void} automatically synchronized promise through #recorder

package/docs/webapi/flushNetworkTraffics.mustache

@@ -0,0 +1,5 @@
+Resets all recorded network requests.
+
+```js
+I.flushNetworkTraffics();
+```

package/docs/webapi/grabRecordedNetworkTraffics.mustache

@@ -0,0 +1,10 @@
+Grab the recording network traffics
+
+```js
+const traffics = await I.grabRecordedNetworkTraffics();
+expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
+expect(traffics[0].response.status).to.equal(200);
+expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
+```
+
+@return { Array } recorded network traffics

package/docs/webapi/seeTraffic.mustache

@@ -0,0 +1,36 @@
+Verifies that a certain request is part of network traffic.
+
+```js
+// checking the request url contains certain query strings
+I.amOnPage('https://openai.com/blog/chatgpt');
+I.startRecordingTraffic();
+await I.seeTraffic({
+    name: 'sentry event',
+    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
+    parameters: {
+    width: '1919',
+    height: '1138',
+    },
+  });
+```
+
+```js
+// checking the request url contains certain post data
+I.amOnPage('https://openai.com/blog/chatgpt');
+I.startRecordingTraffic();
+await I.seeTraffic({
+    name: 'event',
+    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
+    requestPostData: {
+    st: 2,
+    },
+  });
+```
+
+@param {Object} opts - options when checking the traffic network.
+@param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
+@param {string} opts.url Expected URL of request in network traffic
+@param {Object} [opts.parameters] Expected parameters of that request in network traffic
+@param {Object} [opts.requestPostData] Expected that request contains post data in network traffic
+@param {number} [opts.timeout] Timeout to wait for request in seconds. Default is 10 seconds.
+@return {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingTraffic.mustache

@@ -0,0 +1,8 @@
+Starts recording the network traffics.
+This also resets recorded network requests.
+
+```js
+I.startRecordingTraffic();
+```
+
+@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingWebSocketMessages.mustache

@@ -0,0 +1,8 @@
+Starts recording of websocket messages.
+This also resets recorded websocket messages.
+
+```js
+await I.startRecordingWebSocketMessages();
+```
+
+@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/stopRecordingTraffic.mustache

@@ -0,0 +1,5 @@
+Stops recording of network traffic. Recorded traffic is not flashed.
+
+```js
+I.stopRecordingTraffic();
+```

package/docs/webapi/stopRecordingWebSocketMessages.mustache

@@ -0,0 +1,7 @@
+Stops recording WS messages. Recorded WS messages is not flashed.
+
+```js
+await I.stopRecordingWebSocketMessages();
+```
+
+@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForCookie.mustache

@@ -0,0 +1,9 @@
+Waits for the specified cookie in the cookies.
+
+```js
+I.waitForCookie("token");
+```
+
+@param {string} name expected cookie name.
+@param {number} [sec=3] (optional, `3` by default) time in seconds to wait
+@returns {void} automatically synchronized promise through #recorder

package/lib/actor.js

@@ -13,15 +13,18 @@ const output = require('./output');
  */
 class Actor {
   /**
-   * add print comment method`
+   * Print the comment on log. Also, adding a step in the `Test.steps` object
    * @param {string} msg
    * @param {string} color
    * @inner
    *
    * ⚠️ returns a promise which is synchronized internally by recorder
    */
-  say(msg, color = 'cyan') {
-    return recorder.add(`say ${msg}`, () => {
+  async say(msg, color = 'cyan') {
+    const step = new Step('say', 'say');
+    step.status = 'passed';
+    return recordStep(step, [msg]).then(() => {
+      // this is backward compatibility as this event may be used somewhere
       event.emit(event.step.comment, msg);
       output.say(msg, `${color}`);
     });

package/lib/command/dryRun.js

@@ -59,24 +59,39 @@ function printTests(files) {
 
   let numOfTests = 0;
   let numOfSuites = 0;
-  const filteredSuites = [];
+  let outputString = '';
+  const filterBy = process.env.grep ? process.env.grep.toLowerCase() : undefined;
 
-  for (const suite of mocha.suite.suites) {
-    if (process.env.grep && suite.title.toLowerCase().includes(process.env.grep)) {
-      filteredSuites.push(suite);
+  if (filterBy) {
+    for (const suite of mocha.suite.suites) {
+      const currentSuite = suite.title;
+      if (suite.title.toLowerCase().includes(filterBy)) {
+        outputString += `${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests\n`;
+        numOfSuites++;
+      }
+
+      for (test of suite.tests) {
+        if (test.title.toLowerCase().includes(filterBy)) {
+          numOfTests++;
+          outputString += `${colors.white.bold(test.parent.title)} -- ${output.styles.log(test.parent.file || '')} -- ${mocha.suite.suites.length} tests\n`;
+          outputString += `  ${output.styles.scenario(figures.checkboxOff)} ${test.title}\n`;
+        }
+      }
     }
-  }
-  const displayedSuites = process.env.grep ? filteredSuites : mocha.suite.suites;
-  for (const suite of displayedSuites) {
-    output.print(`${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${suite.tests.length} tests`);
-    numOfSuites++;
-
-    for (const test of suite.tests) {
-      numOfTests++;
-      output.print(`  ${output.styles.scenario(figures.checkboxOff)} ${test.title}`);
+    numOfSuites = countSuites(outputString);
+  } else {
+    for (const suite of mocha.suite.suites) {
+      output.print(`${colors.white.bold(suite.title)} -- ${output.styles.log(suite.file || '')} -- ${mocha.suite.suites.length} tests`);
+      numOfSuites++;
+
+      for (test of suite.tests) {
+        numOfTests++;
+        output.print(`  ${output.styles.scenario(figures.checkboxOff)} ${test.title}`);
+      }
     }
   }
 
+  output.print(removeDuplicates(outputString));
   output.print('');
   output.success(`  Total: ${numOfSuites} suites | ${numOfTests} tests  `);
   printFooter();
@@ -87,3 +102,19 @@ function printFooter() {
   output.print();
   output.print('--- DRY MODE: No tests were executed ---');
 }
+
+function removeDuplicates(inputString) {
+  const array = inputString.split('\n');
+  const uniqueLines = [...new Set(array)];
+  const resultString = uniqueLines.join('\n');
+
+  return resultString;
+}
+
+function countSuites(inputString) {
+  const array = inputString.split('\n');
+
+  const uniqueLines = [...new Set(array)];
+  const res = uniqueLines.filter(item => item.includes('-- '));
+  return res.length;
+}

package/lib/helper/Appium.js

@@ -2,6 +2,7 @@ let webdriverio;
 
 const fs = require('fs');
 const axios = require('axios').default;
+const { v4: uuidv4 } = require('uuid');
 
 const Webdriver = require('./WebDriver');
 const AssertionFailedError = require('../assert/error');
@@ -1088,17 +1089,40 @@ class Appium extends Webdriver {
    * Appium: support Android and iOS
    */
   async performSwipe(from, to) {
-    await this.browser.touchPerform([{
-      action: 'press',
-      options: from,
-    }, {
-      action: 'wait',
-      options: { ms: 1000 },
-    }, {
-      action: 'moveTo',
-      options: to,
-    }, {
-      action: 'release',
+    await this.browser.performActions([{
+      id: uuidv4(),
+      type: 'pointer',
+      parameters: {
+        pointerType: 'touch',
+      },
+      actions: [
+        {
+          duration: 0,
+          x: from.x,
+          y: from.y,
+          type: 'pointerMove',
+          origin: 'viewport',
+        },
+        {
+          button: 1,
+          type: 'pointerDown',
+        },
+        {
+          duration: 200,
+          type: 'pause',
+        },
+        {
+          duration: 600,
+          x: to.x,
+          y: to.y,
+          type: 'pointerMove',
+          origin: 'viewport',
+        },
+        {
+          button: 1,
+          type: 'pointerUp',
+        },
+      ],
     }]);
     await this.browser.pause(1000);
   }
@@ -1128,7 +1152,7 @@ class Appium extends Webdriver {
       yoffset = 100;
     }
 
-    return this.swipe(locator, 0, yoffset, speed);
+    return this.swipe(parseLocator.call(this, locator), 0, yoffset, speed);
   }
 
   /**

package/lib/helper/Expect.js

@@ -1,12 +1,15 @@
-const chai = require('chai');
 const output = require('../output');
 
-const { expect } = chai;
+let expect;
 
-chai.use(require('chai-string'));
-// @ts-ignore
-chai.use(require('chai-exclude'));
-chai.use(require('chai-match-pattern'));
+import('chai').then(chai => {
+  expect = chai.expect;
+  chai.use(require('chai-string'));
+  // @ts-ignore
+  chai.use(require('chai-exclude'));
+  chai.use(require('chai-match-pattern'));
+  chai.use(require('chai-json-schema'));
+});
 
 /**
  * This helper allows performing assertions based on Chai.
@@ -179,7 +182,7 @@ class ExpectHelper {
   expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
     // @ts-ignore
     output.step(`I expect "${JSON.stringify(targetData)}" to match this JSON schema "${JSON.stringify(jsonSchema)}"`);
-    chai.use(require('chai-json-schema'));
+
     return expect(targetData, customErrorMsg).to.be.jsonSchema(jsonSchema);
   }
 
@@ -187,7 +190,7 @@ class ExpectHelper {
      * @param {*} targetData
      * @param {*} jsonSchema
      * @param {*} [customErrorMsg]
-     * @param {*} ajvOptions Pass AJV options
+     * @param {*} [ajvOptions] Pass AJV options
      */
   expectJsonSchemaUsingAJV(
     targetData,

package/lib/helper/JSONResponse.js

@@ -1,12 +1,13 @@
-const assert = require('assert');
-const chai = require('chai');
-const joi = require('joi');
-const chaiDeepMatch = require('chai-deep-match');
 const Helper = require('@codeceptjs/helper');
 
-chai.use(chaiDeepMatch);
+let expect;
+
+import('chai').then(chai => {
+  expect = chai.expect;
+  chai.use(require('chai-deep-match'));
+});
 
-const { expect } = chai;
+const joi = require('joi');
 
 /**
  * This helper allows performing assertions on JSON responses paired with following helpers:
@@ -91,7 +92,6 @@ class JSONResponse extends Helper {
   static _checkRequirements() {
     try {
       require('joi');
-      require('chai');
     } catch (e) {
       return ['joi'];
     }
@@ -194,7 +194,7 @@ class JSONResponse extends Helper {
           fails++;
         }
       }
-      assert.ok(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`);
+      expect(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`).to.be.true;
     } else {
       expect(this.response.data).to.deep.match(json);
     }

package/lib/helper/MockServer.js

@@ -0,0 +1,221 @@
+const { mock, settings } = require('pactum');
+
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.(js|ts)
+ *
+ * @typedef MockServerConfig
+ * @type {object}
+ * @prop {number} [port=9393] - Mock server port
+ * @prop {string} [host="0.0.0.0"] - Mock server host
+ * @prop {object} [httpsOpts] - key & cert values are the paths to .key and .crt files
+ */
+let config = {
+  port: 9393,
+  host: '0.0.0.0',
+  httpsOpts: {
+    key: '',
+    cert: '',
+  },
+};
+
+/**
+ * MockServer
+ *
+ * The MockServer Helper in CodeceptJS empowers you to mock any server or service via HTTP or HTTPS, making it an excellent tool for simulating REST endpoints and other HTTP-based APIs.
+ *
+ * <!-- configuration -->
+ *
+ * #### Examples
+ *
+ * You can seamlessly integrate MockServer with other helpers like REST or Playwright. Here's a configuration example inside the `codecept.conf.js` file:
+ *
+ * ```javascript
+ * {
+ *   helpers: {
+ *     REST: {...},
+ *     MockServer: {
+ *       // default mock server config
+ *       port: 9393,
+ *       host: '0.0.0.0',
+ *       httpsOpts: {
+ *         key: '',
+ *         cert: '',
+ *       },
+ *     },
+ *   }
+ * }
+ * ```
+ *
+ * #### Adding Interactions
+ *
+ * Interactions add behavior to the mock server. Use the `I.addInteractionToMockServer()` method to include interactions. It takes an interaction object as an argument, containing request and response details.
+ *
+ * ```javascript
+ * I.addInteractionToMockServer({
+ *    request: {
+ *      method: 'GET',
+ *      path: '/api/hello'
+ *    },
+ *    response: {
+ *      status: 200,
+ *      body: {
+ *        'say': 'hello to mock server'
+ *      }
+ *    }
+ * });
+ * ```
+ *
+ * #### Request Matching
+ *
+ * When a real request is sent to the mock server, it matches the received request with the interactions. If a match is found, it returns the specified response; otherwise, a 404 status code is returned.
+ *
+ * - Strong match on HTTP Method, Path, Query Params & JSON body.
+ * - Loose match on Headers.
+ *
+ * ##### Strong Match on Query Params
+ *
+ * You can send different responses based on query parameters:
+ *
+ * ```javascript
+ * I.addInteractionToMockServer({
+ *   request: {
+ *     method: 'GET',
+ *     path: '/api/users',
+ *     queryParams: {
+ *       id: 1
+ *     }
+ *   },
+ *   response: {
+ *     status: 200,
+ *     body: 'user 1'
+ *   }
+ * });
+ *
+ * I.addInteractionToMockServer({
+ *   request: {
+ *     method: 'GET',
+ *     path: '/api/users',
+ *     queryParams: {
+ *       id: 2
+ *     }
+ *   },
+ *   response: {
+ *     status: 200,
+ *     body: 'user 2'
+ *   }
+ * });
+ * ```
+ *
+ * - GET to `/api/users?id=1` will return 'user 1'.
+ * - GET to `/api/users?id=2` will return 'user 2'.
+ * - For all other requests, it returns a 404 status code.
+ *
+ * ##### Loose Match on Body
+ *
+ * When `strict` is set to false, it performs a loose match on query params and response body:
+ *
+ * ```javascript
+ * I.addInteractionToMockServer({
+ *   strict: false,
+ *   request: {
+ *     method: 'POST',
+ *     path: '/api/users',
+ *     body: {
+ *       name: 'john'
+ *     }
+ *   },
+ *   response: {
+ *     status: 200
+ *   }
+ * });
+ * ```
+ *
+ * - POST to `/api/users` with the body containing `name` as 'john' will return a 200 status code.
+ * - POST to `/api/users` without the `name` property in the body will return a 404 status code.
+ *
+ * Happy testing with MockServer in CodeceptJS! 🚀
+ *
+ * ## Methods
+ */
+class MockServer {
+  constructor(passedConfig) {
+    settings.setLogLevel('SILENT');
+    config = { ...passedConfig };
+    if (global.debugMode) {
+      settings.setLogLevel('VERBOSE');
+    }
+  }
+
+  /**
+   * Start the mock server
+   * @param {number} [port] start the mock server with given port
+   *
+   * @returns void
+   */
+  async startMockServer(port) {
+    const _config = { ...config };
+    if (port) _config.port = port;
+    await mock.setDefaults(_config);
+    await mock.start();
+  }
+
+  /**
+   * Stop the mock server
+   *
+   * @returns void
+   *
+   */
+  async stopMockServer() {
+    await mock.stop();
+  }
+
+  /**
+   * An interaction adds behavior to the mock server
+   *
+   *
+   * ```js
+   * I.addInteractionToMockServer({
+   *    request: {
+   *      method: 'GET',
+   *      path: '/api/hello'
+   *    },
+   *    response: {
+   *      status: 200,
+   *      body: {
+   *        'say': 'hello to mock server'
+   *      }
+   *    }
+   * });
+   * ```
+   * ```js
+   * // with query params
+   * I.addInteractionToMockServer({
+   *    request: {
+   *      method: 'GET',
+   *      path: '/api/hello',
+   *      queryParams: {
+   *       id: 2
+   *     }
+   *    },
+   *    response: {
+   *      status: 200,
+   *      body: {
+   *        'say': 'hello to mock server'
+   *      }
+   *    }
+   * });
+   * ```
+   *
+   * @param {CodeceptJS.MockInteraction|object} interaction add behavior to the mock server
+   *
+   * @returns void
+   *
+   */
+  async addInteractionToMockServer(interaction) {
+    await mock.addInteraction(interaction);
+  }
+}
+
+module.exports = MockServer;