Environment variables for configuration in Cypress - Build an Automation Script

Verify login functionality using environment variables for credentials

Preconditions (2)

Step 1: Open the login page URL

Step 2: Enter the email from environment variable 'CYPRESS_USER_EMAIL' into the email input field with id 'email'

Step 3: Enter the password from environment variable 'CYPRESS_USER_PASSWORD' into the password input field with id 'password'

Step 4: Click the login button with id 'loginBtn'

Step 5: Wait for the dashboard page to load

Step 6: Verify the URL contains '/dashboard'

Step 7: Verify the page contains a welcome message with id 'welcomeMessage'

✅ Expected Result: User is successfully logged in and redirected to the dashboard page with a visible welcome message

Automation Requirements - Cypress

Assertions Needed:

URL contains '/dashboard'

Element with id 'welcomeMessage' is visible

Best Practices:

Use Cypress environment variables accessed via Cypress.env()

Use explicit Cypress commands with proper selectors

Avoid hardcoding credentials in test code

Use beforeEach hook to visit the login page

Use clear and maintainable selectors (id preferred)

Automated Solution

Cypress

describe('Login Test Using Environment Variables', () => {
  beforeEach(() => {
    cy.visit('https://example.com/login');
  });

  it('should login successfully using env variables', () => {
    const email = Cypress.env('USER_EMAIL');
    const password = Cypress.env('USER_PASSWORD');

    cy.get('#email').type(email);
    cy.get('#password').type(password, { log: false });
    cy.get('#loginBtn').click();

    cy.url().should('include', '/dashboard');
    cy.get('#welcomeMessage').should('be.visible');
  });
});

This test suite uses Cypress to automate login using environment variables for credentials.

The beforeEach hook opens the login page before each test.

Inside the test, Cypress.env() fetches the email and password securely without hardcoding them.

Selectors use id attributes for clarity and reliability.

The password input uses { log: false } to avoid showing sensitive data in logs.

Assertions check that the URL contains '/dashboard' and the welcome message is visible, confirming successful login.

Common Mistakes - 4 Pitfalls

Hardcoding credentials directly in the test code

Using non-unique or fragile selectors like XPath or complex CSS selectors

Not waiting for page navigation before asserting URL or elements

Logging sensitive information like passwords in test output

Bonus Challenge

Now add data-driven testing with 3 different sets of environment variables for login credentials

Show Hint

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