@wdio/mocha-framework 8.0.0-alpha.412 → 8.0.0-alpha.504

package/build/common/utils.d.ts

@@ -0,0 +1,3 @@
+import type { FormattedMessage, FrameworkMessage } from '../types';
+export declare function formatMessage(params: FrameworkMessage): FormattedMessage;
+//# sourceMappingURL=utils.d.ts.map

package/build/common/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAElE,wBAAgB,aAAa,CAAE,MAAM,EAAE,gBAAgB,oBA4EtD"}

package/build/common/utils.js

@@ -0,0 +1,66 @@
+import { MOCHA_TIMEOUT_MESSAGE } from '../constants.js';
+export function formatMessage(params) {
+    let message = {
+        type: params.type
+    };
+    const mochaAllHooksIfPresent = params.payload?.title?.match(/^"(before|after)( all| each)?" hook/);
+    if (params.err) {
+        /**
+         * replace "Ensure the done() callback is being called in this test." with a more meaningful message
+         */
+        if (params.err && params.err.message && params.err.message.includes(MOCHA_TIMEOUT_MESSAGE)) {
+            const replacement = (`The execution in the test "${params.payload.parent.title} ${params.payload.title}" took too long. Try to reduce the run time or ` +
+                'increase your timeout for test specs (https://webdriver.io/docs/timeouts).');
+            params.err.message = params.err.message.replace(MOCHA_TIMEOUT_MESSAGE, replacement);
+            params.err.stack = params.err.stack.replace(MOCHA_TIMEOUT_MESSAGE, replacement);
+        }
+        message.error = {
+            name: params.err.name,
+            message: params.err.message,
+            stack: params.err.stack,
+            type: params.err.type || params.err.name,
+            expected: params.err.expected,
+            actual: params.err.actual
+        };
+        /**
+         * hook failures are emitted as "test:fail"
+         */
+        if (mochaAllHooksIfPresent) {
+            message.type = 'hook:end';
+        }
+    }
+    if (params.payload) {
+        message.title = params.payload.title;
+        message.parent = params.payload.parent ? params.payload.parent.title : null;
+        let fullTitle = message.title;
+        if (params.payload.parent) {
+            let parent = params.payload.parent;
+            while (parent && parent.title) {
+                fullTitle = parent.title + '.' + fullTitle;
+                parent = parent.parent;
+            }
+        }
+        message.fullTitle = fullTitle;
+        message.pending = params.payload.pending || false;
+        message.file = params.payload.file;
+        message.duration = params.payload.duration;
+        /**
+         * Add the current test title to the payload for cases where it helps to
+         * identify the test, e.g. when running inside a beforeEach hook
+         */
+        if (params.payload.ctx && params.payload.ctx.currentTest) {
+            message.currentTest = params.payload.ctx.currentTest.title;
+        }
+        if (params.type.match(/Test/)) {
+            message.passed = (params.payload.state === 'passed');
+        }
+        if (params.payload.parent?.title && mochaAllHooksIfPresent) {
+            const hookName = mochaAllHooksIfPresent[0];
+            message.title = `${hookName} for ${params.payload.parent.title}`;
+        }
+        if (params.payload.context) {
+            message.context = params.payload.context;
+        }
+    }
+    return message;
+}

package/build/constants.d.ts

@@ -1,8 +1,13 @@
 export declare const INTERFACES: {
-    readonly bdd: readonly ["it", "before", "beforeEach", "after", "afterEach"];
+    readonly bdd: readonly ["it", "specify", "before", "beforeEach", "after", "afterEach"];
     readonly tdd: readonly ["test", "suiteSetup", "setup", "suiteTeardown", "teardown"];
     readonly qunit: readonly ["test", "before", "beforeEach", "after", "afterEach"];
 };
+export declare const TEST_INTERFACES: {
+    readonly bdd: readonly ["it", "specify"];
+    readonly tdd: readonly ["test"];
+    readonly qunit: readonly ["test"];
+};
 /**
  * to map Mocha events to WDIO events
  */
