Skip to main content
Upgrade your BrowserStack Cypress-CLI to v1.19.1 and leverage the critical fixes & improvements. Learn more!

Integrate your tests

Learn how to integrate your existing Cypress tests with BrowserStack Automate.

This guide assumes that you are integrating an existing Cypress project. If you don’t have access to an existing Cypress project, you can try running your first test using the Cypress Kitchen Sink web app.

In this guide you will learn about:

Prerequisites

Before you integrate your test with BrowserStack, ensure that the following prerequisites are met:

  • BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.
  • Node.js installed on your machine.
  • Git installed on your machine.
  • NPM installed on your machine.
  • An existing Cypress project that you want to integrate with BrowserStack.

Run your test

To run your Cypress test, perform the following steps:

Step 1: Install the BrowserStack CLI. The BrowserStack - Cypress CLI is a command-line tool that is used to enable communication between Cypress and BrowserStack. Use the npm command to install the BrowserStack - Cypress CLI as follows:

Command Line
# Install the BrowserStack Cypress CLI
npm install -g browserstack-cypress-cli

Step 2: Generate and configure the browserstack.json file. The browserstack.json file contains configurations, such as BrowserStack credentials, capabilities, etc, required for running the tests.

Navigate to your project’s root directory and run the following command to generate the browserstack.json configuration file.

Command Line
# Create a sample configuration file for configurations and capabilities
browserstack-cypress init

After the browserstack.json file is created, modify or add the mandatory configurations that are required to run the Cypress test as shown in the following sample code. The mandatory configurations are BrowserStack credentials, Cypress configuration file, browser-device combinations, and the number of parallels:

Object key Value
auth username BrowserStack username from the Automate dashboard
auth access_key BrowserStack access key from the Automate dashboard
browsers browser List of browsers where Cypress tests must be run
  os OS name to use for running tests
  versions OS version to use for running tests
run_settings cypress_config_file Path to the cypress.json file for your project
  cypress_version Cypress version to be used for running tests
  project_name Project name for the Cypress project
  build_name Build name for Cypress build
  parallels Number of parallels you want to use to run the tests. The maximum limit depends on your BrowserStack plan.

The following sample browserstack.json file configuration can be used to create your own configuration:

browserstack.json
      {
      "auth": {
        "username": "YOUR_USERNAME",
        "access_key": "YOUR_ACCESS_KEY"
      },
      "browsers": [{
          "browser": "chrome",
          "os": "Windows 10",
          "versions": ["latest", "latest - 1"]
        },
        {
          "browser": "firefox",
          "os": "OS X Mojave",
          "versions": ["latest", "latest - 1"]
        },
        {
          "browser": "edge",
          "os": "OS X Catalina",
          "versions": ["latest"]
        }
      ],
      "run_settings": {
        "cypress_config_file": "./cypress.config.js",
        "cypress_version": "10",
        "project_name": "Cypress sample build",
        "build_name": "Build no. 1",
        "parallels": "5"
      }
    }
browserstack.json
      {
      "auth": {
        "username": "YOUR_USERNAME",
        "access_key": "YOUR_ACCESS_KEY"
      },
      "browsers": [{
          "browser": "chrome",
          "os": "Windows 10",
          "versions": ["latest", "latest - 1"]
        },
        {
          "browser": "firefox",
          "os": "OS X Mojave",
          "versions": ["latest", "latest - 1"]
        },
        {
          "browser": "edge",
          "os": "OS X Catalina",
          "versions": ["latest"]
        }
      ],
      "run_settings": {
        "cypress_config_file": "./cypress.json",
        "cypress_version": "9",
        "project_name": "Cypress sample build",
        "build_name": "Build no. 1",
        "parallels": "5"
      }
    }
Note: Apart from the mandatory configurations, you can also add other configurations, such as setting dependencies, organizing tests, etc. Check out the sections under the CONFIGURE TEST RUNS header in the left navigation pane of our documentation site to learn more.

Step 3: Run the test using the following command:

Command Line
browserstack-cypress run --sync

Access the test results

After you run your test, visit the Automate dashboard to view your test results as follows:

Automate Cypress Dashboard

All the tests run as part of each spec file are grouped by the browser combination. When you click any browser combination, you can see the detailed view that includes video logs, text logs, etc. If any tests run into an error, relevant screenshots are captured in the Screenshots tab.

On your command-line tool, you can see the completed tests along with their current status as the build execution progresses. After the tests are executed, you can access the results in the results folder that contains the HTML & JSON files with the build summary.

Next Steps

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Talk to an Expert