quine-global/webdriverio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update main branch

Browse source
This commit is contained in:
christian-bromann 2021-01-21 01:59:44 +01:00
parent 2ace7fbac3
commit b1c734d491
No known key found for this signature in database
GPG key ID: 355B5D0EA83B4D19
77 changed files with 162 additions and 162 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/--bug-report.md vendored
View file

@ -3,7 +3,7 @@ name: 🐛 Bug report
about: Create a report to help us improve.
---
[//]: # NOTE: This repository only maintains packages that are listed in the [Readme](https://github.com/webdriverio/webdriverio/blob/master/README.md#packages). Please make sure that your issue is directly caused by one of these packages and if not file an issue in the correct 3rd party package repository.
[//]: # NOTE: This repository only maintains packages that are listed in the [Readme](https://github.com/webdriverio/webdriverio/blob/main/README.md#packages). Please make sure that your issue is directly caused by one of these packages and if not file an issue in the correct 3rd party package repository.
**Environment (please complete the following information):**
- **WebdriverIO version:** [e.g. 4.13.2]

2
.github/ISSUE_TEMPLATE/--documentation.md vendored
View file

@ -5,7 +5,7 @@ about: Suggest improvements or report missing/unclear documentation.
---
**Pre-check**
- [ ] I'm aware that I can [edit the docs](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md) and submit a pull request
- [ ] I'm aware that I can [edit the docs](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md) and submit a pull request
**Describe the improvement**

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -16,7 +16,7 @@
[//]: # (_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._)
- [ ] I have read the [CONTRIBUTING](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md) doc
- [ ] I have read the [CONTRIBUTING](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md) doc
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
- [ ] I have added proper type definitions for new commands (if appropriate)

4
.github/SUPPORT.md vendored
View file

@ -23,5 +23,5 @@ The WebdriverIO Community is also active on Stack Overflow, you can post your qu
## Contributing
* [Contributing Guidelines](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md)
* [Governance](https://github.com/webdriverio/webdriverio/blob/master/GOVERNANCE.md)
* [Contributing Guidelines](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md)
* [Governance](https://github.com/webdriverio/webdriverio/blob/main/GOVERNANCE.md)

2
.github/workflows/publish.yml vendored
View file

@ -32,7 +32,7 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
ref: 'master'
ref: 'main'
fetch-depth: 0
- uses: actions/setup-node@v1
with:

2
.github/workflows/test.yml vendored
View file

@ -5,7 +5,7 @@ name: Test
on:
push:
branches:
- master
- main
pull_request:
jobs:

32
CONTRIBUTING.md
View file

@ -105,31 +105,31 @@ It will ask you about the type and name of the new package and create all the fi
## Run e2e Experience With Smoke Tests
WebdriverIO maintains a set of smoke test suites that allows to represent the full e2e experience of a user running the wdio testrunner. It is set up in a way so it doesn't require an actual browser driver since all requests are mocked using the [`@wdio/webdriver-mock-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-webdriver-mock-service). This offers you an opportunity to run a wdio test suite without setting up a browser driver and a test page. You can run all smoke tests via:
WebdriverIO maintains a set of smoke test suites that allows to represent the full e2e experience of a user running the wdio testrunner. It is set up in a way so it doesn't require an actual browser driver since all requests are mocked using the [`@wdio/webdriver-mock-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service). This offers you an opportunity to run a wdio test suite without setting up a browser driver and a test page. You can run all smoke tests via:
```sh
$ npm run test:smoke
```
There are several [test suites](https://github.com/webdriverio/webdriverio/blob/master/tests/smoke.runner.js#L363-L383) defined that run in different environments, e.g. Mocha, Jasmine and Cucumber. You can run a specific test suite by calling, e.g.:
There are several [test suites](https://github.com/webdriverio/webdriverio/blob/main/tests/smoke.runner.js#L363-L383) defined that run in different environments, e.g. Mocha, Jasmine and Cucumber. You can run a specific test suite by calling, e.g.:
```sh
$ npm run test:smoke mochaTestrunner
```
You can define your own scenario of mock responses in the [`@wdio/webdriver-mock-service`](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-webdriver-mock-service/src/index.js#L136-L147).
You can define your own scenario of mock responses in the [`@wdio/webdriver-mock-service`](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-webdriver-mock-service/src/index.js#L136-L147).
## Setting up and deploying the docs
This repository contains everything to set up, build and deploy the WebdriverIO documentation pages. We are using [Docusaurus](https://docusaurus.io/) (v1) to generate the page. The content is generated based off:
- the guidelines pages from markdown files of the [docs directory](https://github.com/webdriverio/webdriverio/tree/master/docs)
- the guidelines pages from markdown files of the [docs directory](https://github.com/webdriverio/webdriverio/tree/main/docs)
- service and reporter docs from the readme files of those packages within this repository
- service and reporter docs from 3rd party plugins (defined in [these JSON files](https://github.com/webdriverio/webdriverio/tree/master/scripts/docs-generation/3rd-party)) that are downloaded from GitHub and parsed
- the protocol APIs from the [`@wdio/protocols`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-protocols/protocols) package
- the WebdriverIO API that is parsed out of the JSDoc comments of individual commands (e.g., [`execute`](https://github.com/webdriverio/webdriverio/blob/master/packages/webdriverio/src/commands/browser/execute.js#L2-L36) command)
- service and reporter docs from 3rd party plugins (defined in [these JSON files](https://github.com/webdriverio/webdriverio/tree/main/scripts/docs-generation/3rd-party)) that are downloaded from GitHub and parsed
- the protocol APIs from the [`@wdio/protocols`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols/protocols) package
- the WebdriverIO API that is parsed out of the JSDoc comments of individual commands (e.g., [`execute`](https://github.com/webdriverio/webdriverio/blob/main/packages/webdriverio/src/commands/browser/execute.js#L2-L36) command)
After you have [set up the project](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#set-up-project) you can go into the `website` directory to set up the docs page and run it on your local machine. To do so, run:
After you have [set up the project](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#set-up-project) you can go into the `website` directory to set up the docs page and run it on your local machine. To do so, run:
```sh
$ cd website
@ -137,9 +137,9 @@ $ npm install
$ npm start
```
This will set up everything needed to run the page on [`localhost:3000`](http://localhost:3000/). You can now modify the content of the [`/docs`](https://github.com/webdriverio/webdriverio/tree/master/docs) files as well as change styles and templates. The page will be automatically updated. If you add documentation in other places, you have to rerun the `npm start` script to re-generate the docs.
This will set up everything needed to run the page on [`localhost:3000`](http://localhost:3000/). You can now modify the content of the [`/docs`](https://github.com/webdriverio/webdriverio/tree/main/docs) files as well as change styles and templates. The page will be automatically updated. If you add documentation in other places, you have to rerun the `npm start` script to re-generate the docs.
Every time a new release is pushed to GitHub the WebdriverIO docs are automatically generated and pushed to the project's S3 bucket. The process is defined in a GitHub Actions [pipeline](https://github.com/webdriverio/webdriverio/blob/master/.github/workflows/deploy.yml) and does not need to be done manually.
Every time a new release is pushed to GitHub the WebdriverIO docs are automatically generated and pushed to the project's S3 bucket. The process is defined in a GitHub Actions [pipeline](https://github.com/webdriverio/webdriverio/blob/main/.github/workflows/deploy.yml) and does not need to be done manually.
For more information on Docusaurus please checkout their [documentation page](https://docusaurus.io/docs/en/installation).
@ -154,7 +154,7 @@ All type definitions are located in the sub package folders. Some of them are au
- the `@wdio/allure-reporter` has its interface defined in comments within the service (`/packages/wdio-allure-reporter/src/index.js`)
- all other packages have their type definitions directly in the `*.d.ts` in the root directory of the package (e.g. `/packages/wdio-cucumber-framework/cucumber-framework.d.ts`) - these are __not__ autogenerated and you can make modifications directly in these files
You can find all files responsible for the generating the typings here: https://github.com/webdriverio/webdriverio/tree/master/scripts/type-generation. You can trigger the process by calling:
You can find all files responsible for the generating the typings here: https://github.com/webdriverio/webdriverio/tree/main/scripts/type-generation. You can trigger the process by calling:
```sh
$ npm run generate:typings
@ -251,7 +251,7 @@ browser.touchAction(touchAction)
## Test Your Changes
In order to test certain scenarios this project has a test directory that allows you to run predefined tests. It allows you to check your code changes while you are working on it. You can find all these files in `/examples` and additional information in [`/examples/README.md`](https://github.com/webdriverio/webdriverio/tree/master/examples/README.md). When a PR gets submitted, WebdriverIO runs the following checks:
In order to test certain scenarios this project has a test directory that allows you to run predefined tests. It allows you to check your code changes while you are working on it. You can find all these files in `/examples` and additional information in [`/examples/README.md`](https://github.com/webdriverio/webdriverio/tree/main/examples/README.md). When a PR gets submitted, WebdriverIO runs the following checks:
- *Dependency Checks*
We automatically check if every sub-package has all the dependencies from its `package.json` installed.
@ -282,7 +282,7 @@ In order to test certain scenarios this project has a test directory that allows
- *Smoke Tests*
While unit tests already cover a lot of cases, we run in addition to that smoke tests that simulate test scenarios which are difficult to test
on a unit level as they include functionality of dependencies that are stubbed out in unit tests. Such scenarios are, for example, proper
test retries or failure handling. Smoke tests run actual e2e tests where the driver is being stubbed (via [`@wdio/smoke-test-service`](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-smoke-test-service/package.json)) to return fake results.
test retries or failure handling. Smoke tests run actual e2e tests where the driver is being stubbed (via [`@wdio/smoke-test-service`](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-smoke-test-service/package.json)) to return fake results.
You can manually trigger this check by calling:
```sh
$ npm run test:smoke
@ -345,14 +345,14 @@ Backporting sha 77dc52fdb86c51242b92f299998d2904004cb347 from v6 to v5
1 file changed, 2 deletions(-)
Successfully backported 2 PRs 👏!
Please now push them to master and make a new v5.x release!
Please now push them to `v6` and make a new v6.x release!
```
You can always reach out to the `webdriverio/ProjectCommitters` channel on Gitter for questions.
## Release New Version
Package releases are made using Lerna's release capabilities and executed by the [technical steering committee](https://github.com/webdriverio/webdriverio/blob/master/GOVERNANCE.md#the-technical-committee) only. Before you can start please export a `GITHUB_AUTH` token into your environment in order to allow [`lerna-changelog`](https://www.npmjs.com/package/lerna-changelog#github-token) to gather data about the upcoming release and autogenerate the [CHANGELOG.md](/CHANGELOG.md). Go to your [personal access token](https://github.com/settings/tokens) settings page and generate such a token with only having the `public_repo` field enabled. Then export it into your environment:
Package releases are made using Lerna's release capabilities and executed by the [technical steering committee](https://github.com/webdriverio/webdriverio/blob/main/GOVERNANCE.md#the-technical-committee) only. Before you can start please export a `GITHUB_AUTH` token into your environment in order to allow [`lerna-changelog`](https://www.npmjs.com/package/lerna-changelog#github-token) to gather data about the upcoming release and autogenerate the [CHANGELOG.md](/CHANGELOG.md). Go to your [personal access token](https://github.com/settings/tokens) settings page and generate such a token with only having the `public_repo` field enabled. Then export it into your environment:
```sh
$ export GITHUB_AUTH=...
@ -362,7 +362,7 @@ You are now all set and just need to call:
```sh
# ensure to have pulled the latest code
$ git pull origin master --tags
$ git pull origin main --tags
# release using Lerna
$ npm run release
```

78
README.md
View file

@ -35,9 +35,9 @@
<a href="https://webdriver.io">Homepage</a> |
<a href="https://webdriver.io/guide.html">Developer Guide</a> |
<a href="https://webdriver.io/docs/api.html">API Reference</a> |
<a href="https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md">Contribute</a> |
<a href="https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md">Changelog</a> |
<a href="https://github.com/webdriverio/webdriverio/blob/master/ROADMAP.md">Roadmap</a>
<a href="https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md">Contribute</a> |
<a href="https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md">Changelog</a> |
<a href="https://github.com/webdriverio/webdriverio/blob/main/ROADMAP.md">Roadmap</a>
</p>
***
@ -60,60 +60,60 @@ The maintainers of WebdriverIO and thousands of other packages are working with
### Core
- [webdriver](https://github.com/webdriverio/webdriverio/tree/master/packages/webdriver) - A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol
- [devtools](https://github.com/webdriverio/webdriverio/tree/master/packages/devtools) - A Chrome DevTools protocol binding that maps WebDriver commands into Chrome DevTools commands using Puppeteer
- [webdriverio](https://github.com/webdriverio/webdriverio/blob/master/packages/webdriverio) - Next-gen browser and mobile automation test framework for Node.js
- [@wdio/cli](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cli) - A WebdriverIO testrunner command line interface
- [webdriver](https://github.com/webdriverio/webdriverio/tree/main/packages/webdriver) - A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol
- [devtools](https://github.com/webdriverio/webdriverio/tree/main/packages/devtools) - A Chrome DevTools protocol binding that maps WebDriver commands into Chrome DevTools commands using Puppeteer
- [webdriverio](https://github.com/webdriverio/webdriverio/blob/main/packages/webdriverio) - Next-gen browser and mobile automation test framework for Node.js
- [@wdio/cli](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cli) - A WebdriverIO testrunner command line interface
### Helper
- [@wdio/config](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-config) - A helper utility to parse and validate WebdriverIO options
- [@wdio/logger](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-logger) - A helper utility for logging of WebdriverIO packages
- [@wdio/protocols](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-protocols) - Utility package providing information about automation protocols
- [@wdio/repl](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-repl) - A WDIO helper utility to provide a repl interface for WebdriverIO
- [@wdio/reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-reporter) - A WebdriverIO utility to help reporting all events
- [@wdio/runner](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-runner) - A WebdriverIO service that runs tests in arbitrary environments
- [@wdio/sync](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sync) - A WebdriverIO plugin. Helper module to run WebdriverIO commands synchronously
- [@wdio/utils](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-utils) - A WDIO helper utility to provide several utility functions used across the project
- [@wdio/config](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-config) - A helper utility to parse and validate WebdriverIO options
- [@wdio/logger](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-logger) - A helper utility for logging of WebdriverIO packages
- [@wdio/protocols](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols) - Utility package providing information about automation protocols
- [@wdio/repl](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-repl) - A WDIO helper utility to provide a repl interface for WebdriverIO
- [@wdio/reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-reporter) - A WebdriverIO utility to help reporting all events
- [@wdio/runner](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-runner) - A WebdriverIO service that runs tests in arbitrary environments
- [@wdio/sync](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sync) - A WebdriverIO plugin. Helper module to run WebdriverIO commands synchronously
- [@wdio/utils](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-utils) - A WDIO helper utility to provide several utility functions used across the project
### Reporter
- [@wdio/allure-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-allure-reporter) - A WebdriverIO reporter plugin to create Allure Test Reports
- [@wdio/concise-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-concise-reporter) - A WebdriverIO reporter plugin to create concise test reports
- [@wdio/dot-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-dot-reporter) - A WebdriverIO plugin to report in dot style
- [@wdio/junit-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-junit-reporter) - A WebdriverIO reporter that creates test results in XML format
- [@wdio/spec-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-spec-reporter) - A WebdriverIO plugin to report in spec style
- [@wdio/sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sumologic-reporter) - A WebdriverIO reporter that sends test results to Sumologic for data analyses
- [@wdio/allure-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-allure-reporter) - A WebdriverIO reporter plugin to create Allure Test Reports
- [@wdio/concise-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-concise-reporter) - A WebdriverIO reporter plugin to create concise test reports
- [@wdio/dot-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-dot-reporter) - A WebdriverIO plugin to report in dot style
- [@wdio/junit-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-junit-reporter) - A WebdriverIO reporter that creates test results in XML format
- [@wdio/spec-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-spec-reporter) - A WebdriverIO plugin to report in spec style
- [@wdio/sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sumologic-reporter) - A WebdriverIO reporter that sends test results to Sumologic for data analyses
### Services
- [@wdio/appium-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-appium-service) - A WebdriverIO service to start & stop Appium Server
- [@wdio/applitools-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-applitools-service) - A WebdriverIO service for visual regression testing using Applitools
- [@wdio/browserstack-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-browserstack-service) - A WebdriverIO service that provides a better integration into Browserstack
- [@wdio/crossbrowsertesting-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-crossbrowsertesting-service) - A WebdriverIO service that provides a better integration into CrossBrowserTesting
- [@wdio/devtools-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-devtools-service) - A WebdriverIO service that allows you to run Chrome DevTools commands in your tests
- [@wdio/firefox-profile-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-firefox-profile-service) - A WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js
- [@wdio/sauce-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sauce-service) - A WebdriverIO service that provides a better integration into Sauce Labs
- [@wdio/selenium-standalone-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-selenium-standalone-service) - A WebdriverIO service that automatically sets up a selenium standalone server
- [@wdio/shared-store-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-shared-store-service) - A WebdriverIO service to exchange data across processes
- [@wdio/testingbot-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-testingbot-service) - A WebdriverIO service that provides a better integration into TestingBot
- [@wdio/appium-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-appium-service) - A WebdriverIO service to start & stop Appium Server
- [@wdio/applitools-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-applitools-service) - A WebdriverIO service for visual regression testing using Applitools
- [@wdio/browserstack-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service) - A WebdriverIO service that provides a better integration into Browserstack
- [@wdio/crossbrowsertesting-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-crossbrowsertesting-service) - A WebdriverIO service that provides a better integration into CrossBrowserTesting
- [@wdio/devtools-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-devtools-service) - A WebdriverIO service that allows you to run Chrome DevTools commands in your tests
- [@wdio/firefox-profile-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-firefox-profile-service) - A WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js
- [@wdio/sauce-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service) - A WebdriverIO service that provides a better integration into Sauce Labs
- [@wdio/selenium-standalone-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-selenium-standalone-service) - A WebdriverIO service that automatically sets up a selenium standalone server
- [@wdio/shared-store-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-shared-store-service) - A WebdriverIO service to exchange data across processes
- [@wdio/testingbot-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-testingbot-service) - A WebdriverIO service that provides a better integration into TestingBot
### Runner
- [@wdio/local-runner](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-local-runner) - A WebdriverIO runner to run tests locally
- [@wdio/local-runner](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-local-runner) - A WebdriverIO runner to run tests locally
### Framework Adapters
- [@wdio/cucumber-framework](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cucumber-framework) - Adapter for [Cucumber](https://cucumber.io/) testing framework
- [@wdio/jasmine-framework](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-jasmine-framework) - Adapter for [Jasmine](https://jasmine.github.io/) testing framework
- [@wdio/mocha-framework](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-mocha-framework) - Adapter for [Mocha](https://mochajs.org/) testing framework.
- [@wdio/cucumber-framework](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework) - Adapter for [Cucumber](https://cucumber.io/) testing framework
- [@wdio/jasmine-framework](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework) - Adapter for [Jasmine](https://jasmine.github.io/) testing framework
- [@wdio/mocha-framework](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-mocha-framework) - Adapter for [Mocha](https://mochajs.org/) testing framework.
### Others
- [eslint-plugin-wdio](https://github.com/webdriverio/webdriverio/tree/master/packages/eslint-plugin-wdio) - Eslint rules for WebdriverIO
- [@wdio/smoke-test-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-smoke-test-reporter) - A WebdriverIO utility to smoke test reporters for internal testing purposes
- [@wdio/smoke-test-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-smoke-test-service) - A WebdriverIO utility to smoke test services for internal testing purposes
- [@wdio/webdriver-mock-service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-webdriver-mock-service) - A WebdriverIO service to stub all endpoints for internal testing purposes
- [eslint-plugin-wdio](https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio) - Eslint rules for WebdriverIO
- [@wdio/smoke-test-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-smoke-test-reporter) - A WebdriverIO utility to smoke test reporters for internal testing purposes
- [@wdio/smoke-test-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-smoke-test-service) - A WebdriverIO utility to smoke test services for internal testing purposes
- [@wdio/webdriver-mock-service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service) - A WebdriverIO service to stub all endpoints for internal testing purposes
## Project Governance

14
ROADMAP.md
View file

@ -18,10 +18,10 @@ This document is designed to be a living record of the current and projected pri
| Project | Description | Completed | WebdriverIO Release | Notes |
|---------|-------------|-----------|---------------------|-------|
|Make CLI tool more powerful|Adding simple add ons to the setup becomes difficult if the person is not familiar with the project or WebDriver in general. Adding some simple commands to the CLI interface that allows to add service and reporters and modifies the config would make the process of adding plugins much easier.|2019-06-06|[v5.10.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v5100-2019-06-06)|[#3915](https://github.com/webdriverio/webdriverio/issues/3915)|
|Cucumber Framework Support|A lot of people request support for Cucumber as it is their main framework choice. Initial work on this has already been done by the community. The code needs to get proper unit tests but would then be good to go.|2019-07-09|[v5.11.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v5110-2019-07-09)|[#3667](https://github.com/webdriverio/webdriverio/pull/3667)|
|[Jest Framework Support](https://github.com/webdriverio/webdriverio/projects/2)|Jest has become one of the most popular unit test framework in the JS ecosystem. Even though most of their features are not helpful in the e2e space there are some things (e.g. snapshot testing) that could help people writing better e2e tests. There has been some initial work done on this.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Custom Assertion Library](https://github.com/webdriverio/webdriverio/projects/11)|To make assertion on elements or other objects simpler across all frameworks it would be nice if WebdriverIO would come with an native assertion library (similar how Jest or Jasmine provide one) embedded into the testrunner.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Autogenerate Sample Files](https://github.com/webdriverio/webdriverio/projects/10)|Let's allow user to pre-setup an existing boilerplate so that they don't need to setup these files by themselves. The community has gathered a lot of useful boilerplate projects that we want to allow to act as baseline for the test setup using the configuration wizard or a new `wdio` command.|2020-06-13|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)|[#5590](https://github.com/webdriverio/webdriverio/pull/5590)
|[Integrating WebdriverIO is common use setup build tools](https://github.com/webdriverio/webdriverio/projects/5)|There are various of projects that help you to bootstrap a project from scratch (e.g. [create-react-app](https://github.com/facebook/create-react-app)). We should add WebdriverIO as e2e testing option in there which will help us to driver adoption.|2020-07-18|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)|[#5636](https://github.com/webdriverio/webdriverio/pull/5636)
|[Network Primitives](https://github.com/webdriverio/webdriverio/projects/13)|As we have better cross browser support for Puppeteer we should move forward and provide better network primitives for WebdriverIO to help user access the network layer. In addition to that these features are likely to be supported once WebDriver moves to a BiDi protocol (which is a new version of WebDriver that is currently designed by the W3C working group and browser vendors).|2020-07-16|[v6.3.0](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)|[#5477](https://github.com/webdriverio/webdriverio/pull/5477)
|Make CLI tool more powerful|Adding simple add ons to the setup becomes difficult if the person is not familiar with the project or WebDriver in general. Adding some simple commands to the CLI interface that allows to add service and reporters and modifies the config would make the process of adding plugins much easier.|2019-06-06|[v5.10.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v5100-2019-06-06)|[#3915](https://github.com/webdriverio/webdriverio/issues/3915)|
|Cucumber Framework Support|A lot of people request support for Cucumber as it is their main framework choice. Initial work on this has already been done by the community. The code needs to get proper unit tests but would then be good to go.|2019-07-09|[v5.11.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v5110-2019-07-09)|[#3667](https://github.com/webdriverio/webdriverio/pull/3667)|
|[Jest Framework Support](https://github.com/webdriverio/webdriverio/projects/2)|Jest has become one of the most popular unit test framework in the JS ecosystem. Even though most of their features are not helpful in the e2e space there are some things (e.g. snapshot testing) that could help people writing better e2e tests. There has been some initial work done on this.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Custom Assertion Library](https://github.com/webdriverio/webdriverio/projects/11)|To make assertion on elements or other objects simpler across all frameworks it would be nice if WebdriverIO would come with an native assertion library (similar how Jest or Jasmine provide one) embedded into the testrunner.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Autogenerate Sample Files](https://github.com/webdriverio/webdriverio/projects/10)|Let's allow user to pre-setup an existing boilerplate so that they don't need to setup these files by themselves. The community has gathered a lot of useful boilerplate projects that we want to allow to act as baseline for the test setup using the configuration wizard or a new `wdio` command.|2020-06-13|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5590](https://github.com/webdriverio/webdriverio/pull/5590)
|[Integrating WebdriverIO is common use setup build tools](https://github.com/webdriverio/webdriverio/projects/5)|There are various of projects that help you to bootstrap a project from scratch (e.g. [create-react-app](https://github.com/facebook/create-react-app)). We should add WebdriverIO as e2e testing option in there which will help us to driver adoption.|2020-07-18|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5636](https://github.com/webdriverio/webdriverio/pull/5636)
|[Network Primitives](https://github.com/webdriverio/webdriverio/projects/13)|As we have better cross browser support for Puppeteer we should move forward and provide better network primitives for WebdriverIO to help user access the network layer. In addition to that these features are likely to be supported once WebDriver moves to a BiDi protocol (which is a new version of WebDriver that is currently designed by the W3C working group and browser vendors).|2020-07-16|[v6.3.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5477](https://github.com/webdriverio/webdriverio/pull/5477)

2
SECURITY.md
View file

@ -2,4 +2,4 @@
If you believe you have found a security vulnerability in WebdriverIO, we encourage you to let us know right away. We will investigate all legitimate reports and do our best to quickly fix the problem.
Please contact the project [Technical Steering Committee](https://github.com/webdriverio/webdriverio/blob/master/AUTHORS.md#tsc-technical-steering-committee) via E-Mail immediately after discovery of the vulnerability. Thanks!
Please contact the project [Technical Steering Committee](https://github.com/webdriverio/webdriverio/blob/main/AUTHORS.md#tsc-technical-steering-committee) via E-Mail immediately after discovery of the vulnerability. Thanks!

2
docs/API.md
View file

@ -44,4 +44,4 @@ However, it is recommended to use the testrunner to scale up your test suite, as
## Contribute
If you feel like you have a good example for a command, don't hesitate to open a PR and submit it. Just click on the orange button on the top right with the label _“EDIT”_. Make sure you understand the way we write these docs by checking the [Contributing](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md) section.
If you feel like you have a good example for a command, don't hesitate to open a PR and submit it. Just click on the orange button on the top right with the label _“EDIT”_. Make sure you understand the way we write these docs by checking the [Contributing](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md) section.

2
docs/AutomationProtocols.md
View file

@ -71,7 +71,7 @@ NOTE: there is no need to have neither `selenium-standalone` nor `chromedriver`
Now you can run a test (as shown below).
(An example how to run this using WebdriverIO in [standalone mode](https://webdriver.io/docs/setuptypes.html#standalone-mode) can also be found [here](https://github.com/webdriverio/webdriverio/blob/master/examples/devtools/intercept.js).)
(An example how to run this using WebdriverIO in [standalone mode](https://webdriver.io/docs/setuptypes.html#standalone-mode) can also be found [here](https://github.com/webdriverio/webdriverio/blob/main/examples/devtools/intercept.js).)
```js
// example using WDIO testrunner

8
docs/BoilerplateProjects.md
View file

@ -103,7 +103,7 @@ ATDD WEB tests with Mocha, WebdriverIO v6 with PageObject
- Mocha
- Features
- [Page Object](PageObjects.md) Model
- Sauce Labs integration with [Sauce Service](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-sauce-service/README.md)
- Sauce Labs integration with [Sauce Service](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-sauce-service/README.md)
- Allure Report
- Automatic screenshots capture for failing tests
- CircleCI example
@ -227,17 +227,17 @@ Boilerplate project to run appium tests for native and mobile browser using cucu
### [AdarshKumarGM/WebDriverIO-with-CucumberJS](https://github.com/AdarshKumarGM/WebDriverIO-with-CucumberJS)
Boilerplate for bulding cucumberJS with webdriverIO framework.
- Framework:
- Framework:
- WebdriverIO (v6.x)
- CucumberJS (v6.x)
- Node (v12.x)
- Features:
- Capability for desktop browser
- Multiple cucumber html reporting
- Eslint
- Folder structure containing support files to kick start
### [Arjun-Ar91/WebdriverIO-V6-appium-mocha-boilerplate](https://github.com/Arjun-Ar91/WebdriverIO-V6-appium-mocha-boilerplate.git)
Boilerplate project to run appium tests for native and mobile browser using mocha v6 and webdriverIO v6 with page object pattern.

10
docs/CloudServices.md
View file

@ -3,7 +3,7 @@ id: cloudservices
title: Using Cloud Services
---
Using on-demand services like Sauce Labs, Browserstack, TestingBot, CrossBrowserTesting or LambdaTest with WebdriverIO is pretty simple. All you need to do is to set your service's `user` and `key` in your options.
Using on-demand services like Sauce Labs, Browserstack, TestingBot, CrossBrowserTesting or LambdaTest with WebdriverIO is pretty simple. All you need to do is to set your service's `user` and `key` in your options.
Optionally, you can also parametrize your test by setting cloud-specific capabilities like `build`. If you only want to run cloud services in Travis, you can use the `CI` environment variable to check if you are in Travis and modify the config accordingly.
@ -32,7 +32,7 @@ If you want to run tests against a server that is not accessible to the Internet
It is out of the scope of WebdriverIO to support this, so you'll have to start it by yourself.
If you are using the WDIO testrunner download and configure the [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sauce-service) in your `wdio.conf.js`. It helps getting Sauce Connect running and comes with additional features that better integrate your tests into the Sauce service.
If you are using the WDIO testrunner download and configure the [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service) in your `wdio.conf.js`. It helps getting Sauce Connect running and comes with additional features that better integrate your tests into the Sauce service.
### With Travis CI
@ -42,7 +42,7 @@ If you do so, you must set the `tunnel-identifier` test configuration option in
Also, if you want to have Sauce Labs group your tests by build number, you can set the `build` to `TRAVIS_BUILD_NUMBER`.
Lastly, if you set `name`, this changes the name of this test in Sauce Labs for this build. If you are using the WDIO testrunner combined with the [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sauce-service), WebdriverIO automatically sets a proper name for the test.
Lastly, if you set `name`, this changes the name of this test in Sauce Labs for this build. If you are using the WDIO testrunner combined with the [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service), WebdriverIO automatically sets a proper name for the test.
Example `capabilities`:
@ -117,7 +117,7 @@ If you want to run tests against a server that is not accessible to the Internet
Their tunnel support page contains the information necessary to get this up and running.
If you are using the WDIO testrunner, download and configure the [`@wdio/testingbot-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-testingbot-service) in your `wdio.conf.js`. It helps get TestingBot running, and comes with additional features that better integrate your tests into the TestingBot service.
If you are using the WDIO testrunner, download and configure the [`@wdio/testingbot-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-testingbot-service) in your `wdio.conf.js`. It helps get TestingBot running, and comes with additional features that better integrate your tests into the TestingBot service.
## [CrossBrowserTesting](https://crossbrowsertesting.com/)
@ -129,7 +129,7 @@ You can also pass in any optional [supported capabilities](https://help.crossbro
If you want to run tests against a server that is not accessible to the Internet (like on `localhost`), then you need to use Local Testing. CrossBrowserTesting provides a tunnel to allow you to test websites not accessible from the internet.
If you are using the WDIO testrunner, download and configure the [`@wdio/crossbrowsertesting-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-crossbrowsertesting-service) in your `wdio.conf.js`. It helps get CrossBrowserTesting running and comes with additional features that better integrate your tests into the CrossBrowserTesting service.
If you are using the WDIO testrunner, download and configure the [`@wdio/crossbrowsertesting-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-crossbrowsertesting-service) in your `wdio.conf.js`. It helps get CrossBrowserTesting running and comes with additional features that better integrate your tests into the CrossBrowserTesting service.
## [LambdaTest](https://www.lambdatest.com)

8
docs/ConfigurationFile.md
View file

@ -41,7 +41,7 @@ exports.config = {
//
user: 'webdriverio',
key: 'xxxxxxxxxxxxxxxx-xxxxxx-xxxxx-xxxxxxxxx',
// If you run your tests on Sauce Labs you can specify the region you want to run your tests
// in via the `region` property. Available short handles for regions are `us` (default) and `eu`.
// These regions are used for the Sauce Labs VM cloud and the Sauce Labs Real Device Cloud.
@ -211,7 +211,7 @@ exports.config = {
},
//
// Options to be passed to Jasmine.
// See also: https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-jasmine-framework#jasminenodeopts-options
// See also: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework#jasminenodeopts-options
jasmineNodeOpts: {
//
// Jasmine default timeout
@ -230,7 +230,7 @@ exports.config = {
},
//
// If you are using Cucumber you need to specify where your step definitions are located.
// See also: https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cucumber-framework#cucumberopts-options
// See also: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework#cucumberopts-options
cucumberOpts: {
require: [], // <string[]> (file/dir) require files before executing features
backtrace: false, // <boolean> show full backtrace for errors
@ -399,4 +399,4 @@ exports.config = {
}
```
You can also find a file with all possible options and variations in the [example folder](https://github.com/webdriverio/webdriverio/blob/master/examples/wdio.conf.js).
You can also find a file with all possible options and variations in the [example folder](https://github.com/webdriverio/webdriverio/blob/main/examples/wdio.conf.js).

10
docs/Contribute.md
View file

@ -7,12 +7,12 @@ You like WebdriverIO and want to help making it better? Awesome! We are working
## Code of Conduct
Everyone who participates in this project, either as a user or a contributor, is obliged to follow the projects [Code of Conduct](https://github.com/webdriverio/webdriverio/blob/master/CODE_OF_CONDUCT.md). Every violation against it will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Everyone who participates in this project, either as a user or a contributor, is obliged to follow the projects [Code of Conduct](https://github.com/webdriverio/webdriverio/blob/main/CODE_OF_CONDUCT.md). Every violation against it will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
## Requirements
We accept and appreciate any contribution, either big or small by anyone, with any title or any kind of experience.
In order to start contributing to the code we recommend to follow the [Set Up Project](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#set-up-project) guide. Once all tests are passing you are ready to work on your first contribution.
In order to start contributing to the code we recommend to follow the [Set Up Project](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#set-up-project) guide. Once all tests are passing you are ready to work on your first contribution.
__Note:__ If you struggle to follow the guide, join the WebdriverIO support channel on [Gitter](https://gitter.im/webdriverio/webdriverio) and reach out to the maintainer there. Don't be shy, they are there to help!
@ -34,7 +34,7 @@ If you want to contribute code, a general good first way to find a task to work
Often issues require some amount of context to the problem which makes it difficult to get an idea about what needs to be done. Depending on your experience using / working with the project this context can be missing. Often it helps to start with tasks around missing documentation or just increase test coverage of some parts in the code. After some time you will get more familiar with the codebase which allows you to pick up more difficult tasks.
If you can't find something that suits you, look into the [project roadmap](https://github.com/webdriverio/webdriverio/blob/master/ROADMAP.md) to see if there is something interesting for you. At the end you can also _always_ reach out to the maintainers in the [Gitter](https://gitter.im/webdriverio/webdriverio) support channel. They are responsible to find a task for you.
If you can't find something that suits you, look into the [project roadmap](https://github.com/webdriverio/webdriverio/blob/main/ROADMAP.md) to see if there is something interesting for you. At the end you can also _always_ reach out to the maintainers in the [Gitter](https://gitter.im/webdriverio/webdriverio) support channel. They are responsible to find a task for you.
## Proposing a Change
@ -44,9 +44,9 @@ If you’re only fixing a bug, it’s fine to submit a pull request right away,
## Work With The Code
If you make any changes to the code, you want to test it quickly to see if they do what you expect. There are a couple of ways to do that in WebdriverIO. For one, you can link single sub-packages into your own project to see if the changes you've made have the effect you expected. Find a guide on how to [link changes to your current project](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#link-changes-to-your-current-project) in our contributing guide.
If you make any changes to the code, you want to test it quickly to see if they do what you expect. There are a couple of ways to do that in WebdriverIO. For one, you can link single sub-packages into your own project to see if the changes you've made have the effect you expected. Find a guide on how to [link changes to your current project](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#link-changes-to-your-current-project) in our contributing guide.
Another way to test changes in WebdriverIO is by using its [example directory](https://github.com/webdriverio/webdriverio/tree/master/examples) or by running its [smoke test suite](https://github.com/webdriverio/webdriverio/tree/master/tests). The example directory is a set of sample scripts that use WebdriverIO in various of ways. Here, you need to have a browser driver running to run the scripts. With the smoke test suite you can run various flavors of WebdriverIO within a predefined execution scenario. All of these scenarios are defined in our [WebDriver Mock Service](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-webdriver-mock-service) that mimics a browser driver by stubbing the endpoints with predefined responses. It is a great way to run WebdriverIO suites quickly without having to setup anything.
Another way to test changes in WebdriverIO is by using its [example directory](https://github.com/webdriverio/webdriverio/tree/main/examples) or by running its [smoke test suite](https://github.com/webdriverio/webdriverio/tree/main/tests). The example directory is a set of sample scripts that use WebdriverIO in various of ways. Here, you need to have a browser driver running to run the scripts. With the smoke test suite you can run various flavors of WebdriverIO within a predefined execution scenario. All of these scenarios are defined in our [WebDriver Mock Service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service) that mimics a browser driver by stubbing the endpoints with predefined responses. It is a great way to run WebdriverIO suites quickly without having to setup anything.
## Make a Pull Request

4
docs/CustomReporter.md
View file

@ -103,7 +103,7 @@ Note that you cannot defer the test execution in any way.
All event handlers should execute synchronous routines (or you’ll run into race conditions).
Be sure to check out the [example section](https://github.com/webdriverio/webdriverio/tree/master/examples/wdio) where you can find an example custom reporter that prints the event name for each event.
Be sure to check out the [example section](https://github.com/webdriverio/webdriverio/tree/main/examples/wdio) where you can find an example custom reporter that prints the event name for each event.
If you have implemented a custom reporter that could be useful for the community, don't hesitate to make a Pull Request so we can make the reporter available for the public!
@ -122,7 +122,7 @@ const launcher = new Launcher('/path/to/config.file.js', {
## Wait Until `isSynchronised`
If your reporter has to execute async operations to report the data (e.g. upload of log files or other assets) you can overwrite the `isSynchronised` method in your custom reporter to let the WebdriverIO runner wait until you have computed everything. An example of this can be seen in the [`@wdio/sumologic-reporter`](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-sumologic-reporter/src/index.js):
If your reporter has to execute async operations to report the data (e.g. upload of log files or other assets) you can overwrite the `isSynchronised` method in your custom reporter to let the WebdriverIO runner wait until you have computed everything. An example of this can be seen in the [`@wdio/sumologic-reporter`](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-sumologic-reporter/src/index.js):
```js
export default class SumoLogicReporter extends WDIOReporter {

6
docs/CustomServices.md
View file

@ -123,7 +123,7 @@ To make services easier to consume and discover by the WebdriverIO community, pl
* Services should use this naming convention: `wdio-*-service`
* Use NPM keywords: `wdio-plugin`, `wdio-service`
* The `main` entry should `export` an instance of the service
* Example services: [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sauce-service)
* Example services: [`@wdio/sauce-service`](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service)
Following the recommended naming pattern allows services to be added by name:
@ -142,5 +142,5 @@ We really appreciate every new plugin that could help other people run better te
Please raise a pull request with the following changes:
- add your service to the list of [supported services](https://github.com/webdriverio/webdriverio/blob/master/packages/wdio-cli/src/constants.ts#L83-L111)) in the CLI module
- enhance the [service list](https://github.com/webdriverio/webdriverio/blob/master/scripts/docs-generation/3rd-party/services.json) for adding your docs to the offical Webdriver.io page
- add your service to the list of [supported services](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-cli/src/constants.ts#L83-L111)) in the CLI module
- enhance the [service list](https://github.com/webdriverio/webdriverio/blob/main/scripts/docs-generation/3rd-party/services.json) for adding your docs to the offical Webdriver.io page

2
docs/Frameworks.md
View file

@ -265,7 +265,7 @@ npm install @wdio/cucumber-framework --save-dev
If you want to use Cucumber, set the `framework` property to `cucumber` by adding `framework: 'cucumber'` to the [config file](ConfigurationFile.md).
Options for Cucumber can be given in the config file with `cucumberOpts`. Check out the whole list of options [here](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cucumber-framework#cucumberopts-options).
Options for Cucumber can be given in the config file with `cucumberOpts`. Check out the whole list of options [here](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework#cucumberopts-options).
To get up and running quickly with Cucumber, have a look on our [`cucumber-boilerplate`](https://github.com/webdriverio/cucumber-boilerplate) project that comes with all the step definitions you need to get stared, and you'll be writing feature files right away.

2
docs/Options.md
View file

@ -333,7 +333,7 @@ Default: `null`
WebdriverIO allows you to set hooks to trigger at specific times of the test lifecycle. This allows custom actions (e.g., take screenshot if a test fails).
Every hook has as parameter specific information about the lifecycle (i.e. information about the test suite or test). Read more about all hook properties in [our example config](https://github.com/webdriverio/webdriverio/blob/master/examples/wdio.conf.js#L183-L326).
Every hook has as parameter specific information about the lifecycle (i.e. information about the test suite or test). Read more about all hook properties in [our example config](https://github.com/webdriverio/webdriverio/blob/main/examples/wdio.conf.js#L183-L326).
### onPrepare

2
docs/PageObjects.md
View file

@ -127,4 +127,4 @@ From the structural side, it makes sense to separate spec files and page objects
This is the basic principle of how to write page objects with WebdriverIO. But you can build up way more complex page object structures than this! For example, you might have specific page objects for modals, or split up a huge page object into different classes (each representing a different part of the overall web page) that inherit from the main page object. The pattern really provides a lot of opportunities to separate page information from your tests, which is important to keep your test suite structured and clear in times where the project and number of tests grows.
You can find this example (and even more page object examples) in the [`example` folder](https://github.com/webdriverio/webdriverio/tree/master/examples/pageobject) on GitHub.
You can find this example (and even more page object examples) in the [`example` folder](https://github.com/webdriverio/webdriverio/tree/main/examples/pageobject) on GitHub.

2
docs/Versions.md
View file

@ -9,7 +9,7 @@ The project team releases new major versions roughly on a yearly cadence. LTS re
| | | | |
|----|--------------------|--------------------------------------------------------------------------------------|-----------------|
| v6 | [Documentation](/) | [Release Notes](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md) | __Stable__ |
| v6 | [Documentation](/) | [Release Notes](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md) | __Stable__ |
## Past Versions

4
examples/wdio.conf.js
View file

@ -146,7 +146,7 @@ exports.config = {
},
//
// Options to be passed to Jasmine.
// See also: https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-jasmine-framework#jasminenodeopts-options
// See also: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework#jasminenodeopts-options
jasmineNodeOpts: {
//
// Jasmine default timeout
@ -165,7 +165,7 @@ exports.config = {
},
//
// If you are using Cucumber you need to specify the location of your step definitions.
// See also: https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cucumber-framework#cucumberopts-options
// See also: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework#cucumberopts-options
cucumberOpts: {
require: [], // <string[]> (file/dir) require files before executing features
backtrace: false, // <boolean> show full backtrace for errors

2
packages/devtools/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A Chrome DevTools protocol binding that maps WebDriver commands into Chrome DevTools commands using Puppeteer",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/devtools",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/devtools",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/eslint-plugin-wdio/package.json
View file

@ -3,7 +3,7 @@
"version": "6.6.0",
"description": "Eslint rules for WebdriverIO",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/eslint-plugin-wdio",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/eslint-plugin-wdio",
"license": "MIT",
"main": "index.js",
"engines": {

2
packages/wdio-allure-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO reporter plugin to create Allure Test Reports",
"author": "Boris Osipov <osipov.boris@gmail.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-allure-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-allure-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-appium-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A WebdriverIO service to start & stop Appium Server",
"author": "Morten Bjerg Gregersen <morten@mogee.dk>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-appium-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-appium-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-applitools-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.10",
"description": "A WebdriverIO service for visual regression testing using Applitools",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-applitools-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-applitools-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-browserstack-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "WebdriverIO service for better Browserstack integration",
"author": "Adam Bjerstedt <abjerstedt@gmail.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-browserstack-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-cli/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "WebdriverIO testrunner command line interface",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cli",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cli",
"license": "MIT",
"main": "./build/index",
"bin": {

2
packages/wdio-concise-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A concise reporter for WebdriverIO",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-concise-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-concise-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-config/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A helper utility to parse and validate WebdriverIO options",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-config",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-config",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-crossbrowsertesting-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.10",
"description": "A WebdriverIO service that manages local tunnel and job metadata for CrossBrowserTesting users.",
"author": "Daphne Magsby <daphnem@crossbrowsertesting.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-crossbrowsertesting-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-crossbrowsertesting-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-cucumber-framework/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.1",
"description": "A WebdriverIO plugin. Adapter for Cucumber.js testing framework.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-cucumber-framework",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-devtools-service/README.md
View file

@ -278,7 +278,7 @@ console.log(nodeId) // outputs: [ 40, 41, 42, 43, 44, 45 ]
### `startTracing(categories, samplingFrequency)` Command
Start tracing the browser. You can optionally pass in custom tracing categories (defaults to [this list](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-devtools-service/src/constants.js#L1-L9)) and the sampling frequency (defaults to `10000`).
Start tracing the browser. You can optionally pass in custom tracing categories (defaults to [this list](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-devtools-service/src/constants.js#L1-L9)) and the sampling frequency (defaults to `10000`).
```js
browser.startTracing()

2
packages/wdio-devtools-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A WebdriverIO service that allows you to run Chrome DevTools commands in your tests",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-devtools-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-devtools-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-dot-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO plugin to report in dot style",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-dot-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-dot-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-firefox-profile-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.6",
"description": "WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-firefox-profile-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-firefox-profile-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-jasmine-framework/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO plugin. Adapter for Jasmine testing framework.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-jasmine-framework",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-junit-reporter/README.md
View file

@ -143,7 +143,7 @@ Error: some assertion failure
## Configuration
Following code shows the default wdio test runner configuration. Just add `'junit'` as reporter
to the array. To get some output during the test you can run the [WDIO Dot Reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-dot-reporter) and the WDIO JUnit Reporter at the same time:
to the array. To get some output during the test you can run the [WDIO Dot Reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-dot-reporter) and the WDIO JUnit Reporter at the same time:
```js
// wdio.conf.js

2
packages/wdio-junit-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO reporter that creates Jenkins compatible XML based JUnit reports",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-junit-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-junit-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-local-runner/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A WebdriverIO runner to run tests locally",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-local-runner",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-local-runner",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-logger/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.10",
"description": "A helper utility for logging of WebdriverIO packages",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-logger",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-logger",
"license": "MIT",
"main": "./build/node",
"engines": {

2
packages/wdio-mocha-framework/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO plugin. Adapter for Mocha testing framework.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-mocha-framework",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-mocha-framework",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-protocols/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.0",
"description": "Utility package providing information about automation protocols",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-protocols",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols",
"license": "MIT",
"main": "./build/index",
"types": "./build/index.d.ts",

2
packages/wdio-repl/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WDIO helper utility to provide a repl interface for WebdriverIO",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-repl",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-repl",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-reporter/README.md
View file

@ -119,7 +119,7 @@ If `stdout` is set to `false` WebdriverIO will automatically write to a filestre
## Synchronization
If your reporter needs to do some async computation after the test (e.g. upload logs to a server) you can overwrite the `isSynchronised` getter method to manage this. By default this property always returns true as most of the reporters don't require to do any async work. However in case you need to handle this overwrite the getter method with an custom implementation (e.g. [wdio-sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sumologic-reporter)).
If your reporter needs to do some async computation after the test (e.g. upload logs to a server) you can overwrite the `isSynchronised` getter method to manage this. By default this property always returns true as most of the reporters don't require to do any async work. However in case you need to handle this overwrite the getter method with an custom implementation (e.g. [wdio-sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sumologic-reporter)).
```js
class MyReporter extends Reporter {

2
packages/wdio-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO utility to help reporting all events",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-runner/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A WebdriverIO service that runs tests in arbitrary environments",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-runner",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-runner",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-sauce-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "WebdriverIO service that provides a better integration into Sauce Labs",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sauce-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-selenium-standalone-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A WebdriverIO service to start & stop Selenium Standalone",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-selenium-standalone-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-selenium-standalone-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-shared-store-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO service to exchange data across processes",
"author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-shared-store-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-shared-store-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-smoke-test-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO utility to smoke test reporters for internal testing purposes.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-smoke-test-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-smoke-test-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-smoke-test-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.6.2",
"description": "A WebdriverIO utility to smoke test services for internal testing purposes.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-smoke-test-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-smoke-test-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-spec-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO plugin to report in spec style",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-spec-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-spec-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-static-server-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.10",
"description": "A WebdriverIO service that can serve your static websites",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-static-server-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-static-server-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-sumologic-reporter/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO reporter that sends test results to Sumologic for data analyses",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sumologic-reporter",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sumologic-reporter",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-sync/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WebdriverIO plugin. Helper module to run WebdriverIO commands synchronously",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sync",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sync",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-testingbot-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.4",
"description": "A WebdriverIO service that provides a better integration into TestingBot",
"author": "Jochen Delabie <info@testingbot.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-testingbot-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-testingbot-service",
"license": "MIT",
"main": "./build",
"engines": {

2
packages/wdio-types/package.json
View file

@ -3,7 +3,7 @@
"version": "6.10.6",
"description": "Utility package providing type information for a variety of WebdriverIO interfaces",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-types",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-types",
"license": "MIT",
"main": "./build/index.js",
"types": "./build/index.d.ts",

2
packages/wdio-utils/package.json
View file

@ -3,7 +3,7 @@
"version": "6.11.0",
"description": "A WDIO helper utility to provide several utility functions used across the project.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-utils",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-utils",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/wdio-webdriver-mock-service/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.0",
"description": "A WebdriverIO service to stub all endpoints for internal testing purposes.",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-webdriver-mock-service",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service",
"license": "MIT",
"main": "./build/index",
"engines": {

2
packages/webdriver/package.json
View file

@ -3,7 +3,7 @@
"version": "6.12.1",
"description": "A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/webdriver",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/webdriver",
"license": "MIT",
"main": "./build",
"engines": {

4
scripts/backport.js
View file

@ -13,7 +13,7 @@ const maintenanceLTSVersion = 'v5'
if (!process.env.GITHUB_AUTH) {
throw new Error(
'Please export a "GITHUB_AUTH" access token to generate the changelog.\n' +
'See also https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#release-new-version'
'See also https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#release-new-version'
)
}
@ -125,7 +125,7 @@ const api = new Octokit({ auth: process.env.GITHUB_AUTH })
(amount) => console.log(amount
? (
`\nSuccessfully backported ${amount} PRs 👏!\n` +
`Please now push them to master and make a new ${maintenanceLTSVersion}.x release!`
`Please now push them to v6 and make a new ${maintenanceLTSVersion}.x release!`
)
: 'Bye!'
),

2
scripts/changelog.js
View file

@ -20,7 +20,7 @@ if (!process.env.GITHUB_AUTH) {
shell.exec('git checkout -- .')
throw new Error(
'Please export a "GITHUB_AUTH" access token to generate the changelog.\n' +
'See also https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#release-new-version'
'See also https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#release-new-version'
)
}

2
scripts/docs-generation/3rdPartyDocs.js
View file

@ -35,7 +35,7 @@ exports.generate3rdPartyDocs = async (sidebars) => {
const categoryDir = path.join(DOCS_ROOT_DIR, category)
await fs.ensureDir(categoryDir)
for (const { packageName, title, githubUrl, npmUrl, suppressBuildInfo, location = githubReadme, branch = 'master' } of packages3rdParty) {
for (const { packageName, title, githubUrl, npmUrl, suppressBuildInfo, location = githubReadme, branch = 'main' } of packages3rdParty) {
const readme = await downloadReadme(githubUrl, branch, location)
const id = `${packageName}`.replace(/@/g, '').replace(/\//g, '-')

2
scripts/docs-generation/packagesDocs.js
View file

@ -23,7 +23,7 @@ exports.generateReportersAndServicesDocs = (sidebars) => {
const id = `${name.join('-')}-${type}`
const pkgName = name.map((n) => n[0].toUpperCase() + n.slice(1)).join(' ')
const readme = fs.readFileSync(path.join(__dirname, '..', '..', 'packages', pkg, 'README.md')).toString()
const preface = buildPreface(id, pkgName, nameSingular, `https://github.com/webdriverio/webdriverio/edit/master/packages/${pkg}/README.md`)
const preface = buildPreface(id, pkgName, nameSingular, `https://github.com/webdriverio/webdriverio/edit/main/packages/${pkg}/README.md`)
const doc = [...preface, ...readme.split('\n').slice(3)].join('\n')
fs.writeFileSync(path.join(__dirname, '..', '..', 'docs', `_${id}.md`), doc, { encoding: 'utf-8' })

4
scripts/docs-generation/protocolDocs.js
View file

@ -41,7 +41,7 @@ exports.generateProtocolDocs = (sidebars) => {
description.returnTags = [] // tbd
description.throwsTags = [] // tbd
description.isMobile = MOBILE_PROTOCOLS.includes(protocolName)
description.customEditUrl = `${config.repoUrl}/edit/master/packages/wdio-protocols/protocols/${protocolName}.json`
description.customEditUrl = `${config.repoUrl}/edit/main/packages/wdio-protocols/protocols/${protocolName}.json`
let protocolNote
if (VENDOR_PROTOCOLS.includes(protocolName)) {
@ -65,7 +65,7 @@ exports.generateProtocolDocs = (sidebars) => {
'---',
`id: ${protocolName}`,
`title: ${protocol}`,
`custom_edit_url: https://github.com/webdriverio/webdriverio/edit/master/packages/wdio-protocols/protocols/${protocolName}.json`,
`custom_edit_url: https://github.com/webdriverio/webdriverio/edit/main/packages/wdio-protocols/protocols/${protocolName}.json`,
'---\n'
].join('\n')]

2
scripts/generateSubPackage.js
View file

@ -67,7 +67,7 @@ inquirer.prompt(questions).then(answers => {
"version": "0.0.0",
"description": "A WebdriverIO ${packageType} that <provide ${packageType} description>",
"author": "Christian Bromann <christian@saucelabs.com>",
"homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/${fullPackageName}",
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/${fullPackageName}",
"license": "MIT",
"main": "./build/index",
"engines": {

2
scripts/utils/formatter.js
View file

@ -185,7 +185,7 @@ module.exports = function (docfile) {
description: description,
ignore: javadoc.ignore,
examples: files,
customEditUrl: `${config.repoUrl}/edit/master/packages/webdriverio/src/commands/${scope}/${name}.js`,
customEditUrl: `${config.repoUrl}/edit/main/packages/webdriverio/src/commands/${scope}/${name}.js`,
hasDocusaurusHeader: true,
originalId: `api/${scope}/${name}`,
isElementScope : scope === 'element',

6
website/blog/2018-12-19-webdriverio-v5-released.md
View file

@ -34,7 +34,7 @@ If you have been using `wdio-mocha-framework` or `wdio-spec-reporter` in your pr
When people proposed new commands to the API, we contributors became more and more hesitent to introduce them. There were a vast number of existing commands; and many of these requested commands provided very little difference from existing commands. This was beginning to become a maintenance nightmare.<br>
<br>
Starting with v5 we created a "base" WebdriverIO package called [`webdriver`](https://www.npmjs.com/package/webdriver). It contains the bare logic to make a HTTP request to a WebDriver endpoint; and includes all of the commands from [various specifications](https://github.com/webdriverio/webdriverio/tree/master/packages/webdriver/protocol) (including the [WebDriver](https://w3c.github.io/webdriver/) spec as well as Appiums [Mobile JSONWire protocol](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)) defined in a simple to maintain JSON object.<br>
Starting with v5 we created a "base" WebdriverIO package called [`webdriver`](https://www.npmjs.com/package/webdriver). It contains the bare logic to make a HTTP request to a WebDriver endpoint; and includes all of the commands from [various specifications](https://github.com/webdriverio/webdriverio/tree/main/packages/webdriver/protocol) (including the [WebDriver](https://w3c.github.io/webdriver/) spec as well as Appiums [Mobile JSONWire protocol](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)) defined in a simple to maintain JSON object.<br>
<br>
As part of that effort we've renamed many of the commands in order to align them closer to the pattern that has been used in the protocol. The base WebDriver client now also returns the `value` property of all protocol command responses, so that we were able to get rid of a lot of redundancy (e.g. `title` is now called with `getTitle`).<br>
<br>
@ -59,13 +59,13 @@ We are still in the process of finalising this effort, as we want to continue pr
## How To Upgrade To v5
There are significantly more things that we have been working on over the last year that you might like to read about. Check out the official [changelog](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v500-2018-12-20) to find all of the changes that describe the new version. We will probably continue to update this over time, as we weren't able to keep a list of every detail that changed. We would also like to ask you to have a look into the new [guide section](https://webdriver.io/docs/gettingstarted.html) and our updated docs in general.<br>
There are significantly more things that we have been working on over the last year that you might like to read about. Check out the official [changelog](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v500-2018-12-20) to find all of the changes that describe the new version. We will probably continue to update this over time, as we weren't able to keep a list of every detail that changed. We would also like to ask you to have a look into the new [guide section](https://webdriver.io/docs/gettingstarted.html) and our updated docs in general.<br>
<br>
There is unfortunately no easy upgrade tool that you can download and run to update your test suites from v4 to v5 (even though we would love to have such a thing, PRs are welcome 😉). If you run into any issues upgrading to v5 please join our support [![Gitter](https://badges.gitter.im/webdriverio/webdriverio.svg)](https://gitter.im/webdriverio/webdriverio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) and reach out to us.<br>
<br>
Every project is different, so it is impossible to have one single guide for everyone. However, the following step by step description will help you get closer to where you need to be:<br>
<br>
- read the [changelog](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v500-2018-12-20) to understand all breaking changes
- read the [changelog](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v500-2018-12-20) to understand all breaking changes
- remove all `wdio-*` packages from your `package.json`
- remove your `node_modules` directory
- install the latest version of webdriverio: `$ npm install webdriverio@latest`

6
website/blog/2019-07-11-cucumberjs-v5-released.md
View file

@ -34,7 +34,7 @@ This might result in errors like for example `browser.positionClick() is not a f
See the API documentation [here](https://webdriver.io/docs/api.html) to see which command is a Webdriver Protocol (W3C) or a JSONWire protocol command.
Just a little side note, we tried to keep all `browser` and `element` commands, see the link above, agnostic to the protocol. Nothing changed here for you.
To provide you some insight on how this works please check for example the `keys` command, you will find the support for both protocols [here](https://github.com/webdriverio/webdriverio/blob/master/packages/webdriverio/src/commands/browser/keys.js#L45-L50).
To provide you some insight on how this works please check for example the `keys` command, you will find the support for both protocols [here](https://github.com/webdriverio/webdriverio/blob/main/packages/webdriverio/src/commands/browser/keys.js#L45-L50).
If you want to use W3C with cloud vendors, like for example Sauce Labs or Browserstack, you need to use a vendor specific prefix in your capabilities.
Please check the websites of the vendors to see what you need to do.
@ -45,10 +45,10 @@ So, W3C is a major step for us all!!
### Command changes
Over the years WebdriverIO added more and more commands for different automation protocols without applying a pattern to it which resulted in having a bunch of duplication and inconsistent naming.
Even though the list looks exhausting, most of the commands that have changed were used internally. Please check the [changelog of V5](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v500-2018-12-20) to see all the changes.
Even though the list looks exhausting, most of the commands that have changed were used internally. Please check the [changelog of V5](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v500-2018-12-20) to see all the changes.
### Breaking changes
When creating a better product and thus releasing a major version, you will always have breaking changes. We can't repeat it enough but please check the [changelog of V5](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md#v500-2018-12-20) to see all the breaking changes.
When creating a better product and thus releasing a major version, you will always have breaking changes. We can't repeat it enough but please check the [changelog of V5](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v500-2018-12-20) to see all the breaking changes.
**Don't only read the changes in the V5.0.0 release, but also read the rest of the changes!**

2
website/blog/2019-09-16-devtools.md
View file

@ -78,7 +78,7 @@ describe('my e2e tests', () => {
})
```
We also made sure that you can use the `devtools` automation protocol with WDIO testrunner services like [`@wdio/devtools-service`](https://www.npmjs.com/package/@wdio/devtools-service) to make the experience as seamless as possible. You can find the complete script example to run in standalone mode in the WebdriverIO [example directory](https://github.com/webdriverio/webdriverio/tree/master/examples/devtools/intercept.js).
We also made sure that you can use the `devtools` automation protocol with WDIO testrunner services like [`@wdio/devtools-service`](https://www.npmjs.com/package/@wdio/devtools-service) to make the experience as seamless as possible. You can find the complete script example to run in standalone mode in the WebdriverIO [example directory](https://github.com/webdriverio/webdriverio/tree/main/examples/devtools/intercept.js).
We recommend only running tests on the devtools protocol if your functional test requires some sort of automation capability that is not provided by WebDriver. It also makes sense to switch to `devtools` whenever running tests locally as the test execution will be much faster. If you follow our best practices you should split up your wdio config files per environment (e.g. local testing vs. run tests against Sauce Labs or in your grid). You can now have a config that defines a set of tests that require some Puppeteer interaction:

4
website/blog/2020-03-26-webdriverio-v6-released.md
View file

@ -82,7 +82,7 @@ A big goal with the new release was to make WebdriverIO more performant and fast
![bundle size comparison](./assets/bundlesize.png)
By using [`got`](https://github.com/sindresorhus/got) as new dependency to make requests in WebDriver we are now technically also able to run WebdriverIO in the browser which creates interesting possibilities and was a requirement for our [roadmap item](https://github.com/webdriverio/webdriverio/blob/master/ROADMAP.md#upcoming-projects-in-no-particular-order) to build a fiddle platform for WebdriverIO scripts.
By using [`got`](https://github.com/sindresorhus/got) as new dependency to make requests in WebDriver we are now technically also able to run WebdriverIO in the browser which creates interesting possibilities and was a requirement for our [roadmap item](https://github.com/webdriverio/webdriverio/blob/main/ROADMAP.md#upcoming-projects-in-no-particular-order) to build a fiddle platform for WebdriverIO scripts.
The new version v6 will also come with a lot of internal improvements that will speed up test execution and lower CPU and memory usage. Especially when it comes to fetching elements we were able to reduce a lot of overhead and spead things up:
@ -211,6 +211,6 @@ If you are using the `@wdio/appium-service` you don't need to do anything.
## LTS Support
With the release of v6 we will continue to support v5 until we decide to release a new major version v7. We created a [backporting process](https://github.com/webdriverio/webdriverio/blob/master/CONTRIBUTING.md#back-porting-bug-fixes) that allows us to seamlessly backport bug fixes and features from v6 to v5. Please note that as the code between both versions diverge we won't be able to backport every feature and bug fix. We might ask code contributors to provide a similar PR that has been made to the `master` branch also to the `v5` branch.
With the release of v6 we will continue to support v5 until we decide to release a new major version v7. We created a [backporting process](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md#back-porting-bug-fixes) that allows us to seamlessly backport bug fixes and features from v6 to v5. Please note that as the code between both versions diverge we won't be able to backport every feature and bug fix. We might ask code contributors to provide a similar PR that has been made to the `master` branch also to the `v5` branch.
That said, we generally recommend to update to the latest version as soon as possible to make sure that you leverage bug fixes that have been made to the project.

2
website/pages/en/help.js
View file

@ -54,7 +54,7 @@ class Help extends React.Component {
<ul>
<li><a href="https://www.codementor.io/@kevinlamping">Kevin Lamping</a></li>
<li><a href="https://github.com/webdriverio/webdriverio/blob/master/website/pages/en/help.js">Add your name to this list</a></li>
<li><a href="https://github.com/webdriverio/webdriverio/blob/main/website/pages/en/help.js">Add your name to this list</a></li>
</ul>
<p>Otherwise, check out these free resources:</p>

2
website/pages/en/index.js
View file

@ -174,7 +174,7 @@ const AutomationProtocolSupport = () => (
'WebdriverIO is always up to date with the latest automation frameworks and therefore, supports not only capabilities ' +
'of the <a href="https://w3c.github.io/webdriver/">WebDriver</a> but also commands of the <a href="https://chromedevtools.github.io/devtools-protocol/">Chrome DevTools</a> ' +
'protocol using tools like <a href="https://pptr.dev/">Puppeteer</a>. The framework allows you to freely switch between ' +
'running remote WebDriver commands as well stubbing and mocking features of Puppeteer. Have a look into the <a href="https://github.com/webdriverio/webdriverio/blob/master/examples/devtools/intercept.js">examples</a> ' +
'running remote WebDriver commands as well stubbing and mocking features of Puppeteer. Have a look into the <a href="https://github.com/webdriverio/webdriverio/blob/main/examples/devtools/intercept.js">examples</a> ' +
'directory.',
image: imgUrl('w3c-wdio-pptr.png'),
imageAlign: 'right',

2
website/siteConfig.js
View file

@ -18,7 +18,7 @@ module.exports = {
{ href: repoUrl, label: 'GitHub' }
],
repoUrl: repoUrl,
editUrl: repoUrl + '/edit/master/docs/',
editUrl: repoUrl + '/edit/main/docs/',
footerIcon: 'img/twitter-profile.png',
favicon: 'img/favicon.png',