Skip to content

Latest commit

 

History

History

cypress

README.md

Cypress Examples

For Demonstration Purposes Only
The code in these scripts is provided on an "AS-IS" basis without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement. These scripts are provided for educational and demonstration purposes only, and should not be used in production. Issues regarding these scripts should be submitted through GitHub. These scripts are maintained by the Technical Services team at Sauce Labs.

Introduction

This repository will hold multiple examples on how to run Cypress tests locally and with the Sauce Labs Testrunner Toolkit.

It is based on the following user journey:

  1. A QA/DEV already has Cypress tests which he/she can run on his local machine
  2. A QA/DEV wants to run his existing tests on Sauce Labs VMs

Prerequisites

  • Please check our documentation for installing SauceCTL
  • Make sure you've set up your credentials on your local machine and or CI-pipeline, see this-doc
  • Check the Cypress-docs for all options

Install dependencies

You can install all dependencies by running the following command

npm install

This will install all needed dependencies that are listed in the package.json-file

NOTE: Make sure you are in the folder testrunner-toolkit/cypress when you execute this command

Install saucectl

You can install only saucectl by running the following command

npm install -g saucectl

Cypress info

More information about Cypress and writing Cypress tests can be found here

Sauce Labs Testrunner Toolkit info

More information about the Sauce Labs Testrunner Toolkit can be found here

Examples:

All below mentioned examples can be found in the .sauce-folder. You can run the configurations by running the following command from the root of this folder

  saucectl run --config ./.sauce/config-ex{#}.yml

  # OR for use with the EU data center
  npm run test.sauce.ex{#}.eu

  # OR for use with the US data center
  npm run test.sauce.ex{#}.us

The # stands for the number of the below mentioned examples.

Example 1 - Minimal configuration for all tests

config-ex1.yml provides a minimum configuration needed to run the Cypress tests. In this example, all tests are executed on a single chrome browser in sequential order.

Example 2 - Automatically sharding the tests

config-ex2.yml run all tests on chrome. saucectl automatically splits the tests by using "shard" property with the value "spec" so that they can easily run in parallel.

Example 3 - Cross Browser tests

config-ex3.yml run the login and the checkout tests on 3 different types of browsers where saucectl automatically splits the tests by using "shard" property with the value "spec" so that they can easily run in parallel.

Example 4 - Cross Versions tests

config-ex4.yml run all tests on different Chrome versions where saucectl automatically splits the tests by using "shard" property with the value "concurrency" so that they can easily run in parallel. Note: The configured concurrency is 5 and the number of specs are 8. Using "shard: concurrency" will split the 8 specs into 5 jobs.

Example 5 - Using Sauce Connect

config-ex5.yml Similar to config-ex2 but the web site is local. You can download and run local saucedemo.com web site from [here](https://github.com/saucelabs/sample-app-web. You need to add the tunnel name to the tunnel parameter in the config file

Example about using extra dependencies

This folder contains a simple set up for Cypress with a test that uses a dependency. This can be executed locally or on Sauce Labs.