@wdio/cli 7.17.0 → 7.17.3

package/build/commands/run.d.ts

@@ -0,0 +1,172 @@
+import { RunCommandArguments } from '../types';
+import yargs from 'yargs';
+export declare const command = "run <configPath>";
+export declare const desc = "Run your WDIO configuration file to initialize your tests. (default)";
+export declare const cmdArgs: {
+    readonly watch: {
+        readonly desc: "Run WebdriverIO in watch mode";
+        readonly type: "boolean";
+    };
+    readonly hostname: {
+        readonly alias: "h";
+        readonly desc: "automation driver host address";
+        readonly type: "string";
+    };
+    readonly port: {
+        readonly alias: "p";
+        readonly desc: "automation driver port";
+        readonly type: "number";
+    };
+    readonly path: {
+        readonly type: "string";
+        readonly desc: "path to WebDriver endpoints (default \"/\")";
+    };
+    readonly user: {
+        readonly alias: "u";
+        readonly desc: "username if using a cloud service as automation backend";
+        readonly type: "string";
+    };
+    readonly key: {
+        readonly alias: "k";
+        readonly desc: "corresponding access key to the user";
+        readonly type: "string";
+    };
+    readonly logLevel: {
+        readonly alias: "l";
+        readonly desc: "level of logging verbosity";
+        readonly choices: readonly ["trace", "debug", "info", "warn", "error", "silent"];
+    };
+    readonly bail: {
+        readonly desc: "stop test runner after specific amount of tests have failed";
+        readonly type: "number";
+    };
+    readonly baseUrl: {
+        readonly desc: "shorten url command calls by setting a base url";
+        readonly type: "string";
+    };
+    readonly waitforTimeout: {
+        readonly alias: "w";
+        readonly desc: "timeout for all waitForXXX commands";
+        readonly type: "number";
+    };
+    readonly framework: {
+        readonly alias: "f";
+        readonly desc: "defines the framework (Mocha, Jasmine or Cucumber) to run the specs";
+        readonly type: "string";
+    };
+    readonly reporters: {
+        readonly alias: "r";
+        readonly desc: "reporters to print out the results on stdout";
+        readonly type: "array";
+    };
+    readonly suite: {
+        readonly desc: "overwrites the specs attribute and runs the defined suite";
+        readonly type: "array";
+    };
+    readonly spec: {
+        readonly desc: "run only a certain spec file - overrides specs piped from stdin";
+        readonly type: "array";
+    };
+    readonly exclude: {
+        readonly desc: "exclude certain spec file from the test run - overrides exclude piped from stdin";
+        readonly type: "array";
+    };
+    readonly mochaOpts: {
+        readonly desc: "Mocha options";
+    };
+    readonly jasmineOpts: {
+        readonly desc: "Jasmine options";
+    };
+    readonly cucumberOpts: {
+        readonly desc: "Cucumber options";
+    };
+    readonly autoCompileOpts: {
+        readonly desc: "Auto compilation options";
+    };
+};
+export declare const builder: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{}, "framework" | "reporters" | "hostname" | "port" | "path" | "baseUrl" | "exclude" | "user" | "key" | "logLevel" | "spec" | "waitforTimeout" | "watch" | "bail" | "suite" | "mochaOpts" | "jasmineOpts" | "cucumberOpts" | "autoCompileOpts"> & yargs.InferredOptionTypes<{
+    readonly watch: {
+        readonly desc: "Run WebdriverIO in watch mode";
+        readonly type: "boolean";
+    };
+    readonly hostname: {
+        readonly alias: "h";
+        readonly desc: "automation driver host address";
+        readonly type: "string";
+    };
+    readonly port: {
+        readonly alias: "p";
+        readonly desc: "automation driver port";
+        readonly type: "number";
+    };
+    readonly path: {
+        readonly type: "string";
+        readonly desc: "path to WebDriver endpoints (default \"/\")";
+    };
+    readonly user: {
+        readonly alias: "u";
+        readonly desc: "username if using a cloud service as automation backend";
+        readonly type: "string";
+    };
+    readonly key: {
+        readonly alias: "k";
+        readonly desc: "corresponding access key to the user";
+        readonly type: "string";
+    };
+    readonly logLevel: {
+        readonly alias: "l";
+        readonly desc: "level of logging verbosity";
+        readonly choices: readonly ["trace", "debug", "info", "warn", "error", "silent"];
+    };
+    readonly bail: {
+        readonly desc: "stop test runner after specific amount of tests have failed";
+        readonly type: "number";
+    };
+    readonly baseUrl: {
+        readonly desc: "shorten url command calls by setting a base url";
+        readonly type: "string";
+    };
+    readonly waitforTimeout: {
+        readonly alias: "w";
+        readonly desc: "timeout for all waitForXXX commands";
+        readonly type: "number";
+    };
+    readonly framework: {
+        readonly alias: "f";
+        readonly desc: "defines the framework (Mocha, Jasmine or Cucumber) to run the specs";
+        readonly type: "string";
+    };
+    readonly reporters: {
+        readonly alias: "r";
+        readonly desc: "reporters to print out the results on stdout";
+        readonly type: "array";
+    };
+    readonly suite: {
+        readonly desc: "overwrites the specs attribute and runs the defined suite";
+        readonly type: "array";
+    };
+    readonly spec: {
+        readonly desc: "run only a certain spec file - overrides specs piped from stdin";
+        readonly type: "array";
+    };
+    readonly exclude: {
+        readonly desc: "exclude certain spec file from the test run - overrides exclude piped from stdin";
+        readonly type: "array";
+    };
+    readonly mochaOpts: {
+        readonly desc: "Mocha options";
+    };
+    readonly jasmineOpts: {
+        readonly desc: "Jasmine options";
+    };
+    readonly cucumberOpts: {
+        readonly desc: "Cucumber options";
+    };
+    readonly autoCompileOpts: {
+        readonly desc: "Auto compilation options";
+    };
+}>>;
+export declare function launchWithStdin(wdioConfPath: string, params: Partial<RunCommandArguments>): void;
+export declare function launch(wdioConfPath: string, params: Partial<RunCommandArguments>): Promise<void>;
+export declare function handler(argv: RunCommandArguments): Promise<void>;
+//# sourceMappingURL=run.d.ts.map

