@wdio/cli 7.17.0 → 7.18.0

package/build/launcher.js

@@ -0,0 +1,436 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const async_exit_hook_1 = __importDefault(require("async-exit-hook"));
+const logger_1 = __importDefault(require("@wdio/logger"));
+const config_1 = require("@wdio/config");
+const utils_1 = require("@wdio/utils");
+const interface_1 = __importDefault(require("./interface"));
+const utils_2 = require("./utils");
+const log = (0, logger_1.default)('@wdio/cli:launcher');
+class Launcher {
+    constructor(_configFilePath, _args = {}, _isWatchMode = false) {
+        this._configFilePath = _configFilePath;
+        this._args = _args;
+        this._isWatchMode = _isWatchMode;
+        this._exitCode = 0;
+        this._hasTriggeredExitRoutine = false;
+        this._schedule = [];
+        this._rid = [];
+        this._runnerStarted = 0;
+        this._runnerFailed = 0;
+        this.configParser = new config_1.ConfigParser();
+        /**
+         * merge auto compile opts to understand how to parse the config
+         */
+        if (_args.autoCompileOpts) {
+            this.configParser.merge({ autoCompileOpts: _args.autoCompileOpts });
+        }
+        this.configParser.autoCompile();
+        this.configParser.addConfigFile(_configFilePath);
+        this.configParser.merge(_args);
+        const config = this.configParser.getConfig();
+        /**
+         * assign parsed autocompile options into args so it can be used within the worker
+         * without having to read the config again
+         */
+        this._args.autoCompileOpts = config.autoCompileOpts;
+        const capabilities = this.configParser.getCapabilities();
+        this.isMultiremote = !Array.isArray(capabilities);
+        if (config.outputDir) {
+            fs_extra_1.default.ensureDirSync(path_1.default.join(config.outputDir));
+            process.env.WDIO_LOG_PATH = path_1.default.join(config.outputDir, 'wdio.log');
+        }
+        logger_1.default.setLogLevelsConfig(config.logLevels, config.logLevel);
+        const totalWorkerCnt = Array.isArray(capabilities)
+            ? capabilities
+                .map((c) => this.configParser.getSpecs(c.specs, c.exclude).length)
+                .reduce((a, b) => a + b, 0)
+            : 1;
+        const Runner = (0, utils_1.initialisePlugin)(config.runner, 'runner').default;
+        this.runner = new Runner(_configFilePath, config);
+        this.interface = new interface_1.default(config, totalWorkerCnt, this._isWatchMode);
+        config.runnerEnv.FORCE_COLOR = Number(this.interface.hasAnsiSupport);
+    }
+    /**
+     * run sequence
+     * @return  {Promise}               that only gets resolves with either an exitCode or an error
+     */
+    async run() {
+        /**
+         * catches ctrl+c event
+         */
+        (0, async_exit_hook_1.default)(this.exitHandler.bind(this));
+        let exitCode = 0;
+        let error = undefined;
+        try {
+            const config = this.configParser.getConfig();
+            const caps = this.configParser.getCapabilities();
+            const { ignoredWorkerServices, launcherServices } = (0, utils_1.initialiseLauncherService)(config, caps);
+            this._launcher = launcherServices;
+            this._args.ignoredWorkerServices = ignoredWorkerServices;
+            /**
+             * run pre test tasks for runner plugins
+             * (e.g. deploy Lambda function to AWS)
+             */
+            await this.runner.initialise();
+            /**
+             * run onPrepare hook
+             */
+            log.info('Run onPrepare hook');
+            await (0, utils_2.runLauncherHook)(config.onPrepare, config, caps);
+            await (0, utils_2.runServiceHook)(this._launcher, 'onPrepare', config, caps);
+            exitCode = await this.runMode(config, caps);
+            /**
+             * run onComplete hook
+             * Even if it fails we still want to see result and end logger stream.
+             * Also ensure that user hooks are run before service hooks so that e.g.
+             * a user can use plugin service, e.g. shared store service is still
+             * available running hooks in this order
+             */
+            log.info('Run onComplete hook');
+            const onCompleteResults = await (0, utils_2.runOnCompleteHook)(config.onComplete, config, caps, exitCode, this.interface.result);
+            await (0, utils_2.runServiceHook)(this._launcher, 'onComplete', exitCode, config, caps);
+            // if any of the onComplete hooks failed, update the exit code
+            exitCode = onCompleteResults.includes(1) ? 1 : exitCode;
+            await logger_1.default.waitForBuffer();
+            this.interface.finalise();
+        }
+        catch (err) {
+            error = err;
+        }
+        finally {
+            if (!this._hasTriggeredExitRoutine) {
+                this._hasTriggeredExitRoutine = true;
+                await this.runner.shutdown();
+            }
+        }
+        if (error) {
+            this.interface.logHookError(error);
+            throw error;
+        }
+        return exitCode;
+    }
+    /**
+     * run without triggering onPrepare/onComplete hooks
+     */
+    runMode(config, caps) {
+        /**
+         * fail if no caps were found
+         */
+        if (!caps) {
+            return new Promise((resolve) => {
+                log.error('Missing capabilities, exiting with failure');
+                return resolve(1);
+            });
+        }
+        /**
+         * avoid retries in watch mode
+         */
+        const specFileRetries = this._isWatchMode ? 0 : config.specFileRetries;
+        /**
+         * schedule test runs
+         */
+        let cid = 0;
+        if (this.isMultiremote) {
+            /**
+             * Multiremote mode
+             */
+            this._schedule.push({
+                cid: cid++,
+                caps: caps,
+                specs: this.formatSpecs(caps, specFileRetries),
+                availableInstances: config.maxInstances || 1,
+                runningInstances: 0
+            });
+        }
+        else {
+            /**
+             * Regular mode
+             */
+            for (let capabilities of caps) {
+                this._schedule.push({
+                    cid: cid++,
+                    caps: capabilities,
+                    specs: this.formatSpecs(capabilities, specFileRetries),
+                    availableInstances: capabilities.maxInstances || config.maxInstancesPerCapability,
+                    runningInstances: 0
+                });
+            }
+        }
+        return new Promise((resolve) => {
+            this._resolve = resolve;
+            /**
+             * fail if no specs were found or specified
+             */
+            if (Object.values(this._schedule).reduce((specCnt, schedule) => specCnt + schedule.specs.length, 0) === 0) {
+                log.error('No specs found to run, exiting with failure');
+                return resolve(1);
+            }
+            /**
+             * return immediately if no spec was run
+             */
+            if (this.runSpecs()) {
+                resolve(0);
+            }
+        });
+    }
+    /**
+     * Format the specs into an array of objects with files and retries
+     */
+    formatSpecs(capabilities, specFileRetries) {
+        let files = [];
+        files = this.configParser.getSpecs(capabilities.specs, capabilities.exclude);
+        return files.map(file => {
+            if (typeof file === 'string') {
+                return { files: [file], retries: specFileRetries };
+            }
+            else if (Array.isArray(file)) {
+                return { files: file, retries: specFileRetries };
+            }
+            log.warn('Unexpected entry in specs that is neither string nor array: ', file);
+            // Returning an empty structure to avoid undefined
+            return { files: [], retries: specFileRetries };
+        });
+    }
+    /**
+     * run multiple single remote tests
+     * @return {Boolean} true if all specs have been run and all instances have finished
+     */
+    runSpecs() {
+        let config = this.configParser.getConfig();
+        /**
+         * stop spawning new processes when CTRL+C was triggered
+         */
+        if (this._hasTriggeredExitRoutine) {
+            return true;
+        }
+        while (this.getNumberOfRunningInstances() < config.maxInstances) {
+            let schedulableCaps = this._schedule
+                /**
+                 * bail if number of errors exceeds allowed
+                 */
+                .filter(() => {
+                const filter = typeof config.bail !== 'number' || config.bail < 1 ||
+                    config.bail > this._runnerFailed;
+                /**
+                 * clear number of specs when filter is false
+                 */
+                if (!filter) {
+                    this._schedule.forEach((t) => { t.specs = []; });
+                }
+                return filter;
+            })
+                /**
+                 * make sure complete number of running instances is not higher than general maxInstances number
+                 */
+                .filter(() => this.getNumberOfRunningInstances() < config.maxInstances)
+                /**
+                 * make sure the capability has available capacities
+                 */
+                .filter((a) => a.availableInstances > 0)
+                /**
+                 * make sure capability has still caps to run
+                 */
+                .filter((a) => a.specs.length > 0)
+                /**
+                 * make sure we are running caps with less running instances first
+                 */
+                .sort((a, b) => a.runningInstances - b.runningInstances);
+            /**
+             * continue if no capability were schedulable
+             */
+            if (schedulableCaps.length === 0) {
+                break;
+            }
+            let specs = schedulableCaps[0].specs.shift();
+            this.startInstance(specs.files, schedulableCaps[0].caps, schedulableCaps[0].cid, specs.rid, specs.retries);
+            schedulableCaps[0].availableInstances--;
+            schedulableCaps[0].runningInstances++;
+        }
+        return this.getNumberOfRunningInstances() === 0 && this.getNumberOfSpecsLeft() === 0;
+    }
+    /**
+     * gets number of all running instances
+     * @return {number} number of running instances
+     */
+    getNumberOfRunningInstances() {
+        return this._schedule.map((a) => a.runningInstances).reduce((a, b) => a + b);
+    }
+    /**
+     * get number of total specs left to complete whole suites
+     * @return {number} specs left to complete suite
+     */
+    getNumberOfSpecsLeft() {
+        return this._schedule.map((a) => a.specs.length).reduce((a, b) => a + b);
+    }
+    /**
+     * Start instance in a child process.
+     * @param  {Array} specs  Specs to run
+     * @param  {Number} cid  Capabilities ID
+     * @param  {String} rid  Runner ID override
+     * @param  {Number} retries  Number of retries remaining
+     */
+    async startInstance(specs, caps, cid, rid, retries) {
+        let config = this.configParser.getConfig();
+        // wait before retrying the spec file
+        if (typeof config.specFileRetriesDelay === 'number' && config.specFileRetries > 0 && config.specFileRetries !== retries) {
+            await (0, utils_1.sleep)(config.specFileRetriesDelay * 1000);
+        }
+        // Retried tests receive the cid of the failing test as rid
+        // so they can run with the same cid of the failing test.
+        const runnerId = rid || this.getRunnerId(cid);
+        let processNumber = this._runnerStarted + 1;
+        // process.debugPort defaults to 5858 and is set even when process
+        // is not being debugged.
+        let debugArgs = [];
+        let debugType;
+        let debugHost = '';
+        let debugPort = process.debugPort;
+        for (let i in process.execArgv) {
+            const debugArgs = process.execArgv[i].match('--(debug|inspect)(?:-brk)?(?:=(.*):)?');
+            if (debugArgs) {
+                let [, type, host] = debugArgs;
+                if (type) {
+                    debugType = type;
+                }
+                if (host) {
+                    debugHost = `${host}:`;
+                }
+            }
+        }
+        if (debugType) {
+            debugArgs.push(`--${debugType}=${debugHost}${(debugPort + processNumber)}`);
+        }
+        // if you would like to add --debug-brk, use a different port, etc...
+        let capExecArgs = [...(config.execArgv || [])];
+        // The default value for child.fork execArgs is process.execArgs,
+        // so continue to use this unless another value is specified in config.
+        let defaultArgs = (capExecArgs.length) ? process.execArgv : [];
+        // If an arg appears multiple times the last occurrence is used
+        let execArgv = [...defaultArgs, ...debugArgs, ...capExecArgs];
+        // set '--no-wasm-code-gc' deliberatively as it causes problems with
+        // @wdio/sync and recent TypeScript compiles
+        if (!execArgv.includes('--no-wasm-code-gc')) {
+            execArgv.push('--no-wasm-code-gc');
+        }
+        // bump up worker count
+        this._runnerStarted++;
+        // run worker hook to allow modify runtime and capabilities of a specific worker
+        log.info('Run onWorkerStart hook');
+        await (0, utils_2.runLauncherHook)(config.onWorkerStart, runnerId, caps, specs, this._args, execArgv)
+            .catch((error) => this._workerHookError(error));
+        await (0, utils_2.runServiceHook)(this._launcher, 'onWorkerStart', runnerId, caps, specs, this._args, execArgv)
+            .catch((error) => this._workerHookError(error));
+        // prefer launcher settings in capabilities over general launcher
+        const worker = this.runner.run({
+            cid: runnerId,
+            command: 'run',
+            configFile: this._configFilePath,
+            args: { ...this._args, ...((config === null || config === void 0 ? void 0 : config.autoCompileOpts) ? { autoCompileOpts: config.autoCompileOpts } : {}) },
+            caps,
+            specs,
+            execArgv,
+            retries
+        });
+        worker.on('message', this.interface.onMessage.bind(this.interface));
+        worker.on('error', this.interface.onMessage.bind(this.interface));
+        worker.on('exit', this.endHandler.bind(this));
+    }
+    _workerHookError(error) {
+        this.interface.logHookError(error);
+        if (this._resolve) {
+            this._resolve(1);
+        }
+    }
+    /**
+     * generates a runner id
+     * @param  {Number} cid capability id (unique identifier for a capability)
+     * @return {String}     runner id (combination of cid and test id e.g. 0a, 0b, 1a, 1b ...)
+     */
+    getRunnerId(cid) {
+        if (!this._rid[cid]) {
+            this._rid[cid] = 0;
+        }
+        return `${cid}-${this._rid[cid]++}`;
+    }
+    /**
+     * Close test runner process once all child processes have exited
+     * @param  {Number} cid       Capabilities ID
+     * @param  {Number} exitCode  exit code of child process
+     * @param  {Array} specs      Specs that were run
+     * @param  {Number} retries   Number or retries remaining
+     */
+    async endHandler({ cid: rid, exitCode, specs, retries }) {
+        const passed = this._isWatchModeHalted() || exitCode === 0;
+        if (!passed && retries > 0) {
+            // Default is true, so test for false explicitly
+            const requeue = this.configParser.getConfig().specFileRetriesDeferred !== false ? 'push' : 'unshift';
+            this._schedule[parseInt(rid, 10)].specs[requeue]({ files: specs, retries: retries - 1, rid });
+        }
+        else {
+            this._exitCode = this._isWatchModeHalted() ? 0 : this._exitCode || exitCode;
+            this._runnerFailed += !passed ? 1 : 0;
+        }
+        /**
+         * avoid emitting job:end if watch mode has been stopped by user
+         */
+        if (!this._isWatchModeHalted()) {
+            this.interface.emit('job:end', { cid: rid, passed, retries });
+        }
+        /**
+         * Update schedule now this process has ended
+         * get cid (capability id) from rid (runner id)
+         */
+        const cid = parseInt(rid, 10);
+        this._schedule[cid].availableInstances++;
+        this._schedule[cid].runningInstances--;
+        log.info('Run onWorkerEnd hook');
+        const config = this.configParser.getConfig();
+        await (0, utils_2.runLauncherHook)(config.onWorkerEnd, rid, exitCode, specs, retries)
+            .catch((error) => this._workerHookError(error));
+        await (0, utils_2.runServiceHook)(this._launcher, 'onWorkerEnd', rid, exitCode, specs, retries)
+            .catch((error) => this._workerHookError(error));
+        /**
+         * do nothing if
+         * - there are specs to be executed
+         * - we are running watch mode
+         */
+        const shouldRunSpecs = this.runSpecs();
+        if (!shouldRunSpecs || (this._isWatchMode && !this._hasTriggeredExitRoutine)) {
+            return;
+        }
+        if (this._resolve) {
+            this._resolve(passed ? this._exitCode : 1);
+        }
+    }
+    /**
+     * We need exitHandler to catch SIGINT / SIGTERM events.
+     * Make sure all started selenium sessions get closed properly and prevent
+     * having dead driver processes. To do so let the runner end its Selenium
+     * session first before killing
+     */
+    exitHandler(callback) {
+        if (!callback) {
+            return;
+        }
+        if (this._hasTriggeredExitRoutine) {
+            return callback();
+        }
+        this._hasTriggeredExitRoutine = true;
+        this.interface.sigintTrigger();
+        return this.runner.shutdown().then(callback);
+    }
+    /**
+     * returns true if user stopped watch mode, ex with ctrl+c
+     * @returns {boolean}
+     */
+    _isWatchModeHalted() {
+        return this._isWatchMode && this._hasTriggeredExitRoutine;
+    }
+}
+exports.default = Launcher;

