webdriverio / cucumber-boilerplate

Boilerplate project to run WebdriverIO tests with Cucumber

Cucumber Boilerplate

Boilerplate project to run WebdriverIO (alpha v8) tests with Cucumber and brings true BDD to JavaScript. Instead of writing complicated test code that only developers can understand, Cucumber maps an ordinary language to code and allows to start with the test process in the early stages of your product development.

Note: If you are still using an older WebdriverIO version, check out the v7 branch.

Requirements

• Node version 14 or higher
• A preconfigured Selenium Grid, preinstalled browser driver or cloud provider account

Although this project works fine with NPM we recommend to use Yarn (>= 1.0.0) instead, due to its speed & solid dependency locking mechanism. To keep things simple we use yarn in this guide, but feel free to replace this with NPM if that is what you are using.

Also this project doesn't cover setting up a proper test environment. You need to download specific browser driver yourself and run the prior starting tests or use a cloud provider like SauceLabs.

Quick start

Choose one of the following options:

1. Download the latest stable release here or clone the git repo — git clone https://github.com/webdriverio/cucumber-boilerplate.git

2. Then:

• Copy the files to your project into a directory like /integrationtests (note the hidden files!)

3. Clean the project (Optional):

• On OSX/Linux: -- Run yarn run clean

• On Windows: -- Remove the directories /.git, /.github, /demo-app & /test -- Remove the files .travis.yml, jest.json & wdio.BUILD.conf.js -- Remove all the demo features from the /src/features directory

4. Install the dependencies (yarn install)

Now you are ready to write your own features.

Features

• Super simple setup
• Full integration with WebdriverIO
• Over 150 predefined steps that cover almost everything you need, you can start writing tests right away
• Easy integration with cloud services like Sauce Labs
• Integration of WebdriverIO's Multiremote functionality
• Easy to run tests in parallel

How to write a test

Tests are written in Gherkin syntax that means that you write down what's supposed to happen in a real language. All test files are located in ./src/features/* and have the file ending .feature. You will already find some test files in that directory. They should demonstrate, how tests could look like. Just create a new file and write your first test.

myFirstTest.feature

Feature:
    In order to keep my product stable
    As a developer or product manager
    I want to make sure that everything works as expected

Scenario: Check title of website after search
    Given I open the url "http://google.com"
    When I set "WebdriverIO" to the inputfield "#lst-ib"
    And I press "Enter"
    Then I expect that the title is "WebdriverIO - Google Search"

Scenario: Another test
    Given ...

This test opens the browser and navigates them to google.com to check if the title contains the search query after doing a search. As you can see, it is pretty simple and understandable for everyone.

How to run the test

Start the local web server:

$ yarn run test

To run your tests just call the WDIO runner:

$ yarn run wdio

please note The WDIO runner uses the configuration file wdio.conf.js by default.

Configurations

To configure your tests, checkout the wdio.conf.js file in your test directory. It comes with a bunch of documented options you can choose from.

Environment-specific configurations

You can setup multiple configs for specific environments. Let's say you want to have a different baseUrl for your local and pre-deploy tests. Use the wdio.conf.js to set all general configs (like mochaOpts) that don't change. They act as default values. For each different environment you can create a new config with the following name scheme:

wdio.<ENVIRONMENT>.conf.js

Now you can create a specific config for your pre-deploy tests:

wdio.STAGING.conf.js

var config = require('./wdio.conf.js').config;

config.baseUrl = 'http://staging.example.com'

exports.config = config;

Your environment-specific config file will get merged into the default config file and overwrites the values you set. To run a test in a specific environment just add the desired configuration file as the first parameter:

$ yarn run wdio wdio.STAGING.conf.js

Running single feature

Sometimes it's useful to only execute a single feature file, to do so use the following command:

$ npx wdio wdio.conf.js --spec ./test/features/select.feature

Using tags

If you want to run only specific tests you can mark your features with tags. These tags will be placed before each feature like so:

@Tag
Feature: ...

To run only the tests with specific tag(s) use the --cucumberOpts.tagExpression= parameter like so:

$ npx wdio wdio.conf.js --cucumberOpts.tagExpression='@Tag or @AnotherTag'

For more tag options please see the Cucumber.js documentation

Pending test

If you have failing or unimplemented tests you can mark them as "Pending" so they will get skipped.

// skip whole feature file
@Pending
Feature: ...

// only skip a single scenario
@Pending
Scenario: ...

Adding new steps and snippets

The predefined snippets allow you to do a lot of common things but you might need extra snippets which are better aligned with your aims. To do so you will find all step definitions in ./src/steps. They are separated in given, when and then.

You define your snippet using regular expressions. This is pretty powerful as it allows you to create complex sentences with multiple options. Everything that's within "([^"]*)?" gets captured and appended to the callback. The last argument is always a callback function that you need to call when your step is done. You can access the browser and your WebdriverIO instance with browser.

To assert values this boilerplate project uses WebdriverIOs embedded assertion library called expect-webdriverio.

Comments

You can add additional descriptive comments in your feature files.

###
  This is a
  block comment
###
Feature: As a bystander
    I can watch bottles falling from a wall
    So that I can be mildly amused

# This is a single line comment
Scenario: check if username is present
    Given I login as "roboter" with password "test123"
    Then the username "roboter" should be present in the header

List of predefined steps

Check out all predefined snippets. You can see how they get used in sampleSnippets.feature.

Given steps

• I open the (url|site) "([^"]*)?"
  Open a site in the current browser window/tab
• the element "([^"]*)?" is( not)* displayed
  Check the (in)visibility of an element
• the element "([^"]*)?" is( not)* enabled
  Check if an element is (not) enabled
• the element "([^"]*)?" is( not)* selected
  Check if an element is (not) selected
