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

package/docs/webapi/flushNetworkTraffics.mustache

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

package/docs/webapi/grabRecordedNetworkTraffics.mustache

@@ -1,10 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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

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

package/docs/webapi/stopRecordingTraffic.mustache

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

package/docs/webapi/waitForCookie.mustache

@@ -1,9 +0,0 @@
-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/helper/MockServer.js

@@ -1,221 +0,0 @@
-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;

package/lib/helper/errors/ElementAssertion.js

@@ -1,38 +0,0 @@
-const Locator = require('../../locator');
-
-const prefixMessage = 'Element';
-
-function seeElementError(locator) {
-  if (typeof locator === 'object') {
-    locator = JSON.stringify(locator);
-  }
-  throw new Error(`${prefixMessage} "${(new Locator(locator))}" is still visible on page.`);
-}
-
-function seeElementInDOMError(locator) {
-  if (typeof locator === 'object') {
-    locator = JSON.stringify(locator);
-  }
-  throw new Error(`${prefixMessage} "${(new Locator(locator))}" is still seen in DOM.`);
-}
-
-function dontSeeElementError(locator) {
-  if (typeof locator === 'object') {
-    locator = JSON.stringify(locator);
-  }
-  throw new Error(`${prefixMessage} "${(new Locator(locator))}" is not visible on page.`);
-}
-
-function dontSeeElementInDOMError(locator) {
-  if (typeof locator === 'object') {
-    locator = JSON.stringify(locator);
-  }
-  throw new Error(`${prefixMessage} "${(new Locator(locator))}" is not seen in DOM.`);
-}
-
-module.exports = {
-  seeElementError,
-  dontSeeElementError,
-  seeElementInDOMError,
-  dontSeeElementInDOMError,
-};

package/lib/helper/networkTraffics/utils.js

@@ -1,137 +0,0 @@
-const createAdvancedTestResults = (url, dataToCheck, requests) => {
-  // Creates advanced test results for a network traffic check.
-  // Advanced test results only applies when expected parameters are set
-  if (!dataToCheck) return '';
-
-  let urlFound = false;
-  let advancedResults;
-  requests.forEach((request) => {
-    // url not found in this request. continue with next request
-    if (urlFound || !request.url.match(new RegExp(url))) return;
-    urlFound = true;
-
-    // Url found. Now we create advanced test report for that URL and show which parameters failed
-    if (!request.requestPostData) {
-      advancedResults = allParameterValuePairsMatchExtreme(extractQueryObjects(request.url), dataToCheck);
-    } else if (request.requestPostData) {
-      advancedResults = allRequestPostDataValuePairsMatchExtreme(request.requestPostData, dataToCheck);
-    }
-  });
-  return advancedResults;
-};
-
-const extractQueryObjects = (queryString) => {
-  // Converts a string of GET parameters into an array of parameter objects. Each parameter object contains the properties "name" and "value".
-  if (queryString.indexOf('?') === -1) {
-    return [];
-  }
-  const queryObjects = [];
-
-  const queryPart = queryString.split('?')[1];
-
-  const queryParameters = queryPart.split('&');
-
-  queryParameters.forEach((queryParameter) => {
-    const keyValue = queryParameter.split('=');
-    const queryObject = {};
-    // eslint-disable-next-line prefer-destructuring
-    queryObject.name = keyValue[0];
-    queryObject.value = decodeURIComponent(keyValue[1]);
-    queryObjects.push(queryObject);
-  });
-
-  return queryObjects;
-};
-
-const allParameterValuePairsMatchExtreme = (queryStringObject, advancedExpectedParameterValuePairs) => {
-  // More advanced check if all request parameters match with the expectations
-  let littleReport = '\nQuery parameters:\n';
-  let success = true;
-
-  for (const expectedKey in advancedExpectedParameterValuePairs) {
-    if (!Object.prototype.hasOwnProperty.call(advancedExpectedParameterValuePairs, expectedKey)) {
-      continue;
-    }
-    let parameterFound = false;
-    const expectedValue = advancedExpectedParameterValuePairs[expectedKey];
-
-    for (const queryParameter of queryStringObject) {
-      if (queryParameter.name === expectedKey) {
-        parameterFound = true;
-        if (expectedValue === undefined) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')}\n`;
-        } else if (typeof expectedValue === 'object' && expectedValue.base64) {
-          const decodedActualValue = Buffer.from(queryParameter.value, 'base64').toString('utf8');
-          if (decodedActualValue === expectedValue.base64) {
-            littleReport += `   ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})\n`;
-          } else {
-            littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})     -> actual value: "base64(${decodedActualValue})"\n`;
-            success = false;
-          }
-        } else if (queryParameter.value === expectedValue) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')} = ${expectedValue}\n`;
-        } else {
-          littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = ${expectedValue}      -> actual value: "${queryParameter.value}"\n`;
-          success = false;
-        }
-      }
-    }
-
-    if (parameterFound === false) {
-      littleReport += ` ✖ ${expectedKey.padStart(10, ' ')}${expectedValue ? ` = ${JSON.stringify(expectedValue)}` : ''}      -> parameter not found in request\n`;
-      success = false;
-    }
-  }
-
-  return success ? true : littleReport;
-};
-
-const allRequestPostDataValuePairsMatchExtreme = (RequestPostDataObject, advancedExpectedRequestPostValuePairs) => {
-  // More advanced check if all request post data match with the expectations
-  let littleReport = '\nRequest Post Data:\n';
-  let success = true;
-
-  for (const expectedKey in advancedExpectedRequestPostValuePairs) {
-    if (!Object.prototype.hasOwnProperty.call(advancedExpectedRequestPostValuePairs, expectedKey)) {
-      continue;
-    }
-    let keyFound = false;
-    const expectedValue = advancedExpectedRequestPostValuePairs[expectedKey];
-
-    for (const [key, value] of Object.entries(RequestPostDataObject)) {
-      if (key === expectedKey) {
-        keyFound = true;
-        if (expectedValue === undefined) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')}\n`;
-        } else if (typeof expectedValue === 'object' && expectedValue.base64) {
-          const decodedActualValue = Buffer.from(value, 'base64').toString('utf8');
-          if (decodedActualValue === expectedValue.base64) {
-            littleReport += `   ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})\n`;
-          } else {
-            littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = base64(${expectedValue.base64})     -> actual value: "base64(${decodedActualValue})"\n`;
-            success = false;
-          }
-        } else if (value === expectedValue) {
-          littleReport += `   ${expectedKey.padStart(10, ' ')} = ${expectedValue}\n`;
-        } else {
-          littleReport += ` ✖ ${expectedKey.padStart(10, ' ')} = ${expectedValue}      -> actual value: "${value}"\n`;
-          success = false;
-        }
-      }
-    }
-
-    if (keyFound === false) {
-      littleReport += ` ✖ ${expectedKey.padStart(10, ' ')}${expectedValue ? ` = ${JSON.stringify(expectedValue)}` : ''}      -> key not found in request\n`;
-      success = false;
-    }
-  }
-
-  return success ? true : littleReport;
-};
-
-module.exports = {
-  createAdvancedTestResults,
-  extractQueryObjects,
-  allParameterValuePairsMatchExtreme,
-  allRequestPostDataValuePairsMatchExtreme,
-};