package/build/templates/afterTest.ejs

@@ -0,0 +1,20 @@
+/**
+     * Function to be executed after a test (in Mocha/Jasmine only)
+     * @param {Object}  test             test object
+     * @param {Object}  context          scope object the test was executed with
+     * @param {Error}   result.error     error object in case the test fails, otherwise `undefined`
+     * @param {Any}     result.result    return object of test function
+     * @param {Number}  result.duration  duration of test
+     * @param {Boolean} result.passed    true if test has passed, otherwise false
+     * @param {Object}  result.retries   informations to spec related retries, e.g. `{ attempts: 0, limit: 0 }`
+     */<%
+if (reporters.length && reporters.includes('allure')) {%>
+    afterTest: async function(test, context, { error, result, duration, passed, retries }) {
+        if (!passed) {
+            await browser.takeScreenshot();
+        }
+    },
+<% } else { %>
+    // afterTest: function(test, context, { error, result, duration, passed, retries }) {
+    // },
+<% } %>

package/build/templates/exampleFiles/cucumber/features/login.feature

@@ -0,0 +1,12 @@
+Feature: The Internet Guinea Pig Website
+
+  Scenario Outline: As a user, I can log into the secure area
+
+    Given I am on the login page
+    When I login with <username> and <password>
+    Then I should see a flash message saying <message>
+
+    Examples:
+      | username | password             | message                        |
+      | tomsmith | SuperSecretPassword! | You logged into a secure area! |
+      | foobar   | barfoo               | Your username is invalid!      |

