@wdio/mocha-framework 8.0.0-alpha.558 → 8.0.0-alpha.565

package/build/common.d.ts

@@ -0,0 +1,13 @@
+import type { FormattedMessage, FrameworkMessage, MochaOpts } from './types';
+export declare function formatMessage(params: FrameworkMessage): FormattedMessage;
+/**
+ * require external modules
+ * @param modules list of modules to load before the test starts
+ * @param loader  function to import the module, optional and for testing purposes only
+ */
+export declare function requireExternalModules(modules: string[], loader?: typeof loadModule): Promise<any>[];
+type Hook = Function | Function[];
+export declare function setupEnv(cid: string, options: MochaOpts, beforeTest: Hook, beforeHook: Hook, afterTest: Hook, afterHook: Hook): Promise<any>[];
+export declare function loadModule(name: string): Promise<any>;
+export {};
+//# sourceMappingURL=common.d.ts.map

package/build/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAc5E,wBAAgB,aAAa,CAAE,MAAM,EAAE,gBAAgB,oBA4EtD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,oBAAa,kBAc7E;AAED,KAAK,IAAI,GAAG,QAAQ,GAAG,QAAQ,EAAE,CAAA;AACjC,wBAAgB,QAAQ,CAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,kBA6B9H;AAED,wBAAsB,UAAU,CAAE,IAAI,EAAE,MAAM,gBAQ7C"}

package/build/{common/utils.js → common.js}

