@wdio/cli 7.17.0 → 7.18.0

package/build/constants.js

@@ -0,0 +1,370 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUESTIONNAIRE = exports.REGION_OPTION = exports.PROTOCOL_OPTIONS = exports.BACKEND_CHOICES = exports.SUPPORTED_PACKAGES = exports.TS_COMPILER_INSTRUCTIONS = exports.COMPILER_OPTIONS = exports.COMPILER_OPTION_ANSWERS = exports.IOS_CONFIG = exports.ANDROID_CONFIG = exports.NPM_INSTALL = exports.DEPENDENCIES_INSTALLATION_MESSAGE = exports.CONFIG_HELPER_SUCCESS_MESSAGE = exports.CONFIG_HELPER_INTRO = exports.EXCLUSIVE_SERVICES = exports.CLI_EPILOGUE = void 0;
+const utils_1 = require("./utils");
+const pkg = require('../package.json');
+exports.CLI_EPILOGUE = `Documentation: https://webdriver.io\n@wdio/cli (v${pkg.version})`;
+exports.EXCLUSIVE_SERVICES = {
+    'wdio-chromedriver-service': {
+        services: ['@wdio/selenium-standalone-service'],
+        message: '@wdio/selenium-standalone-service already includes chromedriver'
+    }
+};
+exports.CONFIG_HELPER_INTRO = `
+=========================
+WDIO Configuration Helper
+=========================
+`;
+exports.CONFIG_HELPER_SUCCESS_MESSAGE = `
+Configuration file was created successfully!
+To run your tests, execute:
+$ npx wdio run %swdio.conf.%s
+`;
+exports.DEPENDENCIES_INSTALLATION_MESSAGE = `
+To install dependencies, execute:
+%s
+`;
+exports.NPM_INSTALL = '';
+exports.ANDROID_CONFIG = {
+    platformName: 'Android',
+    automationName: 'UiAutomator2',
+    deviceName: 'Test'
+};
+exports.IOS_CONFIG = {
+    platformName: 'iOS',
+    automationName: 'XCUITest',
+    deviceName: 'iPhone Simulator'
+};
+exports.COMPILER_OPTION_ANSWERS = [
+    'Babel (https://babeljs.io/)',
+    'TypeScript (https://www.typescriptlang.org/)',
+    'No!'
+];
+exports.COMPILER_OPTIONS = {
+    babel: exports.COMPILER_OPTION_ANSWERS[0],
+    ts: exports.COMPILER_OPTION_ANSWERS[1],
+    nil: exports.COMPILER_OPTION_ANSWERS[2]
+};
+exports.TS_COMPILER_INSTRUCTIONS = `To have TypeScript support please add the following packages to your "types" list:
+{
+  "compilerOptions": {
+    "types": ["node", %s]
+  }
+}
+
+For for information on TypeScript integration check out: https://webdriver.io/docs/typescript
+`;
+/**
+ * We have to use a string hash for value because InquirerJS default values do not work if we have
+ * objects as a `value` to be stored from the user's answers.
+ */
+exports.SUPPORTED_PACKAGES = {
+    runner: [
+        { name: 'local', value: '@wdio/local-runner$--$local' }
+    ],
+    framework: [
+        { name: 'mocha', value: '@wdio/mocha-framework$--$mocha' },
+        { name: 'jasmine', value: '@wdio/jasmine-framework$--$jasmine' },
+        { name: 'cucumber', value: '@wdio/cucumber-framework$--$cucumber' }
+    ],
+    reporter: [
+        { name: 'spec', value: '@wdio/spec-reporter$--$spec' },
+        { name: 'dot', value: '@wdio/dot-reporter$--$dot' },
+        { name: 'junit', value: '@wdio/junit-reporter$--$junit' },
+        { name: 'allure', value: '@wdio/allure-reporter$--$allure' },
+        { name: 'sumologic', value: '@wdio/sumologic-reporter$--$sumologic' },
+        { name: 'concise', value: '@wdio/concise-reporter$--$concise' },
+        // external
+        { name: 'reportportal', value: 'wdio-reportportal-reporter$--$reportportal' },
+        { name: 'video', value: 'wdio-video-reporter$--$video' },
+        { name: 'json', value: 'wdio-json-reporter$--$json' },
+        { name: 'cucumber', value: 'wdio-cucumber-reporter$--$cucumber' },
+        { name: 'mochawesome', value: 'wdio-mochawesome-reporter$--$mochawesome' },
+        { name: 'timeline', value: 'wdio-timeline-reporter$--$timeline' },
+        { name: 'html', value: '@rpii/wdio-html-reporter$--$html' },
+        { name: 'markdown', value: 'carmenmitru/wdio-markdown-reporter' },
+        { name: 'delta', value: '@delta-reporter/wdio-delta-reporter-service' },
+        { name: 'tesults', value: 'wdio-tesults-reporter$--$tesults' }
+    ],
+    plugin: [
+        { name: 'wait-for', value: 'wdio-wait-for$--$wait-for' },
+        { name: 'angular-component-harnesses', value: '@badisi/wdio-harness$--$harness' }
+    ],
+    service: [
+        // inquirerjs shows list as its orderer in array
+        // put chromedriver first as it is the default option
+        { name: 'chromedriver', value: 'wdio-chromedriver-service$--$chromedriver' },
+        // internal
+        { name: 'sauce', value: '@wdio/sauce-service$--$sauce' },
+        { name: 'testingbot', value: '@wdio/testingbot-service$--$testingbot' },
+        { name: 'selenium-standalone', value: '@wdio/selenium-standalone-service$--$selenium-standalone' },
+        { name: 'devtools', value: '@wdio/devtools-service$--$devtools' },
+        { name: 'browserstack', value: '@wdio/browserstack-service$--$browserstack' },
+        { name: 'appium', value: '@wdio/appium-service$--$appium' },
+        { name: 'firefox-profile', value: '@wdio/firefox-profile-service$--$firefox-profile' },
+        { name: 'crossbrowsertesting', value: '@wdio/crossbrowsertesting-service$--$crossbrowsertesting' },
+        // external
+        { name: 'eslinter-service', value: 'wdio-eslinter-service$--$eslinter' },
+        { name: 'lambdatest', value: 'wdio-lambdatest-service$--$lambdatest' },
+        { name: 'zafira-listener', value: 'wdio-zafira-listener-service$--$zafira-listener' },
+        { name: 'reportportal', value: 'wdio-reportportal-service$--$reportportal' },
+        { name: 'docker', value: 'wdio-docker-service$--$docker' },
+        { name: 'ui5', value: 'wdio-ui5-service$--$ui5' },
+        { name: 'wiremock', value: 'wdio-wiremock-service$--$wiremock' },
+        { name: 'ng-apimock', value: 'wdio-ng-apimock-service$--ng-apimock' },
+        { name: 'slack', value: 'wdio-slack-service$--$slack' },
+        { name: 'intercept', value: 'wdio-intercept-service$--$intercept' },
+        { name: 'docker', value: 'wdio-docker-service$--$docker' },
+        { name: 'image-comparison', value: 'wdio-image-comparison-service$--$image-comparison' },
+        { name: 'novus-visual-regression', value: 'wdio-novus-visual-regression-service$--$novus-visual-regression' },
+        { name: 'rerun', value: 'wdio-rerun-service$--$rerun' },
+        { name: 'winappdriver', value: 'wdio-winappdriver-service$--$winappdriver' },
+        { name: 'ywinappdriver', value: 'wdio-ywinappdriver-service$--$ywinappdriver' },
+        { name: 'performancetotal', value: 'wdio-performancetotal-service$--$performancetotal' },
+        { name: 'cleanuptotal', value: 'wdio-cleanuptotal-service$--$cleanuptotal' },
+        { name: 'aws-device-farm', value: 'wdio-aws-device-farm-service$--$aws-device-farm' },
+        { name: 'ocr-native-apps', value: 'wdio-ocr-service$--$ocr-native-apps' },
+        { name: 'ms-teams', value: 'wdio-ms-teams-service$--$ms-teams' },
+    ]
+};
+exports.BACKEND_CHOICES = [
+    'On my local machine',
+    'In the cloud using Experitest',
+    'In the cloud using Sauce Labs',
+    'In the cloud using Browserstack or Testingbot or LambdaTest or a different service',
+    'I have my own Selenium cloud'
+];
+exports.PROTOCOL_OPTIONS = [
+    'https',
+    'http'
+];
+exports.REGION_OPTION = [
+    'us',
+    'eu',
+    'apac'
+];
+exports.QUESTIONNAIRE = [{
+        type: 'list',
+        name: 'runner',
+        message: 'Where should your tests be launched?',
+        choices: exports.SUPPORTED_PACKAGES.runner,
+        // only ask if there are more than 1 runner to pick from
+        when: /* istanbul ignore next */ () => exports.SUPPORTED_PACKAGES.runner.length > 1
+    }, {
+        type: 'list',
+        name: 'backend',
+        message: 'Where is your automation backend located?',
+        choices: exports.BACKEND_CHOICES
+    }, {
+        type: 'input',
+        name: 'hostname',
+        message: 'What is the host address of that cloud service?',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().indexOf('different service') > -1
+    }, {
+        type: 'input',
+        name: 'port',
+        message: 'What is the port on which that service is running?',
+        default: '80',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().indexOf('different service') > -1
+    }, {
+        type: 'input',
+        name: 'expEnvAccessKey',
+        message: 'Access key from Experitest Cloud',
+        default: 'EXPERITEST_ACCESS_KEY',
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Experitest'
+    }, {
+        type: 'input',
+        name: 'expEnvHostname',
+        message: 'Environment variable for cloud url',
+        default: 'example.experitest.com',
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Experitest'
+    }, {
+        type: 'input',
+        name: 'expEnvPort',
+        message: 'Environment variable for port',
+        default: '443',
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Experitest'
+    }, {
+        type: 'list',
+        name: 'expEnvProtocol',
+        message: 'Choose a protocol for environment variable',
+        default: 'https',
+        choices: exports.PROTOCOL_OPTIONS,
+        when: /* istanbul ignore next */ (answers) => {
+            return answers.backend === 'In the cloud using Experitest' && answers.expEnvPort !== '80' && answers.expEnvPort !== '443';
+        }
+    }, {
+        type: 'input',
+        name: 'env_user',
+        message: 'Environment variable for username',
+        default: 'LT_USERNAME',
+        when: /* istanbul ignore next */ (answers) => (answers.backend.toString().indexOf('LambdaTest') > -1 &&
+            answers.hostname.indexOf('lambdatest.com') > -1)
+    }, {
+        type: 'input',
+        name: 'env_key',
+        message: 'Environment variable for access key',
+        default: 'LT_ACCESS_KEY',
+        when: /* istanbul ignore next */ (answers) => (answers.backend.toString().indexOf('LambdaTest') > -1 &&
+            answers.hostname.indexOf('lambdatest.com') > -1)
+    }, {
+        type: 'input',
+        name: 'env_user',
+        message: 'Environment variable for username',
+        default: 'BROWSERSTACK_USER',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().startsWith('In the cloud using Browserstack')
+    }, {
+        type: 'input',
+        name: 'env_key',
+        message: 'Environment variable for access key',
+        default: 'BROWSERSTACK_ACCESS_KEY',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().startsWith('In the cloud using Browserstack')
+    }, {
+        type: 'input',
+        name: 'env_user',
+        message: 'Environment variable for username',
+        default: 'SAUCE_USERNAME',
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Sauce Labs'
+    }, {
+        type: 'input',
+        name: 'env_key',
+        message: 'Environment variable for access key',
+        default: 'SAUCE_ACCESS_KEY',
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Sauce Labs'
+    }, {
+        type: 'confirm',
+        name: 'headless',
+        message: 'Do you want to run your test on Sauce Headless? (https://saucelabs.com/products/web-testing/sauce-headless)',
+        default: false,
+        when: /* istanbul ignore next */ (answers) => answers.backend === 'In the cloud using Sauce Labs'
+    }, {
+        type: 'list',
+        name: 'region',
+        message: 'In which region do you want to run your Sauce Labs tests in?',
+        choices: exports.REGION_OPTION,
+        when: /* istanbul ignore next */ (answers) => !answers.headless && answers.backend === 'In the cloud using Sauce Labs'
+    }, {
+        type: 'input',
+        name: 'hostname',
+        message: 'What is the IP or URI to your Selenium standalone or grid server?',
+        default: 'localhost',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().indexOf('own Selenium cloud') > -1
+    }, {
+        type: 'input',
+        name: 'port',
+        message: 'What is the port which your Selenium standalone or grid server is running on?',
+        default: '4444',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().indexOf('own Selenium cloud') > -1
+    }, {
+        type: 'input',
+        name: 'path',
+        message: 'What is the path to your browser driver or grid server?',
+        default: '/',
+        when: /* istanbul ignore next */ (answers) => answers.backend.toString().indexOf('own Selenium cloud') > -1
+    }, {
+        type: 'list',
+        name: 'framework',
+        message: 'Which framework do you want to use?',
+        choices: exports.SUPPORTED_PACKAGES.framework,
+    }, {
+        type: 'list',
+        name: 'isUsingCompiler',
+        message: 'Do you want to use a compiler?',
+        choices: exports.COMPILER_OPTION_ANSWERS,
+        default: /* istanbul ignore next */ () => (0, utils_1.hasFile)('babel.config.js')
+            ? exports.COMPILER_OPTIONS.babel // default to Babel
+            : (0, utils_1.hasFile)('tsconfig.json')
+                ? exports.COMPILER_OPTIONS.ts // default to TypeScript
+                : exports.COMPILER_OPTIONS.nil // default to no compiler
+    }, {
+        type: 'input',
+        name: 'specs',
+        message: 'Where are your test specs located?',
+        default: (answers) => (0, utils_1.getDefaultFiles)(answers, './test/specs/**/*'),
+        when: /* istanbul ignore next */ (answers) => answers.framework.match(/(mocha|jasmine)/)
+    }, {
+        type: 'input',
+        name: 'specs',
+        message: 'Where are your feature files located?',
+        default: './features/**/*.feature',
+        when: /* istanbul ignore next */ (answers) => answers.framework.includes('cucumber')
+    }, {
+        type: 'input',
+        name: 'stepDefinitions',
+        message: 'Where are your step definitions located?',
+        default: (answers) => (0, utils_1.getDefaultFiles)(answers, './features/step-definitions/steps'),
+        when: /* istanbul ignore next */ (answers) => answers.framework.includes('cucumber')
+    }, {
+        type: 'confirm',
+        name: 'generateTestFiles',
+        message: 'Do you want WebdriverIO to autogenerate some test files?',
+        default: true
+    }, {
+        type: 'confirm',
+        name: 'usePageObjects',
+        message: 'Do you want to use page objects (https://martinfowler.com/bliki/PageObject.html)?',
+        default: true,
+        when: /* istanbul ignore next */ (answers) => answers.generateTestFiles
+    }, {
+        type: 'input',
+        name: 'pages',
+        message: 'Where are your page objects located?',
+        default: /* istanbul ignore next */ (answers) => (answers.framework.match(/(mocha|jasmine)/)
+            ? (0, utils_1.getDefaultFiles)(answers, './test/pageobjects/**/*')
+            : (0, utils_1.getDefaultFiles)(answers, './features/pageobjects/**/*')),
+        when: /* istanbul ignore next */ (answers) => answers.generateTestFiles && answers.usePageObjects
+    }, {
+        type: 'checkbox',
+        name: 'reporters',
+        message: 'Which reporter do you want to use?',
+        choices: exports.SUPPORTED_PACKAGES.reporter,
+        // @ts-ignore
+        default: [exports.SUPPORTED_PACKAGES.reporter.find(
+            /* istanbul ignore next */
+            ({ name }) => name === 'spec').value
+        ]
+    }, {
+        type: 'checkbox',
+        name: 'plugins',
+        message: 'Do you want to add a plugin to your test setup?',
+        choices: exports.SUPPORTED_PACKAGES.plugin
+    }, {
+        type: 'checkbox',
+        name: 'services',
+        message: 'Do you want to add a service to your test setup?',
+        choices: exports.SUPPORTED_PACKAGES.service,
+        // @ts-ignore
+        default: [exports.SUPPORTED_PACKAGES.service.find(
+            /* istanbul ignore next */
+            ({ name }) => name === 'chromedriver').value
+        ],
+        validate: /* istanbul ignore next */ (answers) => (0, utils_1.validateServiceAnswers)(answers)
+    }, {
+        type: 'input',
+        name: 'outputDir',
+        message: 'In which directory should the xunit reports get stored?',
+        default: './',
+        when: /* istanbul ignore next */ (answers) => answers.reporters.includes('junit')
+    }, {
+        type: 'input',
+        name: 'outputDir',
+        message: 'In which directory should the json reports get stored?',
+        default: './',
+        when: /* istanbul ignore next */ (answers) => answers.reporters.includes('json')
+    }, {
+        type: 'input',
+        name: 'outputDir',
+        message: 'In which directory should the mochawesome json reports get stored?',
+        default: './',
+        when: /* istanbul ignore next */ (answers) => answers.reporters.includes('mochawesome')
+    }, {
+        type: 'input',
+        name: 'baseUrl',
+        message: 'What is the base url?',
+        default: 'http://localhost'
+    }, {
+        type: 'confirm',
+        name: 'npmInstall',
+        message: 'Do you want me to run `npm install`',
+        default: true
+    }];