• the checkbox "([^"]*)?" is( not)* checked
  Check if a checkbox is (not) checked
• there is (an|no) element "([^"]*)?" on the page
  Check if an element (does not) exist
• the title is( not)* "([^"]*)?"
  Check the title of the current browser window/tab
• the element "([^"]*)?" contains( not)* the same text as element "([^"]*)?"
  Compare the text of two elements
• the (button|element) "([^"]*)?"( not)* contains the text "([^"]*)?"
  Check if an element contains the given text
• the (button|element) "([^"]*)?"( not)* contains any text
  Check if an element does not contain any text
• the (button|element) "([^"]*)?" is( not)* empty
  Check if an element is empty
• the page url is( not)* "([^"]*)?"
  Check the url of the current browser window/tab
• the( css)* attribute "([^"]*)?" from element "([^"]*)?" is( not)* "([^"]*)?"
  Check the value of an element's (css) attribute
• the cookie "([^"]*)?" contains( not)* the value "([^"]*)?"
  Check the value of a cookie
• the cookie "([^"]*)?" does( not)* exist
  Check the existence of a cookie
• the element "([^"]*)?" is( not)* ([\d]+)px (broad|tall)
  Check the width/height of an element
• the element "([^"]*)?" is( not)* positioned at ([\d]+)px on the (x|y) axis
  Check the position of an element
• I have a screen that is ([\d]+) by ([\d]+) pixels
  Set the browser size to a given size
• I have closed all but the first (window|tab)
  Close all but the first browser window/tab
• a (alertbox|confirmbox|prompt) is( not)* opened
  Check if a modal is opened

Then steps

• I expect that the title is( not)* "([^"]*)?"
  Check the title of the current browser window/tab
• I expect that element "([^"]*)?" does( not)* appear exactly "([^"]*)?" times
  Checks that the element is on the page a specific number of times
• I expect that element "([^"]*)?" is( not)* visible
  Check if a certain element is visible
• I expect that element "([^"]*)?" becomes( not)* visible
  Check if a certain element becomes visible
• I expect that element "([^"]*)?" is( not)* within the viewport
  Check if a certain element is within the current viewport
• I expect that element "([^"]*)?" does( not)* exist
  Check if a certain element exists
• I expect that element "([^"]*)?"( not)* contains the same text as element "([^"]*)?"
  Compare the text of two elements
• I expect that (button|element) "([^"]*)?"( not)* contains the text "([^"]*)?"
  Check if an element or input field contains the given text
• I expect that (button|element) "([^"]*)?"( not)* contains any text
  Check if an element or input field contains any text
• I expect that (button|elementelement) "([^"]*)?" is( not)* empty
  Check if an element or input field is empty
• I expect that the url is( not)* "([^"]*)?"
  Check if the the URL of the current browser window/tab is a certain string
• I expect that the path is( not)* "([^"]*)?"
  Check if the path of the URL of the current browser window/tab is a certain string
• I expect the url to( not)* contain "([^"]*)?"
  Check if the URL of the current browser window/tab contains a certain string
• I expect that the( css)* attribute "([^"]*)?" from element "([^"]*)?" is( not)* "([^"]*)?"
  Check the value of an element's (css) attribute
• I expect that checkbox "([^"]*)?" is( not)* checked
  Check if a check-box is (not) checked
• I expect that element "([^"]*)?" is( not)* selected
  Check if an element is (not) selected
• I expect that element "([^"]*)?" is( not)* enabled
  Check if an element is (not) enabled
• I expect that cookie "([^"]*)?"( not)* contains "([^"]*)?"
  Check if a cookie with a certain name contains a certain value
• I expect that cookie "([^"]*)?"( not)* exists
  Check if a cookie with a certain name exist
• I expect that element "([^"]*)?" is( not)* ([\d]+)px (broad|tall)
  Check the width/height of an element
• I expect that element "([^"]*)?" is( not)* positioned at ([\d]+)px on the (x|y) axis
  Check the position of an element
• I expect that element "([^"]*)?" (has|does not have) the class "([^"]*)?"
  Check if an element has a certain class
• I expect a new (window|tab) has( not)* been opened
  Check if a new window/tab has been opened
• I expect the url "([^"]*)?" is opened in a new (tab|window)
  Check if a URL is opened in a new browser window/tab
• I expect that element "([^"]*)?" is( not)* focused
  Check if an element has the focus
• I wait on element "([^"]*)?"( for (\d+)ms)*( to( not)* (be checked|be enabled|be selected|be visible|contain a text|contain a value|exist))*
  Wait for an element to be checked, enabled, selected, visible, contain a certain value or text or to exist
• I expect that a (alertbox|confirmbox|prompt) is( not)* opened
  Check if a modal is opened
• I expect that a (alertbox|confirmbox|prompt)( not)* contains the text "$text"
  Check the text of a modal

When steps

• I (click|doubleclick) on the (link|button|element) "([^"]*)?"
  (Double)click a link, button or element
• I (add|set) "([^"]*)?" to the inputfield "([^"]*)?"
  Add or set the content of an input field
• I clear the inputfield "([^"]*)?"
  Clear an input field
• I drag element "([^"]*)?" to element "([^"]*)?"
  Drag an element to another element
• I submit the form "([^"]*)?"
  Submit a form
• I pause for (\d+)ms
  Pause for a certain number of milliseconds
• I set a cookie "([^"]*)?" with the content "([^"]*)?"
  Set the content of a cookie with the given name to the given string
• I delete the cookie "([^"]*)?"
  Delete the cookie with the given name
• I press "([^"]*)?"
  Press a given key. You’ll find all supported characters here. To do that, the value has to correspond to a key from the table.
• I (accept|dismiss) the (alertbox|confirmbox|prompt)
  Accept or dismiss a modal window
• I enter "([^"]*)?" into the prompt
  Enter a given text into a modal prompt