@@ -1,4 +1,16 @@
-import { MOCHA_TIMEOUT_MESSAGE } from '../constants.js';
+import { wrapGlobalTestMethod } from '@wdio/utils';
+import { INTERFACES, TEST_INTERFACES, MOCHA_TIMEOUT_MESSAGE } from './constants.js';
+/**
+* Extracts the mocha UI type following this convention:
+*  - If the mochaOpts.ui provided doesn't contain a '-' then the full name
+*      is taken as ui type (i.e. 'bdd','tdd','qunit')
+*  - If it contains a '-' then it asumes we are providing a custom ui for
+*      mocha. Then it extracts the text after the last '-' (ignoring .js if
+*      provided) as the interface type. (i.e. strong-bdd in
+*      https://github.com/strongloop/strong-mocha-interfaces)
+*/
+const MOCHA_UI_TYPE_EXTRACTOR = /^(?:.*-)?([^-.]+)(?:.js)?$/;
+const DEFAULT_INTERFACE_TYPE = 'bdd';
 export function formatMessage(params) {
     let message = {
         type: params.type
@@ -64,3 +76,48 @@ export function formatMessage(params) {
     }
     return message;
 }
+/**
+ * require external modules
+ * @param modules list of modules to load before the test starts
+ * @param loader  function to import the module, optional and for testing purposes only
+ */
+export function requireExternalModules(modules, loader = loadModule) {
+    return modules.map((module) => {
+        if (!module) {
+            return Promise.resolve();
+        }
+        module = module.replace(/.*:/, '');
+        if (module.startsWith('./') && globalThis.process) {
+            module = `${globalThis.process.cwd()}/${module.slice(2)}`;
+        }
+        return loader(module);
+    });
+}
+export function setupEnv(cid, options, beforeTest, beforeHook, afterTest, afterHook) {
+    const match = MOCHA_UI_TYPE_EXTRACTOR.exec(options.ui);
+    const type = (match && INTERFACES[match[1]] && match[1]) || DEFAULT_INTERFACE_TYPE;
+    const hookArgsFn = (context) => {
+        return [{ ...context.test, parent: context.test?.parent?.title }, context];
+    };
+    INTERFACES[type].forEach((fnName) => {
+        const isTest = TEST_INTERFACES[type].flatMap((testCommand) => [testCommand, testCommand + '.only']).includes(fnName);
+        wrapGlobalTestMethod(isTest, isTest ? beforeTest : beforeHook, 
+        // @ts-ignore
+        hookArgsFn, isTest ? afterTest : afterHook, hookArgsFn, fnName, cid);
+    });
+    let { require = [], compilers = [] } = options;
+    if (typeof require === 'string') {
+        require = [require];
+    }
+    return requireExternalModules([...compilers, ...require]);
+}
+export async function loadModule(name) {
+    try {
+        return await import(name);
+    }
+    catch (err) {
+        throw new Error(`Module ${name} can't get loaded. Are you sure you have installed it?\n` +
+            'Note: if you\'ve installed WebdriverIO globally you need to install ' +
+            'these external modules globally too!');
+    }
+}

package/build/index.d.ts

@@ -27,14 +27,11 @@ declare class MochaAdapter {
     _loadFiles(mochaOpts: MochaOptsImport): Promise<void>;
     hasTests(): boolean;
     run(): Promise<unknown>;
-    options(options: MochaOptsImport): Promise<any>[];
-    preRequire(): Promise<any>[];
     /**
      * 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): import("./types").FormattedMessage;
-    requireExternalModules(modules: string[]): Promise<any>[];
     emit(event: string, payload: any, err?: MochaError): void;
     getSyncEventIdStart(type: EventTypes): string;
     getSyncEventIdEnd(type: EventTypes): string;

package/build/index.d.ts.map

@@ -1 +1 @@
-{"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,KAAK,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAIzD,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;AAK/C,KAAK,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;IAwBJ,UAAU,CAAE,SAAS,EAAE,eAAe;IAyB5C,QAAQ;IAIF,GAAG;IA8BT;;OAEG;IACH,QAAQ,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAUhD,cAAc,CAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC,aAAa;IAuBtD,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,23 +1,10 @@
 import url from 'node:url';
-import path from 'node:path';
 import Mocha from 'mocha';
 import logger from '@wdio/logger';
-import { runTestInFiberContext, executeHooksWithArgs } from '@wdio/utils';
-import { loadModule } from './utils.js';
-import { formatMessage } from './common/utils.js';
-import { INTERFACES, TEST_INTERFACES, EVENTS, NOOP } from './constants.js';
+import { executeHooksWithArgs } from '@wdio/utils';
+import { formatMessage, setupEnv } from './common.js';
+import { EVENTS, NOOP } from './constants.js';
 const log = logger('@wdio/mocha-framework');
-/**
-* Extracts the mocha UI type following this convention:
-*  - If the mochaOpts.ui provided doesn't contain a '-' then the full name
-*      is taken as ui type (i.e. 'bdd','tdd','qunit')
-*  - If it contains a '-' then it asumes we are providing a custom ui for
-*      mocha. Then it extracts the text after the last '-' (ignoring .js if
-*      provided) as the interface type. (i.e. strong-bdd in
-*      https://github.com/strongloop/strong-mocha-interfaces)
-*/
-const MOCHA_UI_TYPE_EXTRACTOR = /^(?:.*-)?([^-.]+)(?:.js)?$/;
-const DEFAULT_INTERFACE_TYPE = 'bdd';
 const FILE_PROTOCOL = 'file://';
 /**
  * Mocha runner
@@ -61,7 +48,8 @@ class MochaAdapter {
         this._specs.forEach((spec) => mocha.addFile(spec.startsWith(FILE_PROTOCOL)
             ? url.fileURLToPath(spec)
             : spec));
-        mocha.suite.on('pre-require', this.preRequire.bind(this));
+        const { beforeTest, beforeHook, afterTest, afterHook } = this._config;
+        mocha.suite.on('pre-require', (context) => setupEnv(this._cid, context, beforeTest, beforeHook, afterTest, afterHook));
         await this._loadFiles(mochaOpts);
         return this;
     }
@@ -115,28 +103,6 @@ class MochaAdapter {
         }
         return result;
     }
-    options(options) {
-        let { require = [], compilers = [] } = options;
-        if (typeof require === 'string') {
-            require = [require];
-        }
-        return this.requireExternalModules([...compilers, ...require]);
-    }
-    preRequire() {
-        const options = this._config.mochaOpts;
-        const match = MOCHA_UI_TYPE_EXTRACTOR.exec(options.ui);
-        const type = (match && INTERFACES[match[1]] && match[1]) || DEFAULT_INTERFACE_TYPE;
-        const hookArgsFn = (context) => {
-            return [{ ...context.test, parent: context.test?.parent?.title }, context];
-        };
-        INTERFACES[type].forEach((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);
-        });
-        return this.options(options);
-    }
     /**
      * Hooks which are added as true Mocha hooks need to call done() to notify async
      */
@@ -165,18 +131,6 @@ class MochaAdapter {
         }
         return formatMessage(params);
     }
-    requireExternalModules(modules) {
-        return modules.map((module) => {
-            if (!module) {
-                return Promise.resolve();
-            }
-            module = module.replace(/.*:/, '');
-            if (module.substr(0, 1) === '.') {
-                module = path.join(process.cwd(), module);
-            }
-            return loadModule(module);
-        });
-    }
     emit(event, payload, err) {
         /**
          * For some reason, Mocha fires a second 'suite:end' event for the root suite,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/mocha-framework",
-  "version": "8.0.0-alpha.558+9156ec0f4",
+  "version": "8.0.0-alpha.565+9959d0e91",
   "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",
@@ -23,16 +23,19 @@
   },
   "type": "module",
   "exports": {
-    "./common": "./build/common/utils.js",
+    "./common": {
+      "import": "./build/common.js",
+      "types": "./build/common.d.ts"
+    },
     ".": "./build/index.js"
   },
   "types": "./build/index.d.ts",
   "typeScriptVersion": "3.8.3",
   "dependencies": {
     "@types/mocha": "^10.0.0",
-    "@wdio/logger": "8.0.0-alpha.558+9156ec0f4",
-    "@wdio/types": "8.0.0-alpha.558+9156ec0f4",
-    "@wdio/utils": "8.0.0-alpha.558+9156ec0f4",
+    "@wdio/logger": "8.0.0-alpha.565+9959d0e91",
+    "@wdio/types": "8.0.0-alpha.565+9959d0e91",
+    "@wdio/utils": "8.0.0-alpha.565+9959d0e91",
     "mocha": "^10.0.0"
   },
   "devDependencies": {
@@ -41,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9156ec0f422b7e784ea148e569fe423ba21a0355"
+  "gitHead": "9959d0e91c0f7d2991a5a0c1eb34d288894dae74"
 }

package/build/common/utils.d.ts

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

@@ -1 +0,0 @@
-{"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/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function loadModule(name: string): Promise<any>;
-//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAsB,UAAU,CAAE,IAAI,EAAE,MAAM,gBAQ7C"}

package/build/utils.js

@@ -1,10 +0,0 @@
-export async function loadModule(name) {
-    try {
-        return await import(name);
-    }
-    catch (err) {
-        throw new Error(`Module ${name} can't get loaded. Are you sure you have installed it?\n` +
-            'Note: if you\'ve installed WebdriverIO globally you need to install ' +
-            'these external modules globally too!');
-    }
-}