package/build/index.d.ts

@@ -0,0 +1,5 @@
+import Launcher from './launcher';
+export declare const run: () => Promise<void>;
+export default Launcher;
+export * from './types';
+//# 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":"AAKA,OAAO,QAAQ,MAAM,YAAY,CAAA;AAkBjC,eAAO,MAAM,GAAG,qBAyDf,CAAA;AAED,eAAe,QAAQ,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/build/index.js

@@ -0,0 +1,88 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const yargs_1 = __importDefault(require("yargs"));
+const launcher_1 = __importDefault(require("./launcher"));
+const run_1 = require("./commands/run");
+const constants_1 = require("./constants");
+const DEFAULT_CONFIG_FILENAME = 'wdio.conf.js';
+const DESCRIPTION = [
+    'The `wdio` command allows you run and manage your WebdriverIO test suite.',
+    'If no command is provided it calls the `run` command by default, so:',
+    '',
+    '$ wdio wdio.conf.js',
+    '',
+    'is the same as:',
+    '$ wdio run wdio.conf.js',
+    '',
+    'For more information, visit: https://webdriver.io/docs/clioptions'
+];
+const run = async () => {
+    const argv = yargs_1.default
+        .commandDir('commands')
+        .example('$0 run wdio.conf.js --suite foobar', 'Run suite on testsuite "foobar"')
+        .example('$0 run wdio.conf.js --spec ./tests/e2e/a.js --spec ./tests/e2e/b.js', 'Run suite on specific specs')
+        .example('$0 run wdio.conf.js --spec ./tests/e2e/a.feature:5', 'Run scenario by line number')
+        .example('$0 run wdio.conf.js --spec ./tests/e2e/a.feature:5:10', 'Run scenarios by line number')
+        .example('$0 run wdio.conf.js --spec ./tests/e2e/a.feature:5:10 --spec ./test/e2e/b.feature', 'Run scenarios by line number in single feature and another complete feature')
+        .example('$0 install reporter spec', 'Install @wdio/spec-reporter')
+        .example('$0 repl chrome -u <SAUCE_USERNAME> -k <SAUCE_ACCESS_KEY>', 'Run repl in Sauce Labs cloud')
+        .updateStrings({ 'Commands:': `${DESCRIPTION.join('\n')}\n\nCommands:` })
+        .epilogue(constants_1.CLI_EPILOGUE);
+    /**
+     * parse CLI arguments according to what run expects, without this adding
+     * `--spec ./test.js` results in propagating the spec parameter as a
+     * string while in reality is should be parsed into a array of strings
+     */
+    if (!process.argv.find((arg) => arg === '--help')) {
+        argv.options(run_1.cmdArgs);
+    }
+    /**
+     * The only way we reach this point is if the user runs the binary without a command (i.e. wdio wdio.conf.js)
+     * We can safely assume that if this is the case, the user is trying to execute the `run` command as it
+     * was previous to https://github.com/webdriverio/webdriverio/pull/4402
+     *
+     * Since the `run` command verifies if the configuration file exists before executing
+     * we don't have to check that again here.
+     */
+    const params = { ...argv.argv };
+    const supportedCommands = fs_1.default
+        .readdirSync(path_1.default.join(__dirname, 'commands'))
+        .map((file) => file.slice(0, -3));
+    if (params._ && !params._.find((param) => supportedCommands.includes(param))) {
+        const args = {
+            ...argv.argv,
+            configPath: path_1.default.resolve(process.cwd(), argv.argv._[0] && argv.argv._[0].toString() || DEFAULT_CONFIG_FILENAME)
+        };
+        return (0, run_1.handler)(args).catch(async (err) => {
+            const output = await new Promise((resolve) => (yargs_1.default.parse('--help', (err, argv, output) => resolve(output))));
+            console.error(`${output}\n\n${err.stack}`);
+            /* istanbul ignore if */
+            if (!process.env.JEST_WORKER_ID) {
+                process.exit(1);
+            }
+        });
+    }
+};
+exports.run = run;
+exports.default = launcher_1.default;
+__exportStar(require("./types"), exports);

