WebDriverIO is one of the progressive automation framework tools built to Test modern web browsers and mobile apps. The main purpose of WebDriverIO is to provide simplified plugins that help the user to have simplified interaction with the browser or the apps.

WebDriver IO helps you to control any browser or a mobile application with the help of just a few lines of code. WebDriverIO is also known as one of the popular Browser testing tools.

In this article, we will look at the best practices for WebdriverIO testing.

Why is WebDriverIO a popular test framework?

WebDriverIO is a well-known test automation framework in JavaScript. It provides many reports and services with various features like Test Frameworks and WDIO CLI tests.

Some of the following supported reporter’s examples:

  • Allure Reporter
  • Concise Reporter
  • Dot reporter
  • Junit Reporter
  • Spec Reporter

Best Practices to Adopt While Developing WebDriverIO Testing

Honestly, while using JavaScript and Selenium, setting up an automated testing tool like WebDriverIO testing is not an easy task. But once you get the grasp of the WebDriverIO testing tool and lay down the right foundation for WebDriverIO testing, the benefits that can be availed are limitless.

Let’s discuss some of the key aspects that are needed to be considered while adopting the best practices for developing the WebDriverIO testing framework.

1.  WebDriverIO version

It is always recommended that go for the latest version of WebdriverIO, and currently, Version 5 is the latest release in the year 2021. The latest v5 has many desirable features that it has to offer let us look at some of the amazing features-

a)    Supports Puppeteer

If you are going to run a local test, in that case, you are free to switch between Puppeteer and WebDriverIO API according to your wish. Also, you are not required to download the browser driver anymore. With the help of WebDriverIO testing, you can also look if a browser driver is working and accessible at localhost:4444/. If the WebDriverIO testing doesn’t work, check if it is using a puppeteer as a fallback. If you can access Puppeteer in your test, then it allows you to:

  • It lets you leverage the Chrome DevTools protocol capabilities which offer you a richer set of automation features.
  • It lets you run commands much faster and helps in speeding up local execution.

b)   Performance Improvements

This comes under one of the primary design goals of WebDriverIO v5. It has also come with many updated internal improvements that are much faster than that of the previous version. The new improvements also speed up test execution and lower CPU memory usage.

2.  Page Object Model

Page Object Model is a kind of framework that is designed in such a way that it can widely adopt the design pattern by Agile practitioners for an easy test. It helps in providing easy test script management and enhances the code reusability. Page Object Model helps you efficiently manage all the locators, reduces duplication, and helps you in making your framework more programmer-friendly.

3.  Create Helper Methods

This method is also linked with code reusability and easy access. The basic idea behind this method is that it wraps the code for most commonly performed tasks like logging in, clicking on various options, processing result, logging out, etc. into a method so that it can be reused and shared by all scripts.

This method also provides you with customizable parameters to help you suit various functions required by the user.

4.  Not Testing the same function twice

To speed up the WebdriverIO testing, one thing we should focus on is being strategic towards test coverage. If we focus more on reducing duplicate and avoidable errors, then it will directly help us to bring the test case count down.

As we already know the lower the test case count, the faster the execution of the result.

5.  Avoid Hardcoding URLs

In WebdriverIO, there’s a configuration file with the extension wdio.conf.js, which helps the user in rectifying the test locations, frameworks that the user wants to use, reporters, browsers, and all other configurations of the project.

One of the other useful configurations of WebdriverIO is the BASE URL of the application, by using that user doesn’t need to specify that every time in his script.

To make the script properly work the user might need to run the application in different environments such as staging, production, QA, etc. and each of the environments has different URLs. If that’s the case then the user and easily configure all the URLs by showing an environmental variable and passing the details of the URL in which the test was supposed to run along with the test run command.

6.  Writing a good test script

In WebdriverIO testing the only thing that matters in the end is the good test script.

There are some of the following practices that can be adopted by the user while designing a test script during JavaScript testing-

  • By writing only one test case in a test file. This helps the user to keep the test cases separate from each other, and also helps in recognizing the failure in parallel testing.
  • Helps in keeping it short as the number of steps was reduced up to 20.

7.  Right Order Of Execution

In WebdriverIO every command is an asynchronous operation. When a command is run, then a request is fired to the Selenium server, and the response contains the result  if the action is passed or failed.

Therefore, time is a crucial component in the entire test execution and testing process. When one action depends on the state of a different action then it is implicit for you to make sure that they get executed in the right order. Hence, Timeouts play an important role  for dealing  with such issues.

Maintaining the right order of execution not only helps in dealing with such issues but also makes the WebdriverIO testing easier.

8.  Debugging

Debugging is one of the best practices that should be used for WebbDriverIO testing. It helps in resolving the error before making the code public. Debugging is an important part of determining why an operating system, application, or program is misbehaving.

If you write a  WebdriverIO test, it should run , but it doesn’t. How to handle such a situation? There are different ways of WebdriverIO debugging to fix these errors

  • Pause browser execution:- An easy way to debug is to run the test with
    pause in it, so it becomes easier if the element is really visible on screen or not.
  • Print the variables and Inspect:- Get the logs printed so as to know about the content of the variables is another good way of debugging the test.
  • Run the tests manually:- You can simulate your automation test cases manually. It is an effective way of debugging the code.

9.  Always executing on real browsers and drivers

It is always important to run the WebdriverIO tests on real browsers and devices. LambdaTest offers Cloud Selenium Grid of 3000+ real browsers and devices for WebDriverIO testing.

It helps you run  Webdriver IO tests on cloud-based infrastructure. You can also accelerate WebDriverIO testing by making most of the LambdaTest parallel testing capabilities over a cloud-based infrastructure.

Some of the features that are offered by LambdaTest and WebDriverIO are:

  • Selenium Automation testing
  • Extendable
  • Real-time testing of all the cloud-based applications and browsers
  • Easy Set-Up

10.Recording The Test Execution

It is always a best practtice to record the test execution, especially to monitor the

failed test cases and to get a clear picture why they got failed. But, this increases
the execution time. Therefore, it is always advisable to use the video recording
feature only when the test fails and not to use the recording feature when the
test passes.

11.Use Text and Visual Logs

Including text and visual logs in the test execution helps you in maintaining a track

of the action performed. Visual logs create screenshots with each step and every

command that gets executed. This practice helps in understanding application

behaviour better and troubleshoot if the result is not as expected.


If you are looking for an automation framework that can help you in leveraging Selenium and also allow you to code in JavaScript?

WebDriverIO gives an all-new full-functioning framework and more tools to make you think out of the box. With the help of the WebDriverIO, you don’t have to start the program from the scratch, as happens with Selenium.

WebDriverIO is full-fledged with all the tools you need to build scalable and sustainable test suites, the features that are not found in any automation framework versions. If you are a coder or a JavaScript developer then this framework would make you happy.

Author Bio: Vixit Raj is Product Growth and Communication Specialist in LambdaTest : The Cross Browser Web App Testing Platform. He is an E&C engineering graduate and in the digital marketing domain for the last 5+ years. He always tries to stay updated with the latest advancements in technology, product growth, software testing and coding.