cy.go() for browser history in Cypress - Framework Patterns

Framework Mode - cy.go() for browser history

Folder Structure

  cypress/
  ├── e2e/                  # Test files
  │   ├── navigation.cy.js  # Tests using cy.go() for browser history
  │   └── ...
  ├── fixtures/             # Test data files
  │   └── example.json
  ├── support/              # Custom commands and reusable utilities
  │   ├── commands.js       # Custom Cypress commands
  │   └── e2e.js            # Global support file
  └── cypress.config.js     # Cypress configuration file
  

Test Framework Layers

• Test Layer (cypress/e2e): Contains test scripts that use cy.go() to navigate browser history (back, forward, or by steps).
• Support Layer (cypress/support): Holds reusable commands and utilities to simplify test code, e.g., custom commands for navigation.
• Fixtures Layer (cypress/fixtures): Stores static test data like JSON files for consistent test inputs.
• Configuration Layer (cypress.config.js): Defines environment settings, base URLs, browser preferences, and test retries.

Configuration Patterns

Use cypress.config.js to manage environments and browser settings:

  import { defineConfig } from 'cypress'

  export default defineConfig({
    e2e: {
      baseUrl: 'https://example.com',
      env: {
        username: 'testuser',
        password: 'password123'
      },
      retries: 1
    }
  })
  

Access environment variables in tests with Cypress.env('username'). This keeps credentials and URLs flexible and secure.

Test Reporting and CI/CD Integration

• Use built-in Cypress Dashboard or plugins like mochawesome for detailed HTML reports.
• Integrate Cypress tests in CI/CD pipelines (GitHub Actions, Jenkins) to run tests on every code push.
• Configure test retries and screenshots/videos on failure for easier debugging.

Best Practices

• Use cy.go('back') and cy.go('forward') to simulate user browser navigation clearly.
• Prefer explicit navigation commands like cy.visit() when possible; use cy.go() for history-specific tests.
• Keep test steps simple and readable; avoid chaining too many cy.go() calls without assertions.
• Use custom commands in cypress/support/commands.js to reuse navigation logic.
• Always assert the page state after navigation to confirm correct history behavior.

Self Check

Where in this folder structure would you add a new test file that verifies the browser back and forward navigation using cy.go()?

Key Result

Organize Cypress tests in cypress/e2e, use support for reusable commands, configure environments in cypress.config.js, and leverage cy.go() for browser history navigation.

Practice

1. What does the Cypress command cy.go('back') do during a test?

easy

A. It reloads the current page.

B. It navigates the browser to the previous page in history.

C. It navigates the browser to the next page in history.

D. It opens a new browser tab.

Solution

1. Step 1: Understand cy.go() usage

   The cy.go() command controls browser history navigation, similar to back and forward buttons.

2. Step 2: Interpret the argument 'back'

   Using 'back' tells Cypress to go to the previous page in the browser history.

3. Final Answer:

   It navigates the browser to the previous page in history. -> Option B

4. Quick Check:

   cy.go('back') = previous page [OK]

Hint: Remember 'back' means previous page in history [OK]

Common Mistakes:

• Confusing 'back' with 'forward'
• Thinking it reloads the page
• Assuming it opens a new tab

2. Which of the following is the correct syntax to move forward one page in browser history using cy.go()?

easy

A. cy.go('forward')

B. cy.go(-1)

C. cy.go('back')

D. cy.go(0)

Solution

1. Step 1: Recall cy.go() arguments

   cy.go() accepts 'back', 'forward' or numbers like -1, 1 to move in history.

2. Step 2: Identify correct forward syntax

   To move forward one page, use 'forward' or 1. Among options, only cy.go('forward') is correct syntax.

3. Final Answer:

   cy.go('forward') -> Option A

4. Quick Check:

   Forward navigation = 'forward' [OK]

Hint: Use 'forward' string or 1 to go forward [OK]

Common Mistakes:

• Using negative number to go forward
• Using 'back' instead of 'forward'
• Using 0 which does nothing

3. Given this Cypress test code:

cy.visit('/page1')
cy.visit('/page2')
cy.go(-1)
cy.url().should('include', '/page1')

What will the assertion check after cy.go(-1) executes?

medium

A. The URL includes '/page1'

B. The URL includes '/page2'

C. The URL includes '/page3'

D. The URL remains unchanged

Solution

1. Step 1: Trace navigation commands

   First, the test visits '/page1', then '/page2', so browser history has '/page1' then '/page2'.

2. Step 2: Understand cy.go(-1)

   cy.go(-1) moves back one page in history, so it goes back from '/page2' to '/page1'.

3. Step 3: Check the assertion

   The assertion checks that the URL includes '/page1', which is true after going back.

4. Final Answer:

   The URL includes '/page1' -> Option A

5. Quick Check:

   cy.go(-1) = back one page = '/page1' [OK]

Hint: Negative number in cy.go() means go back [OK]

Common Mistakes:

• Assuming URL stays at '/page2'
• Confusing -1 with forward navigation
• Expecting URL to be '/page3' which was never visited

4. You wrote this Cypress test:

cy.visit('/home')
cy.visit('/about')
cy.go(2)
cy.url().should('include', '/contact')

But the test fails. What is the likely reason?

medium

A. cy.go(2) is invalid syntax and causes an error.

B. cy.go(2) goes back two pages, so URL is wrong.

C. cy.go(2) reloads the current page instead of navigating.

D. cy.go(2) tries to go forward two pages but no forward history exists.

Solution

1. Step 1: Analyze browser history after visits

   After visiting '/home' then '/about', browser history has two pages: '/home' then '/about'. No forward pages exist.

2. Step 2: Understand cy.go(2) behavior

   cy.go(2) tries to go forward two pages, but since no forward history exists, navigation fails.

3. Step 3: Reason test failure

   The URL does not change to '/contact' because forward navigation is impossible, causing the assertion to fail.

4. Final Answer:

   cy.go(2) tries to go forward two pages but no forward history exists. -> Option D

5. Quick Check:

   Forward navigation beyond history length fails [OK]

Hint: Cannot go forward beyond available history [OK]

Common Mistakes:

• Thinking cy.go(2) reloads page
• Assuming cy.go(2) goes back
• Believing cy.go(2) is invalid syntax

5. You want to test navigation between three pages: '/start', '/middle', and '/end'. You write:

cy.visit('/start')
cy.visit('/middle')
cy.visit('/end')
cy.go(-2)
cy.url().should('include', '/start')

What does cy.go(-2) do here, and why is the assertion correct?

hard

A. cy.go(-2) moves back one page only, so URL includes '/middle'.

B. cy.go(-2) moves forward two pages, which is invalid here.

C. cy.go(-2) moves back two pages from '/end' to '/start', so URL includes '/start'.

D. cy.go(-2) reloads '/end' page twice, so URL stays '/end'.

Solution

1. Step 1: Understand the navigation history

   Visiting '/start', then '/middle', then '/end' creates a history stack: ['/start', '/middle', '/end'].

2. Step 2: Interpret cy.go(-2)

   cy.go(-2) moves back two pages in history, from '/end' back to '/start'.

3. Step 3: Confirm the assertion

   After moving back two pages, the URL should include '/start', so the assertion is correct.

4. Final Answer:

   cy.go(-2) moves back two pages from '/end' to '/start', so URL includes '/start'. -> Option C

5. Quick Check:

   Negative number moves back multiple pages [OK]

Hint: Negative numbers in cy.go() move back that many pages [OK]

Common Mistakes:

• Confusing negative with forward navigation
• Thinking cy.go(-2) reloads pages
• Assuming it moves back only one page