Full-page screenshots in Cypress - Framework Patterns

Framework Mode - Full-page screenshots

Folder Structure

cypress/
├── e2e/                  # Test specs
│   └── fullPageScreenshot.cy.js
├── fixtures/             # Test data files
│   └── example.json
├── support/              # Custom commands and reusable code
│   ├── commands.js       # Custom commands like full-page screenshot
│   └── e2e.js            # Global support file
cypress.config.js         # Cypress configuration
package.json             # Project dependencies and scripts

Test Framework Layers

• Test Specs (cypress/e2e): Contains test files that run scenarios, e.g., capturing full-page screenshots.
• Support Layer (cypress/support): Holds reusable commands and setup code. For full-page screenshots, custom commands can be added here.
• Fixtures (cypress/fixtures): Stores test data files, like JSON, to keep tests clean and data-driven.
• Configuration (cypress.config.js): Defines environment settings, browser options, and screenshot behavior.
• Utilities: Can be added inside support or a separate folder for helper functions if needed.

Configuration Patterns

• Environment Variables: Use cypress.env.json or env section in cypress.config.js to store URLs, credentials, or flags.
• Browser Settings: Configure browser launch options in cypress.config.js to support different browsers.
• Screenshot Settings: Customize full-page screenshot behavior with capture: 'fullPage' option in test commands.
• Test Tags or Suites: Use describe blocks or custom tags to organize tests that require full-page screenshots.

Test Reporting and CI/CD Integration

• Screenshot Artifacts: Full-page screenshots are saved automatically on test failure or manually via commands, useful for debugging.
• Reporters: Integrate with reporters like mochawesome to embed screenshots in HTML reports.
• CI/CD Pipelines: Configure pipelines (GitHub Actions, Jenkins, etc.) to run Cypress tests and collect screenshots as build artifacts.
• Dashboard Service: Use Cypress Dashboard for advanced test insights and screenshot storage.

Framework Design Principles

1. Use Custom Commands: Create a reusable command for full-page screenshots to keep tests clean and consistent.
2. Explicit Waits: Ensure the page is fully loaded before capturing screenshots to avoid partial captures.
3. Organize Screenshots: Store screenshots in a clear folder structure with meaningful names for easy retrieval.
4. Use Environment Configs: Control when to take full-page screenshots (e.g., only on failures or specific environments) via config.
5. Keep Tests Independent: Each test should handle its own screenshot logic without relying on others.

Self Check

Where would you add a new custom command to capture a full-page screenshot in this Cypress framework structure?

Key Result

Organize Cypress tests with clear folder structure, use custom commands for full-page screenshots, and integrate reporting for effective debugging.

Practice

1. What does cy.screenshot({ capture: 'fullPage' }) do in Cypress testing?

easy

A. Clears all previous screenshots

B. Takes a screenshot of the entire webpage, including parts not visible on screen

C. Records a video of the test run

D. Takes a screenshot only of the visible part of the webpage

Solution

1. Step 1: Understand the capture option in cy.screenshot()

   The capture option controls what part of the page is captured. Setting it to 'fullPage' means the entire page, not just the visible viewport.

2. Step 2: Compare with other options

   By default, cy.screenshot() captures only the visible part. 'fullPage' extends this to the whole page including scrollable areas.

3. Final Answer:

   Takes a screenshot of the entire webpage, including parts not visible on screen -> Option B

4. Quick Check:

   Full-page screenshot = entire webpage [OK]

Hint: Remember 'fullPage' means capture everything, not just visible [OK]

Common Mistakes:

• Thinking it captures only visible viewport
• Confusing screenshot with video recording
• Assuming it clears previous screenshots

2. Which of the following is the correct syntax to take a full-page screenshot in Cypress?

easy

A. cy.fullPageScreenshot()

B. cy.screenshot('fullPage')

C. cy.screenshot({ capture: 'fullPage' })

D. cy.screenshot.capture('fullPage')

Solution

1. Step 1: Recall the correct method signature

   The cy.screenshot() command accepts an options object where capture: 'fullPage' is the correct way to specify full-page capture.

