Built using Amiya Pattnaik's webdriverIO-with-cucumberBDD amazing boilerplate as inspiration. If you want more examples, the WebdriverIO community offers a set of boilerplate projects to get you started with test automation.
What is usually the standard way of learning a new frontend framework? The answer is Building a Todo App. So, in a similar fashion, this repository contains the implementation of an automated test suite for a simple React todo App. WebdriverIO-v6 (Selenium - Node.js/JavaScript) allows us to demonstrate how to use the tool and develop an automation suite using the Cucumber (v6.x) BDD framework. It uses the chromedriver NPM package that wraps the ChromeDriver for you. This service does not require a Selenium server, but uses ChromeDriver to communicate with the browser directly.
It support ES5 to ES8 (via babel-register) and uses Grunt to manage tasks. It generate Spec, JUNIT, Allure, JSON reporters as well.
This project is tested on Node v12.0.0 and above. While earlier versions of node may be compatible, but they have not been verified.
Node.JS: Install from the site - https://nodejs.org/en/ take the LTS version based on your Operating system. Please make sure you install NodeJS globally. To take full advantage of the command line and use grunt tasks you will need to make sure that you have added node_modules/.bin to your $PATH. Otherwise you will need to install npm install -g grunt-cli globally.
JDK 1.8: It is optional, install JDK 1.8+ and make sure class path is set properly. JAVA is require to start Selenium Server on your local environment nothing else.
To run your test you must have selenium / Appium server up and running to execute any webdriverIO tests, or it will fail fast with an error. To start selenium automatically it has been added as part of services: ['selenium-standalone'] and services: ['appium'] in the *.conf.js.
To execute the entire test suite in local development, you can use any one of the options mentioned below
Option 1: npm run test-local. You can also run in SauceLabs and BrowserStack using npm run test-sauce, npm run test-browserstack.
Option 2: grunt webdriver:test-local. This executes all features in the [./test/features/*.feature] directory.
The default option for Grunt run is webdriver:test-local. But you can use webdriver:test-sauce or test-browserstack based on your requirements.
During development you may want to execute only just one feature. If that is the case, it can be achieved by using tag expressions. For example, if you want to execute only the @UseFilters feature you should run npm run test-local -- --cucumberOpts.tagExpression="@UFilters" . For further details see https://cucumber.io/docs/cucumber/api/#running-a-subset-of-scenarios
To execute tests on mobile device use : npm run test-mobile.
Note: Before running mobile tests, perform the requisite Appium setup. For hassle free Appium setup on OSX refer appium-setup-made-easy-OSX, for Android please check here OR refer Appium Docs
WebdriverIO uses configuration files to setup and execute tests in specific ways. The configuration is fully customizable, and different functions can be invoked before, during and after each test or test suite. Config files can be found in the /test/config/ directory and all end with *.conf.js. These can be called via the the cli.
SauceLabs and BrowserStack specific code has been added in the wdio.sauce.conf.js and wdio.browserstack.conf.js under the /test/config folder. You just need to provide your SauceLabs/BrowserStack credentials in the config file. To run test on SauceLabs, execute command npm run test-sauce and on BrowserStack npm run test-browserstack.
Complete set of execution logs will be generated during the run time and can be found in the parent folder location /logs.
WebdriverIO uses several different types of test reporters to communicate pass/failure.
To use the dot reporter just add 'dot' to the reporters array in the config file. The dot reporter prints for each test spec a dot. If colors are enabled on your machine you will see three different colors for dots. Yellow dots mean that at least one browser has executed that spec. A green dot means all browser passed that spec and a red to means that at least one browser failed that spec. All config files have this turned on by default.
Test reporter, that prints detailed results to console.
The Allure Reporter creates Allure test reports which is an HTML generated website with all necessary information to debug your test results and take a look on error screenshots. Add allure to the reporters array in config file and define the output directory of the allure reports.
To generate and view an allure report locally, run npm run allure-report.
Allure has several other reporting tools optimized for the CI server of your choice. You can view the documentation here.
The JUnit reporter helps you to create xml reports for your CI server. Add it to the reports array in the config file and define the directory where the xml files should get stored. webdriverIO will create an xml file for each instance under test and the filename will contain the browser and OS.
To generate and view an junit/xunit report locally, run npm run junit-report.
The JSON reporter is especially versatile. Since it produces a literal in a key : value pair, help to read, translate execution results to any custom reporter / it can be used to transport reporter events to another process and format them there, or to store the execution results back to any standard RDBMS or to NoSQL like mongodb with very minimal effort.
You can write test by using Cucumber BDD framework. You can choose javascript based design pattern or ES6 based. This project is ES6 friendly (via babel-register)
Refer complete WebdriverIO v6 API methods to write your automation tests.
Tests are written in the Cucumber framework using the Gherkin Syntax. More about Gherkin & Cucumber can be found at https://cucumber.io/docs/cucumber/
Tests are described in *.feature files in the /test/features/ directory. A typical test will look similar to this:
@UseFilters
Feature: Use filters
As a user
I want to filter my todo list
So that I have a clearer view of my completed/active todos.
Background: User is in the app
Given I am on the app
When I mark the "Do the dishes" todo as completed
@OnlyCompleted
Scenario: 1 Show only completed todos
When I select the completed filter
Then no "active" todos are shown
@OnlyActive
Scenario: 2 Show only active todos
When I select the active filter
Then no "completed" todos are shown
Within your web app's UI there are areas that your tests interact with. A Page Object simply models these as objects within the test code. This reduces the amount of duplicated code and means that if the UI changes, the fix need only be applied in one place. In other wards one of the challenges of writing test automation is keeping your [selectors] (classes, id's, or xpath' etc.) up to date with the latest version of your code. The next challenge is to keep the code you write nice and DRY (Don't Repeat Yourself). The page object pattern helps us accomplish this in one solution. Instead of including our selectors in our step definitions in cucumber, we instead place them in a <pagename>.js file where we can manage all these selectors and methods together. Your test file should only call the test methods.
You can also place reusable functions or logic inside of these pages and call them from your step files. Such cases are better understood if you take a look to the functions that dynamically get the selector of a todo (or marks it as completed) by searching for it using its text. The page object serves as a layer of abstraction between tests and code. When a test fails, it fails on a individual step. That step may call a selector that is no longer valid, but that selector may be used by many other steps. By having a single source of truth of what the selector is supposed to be, fixing one selector on the page object could repair a number of failing tests that were affected by the same selector.
An object called Page will be created with the prototype model or by ES6 class pattern. This ensures that every instance of a page object is exported as a stateless construct. Any any changes to that state are handled in the browser, rather than on the server.
It is preferable to separate page objects into individual files that end with .page.js. These will require the basic page.js prototype construct / abstract class and create new objects for each individual page.
For more information on the implementation of Page Object Design Pattern, refer to the /test/pageobjects directory, or refer to WebdriverIO's documentation.
Create a fork of the project into your own repository. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If approved, project owners will merge it.
MIT