package/build/templates/exampleFiles/cucumber/step_definitions/steps.js.ejs

@@ -0,0 +1,52 @@
+<%- isUsingTypeScript || isUsingBabel
+    ? "import { Given, When, Then } from '@wdio/cucumber-framework';"
+    : "const { Given, When, Then } = require('@wdio/cucumber-framework');" %>
+<%
+/**
+ * step definition without page objects
+ */
+if (usePageObjects) { %>
+<%- isUsingTypeScript || isUsingBabel
+    ? `import LoginPage from '${relativePath}/login.page';`
+    : `const LoginPage = require('${relativePath}/login.page');` %>
+<%- isUsingTypeScript || isUsingBabel
+    ? `import SecurePage from '${relativePath}/secure.page';`
+    : `const SecurePage = require('${relativePath}/secure.page');` %>
+
+const pages = {
+    login: LoginPage
+}
+
+Given(/^I am on the (\w+) page$/, async (page) => {
+    await pages[page].open()
+});
+
+When(/^I login with (\w+) and (.+)$/, async (username, password) => {
+    await LoginPage.login(username, password)
+});
+
+Then(/^I should see a flash message saying (.*)$/, async (message) => {
+    await expect(SecurePage.flashAlert).toBeExisting();
+    await expect(SecurePage.flashAlert).toHaveTextContaining(message);
+});
+<% } else {
+
+/**
+ * step definition with page objects
+ */
+%>
+Given(/^I am on the (\w+) page$/, async (page) => {
+    await browser.url(`https://the-internet.herokuapp.com/${page}`);
+});
+
+When(/^I login with (\w+) and (.+)$/, async (username, password) => {
+    await $('#username').setValue(username);
+    await $('#password').setValue(password);
+    await $('button[type="submit"]').click();
+});
+
+Then(/^I should see a flash message saying (.*)$/, async (message) => {
+    await expect($('#flash')).toBeExisting();
+    await expect($('#flash')).toHaveTextContaining(message);
+});
+<% } %>

