webdriverio/workshop

A hands on course to learn WebdriverIO from scratch

Next-gen browser and mobile automation test framework for Node.js.

---

Homepage | Developer Guide | API Reference | Contribute | Changelog | Roadmap

---

WebdriverIO is a test automation framework, for e2e as well as unit and component testing in the browser, that allows you to run tests based on the WebDriver and WebDriver BiDi as well as Appium automation technology. It provides support for your favorite BDD/TDD test framework and will run your tests locally or in the cloud using Sauce Labs, BrowserStack, TestingBot or LambdaTest.

👩‍💻 👨‍💻 Contributing

Do you like WebdriverIO and want to help make it better? Awesome! Have a look into our Contributor Documentation to get started and find out what contributions can be and how to make them.

Getting started with GitHub Codespaces

To get started, create a codespace for this repository by clicking this 👇

A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with the software needed for this project.

Note: Dev containers are an open spec that is supported by GitHub Codespaces and other tools.

Getting started with Gitpod

You can also just click on:

to get a ready-to-use development environment for you to start working on this code base.

If you're looking for issues to help out with, check out the issues labeled "good first pick". You can also reach out to our Matrix Channel if you have questions on where to start contributing.

🏢 WebdriverIO for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of WebdriverIO and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

📦 Packages

This repository contains some of the core packages of the WebdriverIO project. There are many wonderful curated resources the WebdriverIO community has put together.

Did you build a WebdriverIO service or reporter? That's awesome! Please add it to our configuration wizard and docs (e.g. like in this example commit) as well as to our awesome-webdriverio list. Thank you! 🙏 ❤️

Core

• webdriver - A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol
• webdriverio - Next-gen browser and mobile automation test framework for Node.js
• @wdio/cli - A WebdriverIO testrunner command line interface

Helper

• @wdio/config - A helper utility to parse and validate WebdriverIO options
• @wdio/logger - A helper utility for logging WebdriverIO packages
• @wdio/protocols - Utility package providing information about automation protocols
• @wdio/repl - A WDIO helper utility to provide a repl interface for WebdriverIO
• @wdio/reporter - A WebdriverIO utility to help report all events
• @wdio/runner - A WebdriverIO service that runs tests in arbitrary environments
• @wdio/utils - A WDIO helper utility to provide several utility functions used across the project
• @wdio/globals - A WDIO helper utility for importing global variables directly

Reporter

• @wdio/allure-reporter - A WebdriverIO reporter plugin to create Allure Test Reports
• @wdio/concise-reporter - A WebdriverIO reporter plugin to create concise test reports
• @wdio/dot-reporter - A WebdriverIO plugin to report in dot style
• @wdio/junit-reporter - A WebdriverIO reporter that creates test results in XML format
• @wdio/spec-reporter - A WebdriverIO plugin to report in spec style
• @wdio/sumologic-reporter - A WebdriverIO reporter that sends test results to Sumologic for data analyses

Services

• @wdio/appium-service - A WebdriverIO service to start & stop Appium Server
• @wdio/browserstack-service - A WebdriverIO service that can be used to use BrowserStack Test Observability which is a reporting, debugging, and test suite quality tracking tool for any test running anywhere. The service also helps for a better integration with the BrowserStack grid if you're running tests on the grid.
• @wdio/devtools-service - A WebdriverIO service that allows you to run Chrome DevTools commands in your tests
• @wdio/firefox-profile-service - A WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js
• @wdio/sauce-service - A WebdriverIO service that provides a better integration into Sauce Labs
• @wdio/shared-store-service - A WebdriverIO service to exchange data across processes
• @wdio/testingbot-service - A WebdriverIO service that provides a better integration into TestingBot

Runner

• @wdio/local-runner - A WebdriverIO runner to run tests locally
• @wdio/browser-runner - A WebdriverIO runner to run unit or component tests in the browser

Framework Adapters

• @wdio/cucumber-framework - Adapter for Cucumber testing framework
• @wdio/jasmine-framework - Adapter for Jasmine testing framework
• @wdio/mocha-framework - Adapter for Mocha testing framework.

Others

• eslint-plugin-wdio - Eslint rules for WebdriverIO
• @wdio/smoke-test-reporter - A WebdriverIO utility to smoke test reporters for internal testing purposes
• @wdio/smoke-test-service - A WebdriverIO utility to smoke test services for internal testing purposes
• @wdio/webdriver-mock-service - A WebdriverIO service to stub all endpoints for internal testing purposes