2. Step 2: Eliminate incorrect syntax

   Passing 'fullPage' as a string argument directly, using non-existent commands like cy.fullPageScreenshot(), or trying to chain .capture('fullPage') are not valid Cypress syntax for full-page screenshots.

3. Final Answer:

   cy.screenshot({ capture: 'fullPage' }) -> Option C

4. Quick Check:

   Correct syntax uses options object with capture key [OK]

Hint: Use curly braces and capture key for full-page screenshots [OK]

Common Mistakes:

• Passing 'fullPage' as a string argument directly
• Using non-existent commands like cy.fullPageScreenshot()
• Trying to chain .capture() method

3. Consider this Cypress test code snippet:

cy.visit('https://example.com')
cy.screenshot({ capture: 'fullPage' })

What will happen if the page is still loading when the screenshot is taken?

medium

A. The screenshot will capture the fully loaded page anyway

B. The test will fail with an error

C. Cypress will wait automatically until the page loads before screenshot

D. The screenshot may capture an incomplete or partially loaded page

Solution

1. Step 1: Understand Cypress behavior on page load

   Cypress does not automatically wait for all page content to load unless explicitly told. If cy.screenshot() runs immediately after cy.visit(), the page might still be loading.

2. Step 2: Effect on screenshot

   If the page is not fully loaded, the screenshot will capture whatever is visible at that moment, possibly incomplete content.

3. Final Answer:

   The screenshot may capture an incomplete or partially loaded page -> Option D

4. Quick Check:

   Screenshot timing affects completeness [OK]

Hint: Always wait for page load before screenshot to avoid partial capture [OK]

Common Mistakes:

• Assuming Cypress waits automatically for full load
• Expecting error if page not loaded
• Thinking screenshot always captures full content

4. You wrote this Cypress test:

cy.visit('https://example.com')
cy.screenshot({ capture: 'fullpage' })

Why does the full-page screenshot not work as expected?

medium

A. The option value 'fullpage' is case-sensitive and should be 'fullPage'

B. You must call cy.fullPageScreenshot() instead

C. The cy.screenshot() command does not support options

D. You need to add wait() before screenshot

Solution

1. Step 1: Check the option value spelling and case

   The correct option value is 'fullPage' with capital P. 'fullpage' is invalid and ignored.

2. Step 2: Understand Cypress option sensitivity

   Cypress options are case-sensitive. Using wrong case causes fallback to default behavior (visible viewport only).

3. Final Answer:

   The option value 'fullpage' is case-sensitive and should be 'fullPage' -> Option A

4. Quick Check:

   Option values are case-sensitive in Cypress [OK]

Hint: Check option spelling and case carefully [OK]

Common Mistakes:

• Ignoring case sensitivity in option values
• Using non-existent commands
• Assuming wait fixes option errors

5. You want to capture a full-page screenshot only after a dynamic content section finishes loading. Which Cypress code snippet correctly waits for the content and then takes a full-page screenshot?

hard

A. cy.get('#dynamic-section').should('be.visible')
.then(() => cy.screenshot({ capture: 'fullPage' }))

B. cy.screenshot({ capture: 'fullPage' })
cy.get('#dynamic-section').should('be.visible')

C. cy.wait(5000)
cy.screenshot({ capture: 'fullPage' })

D. cy.get('#dynamic-section').click()
cy.screenshot({ capture: 'fullPage' })

Solution

1. Step 1: Wait for dynamic content visibility

   Using cy.get('#dynamic-section').should('be.visible') waits until the dynamic section is visible, ensuring content is loaded.

2. Step 2: Take full-page screenshot after wait

   Chaining .then(() => cy.screenshot({ capture: 'fullPage' })) ensures the screenshot runs only after the wait condition passes.

3. Final Answer:

   cy.get('#dynamic-section').should('be.visible') .then(() => cy.screenshot({ capture: 'fullPage' })) -> Option A

4. Quick Check:

   Wait for content visible, then screenshot [OK]

Hint: Wait for element visible before screenshot using should('be.visible') [OK]

Common Mistakes:

• Taking screenshot before waiting for content
• Using fixed wait times instead of element checks
• Clicking element unnecessarily before screenshot