jambit / wdio-cucumber-selected-steps-demo

Demo project for the wdio-cucumber-selected-steps library

Description

This is the demo project for the wdio-cucumber-selected-steps library, which ships a set of common steps for writing cucumber feature files for use with webdriver.io.

This demo-project is (like the library itself) also based on the official boilerplate, but has been rewritten to use the above project and also fix some errors.

Official repository: https://github.com/jambit/wdio-cucumber-selected-steps-demo

How to Use

• Download or clone this repository
• Run npm ci to install all dependencies
• Then either run npm test to execute the tests in chrome
• Or run npm run test:ci to execute the tests in headless chrome

List of Included Steps

This project uses existing step definitions for the most basic steps:

https://github.com/jambit/wdio-cucumber-selected-steps/blob/master/README.md#list-of-included-steps

Custom Steps

All of these steps can be used with Given, When, Then and And.

githubLogin

• I log in on github as "([^"]+)" with password "([^"]+)"
  -> Log in to github

userTable

• I create a user "(User A|User B)"
  -> Create a user
• I see the user "(User A|User B)" in "(User Table - User A|User Table - User B)"
  -> Validate a user row exists and has correct values in the columns

Documenting Custom Steps

The documentation for the steps included in this project are automatically generated using the package @jambit/wdio-cucumber-selected-steps-stepdoc. This tool was tailored to be used with this project, but you might be able to use it for your tests as well.

License

Licensed under MIT

wdio-cucumber-selected-steps-demo's Issues

Getting "ReferenceError: result is not defined" error

Node Version: 14.15.0
Error Message
ERROR @wdio/local-runner: Failed launching test session: ReferenceError: result is not defined
at Object.generateEvents (/Users/soduor/Documents/workspace/exam-player/node_modules/gherkin/lib/gherkin/generate_events.js:15:9)
at getTestCases (/Users/soduor/Documents/workspace/exam-player/node_modules/@wdio/cucumber-framework/node_modules/cucumber/lib/cli/helpers.js:79:35)
at /Users/soduor/Documents/workspace/exam-player/node_modules/@wdio/cucumber-framework/node_modules/cucumber/lib/cli/helpers.js:58:35

Pacakge.json
{
"name": "ui-tests",
"version": "1.0.0",
"main": "index.js",
"license": "MIT",
"scripts": {
"serve-storybook": "http-server ../storybooks/storybook-static -S",
"generate-step-def": "cucumber-js -- ",
"install-server": "export NODE_TLS_REJECT_UNAUTHORIZED=0 && selenium-standalone install",
"install-server-win": "setx NODE_TLS_REJECT_UNAUTHORIZED '0' && selenium-standalone install",
"start-server": "selenium-standalone start",
"test": "wdio wdio.conf.js"
},
"devDependencies": {
"@babel/core": "^7.12.9",
"@babel/preset-env": "^7.12.7",
"@babel/register": "^7.12.1",
"@jambit/wdio-cucumber-selected-steps": "^1.2.0",
"@wdio/cli": "^6.10.5",
"@wdio/cucumber-framework": "^6.10.4",
"@wdio/local-runner": "^6.10.5",
"@wdio/selenium-standalone-service": "^6.10.4",
"@wdio/spec-reporter": "^6.8.1",
"@wdio/sync": "^6.10.4",
"cucumber": "^7.0.0-rc.0"
}
}

wdio.conf.js
require("@babel/register")({
// This will override node_modules ignoring - you can alternatively pass
// an array of strings to be explicitly matched or a regex / glob
ignore: [
// Gherkin, however, is not compatible with babel, so ignore it.
'node_modules/gherkin/**/*.js'
],
});

// At the top:
const setupSelectors = require('@jambit/wdio-cucumber-selected-steps').setupSelectors;

exports.config = {
//
// ====================
// Runner Configuration
// ====================
//
// WebdriverIO allows it to run your tests in arbitrary locations (e.g. locally or
// on a remote machine).
runner: 'local',
//
// ==================
// Specify Test Files
// ==================
// Define which test specs should run. The pattern is relative to the directory
// from which wdio was called. Notice that, if you are calling wdio from an
// NPM script (see https://docs.npmjs.com/cli/run-script) then the current working
// directory is where your package.json resides, so wdio will be called from there.
//
specs: [
'./features/**/*.feature'
],
// Patterns to exclude.
exclude: [
// 'path/to/excluded/files'
],
//
// ============
// Capabilities
// ============
// Define your capabilities here. WebdriverIO can run multiple capabilities at the same
// time. Depending on the number of capabilities, WebdriverIO launches several test
// sessions. Within your capabilities you can overwrite the spec and exclude options in
// order to group specific specs to a specific capability.
//
// First, you can define how many instances should be started at the same time. Let's
// say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
// set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
// files and you set maxInstances to 10, all spec files will get tested at the same time
// and 30 processes will get spawned. The property handles how many capabilities
// from the same test should run tests.
//
maxInstances: 10,
//
// If you have trouble getting all important capabilities together, check out the
// Sauce Labs platform configurator - a great tool to configure your capabilities:
// https://docs.saucelabs.com/reference/platforms-configurator
//
capabilities: [{

    // maxInstances can get overwritten per capability. So if you have an in-house Selenium
    // grid with only 5 firefox instances available you can make sure that not more than
    // 5 instances get started at a time.
    maxInstances: 5,
    //
    browserName: 'chrome',
    acceptInsecureCerts: true,
    'goog:chromeOptions': {
        //binary: electronPath,
        //args: [`app=/Applications/cb-exam-player.app/Contents/MacOS/cb-exam-player`]
        //binary: '/Applications/cb-exam-player.app/Contents/MacOS/cb-exam-player'
        // to run chrome headless the following flags are required
        // (see https://developers.google.com/web/updates/2017/04/headless-chrome)
        //args: ['--headless'], //'--disable-gpu', '--no-sandbox', '--disable-dev-shm-usage'],
    }
    // If outputDir is provided WebdriverIO can capture driver session logs
    // it is possible to configure which logTypes to include/exclude.
    // excludeDriverLogs: ['*'], // pass '*' to exclude all driver session logs
    // excludeDriverLogs: ['bugreport', 'server'],
}],
//
// ===================
// Test Configurations
// ===================
// Define all options that are relevant for the WebdriverIO instance here
//
// Level of logging verbosity: trace | debug | info | warn | error | silent
logLevel: 'info',
//
// Set specific log levels per logger
// loggers:
// - webdriver, webdriverio
// - @wdio/applitools-service, @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
// - @wdio/mocha-framework, @wdio/jasmine-framework
// - @wdio/local-runner
// - @wdio/sumologic-reporter
// - @wdio/cli, @wdio/config, @wdio/sync, @wdio/utils
// Level of logging verbosity: trace | debug | info | warn | error | silent
// logLevels: {
//     webdriver: 'info',
//     '@wdio/applitools-service': 'info'
// },
//
// If you only want to run your tests until a specific amount of tests have failed use
// bail (default is 0 - don't bail, run all tests).
bail: 0,
//
// Set a base URL in order to shorten url command calls. If your `url` parameter starts
// with `/`, the base url gets prepended, not including the path portion of your baseUrl.
// If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
// gets prepended directly.
baseUrl: 'http://localhost',
//
// Default timeout for all waitFor* commands.
waitforTimeout: 10000,
//
// Default timeout in milliseconds for request
// if browser driver or grid doesn't send response
connectionRetryTimeout: 120000,
//
// Default request retries count
connectionRetryCount: 3,
//
// Test runner services
// Services take over a specific job you don't want to take care of. They enhance
// your test setup with almost no effort. Unlike plugins, they don't add new
// commands. Instead, they hook themselves up into the test process.
services: ['selenium-standalone'],

// Framework you want to run your specs with.
// The following are supported: Mocha, Jasmine, and Cucumber
// see also: https://webdriver.io/docs/frameworks.html
//
// Make sure you have the wdio adapter package for the specific framework installed
// before running any tests.
framework: 'cucumber',
//
// The number of times to retry the entire specfile when it fails as a whole
// specFileRetries: 1,
//
// Delay in seconds between the spec file retry attempts
// specFileRetriesDelay: 0,
//
// Whether or not retried specfiles should be retried immediately or deferred to the end of the queue
// specFileRetriesDeferred: false,
//
// Test reporter for stdout.
// The only one supported by default is 'dot'
// see also: https://webdriver.io/docs/dot-reporter.html
reporters: ['spec'],


//
// 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: [
        './node_modules/@jambit/wdio-cucumber-selected-steps/lib/steps/*.js',
        './features/step-definitions/steps.js'
    ],
    // <boolean> show full backtrace for errors
    backtrace: false,
    // <string[]> ("extension:module") require files with the given EXTENSION after requiring MODULE (repeatable)
    requireModule: ['@babel/register'],
    // <boolean> invoke formatters without executing steps
    dryRun: false,
    // <boolean> abort the run on first failure
    failFast: false,
    // <string[]> (type[:path]) specify the output format, optionally supply PATH to redirect formatter output (repeatable)
    format: ['pretty'],
    // <boolean> hide step definition snippets for pending steps
    snippets: true,
    // <boolean> hide source uris
    source: true,
    // <string[]> (name) specify the profile to use
    profile: [],
    // <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
},

//
// =====
// Hooks
// =====
// WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
// it and to build services around it. You can either apply a single function or an array of
// methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
// resolved to continue.
/**
 * Gets executed once before all workers get launched.
 * @param {Object} config wdio configuration object
 * @param {Array.<Object>} capabilities list of capabilities details
 */
// onPrepare: function (config, capabilities) {
// },
/**
 * Gets executed before a worker process is spawned and can be used to initialise specific service
 * for that worker as well as modify runtime environments in an async fashion.
 * @param  {String} cid      capability id (e.g 0-0)
 * @param  {[type]} caps     object containing capabilities for session that will be spawn in the worker
 * @param  {[type]} specs    specs to be run in the worker process
 * @param  {[type]} args     object that will be merged with the main configuration once worker is initialised
 * @param  {[type]} execArgv list of string arguments passed to the worker process
 */
// onWorkerStart: function (cid, caps, specs, args, execArgv) {
// },
/**
 * Gets executed just before initialising the webdriver session and test framework. It allows you
 * to manipulate configurations depending on the capability or spec.
 * @param {Object} config wdio configuration object
 * @param {Array.<Object>} capabilities list of capabilities details
 * @param {Array.<String>} specs List of spec file paths that are to be run
 */
// beforeSession: function (config, capabilities, specs) {
// },
/**
 * Gets executed before test execution begins. At this point you can access to all global
 * variables like `browser`. It is the perfect place to define custom commands.
 * @param {Array.<Object>} capabilities list of capabilities details
 * @param {Array.<String>} specs        List of spec file paths that are to be run
 * @param {Object}         browser      instance of created browser/device session
 */
 before: function (capabilities, specs) {
    setupSelectors([
        './src/selectors/*.js'
    ]);
 },
/**
 * Runs before a WebdriverIO command gets executed.
 * @param {String} commandName hook command name
 * @param {Array} args arguments that command would receive
 */
// beforeCommand: function (commandName, args) {
// },
/**
 * Runs before a Cucumber feature
 */
// beforeFeature: function (uri, feature, scenarios) {
// },
/**
 * Runs before a Cucumber scenario
 */
// beforeScenario: function (uri, feature, scenario, sourceLocation, context) {
// },
/**
 * Runs before a Cucumber step
 */
// beforeStep: function ({ uri, feature, step }, context) {
// },
/**
 * Runs after a Cucumber step
 */
// afterStep: function ({ uri, feature, step }, context, { error, result, duration, passed, retries }) {
// },
/**
 * Runs after a Cucumber scenario
 */
// afterScenario: function (uri, feature, scenario, result, sourceLocation, context) {
// },
/**
 * Runs after a Cucumber feature
 */
// afterFeature: function (uri, feature, scenarios) {
// },

/**
 * Runs after a WebdriverIO command gets executed
 * @param {String} commandName hook command name
 * @param {Array} args arguments that command would receive
 * @param {Number} result 0 - command success, 1 - command error
 * @param {Object} error error object if any
 */
// afterCommand: function (commandName, args, result, error) {
// },
/**
 * Gets executed after all tests are done. You still have access to all global variables from
 * the test.
 * @param {Number} result 0 - test pass, 1 - test fail
 * @param {Array.<Object>} capabilities list of capabilities details
 * @param {Array.<String>} specs List of spec file paths that ran
 */
// after: function (result, capabilities, specs) {
// },
/**
 * Gets executed right after terminating the webdriver session.
 * @param {Object} config wdio configuration object
 * @param {Array.<Object>} capabilities list of capabilities details
 * @param {Array.<String>} specs List of spec file paths that ran
 */
// afterSession: function (config, capabilities, specs) {
// },
/**
 * Gets executed after all workers got shut down and the process is about to exit. An error
 * thrown in the onComplete hook will result in the test run failing.
 * @param {Object} exitCode 0 - success, 1 - fail
 * @param {Object} config wdio configuration object
 * @param {Array.<Object>} capabilities list of capabilities details
 * @param {<Object>} results object containing test results
 */
// onComplete: function(exitCode, config, capabilities, results) {
// },
/**
* Gets executed when a refresh happens.
* @param {String} oldSessionId session ID of the old session
* @param {String} newSessionId session ID of the new session
*/
//onReload: function(oldSessionId, newSessionId) {
//}

}