Test configuration per environment in Cypress - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ Predict Output

intermediate

Output of environment-specific baseUrl in Cypress

Given the following Cypress configuration files for two environments, what will be the baseUrl used when running tests with the command cypress run --env configFile=staging?

Cypress

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

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      const envConfig = require(`./cypress.env.${config.env.configFile}.json`)
      return {...config, ...envConfig}
    },
    baseUrl: 'http://localhost:3000'
  }
})

/* cypress.env.staging.json */
{
  "baseUrl": "https://staging.example.com"
}

/* cypress.env.production.json */
{
  "baseUrl": "https://www.example.com"
}

A https://staging.example.com

B http://localhost:3000

C https://www.example.com

D undefined

💡 Hint

Check how the configFile environment variable affects the loaded JSON file.

When running with --env configFile=staging, the setupNodeEvents function loads cypress.env.staging.json which overrides baseUrl to https://staging.example.com.

❓ assertion

intermediate

Correct assertion for environment-specific API endpoint

You want to assert that the API endpoint URL used in your Cypress test matches the environment-specific value. Which assertion correctly verifies that the API URL is set to the production endpoint when running with --env configFile=production?

Cypress

const apiUrl = Cypress.env('apiUrl')

// Production endpoint is https://api.example.com

A assert.equal(apiUrl, 'http://localhost:3000')

B expect(apiUrl).to.equal('https://api.example.com')

C expect(apiUrl).to.be.undefined

D assert.isTrue(apiUrl === 'https://staging.example.com')

💡 Hint

Use the correct assertion style and check the expected URL for production.

Option B uses the correct Cypress assertion syntax and matches the expected production API URL.

🔧 Debug

advanced

Debug failing environment variable in Cypress test

A test fails because the environment variable apiKey is undefined when running tests with --env configFile=qa. The cypress.env.qa.json file contains { "apiKey": "12345" }. What is the most likely cause?

Cypress

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

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      const envConfig = require(`./cypress.env.${config.env.configFile}.json`)
      return {...config, ...envConfig}
    }
  }
})

A The apiKey variable is not accessed via Cypress.env('apiKey')

B The cypress.env.qa.json file is missing the apiKey property

C The test command did not include --env configFile=qa

D The setupNodeEvents function does not merge envConfig correctly

💡 Hint

Check the test run command and environment variable usage.

If the test command does not specify --env configFile=qa, the qa environment config file won't load, so apiKey remains undefined.

🧠 Conceptual

advanced

Best practice for managing sensitive environment variables in Cypress

Which approach is the safest and most recommended way to manage sensitive environment variables like API keys across different environments in Cypress?

A Use OS environment variables and load them in cypress.config.js without committing keys to version control

B Store sensitive keys directly in cypress.env.{env}.json files committed to version control

C Hardcode sensitive keys in test files for easy access

D Include sensitive keys in the baseUrl property in cypress.config.js

💡 Hint

Think about security and version control best practices.

Using OS environment variables and loading them in config files avoids committing sensitive data to version control, improving security.

❓ framework

expert

Configuring Cypress to run tests with multiple environment configurations sequentially

You want to run your Cypress tests sequentially for 'development', 'staging', and 'production' environments, each with its own config file (cypress.env.development.json, etc.). Which approach correctly sets this up in a Node.js script?

Cypress

const { exec } = require('child_process')

// Fill in the missing code to run tests sequentially for each environment

A ['development', 'staging', 'production'].map(env => exec(`cypress run --env configFile=${env}`))

B

async function run() {
  for (const env of ['development', 'staging', 'production']) {
    await exec(`cypress run --env configFile=${env}`)
  }
}
run()

C ['development', 'staging', 'production'].forEach(env => exec(`cypress run --env configFile=${env}`))

D

const runEnv = env => new Promise((res, rej) => {
  exec(`cypress run --env configFile=${env}`, (err) => err ? rej(err) : res())
})

async function run() {
  for (const env of ['development', 'staging', 'production']) {
    await runEnv(env)
  }
}
run()

💡 Hint

Consider how to wait for each exec command to finish before starting the next.

Option D wraps exec in a Promise and uses async/await to run tests sequentially, ensuring one finishes before the next starts.

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