package/build/commands/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAK9C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,eAAO,MAAM,OAAO,qBAAqB,CAAA;AAEzC,eAAO,MAAM,IAAI,yEAAyE,CAAA;AAE1F,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiFV,CAAA;AAEV,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAUnB,CAAA;AAED,wBAAgB,eAAe,CAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,QAc1F;AAED,wBAAgB,MAAM,CAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,iBAgBjF;AAED,wBAAsB,OAAO,CAAE,IAAI,EAAE,mBAAmB,iBAkCvD"}

package/build/commands/run.js

@@ -0,0 +1,172 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.launch = exports.launchWithStdin = exports.builder = exports.cmdArgs = exports.desc = exports.command = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const config_1 = require("./config");
+const launcher_1 = __importDefault(require("../launcher"));
+const watcher_1 = __importDefault(require("../watcher"));
+const constants_1 = require("../constants");
+exports.command = 'run <configPath>';
+exports.desc = 'Run your WDIO configuration file to initialize your tests. (default)';
+exports.cmdArgs = {
+    watch: {
+        desc: 'Run WebdriverIO in watch mode',
+        type: 'boolean',
+    },
+    hostname: {
+        alias: 'h',
+        desc: 'automation driver host address',
+        type: 'string'
+    },
+    port: {
+        alias: 'p',
+        desc: 'automation driver port',
+        type: 'number'
+    },
+    path: {
+        type: 'string',
+        desc: 'path to WebDriver endpoints (default "/")'
+    },
+    user: {
+        alias: 'u',
+        desc: 'username if using a cloud service as automation backend',
+        type: 'string'
+    },
+    key: {
+        alias: 'k',
+        desc: 'corresponding access key to the user',
+        type: 'string'
+    },
+    logLevel: {
+        alias: 'l',
+        desc: 'level of logging verbosity',
+        choices: ['trace', 'debug', 'info', 'warn', 'error', 'silent']
+    },
+    bail: {
+        desc: 'stop test runner after specific amount of tests have failed',
+        type: 'number'
+    },
+    baseUrl: {
+        desc: 'shorten url command calls by setting a base url',
+        type: 'string'
+    },
+    waitforTimeout: {
+        alias: 'w',
+        desc: 'timeout for all waitForXXX commands',
+        type: 'number'
+    },
+    framework: {
+        alias: 'f',
+        desc: 'defines the framework (Mocha, Jasmine or Cucumber) to run the specs',
+        type: 'string'
+    },
+    reporters: {
+        alias: 'r',
+        desc: 'reporters to print out the results on stdout',
+        type: 'array'
+    },
+    suite: {
+        desc: 'overwrites the specs attribute and runs the defined suite',
+        type: 'array'
+    },
+    spec: {
+        desc: 'run only a certain spec file - overrides specs piped from stdin',
+        type: 'array'
+    },
+    exclude: {
+        desc: 'exclude certain spec file from the test run - overrides exclude piped from stdin',
+        type: 'array'
+    },
+    mochaOpts: {
+        desc: 'Mocha options'
+    },
+    jasmineOpts: {
+        desc: 'Jasmine options'
+    },
+    cucumberOpts: {
+        desc: 'Cucumber options'
+    },
+    autoCompileOpts: {
+        desc: 'Auto compilation options'
+    }
+};
+const builder = (yargs) => {
+    return yargs
+        .options(exports.cmdArgs)
+        .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 --mochaOpts.timeout 60000', 'Run suite with custom Mocha timeout')
+        .example('$0 run wdio.conf.js --autoCompileOpts.autoCompile=false', 'Disable auto-loading of ts-node or @babel/register')
+        .example('$0 run wdio.conf.js --autoCompileOpts.tsNodeOpts.project=configs/bdd-tsconfig.json', 'Run suite with ts-node using custom tsconfig.json')
+        .epilogue(constants_1.CLI_EPILOGUE)
+        .help();
+};
+exports.builder = builder;
+function launchWithStdin(wdioConfPath, params) {
+    let stdinData = '';
+    const stdin = process.openStdin();
+    stdin.setEncoding('utf8');
+    stdin.on('data', (data) => {
+        stdinData += data;
+    });
+    stdin.on('end', () => {
+        if (stdinData.length > 0) {
+            params.spec = stdinData.trim().split(/\r?\n/);
+        }
+        launch(wdioConfPath, params);
+    });
+}
+exports.launchWithStdin = launchWithStdin;
+function launch(wdioConfPath, params) {
+    const launcher = new launcher_1.default(wdioConfPath, params);
+    return launcher.run()
+        .then((...args) => {
+        /* istanbul ignore if */
+        if (!process.env.JEST_WORKER_ID) {
+            process.exit(...args);
+        }
+    })
+        .catch(err => {
+        console.error(err);
+        /* istanbul ignore if */
+        if (!process.env.JEST_WORKER_ID) {
+            process.exit(1);
+        }
+    });
+}
+exports.launch = launch;
+async function handler(argv) {
+    const { configPath, ...params } = argv;
+    if (!fs_extra_1.default.existsSync(configPath)) {
+        await (0, config_1.missingConfigurationPrompt)('run', `No WebdriverIO configuration found in "${process.cwd()}"`);
+    }
+    const localConf = path_1.default.join(process.cwd(), 'wdio.conf.js');
+    const wdioConf = configPath || (fs_extra_1.default.existsSync(localConf) ? localConf : undefined);
+    /**
+     * if `--watch` param is set, run launcher in watch mode
+     */
+    if (params.watch) {
+        const watcher = new watcher_1.default(wdioConf, params);
+        return watcher.watch();
+    }
+    /**
+     * if stdin.isTTY, then no piped input is present and launcher should be
+     * called immediately, otherwise piped input is processed, expecting
+     * a list of files to process.
+     *
+     * stdin.isTTY is false when command is from nodes spawn since it's treated as a pipe
+     */
+    if (process.stdin.isTTY || !process.stdout.isTTY) {
+        return launch(wdioConf, params);
+    }
+    /*
+     * get a list of spec files to run from stdin, overriding any other
+     * configuration suite or specs.
+     */
+    launchWithStdin(wdioConf, params);
+}
+exports.handler = handler;