package/build/templates/exampleFiles/jasmine/example.e2e.js.ejs

@@ -0,0 +1,42 @@
+<%
+/**
+ * step definition without page objects
+ */
+if (usePageObjects) {
+%><%- isUsingTypeScript || isUsingBabel
+    ? `import LoginPage from  '${relativePath}/login.page';`
+    : `const LoginPage = require('${relativePath}/login.page');` %>
+<%- isUsingTypeScript || isUsingBabel
+    ? `import SecurePage from '${relativePath}/secure.page';`
+    : `const SecurePage = require('${relativePath}/secure.page');` %>
+
+describe('My Login application', () => {
+    it('should login with valid credentials', async () => {
+        await LoginPage.open();
+
+        await LoginPage.login('tomsmith', 'SuperSecretPassword!');
+        await expect(SecurePage.flashAlert).toBeExisting();
+        await expect(SecurePage.flashAlert).toHaveTextContaining(
+            'You logged into a secure area!');
+    });
+});
+
+<% } else {
+
+/**
+ * step definition with page objects
+ */
+%>describe('My Login application', () => {
+    it('should login with valid credentials', async () => {
+        await browser.url(`https://the-internet.herokuapp.com/login`);
+
+        await $('#username').setValue('tomsmith');
+        await $('#password').setValue('SuperSecretPassword!');
+        await $('button[type="submit"]').click();
+
+        await expect($('#flash')).toBeExisting();
+        await expect($('#flash')).toHaveTextContaining(
+            'You logged into a secure area!');
+    });
+});
+<% } %>

