@wdio/cli 7.17.0 → 7.18.0

package/build/interface.js

@@ -0,0 +1,248 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const events_1 = require("events");
+const logger_1 = __importDefault(require("@wdio/logger"));
+const utils_1 = require("./utils");
+const log = (0, logger_1.default)('@wdio/cli');
+class WDIOCLInterface extends events_1.EventEmitter {
+    constructor(_config, totalWorkerCnt, _isWatchMode = false) {
+        super();
+        this._config = _config;
+        this.totalWorkerCnt = totalWorkerCnt;
+        this._isWatchMode = _isWatchMode;
+        this.result = {
+            finished: 0,
+            passed: 0,
+            retries: 0,
+            failed: 0
+        };
+        this._jobs = new Map();
+        this._skippedSpecs = 0;
+        this._inDebugMode = false;
+        this._start = new Date();
+        this._messages = {
+            reporter: {},
+            debugger: {}
+        };
+        /**
+         * Colors can be forcibly enabled/disabled with env variable `FORCE_COLOR`
+         * `FORCE_COLOR=1` - forcibly enable colors
+         * `FORCE_COLOR=0` - forcibly disable colors
+         */
+        this.hasAnsiSupport = chalk_1.default.supportsColor.hasBasic;
+        this.totalWorkerCnt = totalWorkerCnt;
+        this._isWatchMode = _isWatchMode;
+        this._specFileRetries = _config.specFileRetries || 0;
+        this._specFileRetriesDelay = _config.specFileRetriesDelay || 0;
+        this.on('job:start', this.addJob.bind(this));
+        this.on('job:end', this.clearJob.bind(this));
+        this.setup();
+        this.onStart();
+    }
+    setup() {
+        this._jobs = new Map();
+        this._start = new Date();
+        /**
+         * The relationship between totalWorkerCnt and these counters are as follows:
+         * totalWorkerCnt - retries = finished = passed + failed
+         */
+        this.result = {
+            finished: 0,
+            passed: 0,
+            retries: 0,
+            failed: 0
+        };
+        this._messages = {
+            reporter: {},
+            debugger: {}
+        };
+    }
+    onStart() {
+        this.log(chalk_1.default.bold(`\nExecution of ${chalk_1.default.blue(this.totalWorkerCnt)} workers started at`), this._start.toISOString());
+        if (this._inDebugMode) {
+            this.log(chalk_1.default.bgYellow.black('DEBUG mode enabled!'));
+        }
+        if (this._isWatchMode) {
+            this.log(chalk_1.default.bgYellow.black('WATCH mode enabled!'));
+        }
+        this.log('');
+    }
+    onSpecRunning(rid) {
+        this.onJobComplete(rid, this._jobs.get(rid), 0, chalk_1.default.bold.cyan('RUNNING'));
+    }
+    onSpecRetry(rid, job, retries = 0) {
+        const delayMsg = this._specFileRetriesDelay > 0 ? ` after ${this._specFileRetriesDelay}s` : '';
+        this.onJobComplete(rid, job, retries, chalk_1.default.bold(chalk_1.default.yellow('RETRYING') + delayMsg));
+    }
+    onSpecPass(rid, job, retries = 0) {
+        this.onJobComplete(rid, job, retries, chalk_1.default.bold.green('PASSED'));
+    }
+    onSpecFailure(rid, job, retries = 0) {
+        this.onJobComplete(rid, job, retries, chalk_1.default.bold.red('FAILED'));
+    }
+    onSpecSkip(rid, job) {
+        this.onJobComplete(rid, job, 0, 'SKIPPED', log.info);
+    }
+    onJobComplete(cid, job, retries = 0, message = '', _logger = this.log) {
+        const details = [`[${cid}]`, message];
+        if (job) {
+            details.push('in', (0, utils_1.getRunnerName)(job.caps), this.getFilenames(job.specs));
+        }
+        if (retries > 0) {
+            details.push(`(${retries} retries)`);
+        }
+        return _logger(...details);
+    }
+    onTestError(payload) {
+        var _a, _b, _c;
+        const error = {
+            type: ((_a = payload.error) === null || _a === void 0 ? void 0 : _a.type) || 'Error',
+            message: ((_b = payload.error) === null || _b === void 0 ? void 0 : _b.message) || (typeof payload.error === 'string' ? payload.error : 'Unknown error.'),
+            stack: (_c = payload.error) === null || _c === void 0 ? void 0 : _c.stack
+        };
+        return this.log(`[${payload.cid}]`, `${chalk_1.default.red(error.type)} in "${payload.fullTitle}"\n${chalk_1.default.red(error.stack || error.message)}`);
+    }
+    getFilenames(specs = []) {
+        if (specs.length > 0) {
+            return '- ' + specs.join(', ').replace(new RegExp(`${process.cwd()}`, 'g'), '');
+        }
+        return '';
+    }
+    /**
+     * add job to interface
+     */
+    addJob({ cid, caps, specs, hasTests }) {
+        this._jobs.set(cid, { caps, specs, hasTests });
+        if (hasTests) {
+            this.onSpecRunning(cid);
+        }
+        else {
+            this._skippedSpecs++;
+        }
+    }
+    /**
+     * clear job from interface
+     */
+    clearJob({ cid, passed, retries }) {
+        const job = this._jobs.get(cid);
+        this._jobs.delete(cid);
+        const retryAttempts = this._specFileRetries - retries;
+        const retry = !passed && retries > 0;
+        if (!retry) {
+            this.result.finished++;
+        }
+        if (job && job.hasTests === false) {
+            return this.onSpecSkip(cid, job);
+        }
+        if (passed) {
+            this.result.passed++;
+            this.onSpecPass(cid, job, retryAttempts);
+        }
+        else if (retry) {
+            this.totalWorkerCnt++;
+            this.result.retries++;
+            this.onSpecRetry(cid, job, retryAttempts);
+        }
+        else {
+            this.result.failed++;
+            this.onSpecFailure(cid, job, retryAttempts);
+        }
+    }
+    /**
+     * for testing purposes call console log in a static method
+     */
+    log(...args) {
+        // eslint-disable-next-line no-console
+        console.log(...args);
+        return args;
+    }
+    logHookError(error) {
+        return this.log(`${chalk_1.default.red(error.name)} in "${error.origin}"\n${chalk_1.default.red(error.stack || error.message)}`);
+    }
+    /**
+     * event handler that is triggered when runner sends up events
+     */
+    onMessage(event) {
+        if (event.name === 'reporterRealTime') {
+            this.log(event.content);
+            return;
+        }
+        if (event.origin === 'debugger' && event.name === 'start') {
+            this.log(chalk_1.default.yellow(event.params.introMessage));
+            this._inDebugMode = true;
+            return this._inDebugMode;
+        }
+        if (event.origin === 'debugger' && event.name === 'stop') {
+            this._inDebugMode = false;
+            return this._inDebugMode;
+        }
+        if (event.name === 'testFrameworkInit') {
+            return this.emit('job:start', event.content);
+        }
+        if (!event.origin) {
+            return log.warn(`Can't identify message from worker: ${JSON.stringify(event)}, ignoring!`);
+        }
+        if (event.origin === 'worker' && event.name === 'error') {
+            return this.log(`[${event.cid}]`, chalk_1.default.white.bgRed.bold(' Error: '), event.content.message || event.content.stack || event.content);
+        }
+        if (event.origin !== 'reporter' && event.origin !== 'debugger') {
+            return this.log(event.cid, event.origin, event.name, event.content);
+        }
+        if (event.name === 'printFailureMessage') {
+            return this.onTestError(event.content);
+        }
+        if (!this._messages[event.origin][event.name]) {
+            this._messages[event.origin][event.name] = [];
+        }
+        this._messages[event.origin][event.name].push(event.content);
+        if (this._isWatchMode) {
+            this.printReporters();
+        }
+    }
+    sigintTrigger() {
+        /**
+         * allow to exit repl mode via Ctrl+C
+         */
+        if (this._inDebugMode) {
+            return false;
+        }
+        const isRunning = this._jobs.size !== 0;
+        const shutdownMessage = isRunning
+            ? 'Ending WebDriver sessions gracefully ...\n' +
+                '(press ctrl+c again to hard kill the runner)'
+            : 'Ended WebDriver sessions gracefully after a SIGINT signal was received!';
+        return this.log('\n\n' + shutdownMessage);
+    }
+    printReporters() {
+        /**
+         * print reporter output
+         */
+        const reporter = this._messages.reporter;
+        this._messages.reporter = {};
+        for (const [reporterName, messages] of Object.entries(reporter)) {
+            this.log('\n', chalk_1.default.bold.magenta(`"${reporterName}" Reporter:`));
+            this.log(messages.join(''));
+        }
+    }
+    printSummary() {
+        const totalJobs = this.totalWorkerCnt - this.result.retries;
+        const elapsed = (new Date(Date.now() - this._start.getTime())).toUTCString().match(/(\d\d:\d\d:\d\d)/)[0];
+        const retries = this.result.retries ? chalk_1.default.yellow(this.result.retries, 'retries') + ', ' : '';
+        const failed = this.result.failed ? chalk_1.default.red(this.result.failed, 'failed') + ', ' : '';
+        const skipped = this._skippedSpecs > 0 ? chalk_1.default.gray(this._skippedSpecs, 'skipped') + ', ' : '';
+        const percentCompleted = totalJobs ? Math.round(this.result.finished / totalJobs * 100) : 0;
+        return this.log('\nSpec Files:\t', chalk_1.default.green(this.result.passed, 'passed') + ', ' + retries + failed + skipped + totalJobs, 'total', `(${percentCompleted}% completed)`, 'in', elapsed, '\n');
+    }
+    finalise() {
+        if (this._isWatchMode) {
+            return;
+        }
+        this.printReporters();
+        this.printSummary();
+    }
+}
+exports.default = WDIOCLInterface;

