@wdio/cli 9.16.1 → 9.17.0

package/build/templates/exampleFiles/serenity-js/mocha/example.spec.ts.ejs

@@ -1,88 +0,0 @@
-<%- _.import('describe, it', 'mocha') %>
-
-<%- _.import('Ensure, equals', '@serenity-js/assertions') %>
-<%- _.import('actorCalled', '@serenity-js/core') %>
-<%- _.import('By, Navigate, PageElement, Text', '@serenity-js/web') %>
-
-<%- _.import('GitHubStatus', '../serenity/github-api/GitHubStatus') %>
-<%- _.import('TodoList', '../serenity/todo-list-app/TodoList') %>
-
-/**
- * Serenity/JS Screenplay Pattern test scenarios use one or more actors to represent people and external systems
- * interacting with the system under test.
- *
- * To design a test scenario, give each actor a series of tasks and interactions to perform
- * and instruct them to answer questions about the state of the system under test
- * to ensure that the answers meet the expected results.
- *
- * This example test file demonstrates several ways of writing test scenarios using the Screenplay Pattern.
- *
- * Learn more:
- * - Serenity/JS Screenplay Pattern - https://serenity-js.org/handbook/design/screenplay-pattern/
- * - Web Testing with Serenity/JS - https://serenity-js.org/handbook/web-testing/
- * - API Testing with Serenity/JS - https://serenity-js.org/handbook/api-testing/
- * - Serenity/JS web module - https://serenity-js.org/api/web/
- * - Serenity/JS REST module - https://serenity-js.org/api/rest/
- * - Serenity/JS assertions module - https://serenity-js.org/api/assertions/
- */
-describe('Example', () => {
-
-    /**
-     * This is the most basic example of a Serenity/JS Screenplay Pattern test scenario.
-     *
-     * This scenario uses a single actor configured to perform a series of web-based interactions,
-     * and uses only the low-level abstractions provided by the Serenity/JS web module.
-     */
-    it('offers a web testing tutorial', async () => {
-        await actorCalled('Alice').attemptsTo(
-            Navigate.to('https://serenity-js.org'),
-            Ensure.that(
-                Text.of(PageElement.located(By.id('cta-start-automating'))),
-                equals('Start automating 🚀')
-            ),
-        )
-    })
-
-    /**
-     * This is a more advanced example of a Serenity/JS Screenplay Pattern test scenario.
-     *
-     * This scenario uses two actors:
-     * - Apisitt, responsible for interacting with an API to check if the system is up and running before performing any UI checks
-     * - Wendy, responsible for interacting with the website to perform the actual acceptance test
-     *
-     * In this scenario, rather than list all the interactions in the test itself, we use:
-     * - API Actions Class Pattern to group tasks concerning interacting with the GitHubStatus API
-     * - Screenplay Pattern flavour of Page Objects to group tasks and questions concerning interacting with the Serenity/JS Todo List app
-     *
-     * Note that apart from strongly encouraging the Screenplay Pattern,
-     * Serenity/JS doesn't require you to organise your code in any particular way.
-     * This gives you the freedom to choose patterns and abstractions that work best for you, your team,
-     * and reflect the domain of your system under test.
-     */
-    it(`offers examples to help you practice test automation`, async () => {
-
-        // You can use API interactions to manage test data, or to ensure services are up and running before performing any UI checks.
-        // Since Serenity/JS demo website is deployed to GitHub Pages,
-        // before interacting with the website we ensure that GitHub itself is up and running.
-        await actorCalled('Apisitt').attemptsTo(
-            GitHubStatus.ensureAllSystemsOperational(),
-        )
-
-        // Once we know the system is up and running, Wendy can proceed with the web-based scenario.
-        await actorCalled('Wendy').attemptsTo(
-            TodoList.createListContaining([
-                `Buy dog food`,
-                `Feed the dog`,
-                `Book a vet's appointment`,
-            ]),
-            TodoList.markAsCompleted([
-                `Buy dog food`,
-                `Feed the dog`,
-            ]),
-            Ensure.that(
-                TodoList.outstandingItemsCount(),
-                equals(1)
-            ),
-        )
-    })
-})

