Setting Up Testing in Next.js with Cypress, Jest, Playwright & Vitest – Testing Is Love Made Visible

Testing in Next.js keeps your app safe, fast, and reliable. This article walks through setting up four popular testing tools: Cypress for E2E and component tests, Jest for unit and snapshot tests, Playwright for cross-browser E2E, and Vitest for lightning-fast unit testing. It also includes a recommended testing strategy and CI/CD scripts.

CypressJestPlaywrightVitest

~2 دقیقه مطالعه · آخرین به‌روزرسانی ۲۲ آذر ۱۴۰۴

Testing Tools in Next.js


ToolBest For
CypressEnd-to-End + Component Testing
JestUnit + Snapshot Testing
PlaywrightCross-Browser E2E
VitestFast, Vite-powered Unit Testing

1. Cypress – E2E + Component Testing


npm install -D cypress
npx cypress open

In package.json:

"scripts": {
  "cypress:open": "cypress open"
}

Sample E2E test:

cy.visit('/')
cy.get('a[href*="about"]').click()
cy.url().should('include', '/about')

Sample component test:

cy.mount(<Page />)
cy.get('h1').should('contain', 'Home')

2. Jest – Unit + Snapshot Testing


npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/jest-dom
npm init jest@latest

In jest.config.ts:

testEnvironment: 'jsdom',
setupFilesAfterEnv: ['<rootDir>/jest.setup.ts']

Sample test:

render(<Page />)
expect(screen.getByRole('heading')).toBeInTheDocument()

Snapshot test:

expect(container).toMatchSnapshot()

3. Playwright – Cross-Browser E2E


npm init playwright@latest

Sample test:

await page.goto('/')
await page.click('text=About')
expect(page).toHaveURL('/about')

4. Vitest – Fast Unit Testing


npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react

In vitest.config.mts:

test: {
  environment: 'jsdom',
  globals: true,
}

Sample test:

render(<Page />)
expect(screen.getByRole('heading', { name: 'Home' })).toBeDefined()

Recommended Testing Strategy


  • Unit: Vitest or Jest
  • Component: Cypress Component
  • E2E: Playwright or Cypress
  • CI/CD: Run all in headless mode

CI/CD Scripts in package.json


"scripts": {
  "test": "vitest",
  "test:watch": "vitest --watch",
  "test:jest": "jest",
  "e2e": "start-server-and-test start http://localhost:3000 cypress",
  "e2e:headless": "start-server-and-test start http://localhost:3000 \"cypress run\"",
  "playwright": "playwright test",
  "playwright:headless": "playwright test --headless"
}

نوشته و پژوهش‌شده توسط دکتر شاهین صیامی

مقالات مرتبط

Advanced Client-Side Routing and Performance Hooks in Next.js

Next.js provides a rich set of client-side hooks and caching utilities that empower developers to build dynamic, responsive, and secure applications. From reading route parameters to tracking navigation state and reporting performance metrics, this guide walks you through the most important tools available in the App Router.

ادامه

Handling Authorization and Caching in Next.js: A Developer’s Guide

Next.js introduces powerful experimental features for access control and smart caching. This guide covers the unauthorized() function for custom 401 handling, unstable_cache for persistent memoization, updateTag for instant cache invalidation, and useLinkStatus for inline navigation feedback. Learn how to use these tools to build secure, performant, and responsive applications.

ادامه

redirect and refresh in Next.js — Smart Redirects and Client Refreshing via Server Actions

The redirect function in Next.js allows you to navigate users to a new route, returning either a 307 or 303 HTTP response depending on context. It works in Server Components, Client Components, Route Handlers, and Server Actions. The refresh function is used exclusively within Server Actions to refresh the client router. This article explains how both functions work, with practical examples and key considerations.

ادامه

NextRequest and NextResponse in Next.js — Managing Cookies, Headers, Redirects, and Rewrites

Next.js extends the native Web Request and Response APIs with NextRequest and NextResponse, offering powerful tools for managing cookies, headers, redirects, rewrites, and JSON responses. These utilities simplify server-side logic and improve control over routing, personalization, and security. This guide walks through their capabilities with practical examples and best practices.

ادامه

headers, ImageResponse, notFound, and permanentRedirect in Next.js — Request Handling, Dynamic Images, Errors, and Redirects

Next.js offers powerful tools for handling HTTP requests and responses in Server Components. The headers function lets you read incoming request headers. ImageResponse allows you to generate dynamic images using JSX and CSS. The notFound function renders a custom 404 page, and permanentRedirect enables permanent redirection to another route. This article explains how to use each feature with practical examples.

ادامه

A Complete Guide to Using metadata and generateMetadata in Next.js

In modern versions of Next.js, managing page metadata is more powerful and intuitive than ever. Metadata is automatically injected into the <head> of your pages and plays a vital role in SEO, social sharing, and user experience. This guide explains the two main ways to define metadata: using the static metadata object and the dynamic generateMetadata function.

ادامه