@@ -20,5 +25,4 @@ export declare const EVENTS: {
 };
 export declare const NOOP: () => void;
 export declare const MOCHA_TIMEOUT_MESSAGE = "For async tests and hooks, ensure \"done()\" is called; if returning a Promise, ensure it resolves.";
-export declare const MOCHA_TIMEOUT_MESSAGE_REPLACEMENT: string;
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;CAIb,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;CAWT,CAAA;AAEV,eAAO,MAAM,IAAI,YAA6C,CAAA;AAC9D,eAAO,MAAM,qBAAqB,wGAAsG,CAAA;AACxI,eAAO,MAAM,iCAAiC,QAGnC,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;CAIb,CAAA;AAEV,eAAO,MAAM,eAAe;;;;CAIlB,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;CAWT,CAAA;AAEV,eAAO,MAAM,IAAI,YAA6C,CAAA;AAC9D,eAAO,MAAM,qBAAqB,wGAAsG,CAAA"}

package/build/constants.js

@@ -1,8 +1,13 @@
 export const INTERFACES = {
-    bdd: ['it', 'before', 'beforeEach', 'after', 'afterEach'],
+    bdd: ['it', 'specify', 'before', 'beforeEach', 'after', 'afterEach'],
     tdd: ['test', 'suiteSetup', 'setup', 'suiteTeardown', 'teardown'],
     qunit: ['test', 'before', 'beforeEach', 'after', 'afterEach']
 };
+export const TEST_INTERFACES = {
+    bdd: ['it', 'specify'],
+    tdd: ['test'],
+    qunit: ['test']
+};
 /**
  * to map Mocha events to WDIO events
  */
@@ -20,7 +25,3 @@ export const EVENTS = {
 };
 export const NOOP = /* istanbul ignore next */ function () { };
 export const MOCHA_TIMEOUT_MESSAGE = 'For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves.';
-export const MOCHA_TIMEOUT_MESSAGE_REPLACEMENT = [
-    'The execution in the test "%s %s" took too long. Try to reduce the run time or',
-    'increase your timeout for test specs (https://webdriver.io/docs/timeouts).'
-].join(' ');

package/build/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Capabilities, Services } from '@wdio/types';
-import type { MochaConfig, MochaOpts as MochaOptsImport, FrameworkMessage, FormattedMessage, MochaError } from './types';
+import type { MochaConfig, MochaOpts as MochaOptsImport, FrameworkMessage, MochaError } from './types';
 import type { EventEmitter } from 'node:events';
 declare type EventTypes = 'hook' | 'test' | 'suite';
 /**
@@ -33,8 +33,7 @@ declare class MochaAdapter {
      * Hooks which are added as true Mocha hooks need to call done() to notify async
      */
     wrapHook(hookName: keyof Services.HookFunctions): () => Promise<void | unknown[]>;
