Visual regression testing concept in Cypress - Build an Automation Script

Visual Regression Test for Homepage

Preconditions (2)

Step 1: Open the homepage URL in the browser.

Step 2: Take a screenshot of the homepage.

Step 3: Compare the screenshot with the baseline image stored previously.

✅ Expected Result: The current homepage screenshot matches the baseline image with no visual differences.

Automation Requirements - Cypress with cypress-image-snapshot plugin

Assertions Needed:

Assert that the current screenshot matches the baseline snapshot with zero or acceptable pixel differences.

Best Practices:

Use explicit commands to capture screenshots.

Store baseline images in a dedicated folder.

Use descriptive test names for easy identification.

Run tests in a consistent environment to avoid false positives.

Automated Solution

Cypress

import { addMatchImageSnapshotCommand } from 'cypress-image-snapshot/command';

addMatchImageSnapshotCommand();

describe('Visual Regression Test for Homepage', () => {
  beforeEach(() => {
    cy.visit('https://example.com');
  });

  it('should match the homepage visual snapshot', () => {
    cy.document().toMatchImageSnapshot({
      failureThreshold: 0.01, // 1% threshold for minor acceptable differences
      failureThresholdType: 'percent'
    });
  });
});

This test uses the cypress-image-snapshot plugin to perform visual regression testing.

First, we import and add the snapshot command to Cypress.

In the test, we visit the homepage URL before each test to ensure a fresh state.

The toMatchImageSnapshot command takes a screenshot of the current page and compares it to a baseline image stored in the snapshots folder.

The failureThreshold is set to 1% to allow minor differences like anti-aliasing or rendering variations.

If the images differ more than the threshold, the test fails, indicating a visual regression.

Common Mistakes - 3 Pitfalls

Not setting up the baseline images before running tests

Running tests in different screen sizes or environments

Using too strict failure thresholds (like 0%)

Bonus Challenge

Now add data-driven visual regression tests for three different pages: homepage, about page, and contact page.

Show Hint

Practice

1. What is the main purpose of visual regression testing in Cypress?

easy

A. To check if the webpage links are working

B. To test the speed of webpage loading

C. To verify the correctness of backend data processing

D. To check if the webpage appearance changes unexpectedly after updates

Solution

1. Step 1: Understand visual regression testing goal

   Visual regression testing compares screenshots to detect visual changes.

2. Step 2: Identify the main purpose in Cypress context

   Cypress uses visual regression to ensure UI looks the same after code changes.

3. Final Answer:

   To check if the webpage appearance changes unexpectedly after updates -> Option D

4. Quick Check:

   Visual regression = check appearance changes [OK]

Hint: Visual regression tests page look, not speed or links [OK]

Common Mistakes:

• Confusing visual regression with performance testing
• Thinking it tests backend logic
• Assuming it checks link functionality

2. Which Cypress command is used to take a snapshot for visual regression testing?

easy

A. cy.get()

B. cy.visit()

C. cy.matchImageSnapshot()

D. cy.click()

Solution

1. Step 1: Identify commands related to visual regression

   cy.matchImageSnapshot() is designed to compare screenshots for visual testing.

2. Step 2: Differentiate from other Cypress commands

   cy.visit() loads pages, cy.get() selects elements, cy.click() simulates clicks.

3. Final Answer:

   cy.matchImageSnapshot() -> Option C

4. Quick Check:

   Snapshot command = cy.matchImageSnapshot() [OK]

Hint: Snapshot command has 'matchImage' in its name [OK]

Common Mistakes:

• Choosing cy.visit() which loads pages
• Confusing cy.get() with snapshot command
• Selecting cy.click() which triggers clicks

3. What will happen if the following Cypress test runs and the page appearance has changed since the last snapshot?

cy.visit('https://example.com')
cy.matchImageSnapshot('homepage')

medium

A. The test fails because the new screenshot differs from the saved snapshot

B. The test reloads the page automatically

C. The test passes because it always ignores visual differences

D. The test skips the snapshot comparison

Solution

1. Step 1: Understand snapshot comparison behavior

   cy.matchImageSnapshot compares current screenshot to saved snapshot and fails if different.

2. Step 2: Apply this to changed page appearance

   If the page looks different, the test detects difference and fails.

3. Final Answer:

   The test fails because the new screenshot differs from the saved snapshot -> Option A

4. Quick Check:

   Visual difference causes test failure [OK]

Hint: Changed appearance means snapshot test fails [OK]

Common Mistakes:

• Thinking test always passes regardless of changes
• Assuming test reloads page automatically
• Believing snapshot comparison is skipped

4. Identify the error in this Cypress visual regression test code:

cy.matchImageSnapshot('homepage')
cy.visit('https://example.com')

medium

A. cy.visit() should be called before cy.matchImageSnapshot()

B. cy.matchImageSnapshot() cannot take a string argument

C. cy.visit() is not a valid Cypress command

D. The test is missing cy.get() before snapshot

Solution

1. Step 1: Check command order for visual testing

   Page must be loaded with cy.visit() before taking a snapshot.

2. Step 2: Verify argument and command validity

   cy.matchImageSnapshot() accepts a string name; cy.visit() is valid; cy.get() not required here.

3. Final Answer:

   cy.visit() should be called before cy.matchImageSnapshot() -> Option A

4. Quick Check:

   Visit page first, then snapshot [OK]

Hint: Always visit page before snapshot command [OK]

Common Mistakes:

• Calling snapshot before loading page
• Thinking cy.matchImageSnapshot() disallows string names
• Assuming cy.visit() is invalid
• Believing cy.get() is mandatory before snapshot

5. You want to add visual regression testing for a login page that changes its welcome message based on the user. How should you handle this dynamic content in Cypress visual regression tests?

hard

A. Use a custom snapshot name for each user to save separate images

B. Ignore the dynamic area by masking or hiding it before snapshot

C. Remove cy.visit() to avoid loading the page

D. Run cy.matchImageSnapshot() twice to average results

Solution

1. Step 1: Understand problem with dynamic content

   Dynamic text changes cause snapshot differences and false failures.

2. Step 2: Choose best practice to handle dynamic parts

   Masking or hiding dynamic areas before snapshot avoids false positives.

3. Step 3: Evaluate other options

   Custom names create many snapshots; removing cy.visit() breaks test; averaging snapshots is invalid.

4. Final Answer:

   Ignore the dynamic area by masking or hiding it before snapshot -> Option B

5. Quick Check:

   Mask dynamic content to stabilize snapshots [OK]

Hint: Mask or hide changing parts before snapshot [OK]

Common Mistakes:

• Saving separate snapshots for each user causes clutter
• Skipping page load breaks test
• Trying to average snapshots is not supported