package/build/interface.d.ts

@@ -0,0 +1,77 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import type { Options, Workers } from '@wdio/types';
+import { HookError } from './utils';
+interface TestError {
+    type: string;
+    message: string;
+    stack?: string;
+}
+interface CLIInterfaceEvent {
+    origin?: string;
+    name: string;
+    cid?: string;
+    fullTitle?: string;
+    content?: any;
+    params?: any;
+    error?: TestError;
+}
+export default class WDIOCLInterface extends EventEmitter {
+    private _config;
+    totalWorkerCnt: number;
+    private _isWatchMode;
+    hasAnsiSupport: boolean;
+    result: {
+        finished: number;
+        passed: number;
+        retries: number;
+        failed: number;
+    };
+    private _jobs;
+    private _specFileRetries;
+    private _specFileRetriesDelay;
+    private _skippedSpecs;
+    private _inDebugMode;
+    private _start;
+    private _messages;
+    constructor(_config: Options.Testrunner, totalWorkerCnt: number, _isWatchMode?: boolean);
+    setup(): void;
+    onStart(): void;
+    onSpecRunning(rid: string): void;
+    onSpecRetry(rid: string, job?: Workers.Job, retries?: number): void;
+    onSpecPass(rid: string, job?: Workers.Job, retries?: number): void;
+    onSpecFailure(rid: string, job?: Workers.Job, retries?: number): void;
+    onSpecSkip(rid: string, job?: Workers.Job): void;
+    onJobComplete(cid: string, job?: Workers.Job, retries?: number, message?: string, _logger?: Function): any;
+    onTestError(payload: CLIInterfaceEvent): any[];
+    getFilenames(specs?: string[]): string;
+    /**
+     * add job to interface
+     */
+    addJob({ cid, caps, specs, hasTests }: Workers.Job & {
+        cid: string;
+    }): void;
+    /**
+     * clear job from interface
+     */
+    clearJob({ cid, passed, retries }: {
+        cid: string;
+        passed: boolean;
+        retries: number;
+    }): void;
+    /**
+     * for testing purposes call console log in a static method
+     */
+    log(...args: any[]): any[];
+    logHookError(error: HookError): any[];
+    /**
+     * event handler that is triggered when runner sends up events
+     */
+    onMessage(event: CLIInterfaceEvent): boolean | void | any[];
+    sigintTrigger(): false | any[];
+    printReporters(): void;
+    printSummary(): any[];
+    finalise(): void;
+}
+export {};
+//# sourceMappingURL=interface.d.ts.map