• I scroll to element "([^"]*)?"
  Scroll to a given element
• I close the last opened (window|tab)
  Close the last opened browser window/tab
• I focus the last opened (window|tab)
  Focus the last opened browser window/tab
• I select the (\d+)(st|nd|rd|th) option for element "([^"]*)?"
  Select an option based on it's index
• I select the option with the (name|value|text) "([^"]*)?" for element "([^"]*)?"
  Select an option based on its name, value or visible text
• I move to element "([^"]*)?"( with an offset of (\d+),(\d+))
  Move the mouse by an (optional) offset of the specified element
• I switch to the iframe "([^"]*)?"
  Switch to a particular iFrame on the webpage

cucumber-boilerplate's Issues

German text

At https://github.com/webdriverio/cucumber-boilerplate/blob/master/test/support/helper/checkProperty.js#L20

Under which exact circumstances are multiple browser instances created?

Not sure if this issue is only related to the boilerplate, or also to the webdriverIO multiremote mode:

When I have set options for my browser instances in my default config.js:

...,
options: {
    browser1: {
        logLevel: 'silent'
    },
    browser2: {
        logLevel: 'silent'
    }
},
...

but I want to execute a test with only one browser instance, I use the ENV_NODE variable and write a file config.myCustomTest.js containing:

...,
capabilities: {
    browser1: {
        platform: "WINDOWS",
        browserName: "chrome"
        }
    }
},
...

This leads to the execution of the tests with two browsers (where the capabilities of browser2 are undefined and change on every execution). It seems that the options, which are set in config.js are enough to trigger the execution in multiple browsers. It would be much nicer, if I could set my default for the options without having to overwrite them every time, if I need less browsers than I have options for, because I'm usually not changing the options from test to test and would love to set these values as default.

Add release tags

The README says

and checkout the tagged release you'd like to use

An in-range update of wdio-selenium-standalone-service is breaking the build 🚨

Version 0.0.9 of wdio-selenium-standalone-service just got published.

Branch	Build failing 🚨
Dependency	wdio-selenium-standalone-service
Current Version	0.0.8
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

wdio-selenium-standalone-service is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Commits

The new version differs by 3 commits.

• fba2ca6 v0.0.9
• 7954e91 : update selenium standalone to version 6.5.0
• ae88b3f Bumping version up

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

Block comments do not seem to work properly

Example:

Feature: Valuation slide user journey - pre-reqisite
    As a developer
    I want to open the url /valuation/

    Scenario: Background - load url valuation
        Given I open the url "/valuation/"
        Then I expect the url to contain "/valuation/"

"""
 anything here...

"""        

For the above I get an error -

