@wdio/spec-reporter 7.17.0 → 7.17.3

package/build/index.d.ts

@@ -0,0 +1,104 @@
+import WDIOReporter, { SuiteStats, HookStats, RunnerStats, TestStats } from '@wdio/reporter';
+import { Capabilities } from '@wdio/types';
+import type { Symbols, SpecReporterOptions, TestLink } from './types';
+export default class SpecReporter extends WDIOReporter {
+    private _suiteUids;
+    private _indents;
+    private _suiteIndents;
+    private _orderedSuites;
+    private _consoleOutput;
+    private _suiteIndent;
+    private _preface;
+    private _consoleLogs;
+    private _originalStdoutWrite;
+    private _addConsoleLogs;
+    private _realtimeReporting;
+    private _showPreface;
+    private _suiteName;
+    private _stateCounts;
+    private _symbols;
+    private _onlyFailures;
+    private _sauceLabsSharableLinks;
+    constructor(options: SpecReporterOptions);
+    onRunnerStart(runner: RunnerStats): void;
+    onSuiteStart(suite: SuiteStats): void;
+    onSuiteEnd(): void;
+    onHookEnd(hook: HookStats): void;
+    onTestStart(): void;
+    onTestPass(testStat: TestStats): void;
+    onTestFail(testStat: TestStats): void;
+    onTestSkip(testStat: TestStats): void;
+    onRunnerEnd(runner: RunnerStats): void;
+    /**
+     * Print the report to the stdout realtime
+     */
+    printCurrentStats(stat: TestStats | HookStats | SuiteStats): void;
+    /**
+     * Print the report to the screen
+     */
+    printReport(runner: RunnerStats): void;
+    /**
+     * get link to saucelabs job
+     */
+    getTestLink({ sessionId, isMultiremote, instanceName, capabilities }: TestLink): string[];
+    /**
+     * Get the header display for the report
+     * @param  {Object} runner Runner data
+     * @return {Array}         Header data
+     */
+    getHeaderDisplay(runner: RunnerStats): string[];
+    /**
+     * returns everything worth reporting from a suite
+     * @param  {Object}    suite  test suite containing tests and hooks
+     * @return {Object[]}         list of events to report
+     */
+    getEventsToReport(suite: SuiteStats): (HookStats | TestStats)[];
+    /**
+     * Get the results from the tests
+     * @param  {Array} suites Runner suites
+     * @return {Array}        Display output list
+     */
+    getResultDisplay(prefaceString?: string): string[];
+    /**
+     * Get the display for passing, failing and skipped
+     * @param  {String} duration Duration string
+     * @return {Array} Count display
+     */
+    getCountDisplay(duration: string): string[];
+    /**
+     * Get display for failed tests, e.g. stack trace
+     * @return {Array} Stack trace output
+     */
+    getFailureDisplay(): string[];
+    /**
+     * Get suites in the order they were called
+     * @return {Array} Ordered suites
+     */
+    getOrderedSuites(): SuiteStats[];
+    /**
+     * Indent a suite based on where how it's nested
+     * @param  {String} uid Unique suite key
+     * @return {String}     Spaces for indentation
+     */
+    indent(uid: string): string;
+    /**
+     * Get a symbol based on state
+     * @param  {String} state State of a test
+     * @return {String}       Symbol to display
+     */
+    getSymbol(state?: keyof Symbols): string;
+    /**
+     * Get a color based on a given state
+     * @param  {String} state Test state
+     * @return {String}       State color
+     */
+    getColor(state?: string): "red" | "green" | "cyan" | "gray";
+    /**
+     * Get information about the enviroment
+     * @param  {Object}  caps    Enviroment details
+     * @param  {Boolean} verbose
+     * @return {String}          Enviroment string
+     */
+    getEnviromentCombo(capability: Capabilities.RemoteCapability, verbose?: boolean, isMultiremote?: boolean): string;
+}
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAY,MAAM,gBAAgB,CAAA;AACtG,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1C,OAAO,KAAK,EAAc,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAQjF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IAClD,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,aAAa,CAA6B;IAClD,OAAO,CAAC,cAAc,CAAmB;IACzC,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,oBAAoB,CAA4C;IAExE,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,YAAY,CAAO;IAC3B,OAAO,CAAC,UAAU,CAAK;IAEvB,OAAO,CAAC,YAAY,CAInB;IAED,OAAO,CAAC,QAAQ,CAKf;IAED,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,uBAAuB,CAAO;gBAEzB,OAAO,EAAE,mBAAmB;IAyBzC,aAAa,CAAE,MAAM,EAAE,WAAW;IAIlC,YAAY,CAAE,KAAK,EAAE,UAAU;IAY/B,UAAU;IAIV,SAAS,CAAE,IAAI,EAAE,SAAS;IAO1B,WAAW;IAIX,UAAU,CAAE,QAAQ,EAAE,SAAS;IAM/B,UAAU,CAAE,QAAQ,EAAE,SAAS;IAM/B,UAAU,CAAE,QAAQ,EAAE,SAAS;IAM/B,WAAW,CAAE,MAAM,EAAE,WAAW;IAIhC;;OAEG;IACH,iBAAiB,CAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU;IA+B3D;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,WAAW;IAkD/B;;OAEG;IACH,WAAW,CAAE,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE,QAAQ;IA2C/E;;;;OAIG;IACH,gBAAgB,CAAE,MAAM,EAAE,WAAW;IAkBrC;;;;OAIG;IACH,iBAAiB,CAAE,KAAK,EAAE,UAAU;IAYpC;;;;OAIG;IACH,gBAAgB,CAAE,aAAa,CAAC,EAAE,MAAM;IAyExC;;;;OAIG;IACH,eAAe,CAAE,QAAQ,EAAE,MAAM;IA0BjC;;;OAGG;IACH,iBAAiB;IAmCjB;;;OAGG;IACH,gBAAgB;IAmBhB;;;;OAIG;IACH,MAAM,CAAE,GAAG,EAAE,MAAM;IAKnB;;;;OAIG;IACH,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,OAAO;IAIhC;;;;OAIG;IACH,QAAQ,CAAE,KAAK,CAAC,EAAE,MAAM;IAoBxB;;;;;OAKG;IACH,kBAAkB,CAAE,UAAU,EAAE,YAAY,CAAC,gBAAgB,EAAE,OAAO,UAAO,EAAE,aAAa,UAAQ;CA6CvG"}

