@wdio/browser-runner

WebdriverIO Browser Runner
==========================

> A WebdriverIO runner to run unit and component tests within the browser.

As opposed to the Local Runner the Browser Runner initiates and executes the framework within the browser. This allows you to run unit tests or component tests in an actual browser rather than in a JSDOM like many other test frameworks.

While JSDOM is widely used for testing purposes, it is in the end not an actual browser nor can you emulate mobile environments with it. With this runner WebdriverIO enables you to easily run your tests in the browser and use WebDriver commands to interact with elements rendered on the page.

Here is an overview of running tests within JSDOM vs. WebdriverIOs Browser Runner

| | JSDOM | WebdriverIO Browser Runner |
|-|-------|----------------------------|
|1.| Runs your tests within Node.js using a re-implementation of web standards, notably the WHATWG DOM and HTML Standards | Executes your test in an actual browser and runs the code in an environment that your users use |
|2.| Interactions with components can only be imitated via JavaScript | You can use the WebdriverIO API to interact with elements through the WebDriver protocol |
|3.| Canvas support requires additional dependencies and has limitations | You have access to the real Canvas API |
|4.| JSDOM has some caveats and unsupported Web APIs | All Web APIs are supported as test run in an actual browser |
|5.| Impossible to detect errors cross browser | Support for all browsers including mobile browser |
|6.| Can __not__ test for element pseudo states | Support for pseudo states such as :hover or :active |

This runner uses Vite to compile your test code and load it in the browser. It comes with presets for the following component frameworks:

- React
- Preact
- Vue.js
- Svelte
- SolidJS

Every test file / test file group runs within a single page which means that between each test the page is being reloaded to guarantee isolation between tests.

$3

To use the Browser Runner you can install it via:

``sh
npm install --save-dev @wdio/browser-runner
`

$3

To use the Browser runner, you have to define a runner property within your wdio.conf.js file, e.g.:

`js
// wdio.conf.js
export const {
// ...
runner: 'browser',
// ...
}
`

$3

The Browser runner allows following configurations:

#### preset

If you test components using one of the mentioned frameworks above, you can define a preset that ensures everything is configured out of the box. This option can't be used together with viteConfig.

__Type:__ vue | svelte | solid | react | preact | stencil

__Example:__

`js title="wdio.conf.js"
export const {
// ...
runner: ['browser', {
preset: 'svelte'
}],
// ...
}
`

#### viteConfig

Define your own Vite configuration. You can either pass in a custom object or import an existing vite.conf.ts file if you use Vite.js for development. Note that WebdriverIO merges custom configurations to set up framework and runner objects. This option can't be used together with preset.

__Type:__ UserConfig

__Example:__

`js title="wdio.conf.ts"
import viteConfig from '../vite.config.ts'

export const {
// ...
runner: ['browser', { viteConfig }],
// ...
}
`

#### headless

If set to true the runner will update capabilities to run tests headless. By default this is enabled within CI environments where a CI environment variable is set to '1' or 'true'.

__Type:__ boolean

__Default:__ false, set to true if CI environment variable is set

#### rootDir

Project root directory.

__Type:__ string

__Default:__ process.cwd()

#### coverage

WebdriverIO supports test coverage reporting through istanbul. See Coverage Options for more details.

__Type:__ object

__Default:__ undefined

$3

The following options allow to configure coverage reporting.

#### enabled

Enables coverage collection.

__Type:__ boolean

__Default:__ false

#### include

List of files included in coverage as glob patterns.

__Type:__ string[]

__Default:__ [**]

#### exclude

List of files excluded in coverage as glob patterns.

__Type:__ string[]

__Default:__

`
[
'coverage/**',
'dist/**',
'packages//test{,s}/*',
'*/.d.ts',
'cypress/**',
'test{,s}/**',
'test{,-*}.{js,cjs,mjs,ts,tsx,jsx}',
'*/{.,-}test.{js,cjs,mjs,ts,tsx,jsx}',
'*/{.,-}spec.{js,cjs,mjs,ts,tsx,jsx}',
'/__tests__/',
'*/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build}.config.',
'**/.{eslint,mocha,prettier}rc.{js,cjs,yml}',
]
`

#### extension

List of file extensions the report should include.

__Type:__ string | string[]

__Default:__ ['.js', '.cjs', '.mjs', '.ts', '.mts', '.cts', '.tsx', '.jsx', '.vue', '.svelte']

#### reportsDirectory

Directory to write coverage report to.

__Type:__ string

__Default:__ ./coverage

#### reporter

Coverage reporters to use. See istanbul documentation for detailed list of all reporters.

__Type:__ string[]

__Default:__ ['text', 'html', 'clover', 'json-summary']

#### perFile

Check thresholds per file. See lines, functions, branches and statements for the actual thresholds.

__Type:__ boolean

__Default:__ false

#### clean

Clean coverage results before running tests.

__Type:__ boolean

__Default:__ true

#### lines

Threshold for lines.

__Type:__ number

__Default:__ undefined

#### functions

Threshold for functions.

__Type:__ number

__Default:__ undefined

#### branches

Threshold for branches.

__Type:__ number

__Default:__ undefined

#### statements

Threshold for statements.

__Type:__ number

__Default:__ undefined`

$3

Make sure to check out the docs around component testing and have a look into the example repository for examples using these and various other frameworks.

---

For more information on WebdriverIO runner, check out the documentation.