package/build/templates/exampleFiles/mocha/example.e2e.js.ejs

@@ -0,0 +1,42 @@
+<%
+/**
+ * test with page objects
+ */
+if (usePageObjects) {
+%><%- isUsingTypeScript || isUsingBabel
+    ? `import LoginPage from  '${relativePath}/login.page';`
+    : `const LoginPage = require('${relativePath}/login.page');` %>
+<%- isUsingTypeScript || isUsingBabel
+    ? `import SecurePage from '${relativePath}/secure.page';`
+    : `const SecurePage = require('${relativePath}/secure.page');` %>
+
+describe('My Login application', () => {
+    it('should login with valid credentials', async () => {
+        await LoginPage.open();
+
+        await LoginPage.login('tomsmith', 'SuperSecretPassword!');
+        await expect(SecurePage.flashAlert).toBeExisting();
+        await expect(SecurePage.flashAlert).toHaveTextContaining(
+            'You logged into a secure area!');
+    });
+});
+
+<% } else {
+
+/**
+ * test without page objects
+ */
+%>describe('My Login application', () => {
+    it('should login with valid credentials', async () => {
+        await browser.url(`https://the-internet.herokuapp.com/login`);
+
+        await $('#username').setValue('tomsmith');
+        await $('#password').setValue('SuperSecretPassword!');
+        await $('button[type="submit"]').click();
+
+        await expect($('#flash')).toBeExisting();
+        await expect($('#flash')).toHaveTextContaining(
+            'You logged into a secure area!');
+    });
+});
+<% } %>

