Test configuration per environment in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of test configuration per environment in Cypress?

It allows tests to run with different settings like URLs or credentials depending on the environment (e.g., development, staging, production). This helps tests stay accurate and relevant.

beginner

How do you specify environment variables in Cypress for different environments?

You can define environment variables in the cypress.config.js file under the 'env' key or pass them via command line using '--env'. This lets tests access values like URLs or API keys dynamically.

intermediate

Explain how to run Cypress tests with a specific environment configuration.

Use the command line option '--env' to set variables, for example: 'npx cypress run --env environment=staging'. Inside tests, access with 'Cypress.env("environment")' to adjust behavior.

intermediate

What is the benefit of using separate config files for each environment in Cypress?

Separate config files keep environment settings organized and prevent mistakes. For example, you can have cypress.config.dev.js and cypress.config.prod.js with different base URLs and credentials.

beginner

Show a simple example of accessing an environment variable in a Cypress test.

In your test, use: <pre>const baseUrl = Cypress.env('baseUrl');
cy.visit(baseUrl);</pre> This opens the URL set for the current environment.

How do you pass environment variables to Cypress tests from the command line?

A Using '--variables' option

B Using '--config' option

C Using '--set-env' option

D Using '--env' option

The '--env' option is used to pass environment variables to Cypress tests from the command line.

Where can you define environment variables for Cypress tests?

A In cypress.config.js or via command line

B Only in cypress.config.js

C Only in package.json

D Only inside test files

Environment variables can be defined in cypress.config.js under 'env' or passed via command line using '--env'.

What is the main advantage of using environment-specific config files in Cypress?

A Faster test execution

B More test cases

C Better organization and fewer mistakes

D Automatic bug fixing

Using separate config files for each environment helps keep settings organized and reduces errors.

How do you access an environment variable named 'apiUrl' inside a Cypress test?

A Cypress.env('apiUrl')

B getEnv('apiUrl')

C env.apiUrl

D process.env.apiUrl

Inside Cypress tests, environment variables are accessed using Cypress.env('variableName').

Which command runs Cypress tests with the environment variable 'environment' set to 'production'?

A npx cypress run --config environment=production

B npx cypress run --env environment=production

C npx cypress run --set-env environment=production

D npx cypress run --variables environment=production

The correct syntax to set environment variables when running Cypress tests is '--env environment=production'.

Describe how you would configure Cypress tests to run against different environments like development and production.

Think about how URLs or credentials change per environment.

Explain why managing test configuration per environment is important in automated testing.

Consider what happens if you use production URLs in development tests.

Practice

1. What is the main purpose of setting baseUrl in Cypress configuration for different environments?

easy

A. To change the test framework version automatically

B. To run tests against different websites without changing test code

C. To enable debugging mode in tests

D. To set the timeout for all tests

Solution

1. Step 1: Understand baseUrl role

   baseUrl defines the main website address for tests to run against.

2. Step 2: Relate baseUrl to environment

   Setting different baseUrl values per environment lets tests run on different sites without changing test code.

3. Final Answer:

   To run tests against different websites without changing test code -> Option B

4. Quick Check:

   baseUrl changes target site = A [OK]

Hint: baseUrl points tests to the right website per environment [OK]

Common Mistakes:

• Confusing baseUrl with test timeout
• Thinking baseUrl changes test framework version
• Assuming baseUrl enables debugging

2. Which of the following is the correct way to access an environment variable named apiKey inside a Cypress test?

easy

A. const key = Cypress.env('apiKey')

B. const key = Cypress.get('apiKey')

C. const key = Cypress.config('apiKey')

D. const key = Cypress.variable('apiKey')

Solution

1. Step 1: Recall method to get env variables

   Cypress provides Cypress.env() to access environment variables.

2. Step 2: Match method with variable name

   Using Cypress.env('apiKey') correctly retrieves the apiKey value.

3. Final Answer:

   const key = Cypress.env('apiKey') -> Option A

4. Quick Check:

   Cypress.env() gets env vars = C [OK]

Hint: Use Cypress.env('varName') to get environment variables [OK]

Common Mistakes:

• Using Cypress.config() instead of Cypress.env()
• Trying Cypress.get() which does not exist
• Using Cypress.variable() which is invalid

3. Given this cypress.config.js snippet:

export default defineConfig({
  env: {
    username: 'user1',
    password: 'pass1'
  }
})

What will console.log(Cypress.env('username')) print during a test?

medium

A. null

B. 'username'

C. 'user1'

D. undefined

Solution

1. Step 1: Check env object in config

   The config sets env.username to 'user1'.

2. Step 2: Understand Cypress.env() behavior

   Cypress.env('username') returns the value of the username key from env, which is 'user1'.

3. Final Answer:

   'user1' -> Option C

4. Quick Check:

   Env username value = 'user1' [OK]

Hint: Cypress.env('key') returns the value set in config env [OK]

Common Mistakes:

• Expecting the key name instead of its value
• Assuming undefined if not set in test code
• Confusing Cypress.env() with Cypress.config()

4. You wrote this in cypress.config.js:

env: {
  apiUrl: 'https://api.example.com'
}

But inside your test, Cypress.env('apiUrl') returns undefined. What is the most likely cause?

medium

A. The env object is not inside the exported config

B. You forgot to export the config object

C. You must use process.env instead

D. Cypress.env() only works for baseUrl

Solution

1. Step 1: Check config structure

   The env object must be inside the exported config object for Cypress to read it.

2. Step 2: Identify common mistake

   If env is outside or not properly nested, Cypress.env() returns undefined.

3. Final Answer:

   The env object is not inside the exported config -> Option A

4. Quick Check:

   env must be inside exported config = B [OK]

Hint: Always nest env inside exported config object [OK]

Common Mistakes:

• Not exporting the config at all
• Using process.env instead of Cypress.env
• Thinking Cypress.env only works for baseUrl

5. You want to run tests on two environments: staging and production. You set baseUrl and env.apiKey differently for each in cypress.config.js. How can you run tests on staging without changing the config file each time?

hard

A. Use cy.visit() with full URL every time

B. Manually edit cypress.config.js before each run

C. Set baseUrl and env inside each test file

D. Use command line flag like cypress run --env configFile=staging and load config accordingly

Solution

1. Step 1: Understand environment config switching

   You can pass environment variables or flags via command line to select config variants.

2. Step 2: Use command line flag to select config

   Using --env configFile=staging lets you load staging config without editing files.

3. Final Answer:

   Use command line flag like cypress run --env configFile=staging and load config accordingly -> Option D

4. Quick Check:

   Command line env flags switch configs = A [OK]

Hint: Use CLI flags to pick environment config dynamically [OK]

Common Mistakes:

• Editing config file manually each time
• Hardcoding URLs inside tests
• Ignoring CLI environment options