Run your first Cypress test

Learn how to use the Kitchen Sink example app to run your first test on BrowserStack.

Overview

In this tutorial, we will use Cypress’ kitchen sink example app to run our tests. The Kitchen Sink app is an example app provided by Cypress to learn how Cypress works.

In this guide you will learn about:

• Prerequisites
• Running your first tests
• Viewing test results

Prerequisites

• Ensure that you understand Cypress fundamentals and how Cypress runs tests.
• 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.
• NodeJS version 12 or higher is installed.

Run your first test

To run your first Cypress test with BrowserStack, 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:

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

Step 2: Clone the Kitchen Sink app using the following command:

# Clone the Kitchen Sink repo for Cypress v10 and higher
git clone https://github.com/cypress-io/cypress-example-kitchensink.git && cd cypress-example-kitchensink

# Clone the Kitchen Sink repo for Cypress v9 and lower
git clone https://github.com/cypress-io/cypress-example-kitchensink.git && cd cypress-example-kitchensink && git checkout ab10094ef7b199ae7febafec413a0626414bcd3c

After you clone the repository, the Cypress project will be in the following structure:

app
...
cypress
|-- fixtures
|-- e2e
|-- support
cypress.config.js
...

app
...
cypress
|-- fixtures
|-- integration
|-- plugins
|-- support
cypress.json
...

Step 3: Use the npm command to install dependent node modules required to run the Kitchen Sink example app:

npm install

Step 4: Create and configure the browserstack.json file which contains configurations, such as BrowserStack credentials, capabilities, etc., that are required for running the tests. Use the following init command to initialize the app project folder and create a boilerplate browserstack.json file:

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:

// 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",
    // For Cypress v9 or lower using the following configuration
    // "cypress_config_file": "./cypress.json",
    "cypress_version": "12.3",
    "npm_dependencies": {
      "npm-package-you-need-to-run-tests-1": "^1.2.1",
      "npm-package-you-need-to-run-tests-2": "^7.1.6-beta.13"
    },
    "project_name": "Cypress Kitchen Sink Example",
    "build_name": "Build no: 1",
    "parallels": 5,
    "exclude": ["some-folder/test.js", "static/*.pdf"]
  }
}

Step 5: Set up the application server. The Kitchen sink sample app can be tested on BrowserStack using either the localhost website or using Cypress Kitchen Sink sample app public URL.

  //browserstack.json
  ...
  "connection_settings": {
          "local": false,
      }
  ...

//browserstack.json
...
"connection_settings": {
        "local": true,
        "local_identifier": "My_Sample_Tutorial"
    }
...

npm start

Step 9: Run the test using the following command:

browserstack-cypress run

View your test results

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

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.

Debug builds and analyze trends with Test Observability

Level up your Cypress testing on BrowserStack with Test Observability - with advanced test reporting, debugging, smart failure analysis, and rich insights for your test suites.

Test Observabilty works automatically for all users running Cypress v10 and above. You can explicitly turn off Test Observability by turning the testObservability flag to false. You can explore additional configurations and learn how to use Test Observability for Cypress here.

Please note that Test Observability currently cannot be used alongside existing test reporters like mochawesome, and will automatically disable any other reporters you have set up.

Next Steps

• Learn how to integrate your tests
• Learn how to run tests in parallel