Specify Browsers and OS

Learn about setting the OS and browser combinations to run your Cypress tests.

Introduction

Using BrowserStack, you can run your tests on multiple OS-browser combinations simultaneously. Set the combinations using either of the following options:

• Setting the browser and OS keys in the browserstack.json.
• Using the CLI command and relevant arguments.

Setting the browser and OS keys in browserstack.json

Add the browsers object in the browserstack.json file to set a list of OS, browsers, and browser versions that you want to use.

The sample structure of the browsers object is as follows:

{
  ...
  "browsers": [{
      "os": "<Name of the OS>",
      "browser": "<Name of the browser>",
      "versions": ["latest", "latest-1", "latest-2"],
    }
  ]
  ...
}

The following table explains the different keys under the browsers object.

Consider the following snippet that shows a sample configuration if you want to run the following OS-browser combination. It is recommended that the latest, latest-1, latest-2, etc. values are used for always using the latest browser versions.

• Chrome on Windows 10
• Edge on Windows 10
• WebKit on OS X Big Sur
• Firefox on any OS (run your test on any OS combination to ensure stability and performance)

{
  ...
  "browsers": [{
      "os": "Windows 10",
      "browser": "chrome",
      "versions": ["latest", "latest-1", "latest-2"],
    },
    {
      "os": "Windows 10",
      "browser": "edge",
      "versions": ["latest", "latest-1", "latest-2"],
    },
    {
      "os": "OS X Big Sur",
      "browser": "webkit",
      "versions": ["latest", "latest-1", "latest-2"],
    },
    {
      "browser": "firefox",
      "versions": ["latest", "latest-1", "latest-2"],
    }
  ]
  ...
}

Using WebKit (Experimental)

Cypress has experimental support for WebKit, Safari’s browser engine. To run Cypress tests on WebKit, ensure that the experimentalWebKitSupport capability is set to true in your Cypress config file.

1. Set the following configuration in your cypress.config.js file:

   cypress.config.js

    const { defineConfig } = require('cypress')
    module.exports = defineConfig({
      experimentalWebKitSupport: true
      // the rest of the config settings
      },
    )
   

2. Set the following configuration in your browserstack.json file:

   browserstack.json

    {
      ...
      "browsers": [
        {
          "os": "OS X Big Sur",
          "browser": "webkit",
          "versions": ["latest"],
        }
      ]
      ...
    }
   

Using the CLI

For CLI versions v1.11.0 or higher, you can also pass the browser and OS combinations through the CLI command. The sample command for the following OS-browser combinations is as follows:

browserstack-cypress run --browser "<browser_name>@<browser_version>:<OS_version>","<browser_name>@<browser_version>:<OS_version>"

Consider the following snippet that shows a sample CLI command if you want to run the following OS-browser combination. It is recommended that the latest, latest-1, latest-2, etc. values are used for always using the latest browser versions.

• Chrome on Windows 10
• Firefox on OS X Catalina

browserstack-cypress run --browser "chrome@latest:Windows 10","webkit@latest:Big Sur","firefox@latest-1:OS X Catalina"