package/build/index.js

@@ -0,0 +1,477 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("util");
+const reporter_1 = __importDefault(require("@wdio/reporter"));
+const chalk_1 = __importDefault(require("chalk"));
+const pretty_ms_1 = __importDefault(require("pretty-ms"));
+const utils_1 = require("./utils");
+const DEFAULT_INDENT = '   ';
+class SpecReporter extends reporter_1.default {
+    constructor(options) {
+        /**
+         * make spec reporter to write to output stream by default
+         */
+        super(Object.assign({ stdout: true }, options));
+        this._suiteUids = new Set();
+        this._indents = 0;
+        this._suiteIndents = {};
+        this._orderedSuites = [];
+        this._consoleOutput = '';
+        this._suiteIndent = '';
+        this._preface = '';
+        this._consoleLogs = [];
+        this._originalStdoutWrite = process.stdout.write.bind(process.stdout);
+        this._addConsoleLogs = false;
+        this._realtimeReporting = false;
+        this._showPreface = true;
+        this._suiteName = '';
+        // Keep track of the order that suites were called
+        this._stateCounts = {
+            passed: 0,
+            failed: 0,
+            skipped: 0
+        };
+        this._symbols = {
+            passed: '✓',
+            skipped: '-',
+            pending: '?',
+            failed: '✖'
+        };
+        this._onlyFailures = false;
+        this._sauceLabsSharableLinks = true;
+        this._symbols = { ...this._symbols, ...this.options.symbols || {} };
+        this._onlyFailures = options.onlyFailures || false;
+        this._realtimeReporting = options.realtimeReporting || false;
+        this._showPreface = options.showPreface !== false;
+        this._sauceLabsSharableLinks = 'sauceLabsSharableLinks' in options
+            ? options.sauceLabsSharableLinks
+            : this._sauceLabsSharableLinks;
+        let processObj = process;
+        if (options.addConsoleLogs || this._addConsoleLogs) {
+            processObj.stdout.write = (chunk, encoding, callback) => {
+                if (typeof chunk === 'string' && !chunk.includes('mwebdriver')) {
+                    this._consoleOutput += chunk;
+                }
+                return this._originalStdoutWrite(chunk, encoding, callback);
+            };
+        }
+    }
+    onRunnerStart(runner) {
+        this._preface = this._showPreface ? `[${this.getEnviromentCombo(runner.capabilities, false, runner.isMultiremote).trim()} #${runner.cid}]` : '';
+    }
+    onSuiteStart(suite) {
+        this._suiteName = suite.file.replace(process.cwd(), '');
+        this.printCurrentStats(suite);
+        this._suiteUids.add(suite.uid);
+        if (suite.type === 'feature') {
+            this._indents = 0;
+            this._suiteIndents[suite.uid] = this._indents;
+        }
+        else {
+            this._suiteIndents[suite.uid] = ++this._indents;
+        }
+    }
+    onSuiteEnd() {
+        this._indents--;
+    }
+    onHookEnd(hook) {
+        this.printCurrentStats(hook);
+        if (hook.error) {
+            this._stateCounts.failed++;
+        }
+    }
+    onTestStart() {
+        this._consoleOutput = '';
+    }
+    onTestPass(testStat) {
+        this.printCurrentStats(testStat);
+        this._consoleLogs.push(this._consoleOutput);
+        this._stateCounts.passed++;
+    }
+    onTestFail(testStat) {
+        this.printCurrentStats(testStat);
+        this._consoleLogs.push(this._consoleOutput);
+        this._stateCounts.failed++;
+    }
+    onTestSkip(testStat) {
+        this.printCurrentStats(testStat);
+        this._consoleLogs.push(this._consoleOutput);
+        this._stateCounts.skipped++;
+    }
+    onRunnerEnd(runner) {
+        this.printReport(runner);
+    }
+    /**
+     * Print the report to the stdout realtime
+     */
+    printCurrentStats(stat) {
+        if (!this._realtimeReporting) {
+            return;
+        }
+        const title = stat.title, state = stat.state;
+        const divider = '------------------------------------------------------------------';
+        const indent = (stat.type === 'test') ?
+            `${DEFAULT_INDENT}${this._suiteIndent}` :
+            this.indent(stat.uid);
+        const suiteStartBanner = (stat.type === 'feature' || stat.type === 'suite' || stat.type === 'suite:start') ?
+            `${this._preface} ${divider}\n` +
+                `${this._preface} Suite started : \n` +
+                `${this._preface}   » ${this._suiteName}\n` : '\n';
+        const contentNonTest = stat.type !== 'hook' ?
+            `${suiteStartBanner}${this._preface} ${title}` :
+            `${this._preface} Hook executed : ${title}`;
+        const contentTest = `${this._preface} ${indent}` +
+            `${chalk_1.default[this.getColor(state)](this.getSymbol(state))} ${title}` +
+            ` » ${chalk_1.default[this.getColor(state)]('[')} ${this._suiteName} ${chalk_1.default[this.getColor(state)](']')}`;
+        process.send({
+            name: 'reporterRealTime',
+            content: stat.type === 'test' ? contentTest : contentNonTest
+        });
+    }
+    /**
+     * Print the report to the screen
+     */
+    printReport(runner) {
+        // Don't print non failed tests
+        if (runner.failures === 0 && this._onlyFailures === true) {
+            return;
+        }
+        const duration = `(${(0, pretty_ms_1.default)(runner._duration)})`;
+        const preface = `[${this.getEnviromentCombo(runner.capabilities, false, runner.isMultiremote).trim()} #${runner.cid}]`;
+        const divider = '------------------------------------------------------------------';
+        // Get the results
+        const results = this.getResultDisplay(preface);
+        // If there are no test results then return nothing
+        if (results.length === 0) {
+            return;
+        }
+        const testLinks = runner.isMultiremote
+            ? Object.entries(runner.capabilities).map(([instanceName, capabilities]) => this.getTestLink({
+                capabilities,
+                sessionId: capabilities.sessionId,
+                isMultiremote: runner.isMultiremote,
+                instanceName
+            })).filter((links) => links.length)
+            : this.getTestLink(runner);
+        const output = [
+            ...this.getHeaderDisplay(runner),
+            '',
+            ...results,
+            ...this.getCountDisplay(duration),
+            ...this.getFailureDisplay(),
+            ...(testLinks.length
+                /**
+                 * if we have test links add an empty line
+                 */
+                ? ['', ...testLinks]
+                : [])
+        ];
+        // Prefix all values with the browser information
+        const prefacedOutput = this._showPreface ? output.map((value) => {
+            return value ? `${preface} ${value}` : preface;
+        }) : output;
+        // Output the results
+        this.write(`${divider}\n${prefacedOutput.join('\n')}\n`);
+    }
+    /**
+     * get link to saucelabs job
+     */
+    getTestLink({ sessionId, isMultiremote, instanceName, capabilities }) {
+        var _a, _b, _c;
+        const config = this.runnerStat && this.runnerStat.instanceOptions[sessionId];
+        const isSauceJob = ((config && config.hostname && config.hostname.includes('saucelabs')) ||
+            // only show if multiremote is not used
+            capabilities && (
+            // check w3c cap in jsonwp caps
+            capabilities['sauce:options'] ||
+                // check jsonwp caps
+                capabilities.tunnelIdentifier ||
+                // check w3c caps
+                (capabilities.alwaysMatch &&
+                    capabilities.alwaysMatch['sauce:options'])));
+        if (isSauceJob && config && config.user && config.key && sessionId) {
+            const multiremoteNote = isMultiremote ? ` ${instanceName}` : '';
+            const note = 'Check out%s job at %s';
+            // The report url of RDC is in the caps that are returned
+            if ('testobject_test_report_url' in capabilities) {
+                return [(0, util_1.format)(note, multiremoteNote, capabilities.testobject_test_report_url)];
+            }
+            // VDC urls can be constructed / be made shared
+            const isUSEast = config.headless || ((_a = config.hostname) === null || _a === void 0 ? void 0 : _a.includes('us-east-1'));
+            const isEUCentral = ['eu', 'eu-central-1'].includes((config === null || config === void 0 ? void 0 : config.region) || '') || ((_b = config.hostname) === null || _b === void 0 ? void 0 : _b.includes('eu-central'));
+            const isAPAC = ['apac', 'apac-southeast-1'].includes((config === null || config === void 0 ? void 0 : config.region) || '') || ((_c = config.hostname) === null || _c === void 0 ? void 0 : _c.includes('apac'));
+            const dc = isUSEast ? '.us-east-1' : isEUCentral ? '.eu-central-1' : isAPAC ? '.apac-southeast-1' : '';
+            const sauceLabsSharableLinks = this._sauceLabsSharableLinks
+                ? (0, utils_1.sauceAuthenticationToken)(config.user, config.key, sessionId)
+                : '';
+            const sauceUrl = `https://app${dc}.saucelabs.com/tests/${sessionId}${sauceLabsSharableLinks}`;
+            return [(0, util_1.format)(note, multiremoteNote, sauceUrl)];
+        }
+        return [];
+    }
+    /**
+     * Get the header display for the report
+     * @param  {Object} runner Runner data
+     * @return {Array}         Header data
+     */
+    getHeaderDisplay(runner) {
+        const combo = this.getEnviromentCombo(runner.capabilities, undefined, runner.isMultiremote).trim();
+        // Spec file name and enviroment information
+        const output = [`Running: ${combo}`];
+        /**
+         * print session ID if not multiremote
+         */
+        // @ts-expect-error
+        if (runner.capabilities.sessionId) {
+            // @ts-expect-error
+            output.push(`Session ID: ${runner.capabilities.sessionId}`);
+        }
+        return output;
+    }
+    /**
+     * returns everything worth reporting from a suite
+     * @param  {Object}    suite  test suite containing tests and hooks
+     * @return {Object[]}         list of events to report
+     */
+    getEventsToReport(suite) {
+        return [
+            /**
+             * report all tests and only hooks that failed
+             */
+            ...suite.hooksAndTests
+                .filter((item) => {
+                return item.type === 'test' || Boolean(item.error);
+            })
+        ];
+    }
+    /**
+     * Get the results from the tests
+     * @param  {Array} suites Runner suites
+     * @return {Array}        Display output list
+     */
+    getResultDisplay(prefaceString) {
+        const output = [];
+        const preface = this._showPreface ? prefaceString : '';
+        const suites = this.getOrderedSuites();
+        const specFileReferences = [];
+        for (const suite of suites) {
+            // Don't do anything if a suite has no tests or sub suites
+            if (suite.tests.length === 0 && suite.suites.length === 0 && suite.hooks.length === 0) {
+                continue;
+            }
+            // Get the indent/starting point for this suite
+            const suiteIndent = this.indent(suite.uid);
+            // Display file path of spec
+            if (!specFileReferences.includes(suite.file)) {
+                output.push(`${suiteIndent}» ${suite.file.replace(process.cwd(), '')}`);
+                specFileReferences.push(suite.file);
+            }
+            // Display the title of the suite
+            output.push(`${suiteIndent}${suite.title}`);
+            // display suite description (Cucumber only)
+            if (suite.description) {
+                output.push(...suite.description.trim().split('\n')
+                    .map((l) => `${suiteIndent}${chalk_1.default.grey(l.trim())}`));
+                output.push(''); // empty line
+            }
+            // display suite rule (Cucumber only)
+            if (suite.rule) {
+                output.push(...suite.rule.trim().split('\n')
+                    .map((l) => `${suiteIndent}${chalk_1.default.grey(l.trim())}`));
+            }
+            const eventsToReport = this.getEventsToReport(suite);
+            for (const test of eventsToReport) {
+                const testTitle = test.title;
+                const state = test.state;
+                const testIndent = `${DEFAULT_INDENT}${suiteIndent}`;
+                // Output for a single test
+                output.push(`${testIndent}${chalk_1.default[this.getColor(state)](this.getSymbol(state))} ${testTitle}`);
+                // print cucumber data table cells
+                const args = test.argument;
+                if (args && args.rows && args.rows.length) {
+                    const data = (0, utils_1.buildTableData)(args.rows);
+                    const rawTable = (0, utils_1.printTable)(data);
+                    const table = (0, utils_1.getFormattedRows)(rawTable, testIndent);
+                    output.push(...table);
+                }
+                // print console output
+                const logItem = this._consoleLogs.shift();
+                if (logItem) {
+                    output.push('');
+                    output.push(testIndent.repeat(2) + '.........Console Logs.........');
+                    output.push(testIndent.repeat(3) + (logItem === null || logItem === void 0 ? void 0 : logItem.replace(/\n/g, '\n'.concat(preface + ' ', testIndent.repeat(3)))));
+                }
+            }
+            // Put a line break after each suite (only if tests exist in that suite)
+            if (eventsToReport.length) {
+                output.push('');
+            }
+        }
+        return output;
+    }
+    /**
+     * Get the display for passing, failing and skipped
+     * @param  {String} duration Duration string
+     * @return {Array} Count display
+     */
+    getCountDisplay(duration) {
+        const output = [];
+        // Get the passes
+        if (this._stateCounts.passed > 0) {
+            const text = `${this._stateCounts.passed} passing ${duration}`;
+            output.push(chalk_1.default[this.getColor('passed')](text));
+            duration = '';
+        }
+        // Get the failures
+        if (this._stateCounts.failed > 0) {
+            const text = `${this._stateCounts.failed} failing ${duration}`.trim();
+            output.push(chalk_1.default[this.getColor('failed')](text));
+            duration = '';
+        }
+        // Get the skipped tests
+        if (this._stateCounts.skipped > 0) {
+            const text = `${this._stateCounts.skipped} skipped ${duration}`.trim();
+            output.push(chalk_1.default[this.getColor('skipped')](text));
+        }
+        return output;
+    }
+    /**
+     * Get display for failed tests, e.g. stack trace
+     * @return {Array} Stack trace output
+     */
+    getFailureDisplay() {
+        var _a;
+        let failureLength = 0;
+        const output = [];
+        const suites = this.getOrderedSuites();
+        for (const suite of suites) {
+            const suiteTitle = suite.title;
+            const eventsToReport = this.getEventsToReport(suite);
+            for (const test of eventsToReport) {
+                if (test.state !== 'failed') {
+                    continue;
+                }
+                const testTitle = test.title;
+                const errors = test.errors || (test.error ? [test.error] : []);
+                // If we get here then there is a failed test
+                output.push('', `${++failureLength}) ${suiteTitle} ${testTitle}`);
+                for (const error of errors) {
+                    !((_a = error === null || error === void 0 ? void 0 : error.stack) === null || _a === void 0 ? void 0 : _a.includes('new AssertionError'))
+                        ? output.push(chalk_1.default.red(error.message))
+                        : output.push(...error.message.split('\n'));
+                    if (error.stack) {
+                        output.push(...error.stack.split(/\n/g).map(value => chalk_1.default.gray(value)));
+                    }
+                }
+            }
+        }
+        return output;
+    }
+    /**
+     * Get suites in the order they were called
+     * @return {Array} Ordered suites
+     */
+    getOrderedSuites() {
+        if (this._orderedSuites.length) {
+            return this._orderedSuites;
+        }
+        this._orderedSuites = [];
+        for (const uid of this._suiteUids) {
+            for (const [suiteUid, suite] of Object.entries(this.suites)) {
+                if (suiteUid !== uid) {
+                    continue;
+                }
+                this._orderedSuites.push(suite);
+            }
+        }
+        return this._orderedSuites;
+    }
+    /**
+     * Indent a suite based on where how it's nested
+     * @param  {String} uid Unique suite key
+     * @return {String}     Spaces for indentation
+     */
+    indent(uid) {
+        const indents = this._suiteIndents[uid];
+        return indents === 0 ? '' : Array(indents).join('    ');
+    }
+    /**
+     * Get a symbol based on state
+     * @param  {String} state State of a test
+     * @return {String}       Symbol to display
+     */
+    getSymbol(state) {
+        return (state && this._symbols[state]) || '?';
+    }
+    /**
+     * Get a color based on a given state
+     * @param  {String} state Test state
+     * @return {String}       State color
+     */
+    getColor(state) {
+        // In case of an unknown state
+        let color = 'gray';
+        switch (state) {
+            case 'passed':
+                color = 'green';
+                break;
+            case 'pending':
+            case 'skipped':
+                color = 'cyan';
+                break;
+            case 'failed':
+                color = 'red';
+                break;
+        }
+        return color;
+    }
+    /**
+     * Get information about the enviroment
+     * @param  {Object}  caps    Enviroment details
+     * @param  {Boolean} verbose
+     * @return {String}          Enviroment string
+     */
+    getEnviromentCombo(capability, verbose = true, isMultiremote = false) {
+        const caps = (capability.alwaysMatch ||
+            capability);
+        const device = caps.deviceName;
+        const browser = isMultiremote ? 'MultiremoteBrowser' : (caps.browserName || caps.browser);
+        /**
+         * fallback to different capability types:
+         * browserVersion: W3C format
+         * version: JSONWP format
+         * platformVersion: mobile format
+         * browser_version: invalid BS capability
+         */
+        const version = caps.browserVersion || caps.version || caps.platformVersion || caps.browser_version;
+        /**
+         * fallback to different capability types:
+         * platformName: W3C format
+         * platform: JSONWP format
+         * os, os_version: invalid BS capability
+         */
+        const platform = isMultiremote
+            ? ''
+            : caps.platformName || caps.platform || (caps.os ? caps.os + (caps.os_version ? ` ${caps.os_version}` : '') : '(unknown)');
+        // Mobile capabilities
+        if (device) {
+            const program = (caps.app || '').replace('sauce-storage:', '') || caps.browserName;
+            const executing = program ? `executing ${program}` : '';
+            if (!verbose) {
+                return `${device} ${platform} ${version}`;
+            }
+            return `${device} on ${platform} ${version} ${executing}`.trim();
+        }
+        if (!verbose) {
+            return (browser + (version ? ` ${version} ` : ' ') + (platform)).trim();
+        }
+        if (isMultiremote) {
+            return browser + (version ? ` (v${version})` : '') + ` on ${Object.values(capability).map((c) => c.browserName).join(', ')}`;
+        }
+        return browser + (version ? ` (v${version})` : '') + (` on ${platform}`);
+    }
+}
+exports.default = SpecReporter;

