Test configuration per environment in Cypress

Introduction

Test configuration per environment helps you run tests with settings that match different places like development, testing, or production. This makes sure your tests work correctly everywhere.

You want to test your app on a development server with test data.

You need to run tests on a staging environment before release.

You want to avoid using real user data in tests on production.

You want to change URLs or credentials depending on the environment.

You want to run the same tests but with different settings automatically.

Syntax

Cypress

cypress.config.js

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    baseUrl: 'https://default-url.com',
    env: {
      username: 'defaultUser',
      password: 'defaultPass'
    }
  }
})

The baseUrl sets the main URL for tests.

The env object holds environment-specific variables like usernames or passwords.

Examples

Configuration for development environment with custom URL and credentials.

Cypress

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    baseUrl: 'https://dev.example.com',
    env: {
      username: 'devUser',
      password: 'devPass'
    }
  }
})

Configuration for production environment with secure credentials.

Cypress

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    baseUrl: 'https://prod.example.com',
    env: {
      username: 'prodUser',
      password: 'prodPass'
    }
  }
})

Override configuration and environment variables from command line for a test run.

Cypress

npx cypress run --config baseUrl=https://test.example.com --env username=testUser,password=testPass

Sample Program

This test uses the username and password from the Cypress environment variables set in the config file. You can change these values per environment to test different setups.

Cypress

// cypress.config.js
const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    baseUrl: 'https://default.example.com',
    env: {
      username: 'defaultUser',
      password: 'defaultPass'
    }
  }
})

// cypress/e2e/login.cy.js

describe('Login Test', () => {
  it('logs in using environment config', () => {
    cy.visit('/')
    cy.get('#username').type(Cypress.env('username'))
    cy.get('#password').type(Cypress.env('password'))
    cy.get('button[type=submit]').click()
    cy.url().should('include', '/dashboard')
  })
})

Important Notes

You can pass environment variables via command line to override config values.

Use Cypress.env('variableName') to access environment variables in tests.

Keep sensitive data like passwords out of config files by using environment variables or CI secrets.

Summary

Test configuration per environment helps run tests with different settings easily.

Use baseUrl and env in cypress.config.js to set environment-specific values.

Access environment variables in tests with Cypress.env().

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