package/build/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../src/interface.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAErC,OAAO,KAAK,EAAE,OAAO,EAAgB,OAAO,EAAE,MAAM,aAAa,CAAA;AAEjE,OAAO,EAAiB,SAAS,EAAE,MAAM,SAAS,CAAA;AAIlD,UAAU,SAAS;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,UAAU,iBAAiB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,MAAM,CAAC,EAAE,GAAG,CAAA;IACZ,KAAK,CAAC,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,YAAY;IAyBjD,OAAO,CAAC,OAAO;IACR,cAAc,EAAE,MAAM;IAC7B,OAAO,CAAC,YAAY;IA1BjB,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM;;;;;MAKZ;IAED,OAAO,CAAC,KAAK,CAAsC;IACnD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,qBAAqB,CAAQ;IAErC,OAAO,CAAC,aAAa,CAAI;IACzB,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,SAAS,CAMZ;gBAGO,OAAO,EAAE,OAAO,CAAC,UAAU,EAC5B,cAAc,EAAE,MAAM,EACrB,YAAY,UAAQ;IAuBhC,KAAK;IAqBL,OAAO;IAWP,aAAa,CAAE,GAAG,EAAE,MAAM;IAI1B,WAAW,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,SAAI;IAKxD,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,SAAI;IAIvD,aAAa,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,SAAI;IAI1D,UAAU,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG;IAI1C,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,SAAI,EAAE,OAAO,SAAK,EAAE,OAAO,GAAE,QAAmB;IAYrG,WAAW,CAAE,OAAO,EAAE,iBAAiB;IAUvC,YAAY,CAAE,KAAK,GAAE,MAAM,EAAO;IAOlC;;OAEG;IACH,MAAM,CAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC,GAAG,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IASrE;;OAEG;IACH,QAAQ,CAAE,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IA2BrF;;OAEG;IACH,GAAG,CAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAMnB,YAAY,CAAE,KAAK,EAAE,SAAS;IAI9B;;OAEG;IACH,SAAS,CAAE,KAAK,EAAE,iBAAiB;IA8CnC,aAAa;IAgBb,cAAc;IAYd,YAAY;IAaZ,QAAQ;CAQX"}