@wdio/cli 7.16.16 → 7.17.0

package/build/utils.js

@@ -1,345 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultFiles = exports.getPathForFileGeneration = exports.getAnswers = exports.generateTestFiles = exports.hasPackage = exports.hasFile = exports.getCapabilities = exports.validateServiceAnswers = exports.renderConfigurationFile = exports.convertPackageHashToObject = exports.addServiceDeps = exports.replaceConfig = exports.findInConfig = exports.getRunnerName = exports.runOnCompleteHook = exports.runLauncherHook = exports.runServiceHook = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const ejs_1 = __importDefault(require("ejs"));
-const path_1 = __importDefault(require("path"));
-const inquirer_1 = __importDefault(require("inquirer"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const recursive_readdir_1 = __importDefault(require("recursive-readdir"));
-const webdriverio_1 = require("webdriverio");
-const child_process_1 = require("child_process");
-const util_1 = require("util");
-const constants_1 = require("./constants");
-const log = (0, logger_1.default)('@wdio/cli:utils');
-const TEMPLATE_ROOT_DIR = path_1.default.join(__dirname, 'templates', 'exampleFiles');
-const renderFile = (0, util_1.promisify)(ejs_1.default.renderFile);
-/**
- * run service launch sequences
- */
-async function runServiceHook(launcher, hookName, ...args) {
-    const start = Date.now();
-    return Promise.all(launcher.map(async (service) => {
-        try {
-            if (typeof service[hookName] === 'function') {
-                await service[hookName](...args);
-            }
-        }
-        catch (err) {
-            const message = `A service failed in the '${hookName}' hook\n${err.stack}\n\n`;
-            if (err instanceof webdriverio_1.SevereServiceError) {
-                return { status: 'rejected', reason: message };
-            }
-            log.error(`${message}Continue...`);
-        }
-    })).then(results => {
-        if (launcher.length) {
-            log.debug(`Finished to run "${hookName}" hook in ${Date.now() - start}ms`);
-        }
-        const rejectedHooks = results.filter(p => p && p.status === 'rejected');
-        if (rejectedHooks.length) {
-            return Promise.reject(new Error(`\n${rejectedHooks.map(p => p && p.reason).join()}\n\nStopping runner...`));
-        }
-    });
-}
-exports.runServiceHook = runServiceHook;
-/**
- * Run hook in service launcher
- * @param {Array|Function} hook - can be array of functions or single function
- * @param {Object} config
- * @param {Object} capabilities
- */
-async function runLauncherHook(hook, ...args) {
-    const catchFn = (e) => log.error(`Error in hook: ${e.stack}`);
-    if (typeof hook === 'function') {
-        hook = [hook];
-    }
-    return Promise.all(hook.map((hook) => {
-        try {
-            return hook(...args);
-        }
-        catch (err) {
-            return catchFn(err);
-        }
-    })).catch(catchFn);
-}
-exports.runLauncherHook = runLauncherHook;
-/**
- * Run onCompleteHook in Launcher
- * @param {Array|Function} onCompleteHook - can be array of functions or single function
- * @param {*} config
- * @param {*} capabilities
- * @param {*} exitCode
- * @param {*} results
- */
-async function runOnCompleteHook(onCompleteHook, config, capabilities, exitCode, results) {
-    if (typeof onCompleteHook === 'function') {
-        onCompleteHook = [onCompleteHook];
-    }
-    return Promise.all(onCompleteHook.map(async (hook) => {
-        try {
-            await hook(exitCode, config, capabilities, results);
-            return 0;
-        }
-        catch (err) {
-            log.error(`Error in onCompleteHook: ${err.stack}`);
-            return 1;
-        }
-    }));
-}
-exports.runOnCompleteHook = runOnCompleteHook;
-/**
- * get runner identification by caps
- */
-function getRunnerName(caps = {}) {
-    let runner = caps.browserName ||
-        caps.appPackage ||
-        caps.appWaitActivity ||
-        caps.app ||
-        caps.platformName ||
-        caps['appium:platformName'] ||
-        caps['appium:appPackage'] ||
-        caps['appium:appWaitActivity'] ||
-        caps['appium:app'];
-    // MultiRemote
-    if (!runner) {
-        runner = Object.values(caps).length === 0 || Object.values(caps).some(cap => !cap.capabilities) ? 'undefined' : 'MultiRemote';
-    }
-    return runner;
-}
-exports.getRunnerName = getRunnerName;
-function buildNewConfigArray(str, type, change) {
-    var _a;
-    const newStr = str
-        .split(`${type}s: `)[1]
-        .replace(/'/g, '');
-    let newArray = ((_a = newStr.match(/(\w*)/gmi)) === null || _a === void 0 ? void 0 : _a.filter(e => !!e).concat([change])) || [];
-    return str
-        .replace('// ', '')
-        .replace(new RegExp(`(${type}s: )((.*\\s*)*)`), `$1[${newArray.map(e => `'${e}'`)}]`);
-}
-function buildNewConfigString(str, type, change) {
-    return str.replace(new RegExp(`(${type}: )('\\w*')`), `$1'${change}'`);
-}
-function findInConfig(config, type) {
-    let regexStr = `[\\/\\/]*[\\s]*${type}s: [\\s]*\\[([\\s]*['|"]\\w*['|"],*)*[\\s]*\\]`;
-    if (type === 'framework') {
-        regexStr = `[\\/\\/]*[\\s]*${type}: ([\\s]*['|"]\\w*['|"])`;
-    }
-    const regex = new RegExp(regexStr, 'gmi');
-    return config.match(regex);
-}
-exports.findInConfig = findInConfig;
-function replaceConfig(config, type, name) {
-    if (type === 'framework') {
-        return buildNewConfigString(config, type, name);
-    }
-    const match = findInConfig(config, type);
-    if (!match || match.length === 0) {
-        return;
-    }
-    const text = match.pop() || '';
-    return config.replace(text, buildNewConfigArray(text, type, name));
-}
-exports.replaceConfig = replaceConfig;
-function addServiceDeps(names, packages, update = false) {
-    /**
-     * automatically install latest Chromedriver if `wdio-chromedriver-service`
-     * was selected for install
-     */
-    if (names.some(({ short }) => short === 'chromedriver')) {
-        packages.push('chromedriver');
-        if (update) {
-            // eslint-disable-next-line no-console
-            console.log('\n=======', '\nPlease change path to / in your wdio.conf.js:', "\npath: '/'", '\n=======\n');
-        }
-    }
-    /**
-     * install Appium if it is not installed globally if `@wdio/appium-service`
-     * was selected for install
-     */
-    if (names.some(({ short }) => short === 'appium')) {
-        const result = (0, child_process_1.execSync)('appium --version || echo APPIUM_MISSING').toString().trim();
-        if (result === 'APPIUM_MISSING') {
-            packages.push('appium');
-        }
-        else if (update) {
-            // eslint-disable-next-line no-console
-            console.log('\n=======', '\nUsing globally installed appium', result, '\nPlease add the following to your wdio.conf.js:', "\nappium: { command: 'appium' }", '\n=======\n');
-        }
-    }
-}
-exports.addServiceDeps = addServiceDeps;
-/**
- * @todo add JSComments
- */
-function convertPackageHashToObject(pkg, hash = '$--$') {
-    const splitHash = pkg.split(hash);
-    return {
-        package: splitHash[0],
-        short: splitHash[1]
-    };
-}
-exports.convertPackageHashToObject = convertPackageHashToObject;
-async function renderConfigurationFile(answers) {
-    const tplPath = path_1.default.join(__dirname, 'templates/wdio.conf.tpl.ejs');
-    const filename = `wdio.conf.${answers.isUsingTypeScript ? 'ts' : 'js'}`;
-    const renderedTpl = await renderFile(tplPath, { answers });
-    return fs_extra_1.default.promises.writeFile(path_1.default.join(process.cwd(), answers.isUsingTypeScript ? 'test' : '', filename), renderedTpl);
-}
-exports.renderConfigurationFile = renderConfigurationFile;
-const validateServiceAnswers = (answers) => {
-    let result = true;
-    Object.entries(constants_1.EXCLUSIVE_SERVICES).forEach(([name, { services, message }]) => {
-        const exists = answers.some(answer => answer.includes(name));
-        const hasExclusive = services.some(service => answers.some(answer => answer.includes(service)));
-        if (exists && hasExclusive) {
-            result = `${name} cannot work together with ${services.join(', ')}\n${message}\nPlease uncheck one of them.`;
-        }
-    });
-    return result;
-};
-exports.validateServiceAnswers = validateServiceAnswers;
-function getCapabilities(arg) {
-    const optionalCapabilites = {
-        platformVersion: arg.platformVersion,
-        udid: arg.udid,
-        ...(arg.deviceName && { deviceName: arg.deviceName })
-    };
-    /**
-     * Parsing of option property and constructing desiredCapabilities
-     * for Appium session. Could be application(1) or browser(2-3) session.
-     */
-    if (/.*\.(apk|app|ipa)$/.test(arg.option)) {
-        return {
-            capabilities: {
-                app: arg.option,
-                ...(arg.option.endsWith('apk') ? constants_1.ANDROID_CONFIG : constants_1.IOS_CONFIG),
-                ...optionalCapabilites,
-            }
-        };
-    }
-    else if (/android/.test(arg.option)) {
-        return { capabilities: { browserName: 'Chrome', ...constants_1.ANDROID_CONFIG, ...optionalCapabilites } };
-    }
-    else if (/ios/.test(arg.option)) {
-        return { capabilities: { browserName: 'Safari', ...constants_1.IOS_CONFIG, ...optionalCapabilites } };
-    }
-    return { capabilities: { browserName: arg.option } };
-}
-exports.getCapabilities = getCapabilities;
-/**
- * Check if file exists in current work directory
- * @param {string} filename to check existance for
- */
-function hasFile(filename) {
-    return fs_extra_1.default.existsSync(path_1.default.join(process.cwd(), filename));
-}
-exports.hasFile = hasFile;
-/**
- * Check if package is installed
- * @param {string} package to check existance for
- */
-function hasPackage(pkg) {
-    try {
-        /**
-         * this is only for testing purposes as we want to check whether
-         * we add `@babel/register` to the packages to install when resolving fails
-         */
-        if (process.env.JEST_WORKER_ID && process.env.WDIO_TEST_THROW_RESOLVE) {
-            throw new Error('resolve error');
-        }
-        require.resolve(pkg);
-        return true;
-    }
-    catch (err) {
-        return false;
-    }
-}
-exports.hasPackage = hasPackage;
-/**
- * generate test files based on CLI answers
- */
-async function generateTestFiles(answers) {
-    const testFiles = answers.framework === 'cucumber'
-        ? [path_1.default.join(TEMPLATE_ROOT_DIR, 'cucumber')]
-        : (answers.framework === 'mocha'
-            ? [path_1.default.join(TEMPLATE_ROOT_DIR, 'mocha')]
-            : [path_1.default.join(TEMPLATE_ROOT_DIR, 'jasmine')]);
-    if (answers.usePageObjects) {
-        testFiles.push(path_1.default.join(TEMPLATE_ROOT_DIR, 'pageobjects'));
-    }
-    const files = (await Promise.all(testFiles.map((dirPath) => (0, recursive_readdir_1.default)(dirPath, [(file, stats) => !stats.isDirectory() && !(file.endsWith('.ejs') || file.endsWith('.feature'))])))).reduce((cur, acc) => [...acc, ...(cur)], []);
-    for (const file of files) {
-        const renderedTpl = await renderFile(file, answers);
-        let destPath = (file.endsWith('page.js.ejs')
-            ? `${answers.destPageObjectRootPath}/${path_1.default.basename(file)}`
-            : file.includes('step_definition')
-                ? `${answers.stepDefinitions}`
-                : `${answers.destSpecRootPath}/${path_1.default.basename(file)}`).replace(/\.ejs$/, '').replace(/\.js$/, answers.isUsingTypeScript ? '.ts' : '.js');
-        fs_extra_1.default.ensureDirSync(path_1.default.dirname(destPath));
-        await fs_extra_1.default.promises.writeFile(destPath, renderedTpl);
-    }
-}
-exports.generateTestFiles = generateTestFiles;
-async function getAnswers(yes) {
-    return yes
-        ? constants_1.QUESTIONNAIRE.reduce((answers, question) => Object.assign(answers, question.when && !question.when(answers)
-            /**
-             * set nothing if question doesn't apply
-             */
-            ? {}
-            : { [question.name]: typeof question.default !== 'undefined'
-                    /**
-                     * set default value if existing
-                     */
-                    ? typeof question.default === 'function'
-                        ? question.default(answers)
-                        : question.default
-                    : question.choices && question.choices.length
-                        /**
-                         * pick first choice, select value if it exists
-                         */
-                        ? question.choices[0].value
-                            ? question.choices[0].value
-                            : question.choices[0]
-                        : {}
-            }), {})
-        : await inquirer_1.default.prompt(constants_1.QUESTIONNAIRE);
-}
-exports.getAnswers = getAnswers;
-function getPathForFileGeneration(answers) {
-    const destSpecRootPath = path_1.default.join(process.cwd(), path_1.default.dirname(answers.specs || '').replace(/\*\*$/, ''));
-    const destStepRootPath = path_1.default.join(process.cwd(), path_1.default.dirname(answers.stepDefinitions || ''));
-    const destPageObjectRootPath = answers.usePageObjects
-        ? path_1.default.join(process.cwd(), path_1.default.dirname(answers.pages || '').replace(/\*\*$/, ''))
-        : '';
-    let relativePath = (answers.generateTestFiles && answers.usePageObjects)
-        ? !(convertPackageHashToObject(answers.framework).short === 'cucumber')
-            ? path_1.default.relative(destSpecRootPath, destPageObjectRootPath)
-            : path_1.default.relative(destStepRootPath, destPageObjectRootPath)
-        : '';
-    /**
-    * On Windows, path.relative can return backslashes that could be interpreted as espace sequences in strings
-    */
-    if (process.platform === 'win32') {
-        relativePath = relativePath.replace(/\\/g, '/');
-    }
-    return {
-        destSpecRootPath: destSpecRootPath,
-        destStepRootPath: destStepRootPath,
-        destPageObjectRootPath: destPageObjectRootPath,
-        relativePath: relativePath
-    };
-}
-exports.getPathForFileGeneration = getPathForFileGeneration;
-function getDefaultFiles(answers, filePath) {
-    var _a;
-    return ((_a = answers === null || answers === void 0 ? void 0 : answers.isUsingCompiler) === null || _a === void 0 ? void 0 : _a.toString().includes('TypeScript'))
-        ? `${filePath}.ts`
-        : `${filePath}.js`;
-}
-exports.getDefaultFiles = getDefaultFiles;

package/build/watcher.d.ts

@@ -1,34 +0,0 @@
-import type { Workers } from '@wdio/types';
-import { RunCommandArguments, ValueKeyIteratee } from './types.js';
-declare type Spec = string | string[];
-export default class Watcher {
-    private _configFile;
-    private _args;
-    private _launcher;
-    private _specs;
-    constructor(_configFile: string, _args: Omit<RunCommandArguments, 'configPath'>);
-    watch(): Promise<void>;
-    /**
-     * return file listener callback that calls `run` method
-     * @param  {Boolean}  [passOnFile=true]  if true pass on file change as parameter
-     * @return {Function}                    chokidar event callback
-     */
-    getFileListener(passOnFile?: boolean): (spec: string) => void[];
-    /**
-     * helper method to get workers from worker pool of wdio runner
-     * @param  predicate         filter by property value (see lodash.pickBy)
-     * @param  includeBusyWorker don't filter out busy worker (default: false)
-     * @return                   Object with workers, e.g. {'0-0': { ... }}
-     */
-    getWorkers(predicate?: ValueKeyIteratee<Workers.Worker> | null | undefined, includeBusyWorker?: boolean): Workers.WorkerPool;
-    /**
-     * run workers with params
-     * @param  params parameters to run the worker with
-     */
-    run(params?: Omit<Partial<RunCommandArguments>, 'spec'> & {
-        spec?: Spec;
-    }): void;
-    cleanUp(): void;
-}
-export {};
-//# sourceMappingURL=watcher.d.ts.map

package/build/watcher.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"watcher.d.ts","sourceRoot":"","sources":["../src/watcher.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAgB,OAAO,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAIlE,aAAK,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;AAC7B,MAAM,CAAC,OAAO,OAAO,OAAO;IAKpB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,KAAK;IALjB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,MAAM,CAAQ;gBAGV,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC;IAYpD,KAAK;IAwCX;;;;OAIG;IACH,eAAe,CAAE,UAAU,UAAO,UAChB,MAAM;IA6BxB;;;;;OAKG;IACH,UAAU,CAAE,SAAS,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU;IAiB7H;;;OAGG;IACH,GAAG,CAAE,MAAM,GAAE,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,IAAI,CAAA;KAAO;IAuC9E,OAAO;CAGV"}

package/build/watcher.js

@@ -1,150 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const chokidar_1 = __importDefault(require("chokidar"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const lodash_pickby_1 = __importDefault(require("lodash.pickby"));
-const lodash_flattendeep_1 = __importDefault(require("lodash.flattendeep"));
-const lodash_union_1 = __importDefault(require("lodash.union"));
-const launcher_1 = __importDefault(require("./launcher"));
-const log = (0, logger_1.default)('@wdio/cli:watch');
-class Watcher {
-    constructor(_configFile, _args) {
-        this._configFile = _configFile;
-        this._args = _args;
-        log.info('Starting launcher in watch mode');
-        this._launcher = new launcher_1.default(this._configFile, this._args, true);
-        const specs = this._launcher.configParser.getSpecs();
-        const capSpecs = this._launcher.isMultiremote ? [] : (0, lodash_union_1.default)((0, lodash_flattendeep_1.default)(this._launcher.configParser.getCapabilities().map(cap => cap.specs || [])));
-        this._specs = [...specs, ...capSpecs];
-    }
-    async watch() {
-        /**
-         * listen on spec changes and rerun specific spec file
-         */
-        let flattenedSpecs = (0, lodash_flattendeep_1.default)(this._specs);
-        chokidar_1.default.watch(flattenedSpecs, { ignoreInitial: true })
-            .on('add', this.getFileListener())
-            .on('change', this.getFileListener());
-        /**
-         * listen on filesToWatch changes an rerun complete suite
-         */
-        const { filesToWatch } = this._launcher.configParser.getConfig();
-        if (filesToWatch.length) {
-            chokidar_1.default.watch(filesToWatch, { ignoreInitial: true })
-                .on('add', this.getFileListener(false))
-                .on('change', this.getFileListener(false));
-        }
-        /**
-         * run initial test suite
-         */
-        await this._launcher.run();
-        /**
-         * clean interface once all worker finish
-         */
-        const workers = this.getWorkers();
-        Object.values(workers).forEach((worker) => worker.on('exit', () => {
-            /**
-             * check if all workers have finished
-             */
-            if (Object.values(workers).find((w) => w.isBusy)) {
-                return;
-            }
-            this._launcher.interface.finalise();
-        }));
-    }
-    /**
-     * return file listener callback that calls `run` method
-     * @param  {Boolean}  [passOnFile=true]  if true pass on file change as parameter
-     * @return {Function}                    chokidar event callback
-     */
-    getFileListener(passOnFile = true) {
-        return (spec) => {
-            const runSpecs = [];
-            let singleSpecFound = false;
-            for (let index = 0, length = this._specs.length; index < length; index += 1) {
-                const value = this._specs[index];
-                if (Array.isArray(value) && value.indexOf(spec) > -1) {
-                    runSpecs.push(value);
-                }
-                else if (!singleSpecFound && spec === value) {
-                    // Only need to run a singleFile once  - so avoid duplicates
-                    singleSpecFound = true;
-                    runSpecs.push(value);
-                }
-            }
-            // If the runSpecs array is empty, then this must be a new file/array
-            // so add the spec directly to the runSpecs
-            if (runSpecs.length === 0) {
-                runSpecs.push(spec);
-            }
-            // Do not pass the `spec` command line option to `this.run()`
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const { spec: _specArg, ...args } = this._args;
-            return runSpecs.map((spec) => {
-                return this.run({ ...args, ...(passOnFile ? { spec } : {}) });
-            });
-        };
-    }
-    /**
-     * helper method to get workers from worker pool of wdio runner
-     * @param  predicate         filter by property value (see lodash.pickBy)
-     * @param  includeBusyWorker don't filter out busy worker (default: false)
-     * @return                   Object with workers, e.g. {'0-0': { ... }}
-     */
-    getWorkers(predicate, includeBusyWorker) {
-        let workers = this._launcher.runner.workerPool;
-        if (typeof predicate === 'function') {
-            workers = (0, lodash_pickby_1.default)(workers, predicate);
-        }
-        /**
-         * filter out busy workers, only skip if explicitly desired
-         */
-        if (!includeBusyWorker) {
-            workers = (0, lodash_pickby_1.default)(workers, (worker) => !worker.isBusy);
-        }
-        return workers;
-    }
-    /**
-     * run workers with params
-     * @param  params parameters to run the worker with
-     */
-    run(params = {}) {
-        const workers = this.getWorkers((params.spec ? (worker) => {
-            if (Array.isArray(params.spec)) {
-                return params.spec === worker.specs;
-            }
-            return worker.specs.includes(params.spec);
-        } : undefined));
-        /**
-         * don't do anything if no worker was found
-         */
-        if (Object.keys(workers).length === 0) {
-            return;
-        }
-        /**
-         * update total worker count interface
-         * ToDo: this should have a cleaner solution
-         */
-        this._launcher.interface.totalWorkerCnt = Object.entries(workers).length;
-        /**
-         * clean up interface
-         */
-        this.cleanUp();
-        /**
-         * trigger new run for non busy worker
-         */
-        for (const [, worker] of Object.entries(workers)) {
-            const { cid, caps, specs, sessionId } = worker;
-            const args = Object.assign({ sessionId }, params);
-            worker.postMessage('run', args);
-            this._launcher.interface.emit('job:start', { cid, caps, specs });
-        }
-    }
-    cleanUp() {
-        this._launcher.interface.setup();
-    }
-}
-exports.default = Watcher;