package/build/launcher.d.ts

@@ -0,0 +1,96 @@
+import { ConfigParser } from '@wdio/config';
+import type { Options, Capabilities, Services } from '@wdio/types';
+import CLInterface from './interface';
+import { RunCommandArguments } from './types';
+interface EndMessage {
+    cid: string;
+    exitCode: number;
+    specs: string[];
+    retries: number;
+}
+declare class Launcher {
+    private _configFilePath;
+    private _args;
+    private _isWatchMode;
+    configParser: ConfigParser;
+    isMultiremote: boolean;
+    runner: Services.RunnerInstance;
+    interface: CLInterface;
+    private _exitCode;
+    private _hasTriggeredExitRoutine;
+    private _schedule;
+    private _rid;
+    private _runnerStarted;
+    private _runnerFailed;
+    private _launcher?;
+    private _resolve?;
+    constructor(_configFilePath: string, _args?: Partial<RunCommandArguments>, _isWatchMode?: boolean);
+    /**
+     * run sequence
+     * @return  {Promise}               that only gets resolves with either an exitCode or an error
+     */
+    run(): Promise<number>;
+    /**
+     * run without triggering onPrepare/onComplete hooks
+     */
+    runMode(config: Required<Options.Testrunner>, caps: Capabilities.RemoteCapabilities): Promise<number>;
+    /**
+     * Format the specs into an array of objects with files and retries
+     */
+    formatSpecs(capabilities: (Capabilities.DesiredCapabilities | Capabilities.W3CCapabilities | Capabilities.RemoteCapabilities), specFileRetries: number): {
+        files: string[];
+        retries: number;
+    }[];
+    /**
+     * run multiple single remote tests
+     * @return {Boolean} true if all specs have been run and all instances have finished
+     */
+    runSpecs(): boolean;
+    /**
+     * gets number of all running instances
+     * @return {number} number of running instances
+     */
+    getNumberOfRunningInstances(): number;
+    /**
+     * get number of total specs left to complete whole suites
+     * @return {number} specs left to complete suite
+     */
+    getNumberOfSpecsLeft(): number;
+    /**
+     * Start instance in a child process.
+     * @param  {Array} specs  Specs to run
+     * @param  {Number} cid  Capabilities ID
+     * @param  {String} rid  Runner ID override
+     * @param  {Number} retries  Number of retries remaining
+     */
+    startInstance(specs: string[], caps: Capabilities.DesiredCapabilities | Capabilities.W3CCapabilities | Capabilities.MultiRemoteCapabilities, cid: number, rid: string | undefined, retries: number): Promise<void>;
+    private _workerHookError;
+    /**
+     * generates a runner id
+     * @param  {Number} cid capability id (unique identifier for a capability)
+     * @return {String}     runner id (combination of cid and test id e.g. 0a, 0b, 1a, 1b ...)
+     */
+    getRunnerId(cid: number): string;
+    /**
+     * Close test runner process once all child processes have exited
+     * @param  {Number} cid       Capabilities ID
+     * @param  {Number} exitCode  exit code of child process
+     * @param  {Array} specs      Specs that were run
+     * @param  {Number} retries   Number or retries remaining
+     */
+    endHandler({ cid: rid, exitCode, specs, retries }: EndMessage): Promise<void>;
+    /**
+     * We need exitHandler to catch SIGINT / SIGTERM events.
+     * Make sure all started selenium sessions get closed properly and prevent
+     * having dead driver processes. To do so let the runner end its Selenium
+     * session first before killing
+     */
+    exitHandler(callback?: (value: void) => void): void | Promise<void>;
+    /**
+     * returns true if user stopped watch mode, ex with ctrl+c
+     * @returns {boolean}
+     */
+    private _isWatchModeHalted;
+}
+export default Launcher;
+//# sourceMappingURL=launcher.d.ts.map

