WebdriverIO extension for Visual Studio Code.

Available on the Visual Studio Marketplace.

Features

• Run WebdriverIO tests in Visual Studio Code.
• All of the frameworks supported by WebdriverIO can be used with this extension.

Requirements

• Visual Studio Code version >= 1.96.0
• WebdriverIO version >= v9.0.0
• Node.js version >= 18.0.0 (follows WebdriverIO)

Usage

You can manage tests both from the Testing view.

The WebdriverIO uses vscode's `TestController' APIs to provide a unified testing experience.
You can read the official guides about how to run the tests in the VSCode Documentation.

First step

It is necessary to install WebdriverIO to your project. (See also project docs)

Please ensure that there is at least one configuration file of WebdriverIO that is named according to the pattern *wdio*.conf*.{ts, js, mjs, cjs, cts, mts}. This extension is enabled when a matching file exists in the workspace (workspace root folder and sub-folder are supported).

Testing view

The toolbar at the top provides various commands to manage test execution:

• Refresh Tests: To reload your test suite, reflecting any new changes.
• Run Tests: To start testing all cases that are currently visible.
• Debug Tests: To begin a debugging session for the tests.
• Show Output: To display detailed logs from test executions.
• Miscellaneous Settings: To customize the Testing view, such as sorting and grouping tests.

Icons next to each test indicate their status

• passed (checkmark)
• failed (cross)
• skipped (arrow)
• running or loading (spinner)
• not executed (dot)

Test File

When you open a test file, you could notice test icons in the gutter next to each test case.

You can do the following actions:

• Run a Single Test: Click the test icon next to a test case to run that specific test.
• More Options: Right-click the test icon to open a context menu with additional options:
  • Run Test: Execute the selected test case.
  • Debug Test: Execute the selected test case with a debugging session.
  • Reveal in Test Explorer: Locate and highlight the test in the centralized Testing view.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• webdriverio.configFilePattern: Glob pattern for WebdriverIO configuration file
• webdriverio.nodeExecutable: The path to the Node.js executable. If not assigned, WebdriverIO try to resolve the node path from environment valuables of PATH.
• webdriverio.workerIdleTimeout: If no processing is performed in the Worker for the set amount of time(defined by seconds), the Worker is terminated. If processing is requested again, it will be started automatically.
• webdriverio.envFiles: A list of .env files, from which environment variables are loaded when WebdriverIO is run from the file set in this parameter.
  If a variable is defined in more than one .env file, the first value set will take precedence unless the webdriverio.overrideEnv is set.
• webdriverio.overrideEnv: Override any environment variables that have already been set on your machine with values from your .env file(s).
  See also webdriverio.envFiles
• webdriverio.showOutput: Show WebdriverIO output in the test result when set true this option
• webdriverio.logLevel: Set the logLevel

Remarks

This extension is pre-release status. So, the interface (e.g. configuration parameters) is subject to change.