1. Background - load url valuation6 I expect the url to contain "/valuation/":
   [chrome #0-0] done is not a function

I think the problem is, that cucumber doesn't recognise that it has completed all it's scenarios. The done() method doesn't seem to exist.

Is it possible so that the browser closes after each test

I just want to say great work on this frame work, from a non coder here learning JS it's an amazing piece of work!

I just have 2 questions though..

1. Is there anyway to ensure the browser quits after each test has complete?
2. Also is there a way that the selenium standalone server could start up prior to a test commencing?

Thanks in advance!

How to implement value change or text change?

Multi mode for features

Hi. Your project very like me.
But, i wish to run my features in multi mode(parallel).
I saw in README your have planned - "Easy to run tests in parallel (coming soon)" - it is very needed feature 👍

I think it can be like it is code for example

@Multi
Feature: Some feature

or

@Multi
Scenario: Some scenario

Improve documentation around command support for desktop vs. mobile

this is my feature

Feature: Admin login
Scenario: Login successful
     When I set "lixun" to the inputfield "//android.widget.EditText[@resource-id="com.lilun.passionlife:id/et_username"]"
     And I set "lixun" to the inputfield "//android.widget.EditText[@resource-id="com.lilun.passionlife:id/et_pwd"]"
     And I click on the element "//android.widget.Button[@resource-id="com.lilun.passionlife:id/login"]"
     Then I expect that the title is "//android.widget.TextView[@resource-id="com.lilun.passionlife:id/home_title"]" 

there is some error

Admin login Login successful Then I expect that the title is "//android.widget.TextView[@resource-id="com.lilun.passionlife:id/home_title"]":
     Uncaught RuntimeError: Method has not yet been implemented
      at getTitle() - E:\cucumber\cucumber-boilerplate\test\support\check\checkTitle.js:7:10
      at touchClick("3") - E:\cucumber\cucumber-boilerplate\node_modules\webdriverio\lib\commands\click.js:30:33

i'm just a new beginner,i hope you can tell something for me, thanks very much

Example showing usage with Page Object Pattern (suggestion)

Having trouble figuring out how to get this hooked up using Page Objects
Would I have to reimplement each support function?

Installing cucumber-boilerplate as an NPM package?

I am afraid I am a javascript/NPM noob, but is there any reason why cucumber-boilerplate is not available as an NPM module? I have a client who is considering using cucumber-boilerplate and it would make management easier if we could install it via NPM.

If the reason is simply that it is just not a priority (as opposed to technical reasons) I am happy to do the legwork, if somebody can point me in the right direction in terms of getting started.

can't make 'cucumberOpts' work on webdriverIO runner

Hi,
our automation team are using "cucumber-boilerplate" and I have successfully run it as part of my CI in Jenkins. I'm trying to generate a json report to be read by Jenkins at the end of the run.
problem is it seems that the 'cucumberOpts' in conf.js file do not take any effect. is there another way to make them work?
or even better - another way to generate reports?
my conf.js file is this:

exports.config = {

    /**
     * language of your feature files
     * options: french, spanish, norwegian, polish, german, russian
     */
    language: 'english',

    /**
     * set selenium host and port
     */
    selenium: {
        host: '127.0.0.1',
        port: 5555
    },

    /**
     * webdriverio options
     *
     * - logLevel: stdout log level
     *   Options: *verbose* | *silent* | *command* | *data* | *result*
     *
     * - coloredLogs: Enables colors for log output
     *   default: true
     *
     * - singleton: Set to true if you always want to reuse the same remote
     *   default: false
     *
     * - waitforTimeout: Default timeout for all waitForXXX commands
     *   default: 500
     */
    options: {
        logLevel: 'verbose'
    },


    reporters: ['xunit'],
        cucumberOpts: {
            out:'../',
            failFast:true,
            require: [],        // <string[]> (file/dir) require files before executing features
            backtrace: false,   // <boolean> show full backtrace for errors
            compiler: [],       // <string[]> ("extension:module") require files with the given EXTENSION after requiring MODULE (repeatable)
            dryRun: false,      // <boolean> invoke formatters without executing steps
            failFast: false,    // <boolean> abort the run on first failure
            format: ['json:../result.json','pretty'], // <string[]> (type[:path]) specify the output format, optionally supply PATH to redirect formatter output (repeatable)
            colors: false,       // <boolean> disable colors in formatter output
            snippets: true,     // <boolean> hide step definition snippets for pending steps
            source: true,       // <boolean> hide source uris
            profile: [],        // <string[]> (name) specify the profile to use
            require: [],        // <string[]> (file/dir) require files before executing features
            strict: true,      // <boolean> fail if there are any undefined or pending steps
            tags: [],           // <string[]> (expression) only execute the features or scenarios with tags matching the expression
            timeout: 20000,      // <number> timeout for step definitions
            ignoreUndefinedDefinitions: false // <boolean> Enable this config to treat undefined definitions as warnings.
        },
    /**
     * desired capabilities
     */
    capabilities: {
        browserName: 'firefox'
    },

    /**
     * location of feature files
     */
    featureFiles: [
       'test/features/automation/Registration/Registration.feature'
    ],


    env: {
        baseUrl: '<our app site>'
    }


};

my indication for the 'cucumberOpts' is the "failFast:true" which doesnot take any effect, also no json is being generated.

Dictionary definitions are ignored

Dictionary definitions are being ignored because the library is not being initialised with the dictionary on https://github.com/webdriverio/cucumber-boilerplate/blob/master/test/support/step-definitions.js#L10-L11

If you change this to

var dictionary = new Yadda.Dictionary();
var library = language.library(dictionary);

The definitions start getting picked up.

Naming conflict in custom given / when steps

Issue description

When having the same name within a Given or When step the corresponding step no longer gets executed and the end result will be pending.

Steps to reproduce

Create a custom step with the same name for Given and When.

Within given.js:

this.Given(
    /^foobar$/,
    (done) => { done(); }
);

Within when.js:

this.When(
    /^foobar$/,
    (done) => { done(); }
);

Expected behavior

I expect the custom rule the get executed. Like:

[chrome #0-0]   My scenario
[chrome #0-0]       ✓ I open the site "/"
[chrome #0-0]       ✓ foobar
[chrome #0-0] 2 passing

Actual behavior

The custom rule returns pending and does not get executed. Like:

[chrome #0-0]   My scenario
[chrome #0-0]       ✓ I open the site "/"
[chrome #0-0]       - foobar
[chrome #0-0] 1 passing
[chrome #0-0] 1 pending

Issue occurred on browser/platform

• NodeJS v5.6.0
• The latest master branch with the changes from #60
• Chrome

Cannot run features using tags

I've added some tags to my feature files and but they seem to be ignored by the CLI

Steps: add a @tag to a feature file and then run it (wdio --tags=@auth) using the CLI

Expected: I expect that the feature file containing @tag to run

Actual: Browser opened, url did not load, it looked like @pending tags are running

Windows 10 / Chrome

Using junit reporter with cucumber-boilerplate seems to not work

Using cucumber-boilerplate with junit reporter, I get an error:
This is inside my wdio.conf:

    reporters: ['spec','junit'],
    reporterOptions: {
        junit: {
            outputDir: './reports/'
        }
    },  

This is are my package.json dependencies:

    "babel-polyfill": "~6.20.0",
    "babel-preset-es2015": "~6.18.0",
    "babel-register": "~6.18.0",
    "chai": "~3.5.0",
    "cucumber": "^1.3.1",
    "eslint": "~3.13.1",
    "eslint-config-airbnb-base": "~11.0.1",
    "gulp": "^3.9.1",
    "gulp-util": "^3.0.8",
    "gutil": "^1.6.4",
    "lodash": "^4.17.4",
    "node-notifier": "^5.1.2",
    "wdio-cucumber-framework": "~0.2.15",
    "wdio-junit-reporter": "^0.3.0",
    "wdio-phantomjs-service": "~0.2.2",
    "wdio-selenium-standalone-service": "~0.0.7",
    "wdio-spec-reporter": "~0.0.5",
    "webdriverio": "~4.6.1"

This is my gulp task which triggers the test:

gulp.task('webdriverTest', ['selenium'], function() {
  var creatLauncherWithConfig = function(env){
    var strFile = path.join(__dirname, 'wdio.conf.js');
	  var wdio = new Launcher(strFile);	  
    return wdio;
  }
  var wdio = creatLauncherWithConfig(gutil.env);
  wdio.run().then(function (code) {
      process.exit(code);
    }, function (error) {
      console.error('Launcher failed to start the test', error.stacktrace);
      process.exit(1);
  });
});

This is the error:

cucumber_boilerplate_prototype\node_modules\webdriverio\build\lib\utils\BaseReporter.js:336
                        throw _iteratorError;
                        ^

TypeError: Cannot read property 'toLowerCase' of undefined
    at JunitReporter.prepareName (c:\projects\cucumber_boilerplate_prototype\node_modules\wdio-junit-reporter\build\reporter.js:98:24)
    at JunitReporter.prepareXml (c:\projects\cucumber_boilerplate_prototype\node_modules\wdio-junit-reporter\build\reporter.js:147:57)
    at JunitReporter.onEnd (c:\projects\cucumber_boilerplate_prototype\node_modules\wdio-junit-reporter\build\reporter.js:75:36)
    at emitOne (events.js:77:13)
    at JunitReporter.emit (events.js:169:7)
    at BaseReporter.handleEvent (c:\projects\cucumber_boilerplate_prototype\node_modules\webdriverio\build\lib\utils\BaseReporter.js:324:35)
    at Launcher.endHandler (c:\projects\cucumber_boilerplate_prototype\node_modules\webdriverio\build\lib\launcher.js:637:28)
    at emitTwo (events.js:87:13)
    at ChildProcess.emit (events.js:172:7)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:200:12)

Error: done() invoked with non-Error:

 Test feature to log into wordpress admin
    add value to an inputs element
      √ Given I open the site "/wp-admin/" (2456ms)
      √ And   I clear the inputfield "#user_login" (135ms)
      √ And   I clear the inputfield "#user_pass" (87ms)
      √ And   the inputfield "#user_login" does not contain any text (78ms)
      √ And   I add "value" to the inputfield "#user_login" (122ms)
      √ And   I add "value" to the inputfield "#user_pass" (146ms)
      √ When  I click on the button "#wp-submit" (2745ms)
      √ Then  I expect that element "#wpadminbar" is visible (83ms)
    1) "after all" hook


  8 passing (9s)
  1 failing

  1) Test feature to log into wordpress admin "after all" hook:
     Error: done() invoked with non-Error: {"state":"success","sessionId":"c6f88ee4-f886-4818-8a6d-259386535b8d","hCode":960784190,"value":null,"class":"org.openqa.selenium.remote.Response","status":0}

the code in hooks

var AfterHook = module.exports = function (done) {
    this.browser.end().then(done);
};

How to create reports in xml?

I try use wdio-junit-reporter, but it does't works for me. What i need to do, i need xml reports.

is empty gives wrong result

contains any text and empty are sharing the same support function, checkContainsAnyText. In reality, they should be opposite.

this.Then(
        /^I expect that (element|inputfield) "([^"]*)?"( not)* contains any text$/,
        checkContainsAnyText
    );

    this.Then(
        /^I expect that (element|inputfield) "([^"]*)?" is( not)* empty$/,
        checkContainsAnyText
    );

Right now, is empty is given the wrong result.

unable to run test

Hi all!
I am trying to run test from my os,
I added all dep but still non of test arent working,
the errors:

/usr/local/bin/node run.js
child_process: customFds option is deprecated, use stdio instead.

Github test
1) "before all" hook

Pending scenario
do somethimg
- Given I open the site "/"

Sample Snippets test
open URL
2) Given the page url is not "http://webdriverjs.christian-bromann.com/"
- And I open the url "http://webdriverjs.christian-bromann.com/"
- Then I expect that the url is "http://webdriverjs.christian-bromann.com/"
- And I expect that the url is not "http://google.com"

A few questions

Hi, it s not issue, just want to ask you.
Can i write smth like this if it was by jquery.

I expect that $('.my_class').text() == $('body').data('myparam')
And the second one is how to parse urls by class i mean i need check www.site.com?param=1000
If $('body').data('myparam') == ?param

Thanks.

Scenario Outline not working

I started using your boiletplate recently and it's bee great so far.

I was trying to use a Scenario Outline to cut down on cucumber test file bulk. It was just passing the tests even when I set them to fail by using the wrong information in the table.

I thought cucumber had all this setup by default.

Can not test web site write with react.

Hi,

I change the browserName in this boilerplate from 'chrome' to 'phantomjs' to test a web site written in React which means html page rendered with js.

It ends with element not found.(goto the page and assert title of the page is working, but not the element in render with react)

It works when I change browserName back to chrome.

Is there any solution for testing js rendered web site with phantomjs?

Add tag configuration

Hi.
Does this solution allows adding a "tags" configuration parameter so that we can specify the test to run? (e.g run only the test with the @example annotation).

I'm trying to find it but so far no luck...

Syntax error on running npm clean

Issue description

Unable to run npm clean with follow errors

mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ npm run clean

> [email protected] clean /home/mondwan/Documents/codeTest/cucumber-boilerplate
> read -p "Are you sure you want to clean the project? [y/n] " -n 1 -r; if [[ $REPLY =~ ^[Yy]$ ]]; then sudo rm -R .git .github demo-app test .codeclimate.yml .travis.yml jest.json wdio.BUILD.conf.js src/features/**; fi

sh: 1: read: Illegal option -n
sh: 1: [[: not found

However, it works in this way

mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ read -p "Are you sure you want to clean the project? [y/n] " -n 1 -r
Are you sure you want to clean the project? [y/n] ^C

Steps to reproduce

$> npm run clean

Expected behavior

No ERROR expected

Actual behavior

As stated above

Issue occurred on browser/platform

# Commit number
mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ git log -1 --oneline
d243717 (HEAD -> master, origin/master, origin/HEAD) fix(package): update wdio-cucumber-framework to version 0.3.0

# npm version
mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ npm --version
4.6.1

# OS version
mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ lsb_release -a
LSB Version:	core-9.20160110ubuntu0.2-amd64:core-9.20160110ubuntu0.2-noarch:printing-9.20160110ubuntu0.2-amd64:printing-9.20160110ubuntu0.2-noarch:security-9.20160110ubuntu0.2-amd64:security-9.20160110ubuntu0.2-noarch
Distributor ID:	Ubuntu
Description:	Ubuntu 16.04.2 LTS
Release:	16.04
Codename:	xenial

# node version
mondwan@mondwan-All-Series:~/Documents/codeTest/cucumber-boilerplate$ node --version
v6.10.1

Support for iteration via templates and placeholders

Currently there is no solution for iteration. Cucumber-js supports supplying tables for iterating properties.

Example:
https://github.com/cucumber/cucumber/wiki/Scenario-Outlines

An in-range update of babel-jest is breaking the build 🚨

Version 20.0.1 of babel-jest just got published.

Branch	Build failing 🚨
Dependency	babel-jest
Current Version	20.0.0
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As babel-jest is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build failed Details

---

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

How to end session and start again in scenario?

I have some problem, I have ane Feature with all login actions.
First Scenario checks correct login, second incorrect, but problem, if first scenario pass, i still loggined. How to clear session?

checkClass does not work correctly and always returns success

This can be verified by testing an element a non-existing class in class.feature. The test returns as a success, even though it does not exist on the element.

Use "merge" instead of "deepmerge"

I would suggest to use "merge" rather than the "deepmerge" module when merging config.js and config.whatever.js in test/support/configure.js, since deepmerge combines arrays instead of replacing them.

This leads to an array consisting of 'test/features/**/*.feature' from the default file + 'test/features/whatever1.feature', 'test/features/whatever2.feature', 'test/features/whatever3.feature', ... that you add in the specific configuration file.

I guess this is never what you want.

Is there any drawback in not using the "deepmerge" module?

Making config data available to step helpers/snippets

At the moment, based on reading the code, the config object that is created in init.js is not available to steps or their helpers/snippets.

I have some complicated orchestration which requires access to the config data, and I am wondering which would be the recommended approach?

1. Make the config object globally available
   or
2. Require configure.js wherever it is required.

Incorrect order in checkUrl helper & missing this. in isExisting helper

Hello,

I found to issues in the test templates.

The first is a incorrect order of element in the checkUrl helper:

result.value.should.equal(url, 'expected url to be "<result>"  but found "<expected>');

This should be:

result.value.should.equal(url, 'expected url to be "<expected>"  but found "<result>');

The other issue is with the isExisting helper on line 6:

browser.elements(selector, function (err, elements) {

The this. reference is missing:

this.browser.elements(selector, function (err, elements) {

I created a pull request that will correct both issues.

MultiRemote update?

The README says MultiRemote was coming soon, and that was before the v3 update.

Same for running tests in parallel.

Method checkoutContainsText is not contain but equal

Issue description

This method by name implies that an element contains text, but it is actually testing that it is equal to.

then.js

this.Then(
        /^I expect that (element|inputfield) "([^"]*)?"( not)* contains the text "([^"]*)?"$/,
        checkContainsText
    );

checkContainsText.js

    if (boolFalseCase) {
        expect(text).to.not.equal(stringExpectedText);
    } else {
        expect(text).to.equal(stringExpectedText);
    }

Running using tag causes opening empty tabs

Issue description

I have few features and glob in specs option like: specs: [ './src/features/**/*.feature' ]
When I try to run tests through wdio cli with tags parameter I see that cli executes for each feature, but for features without specified tag it just open browser and close it immediately.

Issue occurred on browser/platform

"wdio-cucumber-framework": "^0.2.15",
"webdriverio": "^4.6.2"

TypeError: Cannot read property 'tests' of undefined

Issue description

Got a nodeJS exception when running test

Steps to reproduce

1. Clone project
2. npm install
3. Run an external selenium
4. Run web app
5. Run test: ./node_modules/.bin/wdio --host localhost --port 4444

Expected behavior

This should work ^^

Actual behavior

/Volumes/Data/tom/www/cucumber-boilerplate/node_modules/webdriverio/build/lib/utils/ReporterStats.js:318
            this.getSuiteStats(runner, runner.parent).tests[runner.title] = new TestStats(runner);
                                                     ^

TypeError: Cannot read property 'tests' of undefined
    at ReporterStats.testStart (/Volumes/Data/tom/www/cucumber-boilerplate/node_modules/webdriverio/build/lib/utils/ReporterStats.js:318:54)
    at BaseReporter.<anonymous> (/Volumes/Data/tom/www/cucumber-boilerplate/node_modules/webdriverio/build/lib/utils/BaseReporter.js:151:25)
    at emitOne (events.js:96:13)
    at BaseReporter.emit (events.js:188:7)
    at BaseReporter.handleEvent (/Volumes/Data/tom/www/cucumber-boilerplate/node_modules/webdriverio/build/lib/utils/BaseReporter.js:300:27)
    at Launcher.messageHandler (/Volumes/Data/tom/www/cucumber-boilerplate/node_modules/webdriverio/build/lib/launcher.js:594:28)
    at emitTwo (events.js:106:13)
    at ChildProcess.emit (events.js:191:7)
    at process.nextTick (internal/child_process.js:752:12)
    at _combinedTickCallback (internal/process/next_tick.js:67:7)

Issue occurred on browser/platform

node v7.2.0

npm run-script local-webserver Unhandled 'error' event

Issue description

Please provide a brief description of the problem you are experiencing

Steps to reproduce

How can you reproduce the issue you are facing?
npm run-script local-webserver

Expected behavior

What did you expect to happen?
it would start a webserver

Actual behavior

What did happen?
threw an error

Issue occurred on browser/platform

mac osx
node v7.2.1
npm 3.10.10

What platform did you experience this issue on? If you tested multiple browsers/platforms please add them, if you did not experience the issue on other tested browsers or platforms note it as well.

events.js:160
throw er; // Unhandled 'error' event
^

Error: listen EADDRINUSE 0.0.0.0:8080
at Object.exports._errnoException (util.js:1022:11)
at exports._exceptionWithHostPort (util.js:1045:20)
at Server._listen2 (net.js:1262:14)
at listen (net.js:1298:10)
at doListening (net.js:1397:7)
at _combinedTickCallback (internal/process/next_tick.js:77:11)
at process._tickCallback (internal/process/next_tick.js:98:9)
at Module.runMain (module.js:607:11)
at run (bootstrap_node.js:420:7)
at startup (bootstrap_node.js:139:9)

npm ERR! Darwin 16.3.0
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "run-script" "local-webserver"
npm ERR! node v7.2.1
npm ERR! npm v3.10.10
npm ERR! code ELIFECYCLE
npm ERR! [email protected] local-webserver: http-server ./demo-app -s
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] local-webserver script 'http-server ./demo-app -s'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the cucumber-boilerplate package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! http-server ./demo-app -s
npm ERR! You can get information on how to open an issue for this project with:
npm ERR! npm bugs cucumber-boilerplate
npm ERR! Or if that isn't available, you can get their info via:
npm ERR! npm owner ls cucumber-boilerplate
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR! /Users/andrewjones/Documents/codePen/did/darkdiner/integrationTests/cucumber-boilerplate/npm-debug.log

Check for element existing on page is to slow

Currently the tests that contain the rule

there is no element "$string" on the page

all fail the default test because this rule takes longer than the timer set on the demo page:

wait for element
[22:52:08]:  COMMAND    POST     "/wd/hub/session/4daa3f64-b4c9-4f6c-874a-dc21d926544e/url"
[22:52:08]:  DATA        {"url":"http://webdriverjs.christian-bromann.com/"}
[22:52:08]:  RESULT      null
  ✓ Given I open the site "/" (75ms)
[22:52:08]:  COMMAND    POST     "/wd/hub/session/4daa3f64-b4c9-4f6c-874a-dc21d926544e/elements"
[22:52:08]:  DATA        {"using":"css selector","value":".lateElem"}
[22:52:10]:  RESULT      [{"ELEMENT":"24"}]
  1) And   there is no element ".lateElem" on the page
  - When  I wait on element ".lateElem" for 5000ms
  - Then  I expect that element ".lateElem" is visible

I tested with a custom test page and the turnaround seems to be at 5000 ms ( so letting the element appear after 6000ms and then testing for existence @ 8000ms)

This makes me think that these tests should be altered to have an element added after a button click or something similar.

npm run clean requires sudo

Running npm run clean requires sudo which is completely unnecessary. It is better to change the command to:

read -p \"Are you sure you want to clean the project? [y/n] \" -n 1 -r; if [[ $REPLY =~ ^[Yy]$ ]]; then rm -Rf .git .github demo-app test .codeclimate.yml .travis.yml jest.json wdio.BUILD.conf.js src/features/**; fi

How to run a test in isolation?

Is there any way to run a test in isolation while developing? I see "Pending" but not "Isolate".
If is not a feature yet, is there a better way then looping on the file looking for the isolation tag and run if found, otherwise run all?

An in-range update of webdriverio is breaking the build 🚨

Version 4.7.1 of webdriverio just got published.

Branch	Build failing 🚨
Dependency	webdriverio
Current Version	4.7.0
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

As webdriverio is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

---

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build failed Details

Commits

The new version differs by 4 commits .

• a611b80 4.7.1
• cf56b07 updated Changelog
• 10adef3 don't fail lazyloading for isVisible and isExisting - closes #2003
• 1ae50f1 Update index.js with current github url

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

clearInputField Not Working

Issue description

Please provide a brief description of the problem you are experiencing

I wish to clear a text input field of its text, but it does not remove the tet.

Steps to reproduce

How can you reproduce the issue you are facing?

I open a url that contains a text input field containing text. I issue the gherkin command When I clear the inputfield "//textarea[@id='description']". Never clears the text.

Expected behavior

I expected the text in the input field to be cleared.

Actual behavior

Field sort of, I think, blinks but does not clear the text.

Issue occurred on browser/platform

Chrome Version 58.0.3029.96 (64-bit)/ MacBook Pro, OS X Yosemite, version 10.10.5

An in-range update of jest is breaking the build 🚨

Version 20.0.4 of jest just got published.

Branch	Build failing 🚨
Dependency	jest
Current Version	20.0.3
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As jest is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build failed Details

---

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

---

Your Greenkeeper Bot 🌴

jest.json: "testPathDirs" is deprecated, ==> "roots"

First of all, thanks for this! it's one of the few things that "just worked" on initial download!

Issue description

Please provide a brief description of the problem you are experiencing

Ran npm test and got

  Option "testPathDirs" was replaced by "roots".

  Jest now treats your current configuration as:
  {
    "roots": ["test/"]
  }

  Please update your configuration.


  Configuration Documentation:
  https://facebook.github.io/jest/docs/configuration.html

Steps to reproduce

How can you reproduce the issue you are facing?

1. Download the boilerplate
2. npm install
3. npm test

Expected behavior

What did you expect to happen?

I expected no warnings for deprecated config variables

Actual behavior

What did happen?

I got a warning for a deprecated config variable

Issue occurred on browser/platform

What platform did you experience this issue on? If you tested multiple browsers/platforms please add them, if you did not experience the issue on other tested browsers or platforms note it as well.

not in a browser. Mac OSX, zsh. looks like [email protected] was installed.

Error: timeout of 10000ms exceeded. Ensure the done() callback is being called in this test.

Hello,

There is an error in fresh setup:

 COMMAND    POST     "/wd/hub/session"
[14:14:32]  DATA        {"desiredCapabilities":{"javascriptEnabled":true,"locationContextEnabled":true,"handlesAlerts":true,"rotatable":true,"browserName":"chrome","loggingPrefs":{"browser":"ALL","driver":"ALL"},"requestOrigins":{"url":"http://webdriver.io","version":"4.0.9","name":"webdriverio"}}}
[14:14:33]  INFO    SET SESSION ID a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e
[14:14:33]  RESULT      {"applicationCacheEnabled":false,"rotatable":false,"mobileEmulationEnabled":false,"chrome":{"chromedriverVersion":"2.21.371461 (633e689b520b25f3e264a2ede6b74ccc23cb636a)","userDataDir":"/tmp/.com.google.Chrome.A8VkqP"},"takesHeapSnapshot":true,"databaseEnabled":false,"handlesAlerts":true,"hasTouchScreen":false,"version":"50.0.2661.86","platform":"LINUX","browserConnectionEnabled":false,"nativeEvents":true,"acceptSslCerts":true,"webdriver.remote.sessionid":"a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e","locationContextEnabled":true,"webStorageEnabled":true,"browserName":"chrome","takesScreenshot":true,"javascriptEnabled":true,"cssSelectorsEnabled":true}
    check default root page title
[14:14:33]  COMMAND POST     "/wd/hub/session/a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e/url"
[14:14:33]  DATA        {"url":"http://192.168.64.1:4000/"}
[14:14:33]  RESULT      null
      ✓ Given I open the site "/" (404ms)
[14:14:33]  COMMAND GET      "/wd/hub/session/a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e/title"
[14:14:33]  DATA        {}
[14:14:33]  RESULT      "Hello Ave88!"
      ✓ Then I expect that the title is "Hello Ave88!" (72ms)
[14:14:33]  COMMAND DELETE   "/wd/hub/session/a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e"
[14:14:33]  DATA        {}
[14:14:33]  RESULT      null
    1) "after all" hook for "Then I expect that the title is "Hello Ave88!""


  2 passing (12s)
  1 failing

  1) Test the page title "after all" hook for "Then I expect that the title is "Hello Ave88!"":
     Error: timeout of 10000ms exceeded. Ensure the done() callback is being called in this test.

Selenium log:

selenium_1       | 00:14:18.326 INFO - Executing: [new session: Capabilities [{rotatable=true, locationContextEnabled=true, loggingPrefs=org.openqa.selenium.logging.LoggingPreferences@4d773871, browserName=chrome, javascriptEnabled=true, handlesAlerts=true, requestOrigins={name=webdriverio, version=4.0.9, url=http://webdriver.io}}]])
selenium_1       | 00:14:18.336 INFO - Creating a new session for Capabilities [{rotatable=true, locationContextEnabled=true, loggingPrefs=org.openqa.selenium.logging.LoggingPreferences@4d773871, browserName=chrome, javascriptEnabled=true, handlesAlerts=true, requestOrigins={name=webdriverio, version=4.0.9, url=http://webdriver.io}}]
selenium_1       | Starting ChromeDriver 2.21.371461 (633e689b520b25f3e264a2ede6b74ccc23cb636a) on port 9985
selenium_1       | Only local connections are allowed.
selenium_1       | 00:14:19.376 INFO - Done: [new session: Capabilities [{rotatable=true, locationContextEnabled=true, loggingPrefs=org.openqa.selenium.logging.LoggingPreferences@4d773871, browserName=chrome, javascriptEnabled=true, handlesAlerts=true, requestOrigins={name=webdriverio, version=4.0.9, url=http://webdriver.io}}]]
selenium_1       | 00:14:19.426 INFO - Executing: [get: http://192.168.64.1:4000/])
selenium_1       | 00:14:19.786 INFO - Done: [get: http://192.168.64.1:4000/]
selenium_1       | 00:14:19.826 INFO - Executing: [get title])
selenium_1       | 00:14:19.866 INFO - Done: [get title]
selenium_1       | 00:14:19.886 INFO - Executing: [delete session: a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e])
selenium_1       | 00:14:19.956 INFO - Done: [delete session: a5e84d1c-cc3e-44fc-8275-8dad3bc2a67e]

How to debug?

I have been experimenting with this boilerplate and find it as a very sane collection of tools and practice. I would like to be able to use node inspector and place breakpoints and debugger in my tests.

Is there a recommended way to achieve this?

To keep scenarios smaller, we need a beforeAll scenarios solution

Issue description

I have a slideshow that has complicated functionality between each slide, but is all within the same url.
Slide 2 will not display until slide 1 has been clicked Next and so forth. If I were to use "Background" to open the url, then each slide I have reached with each scenario would then go back to the start which I don't want.
"Background" runs everytime a scenario is run.

I need a "beforeAll" method that only every runs once, and then all the scenarios are run, so that I can open a url in my "beforeAll" suite, and all my subsequent scenarios of this feature are within the same url.

Is Windows supported?

Following the instruction on my Windows 7 (with all the necessary packages installed), I struggled to get the run.js to work with Node or Mocha.

Is windows supported and if so, what commands should I use?

Possible to have steps not have to specify element vs inputfield?

It seems unnecessary as whether the element is an inputfield should be inferable via an element's tagName

One less thing for the BAs to worry about

After following the steps I cannot run tests - 'SupportCode' of undefined

Issue description

When following the steps provided in the cucumber readme I cannot run even your default feature tests successfully.

Steps to reproduce

Pre-requisites - [email protected], npm

1. git clone https://github.com/webdriverio/cucumber-boilerplate.git
2. cd cucumber-boilerplate
3. npm install

Additional step, not included in readme, because this file is missing from package.json:
4) npm install cucumber --save

5. npm run-script local-webserver
6. open new cmd dialog - enter - node_modules.bin\wdio
   to trigger wdio

Expected behavior

I guess for the tests to run.

Actual behavior

browsers open, then suddently it crashes with this:
ERROR: Cannot read property 'SupportCode' of undefined

Issue occurred on browser/platform

windows 10.