Skip to content

Latest commit

 

History

History
512 lines (336 loc) · 11 KB

run-settings.md

File metadata and controls

512 lines (336 loc) · 11 KB
id title hide_title sidebar_label description keywords url site_name slug
run-settings
Configuring Cypress Test Execution
true
Configure Cypress Test Execution
Explore LambdaTest's comprehensive guide on configuring run settings for seamless cross-browser testing. Optimize your testing workflow today.
Cypress Automation
Cypress Testing Guide
Cypress Test Automation
Cypress Automation Testing
Running Cypress Tests
Cypress Testing Online
Run Cypress
Cypress Run Specific Test
Cypress Testing Environment
How to Run Cypress Tests
LambdaTest
run-settings/

import CodeBlock from '@theme/CodeBlock'; import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Configuring Cypress Test Execution

You can specify Cypress CLI flags to run on LambdaTest in two ways:

  1. Adding the CLI flag details in lambdatest-config.json file
  2. Using the CLI

:::info Important If a glob pattern path is passed in the specs flag using CLI, you must enclose it within double quotes.

lambdatest-cypress-cli run --env=stage --verbose --specs "./cypress/integration/examples/*" :::

Specifying Cypress Config File

Using lambdatest-config.json: You can use the cypress_config_file key in run_settings option to specify the Cypress configuration file.

:::info Note Cypress 10 and above versions automatically identify the cypress.config.js file in the project. Therefore, you don't need to specify the cypress_config.js capability. :::

Example:

// lambdatest-config.json

{
  "run_settings": {
    "cypress_config_file": "cypress.json",
  }
}
// In case of Cypress 10 and above, you can specify your custom config files by using the --cy flag.

lambdatest-cypress run --cy="--config-file <file path>"

Using CLI: You can specify the Cypress configuration file using the below CLI flag with run command.

Flag Purpose Type
--ccf, --cypress-config-file Path of the config file String

Specifying Spec Files

Using lambdatest-config.json: You can use the specs key in run_settings option to specify the Spec files.

Example:

// lambdatest-config.json

{
  "run_settings": {
     "specs": "**/*.cy.js",
  }
}
// lambdatest-config.json

{
  "run_settings": {
    "specs": "./cypress/integration/examples/*.spec.js",
  }
}

Using CLI: You can specify the Spec files using the below CLI flag with run command.

Flag Purpose Type
-s, --specs Path of the spec file or directory or pattern String

Specifying Exclude Specs Files

You can use the exclude_specs key in run_settings option to specify the spec files that you want to exclude from the test execution.

Example:

// lambdatest-config.json

{
  "run_settings": {
     "exclude_specs": "./examples/assertion.spec.js, ./examples/connectors.spec.js",
  }
}
// lambdatest-config.json

{
  "run_settings": {
         "exclude_specs": "./examples/assertion.spec.js, ./examples/connectors.spec.js",
  }
}

Specifying Geolocation

Using lambdatest-config.json: You can use the geo_location key in run_settings option to specify the Spec files.

Example:

// lambdatest-config.json

{
  "run_settings": {
    "geo_location": "<country_code>",
  }
}
// lambdatest-config.json

{
  "run_settings": {
    "geo_location": "<country_code>",
  }
}

Using CLI: You can specify the geolocation files using the below CLI flag with run command.

Flag Purpose Type
--geo, --geo_location Pass the Geo country code String

Specifying Resolution

Using lambdatest-config.json: Use the resolution key in run_settings option to specify the resolution.

Example:

// lambdatest-config.json

{
  "run_settings": {
     "resolution": "1024x768",
  }
}
// lambdatest-config.json

{
  "run_settings": {
     "resolution": "1024x768",
  }
}

Using CLI: You can specify the system's resolution using the below CLI flag with run command.

Flag Purpose Type
--res Pass the resolution String

It will change the resolution of the system but the viewport in which Cypress launches the website is controlled by Cypress.

Supported resolutions: 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1080, 2048x1536, 2560x1440

Excluding Files From Test Uploads

Using lambdatest-config.json: You can use the ignore_files key in run_settings option to ignore or exclude any particular files while uploading your tests.

Example:

// lambdatest-config.json

{
  "run_settings": {
    "ignore_files": "<glob_pattern>",
  }
}
// lambdatest-config.json

{
  "run_settings": {
    "ignore_files": "<glob_pattern>",
  }
}

Using CLI: Specify the files that you want to exclude using the below CLI flag with run command.

Flag Purpose Type
--if, --ignore_files Files to ignore in the zip project String

Specifying Max Duration for Test Session Timeout

When running tests, if you encounter a situation where a particular test is running for an extended period and causing other parallel tests to be blocked, in this case, you can use the max duration flag to mitigate the issue. This flag allows you to specify a maximum time limit for the test to run before it is automatically stopped, thus freeing up resources for other tests to execute.

The valid input for max_duration must be an integer, and it can only be within the range of 2 to 240 minutes.

You can specify max_duration:

Using lambdatest-config.json: You can use the max_duration key in run_settings option to specify the session timeout.

Example:

// lambdatest-config.json

{
  "run_settings": {
     "max_duration":2
  }
}
// lambdatest-config.json

{
  "run_settings": {
    "max_duration":2
  }
}

Using CLI: You can specify the timeout using the below CLI flag with run command.

Flag Purpose Type
--max_duration idle timeout of a test session Integer

Organizing Tests

You can name your test cases and categorize your Cypress builds by build number, build name, test and build tags for easier analysis. Use the following keys to organize your tests.

Key Description Type
build-name Represent the name of the build for your test String
project-name Represents the name of your project String
tags Group your tests String

Example:

// lambdatest-config.json

{
  "run_settings": {
    "build-name": "Cypress 10 Demo",
    "project-name": "DemoTest",
    "tags": "Sprint1",
  }
}

Headless Browser

You can run Headless tests with Cypress by the headless key to true.

Key Description Type
headless Run test in Headless mode Boolean

Example:

// lambdatest-config.json

{
  "run_settings": {
    "headless": "true",
  }
}

Capture Network Logs

You can generate Network logs with Cypress by setting the network key to true.

Key Description Type
headless Record network packets while the test is running Boolean

Example:

// lambdatest-config.json

{
  "run_settings": {
    "network": "true",
  }
}

Specifying NPM Package Dependencies

Need of npm_dependencies: In order to run your tests on LambdaTest, we refer to your package.json and use those dependencies and devDependencies. Since, package.json may contain several dependencies which may not be required to run your Cypress tests. We recommend to use "npm_dependencies" parameter to list down the required dependencies to run your test, because it will reduce your build time on LambdaTest.

Below are the ways through which LambdaTest detects the dependencies which has to be installed before running the test on LambdaTest.

  1. npm_dependencies: Inside run_settings of lambdatest-config.json, you can provide the list of NPM dependencies.

Example:

"npm_dependencies": {
	"cypress": "9.0.0"
		}
  1. package.json: LambdaTest will automatically detects the dependencies that has to be installed from package.json.

Example:

"devDependencies": {
    "cypress": "9.2.1",
    "eslint": "7.0.0",
    "eslint-plugin-json-format": "2.0.1",
    "eslint-plugin-mocha": "5.3.0",
  },

:::info Note It's recommended to use npm_dependencies instead of package.json because package.json may contain the dependencies which are not actually used while running the Cypress tests and also, installing these unwanted dependencies will increase the build time. :::