package/build/launcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAElE,OAAO,WAAW,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAmB7C,UAAU,UAAU;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,cAAM,QAAQ;IAiBN,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,YAAY;IAlBxB,YAAY,EAAE,YAAY,CAAA;IAC1B,aAAa,EAAE,OAAO,CAAA;IACtB,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAA;IAC/B,SAAS,EAAE,WAAW,CAAA;IAEtB,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,wBAAwB,CAAQ;IACxC,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,IAAI,CAAe;IAC3B,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,aAAa,CAAI;IAEzB,OAAO,CAAC,SAAS,CAAC,CAA4B;IAC9C,OAAO,CAAC,QAAQ,CAAC,CAAU;gBAGf,eAAe,EAAE,MAAM,EACvB,KAAK,GAAE,OAAO,CAAC,mBAAmB,CAAM,EACxC,YAAY,UAAQ;IA8ChC;;;OAGG;IACG,GAAG;IA+DT;;OAEG;IACH,OAAO,CAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkEtG;;OAEG;IACH,WAAW,CAAC,YAAY,EAAE,CAAC,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC,EAAE,eAAe,EAAE,MAAM;;;;IAgBtJ;;;OAGG;IACH,QAAQ;IAmER;;;OAGG;IACH,2BAA2B;IAI3B;;;OAGG;IACH,oBAAoB;IAIpB;;;;;;OAMG;IACG,aAAa,CACf,KAAK,EAAE,MAAM,EAAE,EACf,IAAI,EAAE,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,uBAAuB,EAC5G,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,OAAO,EAAE,MAAM;IA+EnB,OAAO,CAAC,gBAAgB;IAOxB;;;;OAIG;IACH,WAAW,CAAE,GAAG,EAAE,MAAM;IAOxB;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,UAAU;IAkDnE;;;;;OAKG;IACH,WAAW,CAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,IAAI;IAc7C;;;OAGG;IACH,OAAO,CAAC,kBAAkB;CAG7B;AAED,eAAe,QAAQ,CAAA"}