-    prepareMessage(hookName: keyof Services.HookFunctions): FormattedMessage;
-    formatMessage(params: FrameworkMessage): FormattedMessage;
+    prepareMessage(hookName: keyof Services.HookFunctions): import("./types").FormattedMessage;
     requireExternalModules(modules: string[]): Promise<any>[];
     emit(event: string, payload: any, err?: MochaError): void;
     getSyncEventIdStart(type: EventTypes): string;

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAIzD,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,IAAI,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACxH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAiB/C,aAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;AAG3C;;GAEG;AACH,cAAM,YAAY;IAcV,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IAjBrB,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,cAAc,CAAC,CAAO;IAE9B,OAAO,CAAC,MAAM,CAAI;IAClB,OAAO,CAAC,SAAS,CAAO;IACxB,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,SAAS,CAAiC;IAClD,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,eAAe,CAAqB;gBAGhC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY;IAO7B,IAAI;IAqBJ,UAAU,CAAE,SAAS,EAAE,eAAe;IAyB5C,QAAQ;IAIF,GAAG;IA8BT,OAAO,CAAE,OAAO,EAAE,eAAe;IAUjC,UAAU;IA4BV;;OAEG;IACH,QAAQ,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAUhD,cAAc,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAuBtD,aAAa,CAAE,MAAM,EAAE,gBAAgB;IA2EvC,sBAAsB,CAAE,OAAO,EAAE,MAAM,EAAE;IAgBzC,IAAI,CAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,UAAU;IAgBnD,mBAAmB,CAAE,IAAI,EAAE,UAAU;IAUrC,iBAAiB,CAAE,IAAI,EAAE,UAAU;IAOnC,MAAM,CAAE,OAAO,EAAE,gBAAgB;CAwCpC;AAED,QAAA,MAAM,cAAc,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAO,CAAA;AAS9C,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,CAAA;AAEvC,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,SAAU,SAAQ,eAAe;SAAG;KACjD;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAMA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAKzD,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,IAAI,eAAe,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACtG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAiB/C,aAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;AAG3C;;GAEG;AACH,cAAM,YAAY;IAcV,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IAjBrB,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,cAAc,CAAC,CAAO;IAE9B,OAAO,CAAC,MAAM,CAAI;IAClB,OAAO,CAAC,SAAS,CAAO;IACxB,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,SAAS,CAAiC;IAClD,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,eAAe,CAAqB;gBAGhC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,MAAM,EAAE,EAChB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,SAAS,EAAE,YAAY;IAO7B,IAAI;IAqBJ,UAAU,CAAE,SAAS,EAAE,eAAe;IAyB5C,QAAQ;IAIF,GAAG;IA8BT,OAAO,CAAE,OAAO,EAAE,eAAe;IAUjC,UAAU;IA2BV;;OAEG;IACH,QAAQ,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAUhD,cAAc,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAuBtD,sBAAsB,CAAE,OAAO,EAAE,MAAM,EAAE;IAgBzC,IAAI,CAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,UAAU;IAgBnD,mBAAmB,CAAE,IAAI,EAAE,UAAU;IAUrC,iBAAiB,CAAE,IAAI,EAAE,UAAU;IAOnC,MAAM,CAAE,OAAO,EAAE,gBAAgB;CAwCpC;AAED,QAAA,MAAM,cAAc,EAAE;IAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;CAAO,CAAA;AAS9C,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,CAAA;AAEvC,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,SAAU,SAAQ,eAAe;SAAG;KACjD;CACJ"}

package/build/index.js

@@ -1,11 +1,11 @@
 import url from 'node:url';
 import path from 'node:path';
-import { format } from 'node:util';
 import Mocha from 'mocha';
 import logger from '@wdio/logger';
 import { runTestInFiberContext, executeHooksWithArgs } from '@wdio/utils';
 import { loadModule } from './utils.js';
