Why Environment variables for configuration in Cypress? - Purpose & Use Cases

The Big Idea

What if you never had to edit your test code just to switch servers again?

The Scenario

Imagine you have to test the same website on different servers: development, staging, and production. Every time you switch, you open your test code and change URLs and credentials manually.

The Problem

This manual change is slow and easy to forget. You might run tests against the wrong server by mistake, causing confusion and wasted time. It's also hard to share tests with teammates because everyone needs to update settings themselves.

The Solution

Environment variables let you store configuration like URLs and secrets outside your test code. You just tell Cypress which environment to use, and it picks the right settings automatically. This keeps tests clean, safe, and easy to run anywhere.

Before vs After

✗ Before

const baseUrl = 'https://dev.example.com'; // change manually for each environment

✓ After

const baseUrl = Cypress.env('BASE_URL'); // set once per environment

What It Enables

Environment variables make your tests flexible and error-proof, so you can run the same tests anywhere without changing code.

Real Life Example

A QA team runs tests every night on the staging server by setting environment variables in their CI tool, avoiding manual edits and catching bugs early.

Key Takeaways

Manual config changes are slow and risky.

Environment variables keep settings outside code.

This makes tests safer, cleaner, and easier to share.

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