package/build/templates/snippets/afterTest.ejs

@@ -1,20 +0,0 @@
-/**
-     * 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 {*}       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   information about 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/snippets/capabilities.ejs

@@ -1,57 +0,0 @@
-capabilities: [{<%
-    if (answers.expEnvAccessKey) { %>
-        // Experitest Access Key
-        // get more information at https://docs.experitest.com/display/TE/Obtaining+Access+Key
-        'experitest:accessKey': '<%- answers.expEnvAccessKey %>',<%
-    }
-    if (answers.browserEnvironment && answers.browserEnvironment.length) { %>
-        <%- answers.browserEnvironment.map((browserName) => {
-            return `browserName: '${browserName}'`
-        }).join('\n    }, {\n        ') %><%
-    } else if (answers.mobileEnvironment === 'android') { %>
-        // capabilities for local Appium web tests on an Android Emulator
-        platformName: 'Android',
-        browserName: 'Chrome',
-        'appium:deviceName': 'Android GoogleAPI Emulator',
-        'appium:platformVersion': '12.0',
-        'appium:automationName': 'UiAutomator2'<%
-    } else if (answers.mobileEnvironment === 'ios') { %>
-        // capabilities for local Appium web tests on iOS
-        platformName: 'iOS',
-        browserName: 'Safari',
-        'appium:deviceName': 'iPhone Simulator',
-        'appium:platformVersion': '16.4',
-        'appium:automationName': 'XCUITest'<%
-    } else if (answers.purpose === 'macos') { %>
-        platformName: 'Mac',
-        'appium:automationName': 'Mac2',
-        'appium:bundleId': '<%= answers.generateTestFiles ? 'com.apple.calculator' : '...' %>'<%
-    } else if (answers.purpose === 'vscode') { %>
-        browserName: 'vscode',
-        browserVersion: 'stable', // also possible: "insiders" or a specific version e.g. "1.80.0"
-        'wdio:vscodeOptions': {
-            // points to directory where extension package.json is located
-            extensionPath: __dirname,
-            // optional VS Code settings
-            userSettings: {
-                "editor.fontSize": 14
-            }
-        }<%
-    } else if (answers.purpose === 'electron') { %>
-        browserName: 'electron',
-        // Electron service options
-        // see https://webdriver.io/docs/desktop-testing/electron/configuration/#service-options
-        'wdio:electronServiceOptions': {<%
-            if (answers.electronAppBinaryPath) { %>
-            // custom path to app binary
-            appBinaryPath: '<%- answers.electronAppBinaryPath %>',<%
-            } %>
-            // custom application args
-            appArgs: []
-        }<%
-    } else {
-        %>
-        // capabilities for local browser web tests
-        browserName: 'chrome' // or "firefox", "microsoftedge", "safari"<%
-    } %>
-    }],

package/build/templates/snippets/cucumber.ejs

@@ -1,50 +0,0 @@
-<%  if (answers.framework === 'cucumber') { %>
-    // If you are using Cucumber you need to specify the location of your step definitions.
-    cucumberOpts: {
-        // <string[]> (file/dir) require files before executing features
-        require: ['<%- answers.stepDefinitions %>'],
-        // <boolean> show full backtrace for errors
-        backtrace: false,
-        // <string[]> ("extension:module") require files with the given EXTENSION after requiring MODULE (repeatable)
-        requireModule: [],
-        // <boolean> invoke formatters without executing steps
-        dryRun: false,
-        // <boolean> abort the run on first failure
-        failFast: false,
-        // <string[]> Only execute the scenarios with name matching the expression (repeatable).
-        name: [],
-        // <boolean> hide step definition snippets for pending steps
-        snippets: true,
-        // <boolean> hide source uris
-        source: true,
-        // <boolean> fail if there are any undefined or pending steps
-        strict: false,
-        // <string> (expression) only execute the features or scenarios with tags matching the expression
-        tagExpression: '',
-        // <number> timeout for step definitions
-        timeout: 60000,
-        // <boolean> Enable this config to treat undefined definitions as warnings.
-        ignoreUndefinedDefinitions: false
-    },
-<% } else if (answers.serenityAdapter === 'cucumber') { %>
-    // Cucumber configuration, see
-    //  https://serenity-js.org/api/cucumber-adapter/interface/CucumberConfig/
-    cucumberOpts: {
-        // <string[]> (file/dir) require files before executing features
-        import: [
-            <% if (answers.stepDefinitions) {
-                %>'<%- answers.stepDefinitions %>',
-            <% } %>'./features/support/*.<%- answers.isUsingTypeScript ? 'ts' : 'js' %>',
-        ],
-        // <string[]> (type[:path]) specify native Cucumber.js output format, if needed. Optionally supply PATH to redirect formatter output (repeatable)
-        format: [ ],
-        // <string> (name) specify the profile to use
-        profile: '',
-        // <boolean> fail if there are any undefined or pending steps
-        strict: false,
-        // <string[] | string> (expression) only execute the features or scenarios with tags matching the expression
-        tags: [],
-        // <number> timeout for step definitions
-        timeout: 60000,
-    },
-<% } %>

package/build/templates/snippets/electronTest.js.ejs

@@ -1,7 +0,0 @@
-import { browser } from '@wdio/globals'
-
-describe('Electron Testing', () => {
-    it('should print application title', async () => {
-        console.log('Hello', await browser.getTitle(), 'application!')
-    })
-})

package/build/templates/snippets/jasmine.ejs

@@ -1,20 +0,0 @@
-<%  if (answers.framework === 'jasmine') { %>
-    // Options to be passed to Jasmine.
-    jasmineOpts: {
-        // Jasmine default timeout
-        defaultTimeoutInterval: 60000,
-        //
-        // The Jasmine framework allows interception of each assertion in order to log the state of the application
-        // or website depending on the result. For example, it is pretty handy to take a screenshot every time
-        // an assertion fails.
-        expectationResultHandler: function(passed, assertion) {
-            // do something
-        }
-    },
-<% } else if (answers.serenityAdapter === 'jasmine') { %>
-    // Jasmine configuration, see:
-    //  https://serenity-js.org/api/jasmine-adapter/interface/JasmineConfig
-    jasmineOpts: {
-        defaultTimeoutInterval: 60000,
-    },
-<% } %>

package/build/templates/snippets/macosTest.js.ejs

@@ -1,11 +0,0 @@
-import { expect, $ } from '@wdio/globals'
-
-describe('MacOS Testing', () => {
-    it('should calculate the meaning of life', async function () {
-        await $('//XCUIElementTypeButton[@label="seven"]').click()
-        await $('//XCUIElementTypeButton[@label="multiply"]').click()
-        await $('//XCUIElementTypeButton[@label="six"]').click()
-        await $('//XCUIElementTypeButton[@title="="]').click()
-        await expect($('//XCUIElementTypeStaticText[@label="main display"]')).toHaveText('42')
-    })
-})

package/build/templates/snippets/mocha.ejs

@@ -1,14 +0,0 @@
-<%  if (answers.framework === 'mocha') { %>
-    // Options to be passed to Mocha.
-    // See the full list at http://mochajs.org/
-    mochaOpts: {
-        ui: 'bdd',
-        timeout: 60000
-    },
-<% } else if (answers.serenityAdapter === 'mocha') { %>
-    // Mocha configuration, see:
-    //  https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/
-    mochaOpts: {
-        timeout: 60000
-    },
-<% } %>

package/build/templates/snippets/reporters.ejs

@@ -1,14 +0,0 @@
-// Test reporter for stdout.
-    // The only one supported by default is 'dot'
-    // see also: https://webdriver.io/docs/dot-reporter<%
-if (reporters.length) { %>
-    reporters: [<%- reporters.map(reporter => {
-        if (reporter === 'allure') {
-            return `['${reporter}', {outputDir: 'allure-results'}]`
-        } else {
-            return `'${reporter}'`
-        }
-    }) %>],<% } else { %>
-    // reporters: ['dot'],<%
-    }
-%>

package/build/templates/snippets/serenity.ejs

@@ -1,18 +0,0 @@
-//
-    // Serenity/JS configuration, see:
-    //  https://serenity-js.org/handbook/getting-started/serenity-js-with-webdriverio/
-    serenity: {
-        runner: '<%- answers.serenityAdapter %>',
-
-        // Configure reporting services, see:
-        //  https://serenity-js.org/handbook/reporting/
-        crew: [
-            '@serenity-js/console-reporter',
-            '@serenity-js/serenity-bdd',
-            [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
-            [ '@serenity-js/web:Photographer',      {
-                // strategy: 'TakePhotosOfFailures'  // fast execution, screenshots only when tests fail
-                strategy: 'TakePhotosOfInteractions' // slower execution, more comprehensive reports
-            } ],
-        ]
-    },

package/build/templates/snippets/services.ejs

@@ -1,18 +0,0 @@
-services: [<%- answers.services.map((service) => {
-    if (service === 'electron') {
-        return /*js*/`'electron'`
-    } else if (service === 'sauce' && answers.useSauceConnect) {
-        return /*js*/`[
-        'sauce',
-        {
-            sauceConnect: true,
-            sauceConnectOpts: {
-                // add Sauce Connect Options if needed
-                // see more at https://docs.saucelabs.com/dev/cli/sauce-connect-5/
-            }
-        }
-    ]`
-    }
-
-    return `'${service}'`
-}).join(', ') %>],