-import { INTERFACES, EVENTS, NOOP, MOCHA_TIMEOUT_MESSAGE, MOCHA_TIMEOUT_MESSAGE_REPLACEMENT } from './constants.js';
+import { formatMessage } from './common/utils.js';
+import { INTERFACES, TEST_INTERFACES, EVENTS, NOOP } from './constants.js';
 const log = logger('@wdio/mocha-framework');
 /**
 * Extracts the mocha UI type following this convention:
@@ -130,8 +130,7 @@ class MochaAdapter {
             return [{ ...context.test, parent: context.test?.parent?.title }, context];
         };
         INTERFACES[type].forEach((fnName) => {
-            let testCommand = INTERFACES[type][0];
-            const isTest = [testCommand, testCommand + '.only'].includes(fnName);
+            const isTest = TEST_INTERFACES[type].flatMap((testCommand) => [testCommand, testCommand + '.only']).includes(fnName);
             runTestInFiberContext(isTest, isTest ? this._config.beforeTest : this._config.beforeHook, 
             // @ts-ignore
             hookArgsFn, isTest ? this._config.afterTest : this._config.afterHook, hookArgsFn, fnName, this._cid);
@@ -164,71 +163,7 @@ class MochaAdapter {
                 params.payload = this._runner?.test;
                 break;
         }
-        return this.formatMessage(params);
-    }
-    formatMessage(params) {
-        let message = {
-            type: params.type
-        };
-        const mochaAllHooksIfPresent = params.payload?.title?.match(/^"(before|after)( all| each)?" hook/);
-        if (params.err) {
-            /**
-             * replace "Ensure the done() callback is being called in this test." with a more meaningful message
-             */
-            if (params.err && params.err.message && params.err.message.includes(MOCHA_TIMEOUT_MESSAGE)) {
-                const replacement = format(MOCHA_TIMEOUT_MESSAGE_REPLACEMENT, params.payload.parent.title, params.payload.title);
-                params.err.message = params.err.message.replace(MOCHA_TIMEOUT_MESSAGE, replacement);
-                params.err.stack = params.err.stack.replace(MOCHA_TIMEOUT_MESSAGE, replacement);
-            }
-            message.error = {
-                name: params.err.name,
-                message: params.err.message,
-                stack: params.err.stack,
-                type: params.err.type || params.err.name,
-                expected: params.err.expected,
-                actual: params.err.actual
-            };
-            /**
-             * hook failures are emitted as "test:fail"
-             */
-            if (mochaAllHooksIfPresent) {
-                message.type = 'hook:end';
-            }
-        }
-        if (params.payload) {
-            message.title = params.payload.title;
-            message.parent = params.payload.parent ? params.payload.parent.title : null;
-            let fullTitle = message.title;
-            if (params.payload.parent) {
-                let parent = params.payload.parent;
-                while (parent && parent.title) {
-                    fullTitle = parent.title + '.' + fullTitle;
-                    parent = parent.parent;
-                }
-            }
-            message.fullTitle = fullTitle;
-            message.pending = params.payload.pending || false;
-            message.file = params.payload.file;
-            message.duration = params.payload.duration;
-            /**
-             * Add the current test title to the payload for cases where it helps to
-             * identify the test, e.g. when running inside a beforeEach hook
-             */
-            if (params.payload.ctx && params.payload.ctx.currentTest) {
-                message.currentTest = params.payload.ctx.currentTest.title;
-            }
-            if (params.type.match(/Test/)) {
-                message.passed = (params.payload.state === 'passed');
-            }
-            if (params.payload.parent?.title && mochaAllHooksIfPresent) {
-                const hookName = mochaAllHooksIfPresent[0];
-                message.title = `${hookName} for ${params.payload.parent.title}`;
-            }
-            if (params.payload.context) {
-                message.context = params.payload.context;
-            }
-        }
-        return message;
+        return formatMessage(params);
     }
     requireExternalModules(modules) {
         return modules.map((module) => {
@@ -249,7 +184,7 @@ class MochaAdapter {
          */
         if (payload.root)
             return;
-        let message = this.formatMessage({ type: event, payload, err });
+        let message = formatMessage({ type: event, payload, err });
         message.cid = this._cid;
         message.specs = this._specs;
         message.uid = this.getUID(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/mocha-framework",
-  "version": "8.0.0-alpha.412+a2bc7ec67",
+  "version": "8.0.0-alpha.504+428a9d729",
   "description": "A WebdriverIO plugin. Adapter for Mocha testing framework.",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-mocha-framework",
@@ -22,14 +22,17 @@
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
   "type": "module",
-  "exports": "./build/index.js",
+  "exports": {
+    "./common": "./build/common/utils.js",
+    ".": "./build/index.js"
+  },
   "types": "./build/index.d.ts",
   "typeScriptVersion": "3.8.3",
   "dependencies": {
     "@types/mocha": "^10.0.0",
-    "@wdio/logger": "8.0.0-alpha.412+a2bc7ec67",
-    "@wdio/types": "8.0.0-alpha.412+a2bc7ec67",
-    "@wdio/utils": "8.0.0-alpha.412+a2bc7ec67",
+    "@wdio/logger": "8.0.0-alpha.504+428a9d729",
+    "@wdio/types": "8.0.0-alpha.504+428a9d729",
+    "@wdio/utils": "8.0.0-alpha.504+428a9d729",
     "mocha": "^10.0.0"
   },
   "devDependencies": {
@@ -38,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a2bc7ec67e2a5fe000e539f44b0ea97f6e08ccbd"
+  "gitHead": "428a9d729ae6231968a60908732fa3f607d195e9"
 }