codeceptjs 3.5.12-beta.8 → 3.5.12

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/step.js

@@ -119,7 +119,9 @@ class Step {
     }
     let result;
     try {
-      result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      if (this.helperMethod !== 'say') {
+        result = this.helper[this.helperMethod].apply(this.helper, this.args);
+      }
       this.setStatus('success');
     } catch (err) {
       this.setStatus('failed');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.5.12-beta.8",
+  "version": "3.5.12",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -55,7 +55,6 @@
     "test:unit:webbapi:webDriver:devtools": "mocha test/helper/WebDriver_devtools_test.js --exit",
     "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
     "test:unit:expect": "mocha test/helper/Expect_test.js",
-    "test:unit:mockServer": "mocha test/helper/MockServer_test.js",
     "test:plugin": "mocha test/plugin/plugin_test.js",
     "def": "./runok.js def",
     "dev:graphql": "node test/data/graphql/index.js",
@@ -105,7 +104,6 @@
     "ms": "2.1.3",
     "openai": "3.2.1",
     "ora-classic": "5.4.2",
-    "pactum": "3.6.0",
     "parse-function": "5.6.4",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
@@ -126,7 +124,7 @@
     "@types/node": "20.10.7",
     "@wdio/sauce-service": "8.27.0",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.27.2",
+    "@wdio/utils": "8.28.8",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
@@ -171,4 +169,4 @@
     "npm": ">=5.6.0"
   },
   "es6": true
-}
+}

package/typings/index.d.ts

@@ -382,22 +382,6 @@ declare namespace CodeceptJS {
     [key: string]: any;
   };
 
-  type MockRequest = {
-    method: 'GET'|'PUT'|'POST'|'PATCH'|'DELETE'|string;
-    path: string;
-    queryParams?: object;
-  }
-
-  type MockResponse = {
-    status: number;
-    body?: object;
-  }
-
-  type MockInteraction = {
-    request: MockRequest;
-    response: MockResponse;
-  }
-
   interface PageScrollPosition {
     x: number;
     y: number;

package/typings/types.d.ts

@@ -1895,12 +1895,12 @@ declare namespace CodeceptJS {
         /**
          * Start the mock server
          * @param [port] - start the mock server with given port
-         * @returns Promise<void>
+         * @returns void
          */
         startMockServer(port?: number): any;
         /**
          * Stop the mock server
-         * @returns Promise<void>
+         * @returns void
          */
         stopMockServer(): any;
         /**
@@ -1940,7 +1940,7 @@ declare namespace CodeceptJS {
          * });
          * ```
          * @param interaction - add behavior to the mock server
-         * @returns Promise<void>
+         * @returns void
          */
         addInteractionToMockServer(interaction: CodeceptJS.MockInteraction | any): any;
     }
@@ -11448,7 +11448,7 @@ declare namespace CodeceptJS {
     }
     interface ActorStatic {
         /**
-         * add print comment method`
+         * Print the comment on log. Also, adding a step in the `Test.steps` object
          */
         say(msg: string, color?: string): void;
         /**

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 Promise<void>
-   */
-  async startMockServer(port) {
-    const _config = { ...config };
-    if (port) _config.port = port;
-    await mock.setDefaults(_config);
-    await mock.start();
-  }
-
-  /**
-   * Stop the mock server
-   *
-   * @returns Promise<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 Promise<void>
-   *
-   */
-  async addInteractionToMockServer(interaction) {
-    await mock.addInteraction(interaction);
-  }
-}
-
-module.exports = MockServer;