package/build/templates/snippets/testWithPO.js.ejs

@@ -1,22 +0,0 @@
-<%- answers.isUsingTypeScript || answers.esmSupport
-    ? `import { expect } from '@wdio/globals'`
-    : `const { expect } = require('@wdio/globals')` %>
-<%- answers.isUsingTypeScript || answers.esmSupport
-    ? `import LoginPage from '${answers.relativePath}/login.page${answers.esmSupport ? '.js' : ''}'`
-    : `const LoginPage = require('${answers.relativePath}/login.page')` %>
-<%- answers.isUsingTypeScript || answers.esmSupport
-    ? `import SecurePage from '${answers.relativePath}/secure.page${answers.esmSupport ? '.js' : ''}'`
-    : `const SecurePage = require('${answers.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).toHaveText(
-            expect.stringContaining('You logged into a secure area!'))<%-
-        answers.includeVisualTesting ? `
-        await expect(SecurePage.flashAlert).toMatchElementSnapshot('flashAlert')` : '' %>
-    })
-})

package/build/templates/snippets/testWithoutPO.js.ejs

@@ -1,19 +0,0 @@
-<%- answers.isUsingTypeScript || answers.esmSupport
-    ? `import { expect, browser, $ } from '@wdio/globals'`
-    : `const { expect, browser, $ } = require('@wdio/globals')` %>
-
-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')).toHaveText(
-            expect.stringContaining('You logged into a secure area!'))<%-
-        answers.includeVisualTesting ? `
-        await expect($('#flash')).toMatchElementSnapshot('flashAlert')` : '' %>
-    })
-})

package/build/templates/snippets/vscodeTest.js.ejs

@@ -1,9 +0,0 @@
-import { browser, expect } from '@wdio/globals'
-
-describe('VS Code Extension Testing', () => {
-    it('should be able to load VSCode', async () => {
-        const workbench = await browser.getWorkbench()
-        expect(await workbench.getTitleBar().getTitle())
-            .toContain('[Extension Development Host]')
-    })
-})