🤝 Project Governance

This project is maintained by awesome people following a common set of rules and treating each other with respect and appreciation.

👨‍🍳 👩‍🍳 Backers

Become a backer and show your support for our open-source project.

💸 Sponsors

Does your company use WebdriverIO? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time to maintenance and new features for everyone. Also, your company's logo will show on GitHub - who doesn't want a little extra exposure? Here's the info.

💎 Premium Sponsor

We are immensely grateful to our exclusive Premium Sponsor for their invaluable support in the development of this project:

     

🥈 Silver Sponsor

🥉 Bronze Sponsor

📄 License

MIT

🔰 Badge

Show the world you're using webdriver.io →

GitHub markup

[![tested with webdriver.io](https://img.shields.io/badge/tested%20with-webdriver.io-%23ea5906)](https://webdriver.io/)

HTML

<a href="https://webdriver.io/">
    <img alt="WebdriverIO" src="https://img.shields.io/badge/tested%20with-webdriver.io-%23ea5906">
</a>

👏 Supporters

workshop's Issues

set Time issue

Error: Timeout of 60000ms exceeded. The execution in the test "ACRT login It should login with valid login user " took too long. Try to reduce the run time or increase your timeout for test specs (https://webdriver.io/docs/timeouts). (D:\WDIO\test\specs\AcrtLogin.ts).

I am faceing this type of issue while switch the screen 1 to 2

Add chapter on running tests using DevTools

Find TodoMVC backend

In our 2nd chapter we use the TodoMVC example app to demonstrate some automation basics. As extra task we ask to bring the application into a specific state mocking out a TodoMVC with a REST backend. Unfortunately at this point there aren't any TodoMVC backends accessible anymore.

We should:

• either update the example
• deploy our own or
• find a working backend

Why don't you use selenium-standalone service?

Why don't you use selenium-standalone service to take care of the drivers and selenium server?
I see that in the first chapter you are downloading the chrome driver manually.

foobar

barfoo

---

Code References

solutions/chapter_04/wdio.conf.js (Line: 120 - 131)

    reporters: [
      'spec',
      ['allure', {
        outputDir: 'allure-results'
      }]
    ],
    services: [
      [
        'chromedriver',
        { outputDir: './logs' }
      ]
    ],

Add section Performance Testing

Add a chapter to showcase local and remote performance testing.

Foobar

dsadassdasdasad

---

Code References

chapter_02.md (Line: 7 - 9 / with comment)

here you do that

3. Enter 3 items into the ToDo list
4. Mark the second item as completed
5. Print out the amount of items left

chapter_11.md (Line: 7 - 11 / with comment)

here that!

- add `@wdio/devtools-service` to your setup
- write a new test that captures and asserts the Google Lighthouse performance score of our [example application](http://todomvc.com/examples/vue/)
    - to emulate a real user experience for our test we mimic our browser to be an iPhone X with a good 3G connection
- add an assertion for the `speedIndex` metric
- modify the test so we can run it locally as well as on Sauce Labs

browser.takeSnapshot is not a function

Hi i have a problem with the example test.
Error Message: browser.takeSnapshot is not a function

If I go with the instructions from webdrivier.io, then the method "takesnapshot" works. But if I
clone your webdriverio-hand-on the method "takesnapshot" doesnt work.
I hope you can help me.

my package.json includes this:
{
"name": "chapter1",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "wdio wdio.local.conf.js",
"test:sauce": "wdio wdio.sauce.conf.js"
},
"keywords": [],
"author": "Christian Bromann [email protected]",
"license": "MIT",
"devDependencies": {
"@applitools/eyes.webdriverio": "^2.4.1",
"@wdio/allure-reporter": "^5.7.11",
"@wdio/applitools-service": "^5.9.3",
"@wdio/cli": "^5.8.0",
"@wdio/local-runner": "^5.8.0",
"@wdio/mocha-framework": "^5.8.0",
"@wdio/sauce-service": "^5.8.0",
"@wdio/spec-reporter": "^5.8.0",
"@wdio/sync": "^5.8.0",
"allure-commandline": "^2.9.0",
"chai": "^4.2.0",
"chromedriver": "^74.0.0",
"wdio-chromedriver-service": "^5.0.1",
"webdriverio": "^5.7.15"
}
}

Test

foo

---

Code References

package.json (Line: 8 - 9 / with comment)

bar

  "keywords": [],
  "author": "Christian Bromann <[email protected]>",