Environment variables for configuration in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What are environment variables in Cypress used for?

Environment variables in Cypress store configuration values that can change between test runs, like URLs, credentials, or API keys. They help keep tests flexible and secure.

beginner

How do you set environment variables in Cypress using the command line?

You can set environment variables by running Cypress with the command: cypress run --env key=value. Multiple variables can be set separated by commas.

intermediate

Where can you define environment variables in Cypress configuration files?

Environment variables can be defined inside cypress.config.js under the env property as key-value pairs, making them available to all tests.

beginner

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

Use Cypress.env('key') to get the value of an environment variable named key inside your test code.

intermediate

Why is it better to use environment variables for sensitive data in tests?

Using environment variables keeps sensitive data like passwords out of the test code and version control, improving security and making it easier to change values without editing tests.

How can you pass multiple environment variables when running Cypress from the command line?

A cypress run --env key1=value1&key2=value2

B cypress run --env key1=value1 key2=value2

C cypress run --env key1=value1;key2=value2

D cypress run --env key1=value1,key2=value2

Multiple environment variables are passed as a comma-separated list with no spaces using --env.

Where in Cypress can you define environment variables to be used globally in tests?

A Only in the test files themselves

B In the <code>package.json</code> file

C Inside <code>cypress.config.js</code> under the <code>env</code> property

D In the browser console

The cypress.config.js file's env property is the standard place for global environment variables.

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

A process.env.apiUrl

B Cypress.env('apiUrl')

C getEnv('apiUrl')

D env.apiUrl

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

Why should sensitive data be stored in environment variables rather than hard-coded in tests?

A To keep secrets out of code and version control

B To make tests run faster

C To avoid syntax errors

D To reduce test file size

Storing sensitive data in environment variables improves security by not exposing secrets in code.

Which of the following is a valid way to set an environment variable in cypress.config.js?

A env: { baseUrl: 'https://example.com' }

B environment: { baseUrl: 'https://example.com' }

C config.env.baseUrl = 'https://example.com'

D setEnv('baseUrl', 'https://example.com')

The correct syntax is to use the env property with key-value pairs.

Explain how to set and use environment variables in Cypress tests.

Think about configuration files, command line options, and test code access.

Why is using environment variables important for managing sensitive data in test automation?

Consider security and maintainability benefits.

Practice

1. What is the main purpose of environment variables in Cypress testing?

easy

A. To configure tests without changing the test code

B. To write test assertions

C. To locate elements on the page

D. To generate test reports

Solution

1. Step 1: Understand environment variables role

   Environment variables store configuration data separately from code.

2. Step 2: Identify their use in Cypress

   They allow changing test settings without modifying test scripts.

3. Final Answer:

   To configure tests without changing the test code -> Option A

4. Quick Check:

   Environment variables = configure tests without code change [OK]

Hint: Environment variables store config, not test logic [OK]

Common Mistakes:

• Confusing environment variables with test assertions
• Thinking environment variables locate page elements
• Assuming environment variables generate reports

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

easy

A. Cypress.env('API_URL')

B. process.env.API_URL

C. env.API_URL

D. getEnv('API_URL')

Solution

1. Step 1: Recall Cypress environment variable syntax

   Cypress uses Cypress.env('VAR_NAME') to access env variables.

2. Step 2: Match the correct syntax

   Only Cypress.env('API_URL') uses this correct method.

3. Final Answer:

   Cypress.env('API_URL') -> Option A

4. Quick Check:

   Access env vars with Cypress.env('VAR_NAME') [OK]

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

Common Mistakes:

• Using Node.js process.env inside Cypress tests
• Trying to access env vars as plain variables
• Using incorrect function names like getEnv

3. Given the following cypress.config.js snippet:

export default defineConfig({
  env: {
    USERNAME: 'testUser',
    PASSWORD: 'pass123'
  }
})

What will cy.log(Cypress.env('USERNAME')) print during test execution?

medium

A. undefined

B. 'USERNAME'

C. 'testUser'

D. An error

Solution

1. Step 1: Check environment variable definition

   USERNAME is set to 'testUser' in cypress.config.js under env.

2. Step 2: Understand Cypress.env usage

   Cypress.env('USERNAME') returns the value 'testUser'.

3. Final Answer:

   'testUser' -> Option C

4. Quick Check:

   Cypress.env('USERNAME') = 'testUser' [OK]

Hint: Env vars return their set values, not keys [OK]

Common Mistakes:

• Expecting the key name instead of the value
• Assuming undefined if not set in test file
• Thinking Cypress.env throws error if variable exists

4. You wrote this code in your test:

const apiUrl = Cypress.env.API_URL;
cy.visit(apiUrl);

But the test fails with TypeError: Cannot read property 'API_URL' of undefined. What is the problem?

medium

A. cy.visit() cannot accept variables

B. The environment variable API_URL is not set in cypress.config.js

C. You must import Cypress before using it

D. You should use Cypress.env('API_URL') instead of Cypress.env.API_URL

Solution

1. Step 1: Identify how Cypress.env is accessed

   Cypress.env is a function, not an object, so use parentheses and quotes.

2. Step 2: Understand the error cause

   Using dot notation like Cypress.env.API_URL causes undefined error.

3. Final Answer:

   You should use Cypress.env('API_URL') instead of Cypress.env.API_URL -> Option D

4. Quick Check:

   Access env vars with Cypress.env('VAR_NAME') [OK]

Hint: Always call Cypress.env() as a function with string key [OK]

Common Mistakes:

• Using dot notation instead of function call
• Assuming env vars are properties, not accessed by function
• Ignoring error message details

5. You want to run Cypress tests with a different API URL without changing cypress.config.js. Which command line option correctly sets the environment variable API_URL to https://api.test.com?

hard

A. cypress run --config API_URL=https://api.test.com

B. cypress run --env API_URL=https://api.test.com

C. cypress open --env API_URL=https://api.test.com

D. cypress open --config API_URL=https://api.test.com

Solution

1. Step 1: Understand command line env variable setting

   Use --env VAR_NAME=value to set env variables temporarily.

2. Step 2: Identify correct command for running tests

   cypress run runs tests in headless mode; --env sets env vars.

3. Final Answer:

   cypress run --env API_URL=https://api.test.com -> Option B

4. Quick Check:

   Use --env to set env vars on command line [OK]

Hint: Use --env VAR=value with cypress run to override env vars [OK]

Common Mistakes:

• Using --config instead of --env for environment variables
• Trying to set env vars with cypress open command
• Confusing config options with env variables