package/build/types.d.ts

@@ -0,0 +1,61 @@
+import { Capabilities } from '@wdio/types';
+export interface StateCount {
+    passed: number;
+    failed: number;
+    skipped: number;
+}
+export interface Symbols {
+    passed: string;
+    skipped: string;
+    pending: string;
+    failed: string;
+}
+export interface SpecReporterOptions {
+    /**
+     * Be default the test results in Sauce Labs can only be viewed by a team member from the same team, not by a team
+     * member from a different team. This options will enable
+     * [sharable links](https://wiki.saucelabs.com/display/DOCS/Building+Sharable+Links+to+Test+Results)
+     * by default, which means that all tests that are executed in Sauce Labs can be viewed by everybody.
+     * Adding `sauceLabsSharableLinks: false`, in the reporter options will disable this feature.
+     *
+     * @default: true
+     */
+    sauceLabsSharableLinks?: boolean;
+    /**
+     * Provide custom symbols for `passed`, `failed` and or `skipped` tests
+     *
+     * @default: {passed: '✓', skipped: '-', failed: '✖'}
+     */
+    symbols?: Partial<Symbols>;
+    /**
+     * Ability to show only failed specs results
+     *
+     * @default: false
+     */
+    onlyFailures?: boolean;
+    /**
+     * Ability to show console logs from steps in report
+     *
+     * @default: false
+     */
+    addConsoleLogs?: boolean;
+    /**
+     * Ability to show test status realtime
+     *
+     * @default: `false`
+     */
+    realtimeReporting?: boolean;
+    /**
+     * Ability to show or hide preface on each line of the report ('[MultiRemote ...]')
+     *
+     * @default: `true`
+     */
+    showPreface?: boolean;
+}
+export interface TestLink {
+    capabilities: Capabilities.RemoteCapability;
+    sessionId: string;
+    isMultiremote: boolean;
+    instanceName?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,OAAO;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,mBAAmB;IAChC;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACF,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;OAIG;IACF,WAAW,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,QAAQ;IACrB,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAA;IAC3C,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB"}

package/build/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * transform cucumber table to format suitable for `easy-table`
+ * @param   {object[]} rows cucumber table rows
+ * @returns {object[]}
+ */
+export declare const buildTableData: (rows: any) => any;
+/**
+ * returns table in string format
+ * @param   {object[]} data table data
+ * @returns {string}
+ */
+export declare const printTable: (data: any) => string;
+/**
+ * add indentation
+ * @param {string} table printed table
+ * @param {string} testIndent whitespaces
+ */
+export declare const getFormattedRows: (table: string, testIndent: string) => string[];
+/**
+ * Get Sauce Labs Authentication url
+ * @param {string} user
+ * @param {string} key
+ * @param {string} sessionId
+ */
+export declare const sauceAuthenticationToken: (user: string, key: string, sessionId: string) => string;
+//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,cAAc,SAAU,GAAG,QAMtC,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,SAAU,GAAG,WAGlC,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,UAAW,MAAM,cAAc,MAAM,aACuB,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,SAAS,MAAM,OAAM,MAAM,aAAY,MAAM,WAajF,CAAA"}

package/build/utils.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sauceAuthenticationToken = exports.getFormattedRows = exports.printTable = exports.buildTableData = void 0;
+const easy_table_1 = __importDefault(require("easy-table"));
+const Crypto = __importStar(require("crypto"));
+const SEPARATOR = '│';
+/**
+ * transform cucumber table to format suitable for `easy-table`
+ * @param   {object[]} rows cucumber table rows
+ * @returns {object[]}
+ */
+const buildTableData = (rows) => rows.map((row) => {
+    const tableRow = {};
+    [...row.cells, ''].forEach((cell, idx) => {
+        tableRow[idx] = (idx === 0 ? `${SEPARATOR} ` : '') + cell;
+    });
+    return tableRow;
+});
+exports.buildTableData = buildTableData;
+/**
+ * returns table in string format
+ * @param   {object[]} data table data
+ * @returns {string}
+ */
+const printTable = (data) => easy_table_1.default.print(data, undefined, (table) => {
+    table.separator = ` ${SEPARATOR} `;
+    return table.print();
+});
+exports.printTable = printTable;
+/**
+ * add indentation
+ * @param {string} table printed table
+ * @param {string} testIndent whitespaces
+ */
+const getFormattedRows = (table, testIndent) => table.split('\n').filter(Boolean).map((line) => `${testIndent}  ${line}`.trimRight());
+exports.getFormattedRows = getFormattedRows;
+/**
+ * Get Sauce Labs Authentication url
+ * @param {string} user
+ * @param {string} key
+ * @param {string} sessionId
+ */
+const sauceAuthenticationToken = (user, key, sessionId) => {
+    const secret = `${user}:${key}`;
+    // Create the token
+    const token = Crypto
+        // Calling createHmac method
+        .createHmac('md5', secret)
+        // Update data
+        .update(sessionId)
+        // Encoding to be used
+        .digest('hex');
+    return `?auth=${token}`;
+};
+exports.sauceAuthenticationToken = sauceAuthenticationToken;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/spec-reporter",
-  "version": "7.17.0",
+  "version": "7.17.3",
   "description": "A WebdriverIO plugin to report in spec style",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-spec-reporter",
@@ -23,8 +23,8 @@
   },
   "dependencies": {
     "@types/easy-table": "^0.0.33",
-    "@wdio/reporter": "7.16.14",
-    "@wdio/types": "7.16.14",
+    "@wdio/reporter": "7.17.3",
+    "@wdio/types": "7.17.3",
     "chalk": "^4.0.0",
     "easy-table": "^1.1.1",
     "pretty-ms": "^7.0.0"
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e18d2cde6ff979758830bdff4c3bc82ca9818b24"
+  "gitHead": "2bcb589dbdd10ca181f301a269b4dd158faab257"
 }