package/build/templates/exampleFiles/pageobjects/login.page.js.ejs

@@ -0,0 +1,44 @@
+<%- isUsingTypeScript ? "import { ChainablePromiseElement } from 'webdriverio';" : "" %>
+
+<%- isUsingTypeScript || isUsingBabel
+    ? "import Page from './page';"
+    : "const Page = require('./page');" %>
+
+/**
+ * sub page containing specific selectors and methods for a specific page
+ */
+class LoginPage extends Page {
+    /**
+     * define selectors using getter methods
+     */
+    <%- isUsingTypeScript ? "public " : "" %>get inputUsername () {
+        return $('#username');
+    }
+
+    <%- isUsingTypeScript ? "public " : "" %>get inputPassword () {
+        return $('#password');
+    }
+
+    <%- isUsingTypeScript ? "public " : "" %>get btnSubmit () {
+        return $('button[type="submit"]');
+    }
+
+    /**
+     * a method to encapsule automation code to interact with the page
+     * e.g. to login using username and password
+     */
+    <%- isUsingTypeScript ? "public " : "" %>async login (username<%- isUsingTypeScript ? ": string": "" %>, password<%- isUsingTypeScript ? ": string": "" %>) {
+        await this.inputUsername.setValue(username);
+        await this.inputPassword.setValue(password);
+        await this.btnSubmit.click();
+    }
+
+    /**
+     * overwrite specific options to adapt it to page object
+     */
+    <%- isUsingTypeScript ? "public " : "" %>open () {
+        return super.open('login');
+    }
+}
+
+<%- isUsingTypeScript || isUsingBabel ? "export default": "module.exports =" %> new LoginPage();

package/build/templates/exampleFiles/pageobjects/page.js.ejs

@@ -0,0 +1,13 @@
+/**
+* main page object containing all methods, selectors and functionality
+* that is shared across all page objects
+*/
+<%- isUsingTypeScript || isUsingBabel ? "export default" : "module.exports =" %> class Page {
+    /**
+    * Opens a sub page of the page
+    * @param path path of the sub page (e.g. /path/to/page.html)
+    */
+    <%- isUsingTypeScript ? "public " : "" %>open (path<%- isUsingTypeScript ? ": string" : "" %>) {
+        return browser.url(`https://the-internet.herokuapp.com/${path}`)
+    }
+}

package/build/templates/exampleFiles/pageobjects/secure.page.js.ejs

@@ -0,0 +1,19 @@
+<%- isUsingTypeScript ? "import { ChainablePromiseElement } from 'webdriverio';" : "" %>
+
+<%- isUsingTypeScript || isUsingBabel
+    ? "import Page from './page';"
+    : "const Page = require('./page');" %>
+
+/**
+ * sub page containing specific selectors and methods for a specific page
+ */
+class SecurePage extends Page {
+    /**
+     * define selectors using getter methods
+     */
+    <%- isUsingTypeScript ? "public " : "" %>get flashAlert () {
+        return $('#flash');
+    }
+}
+
+<%- isUsingTypeScript || isUsingBabel ? "export default": "module.exports =" %> new SecurePage();