Next.js Route Testing

README.md

Testing Routes in Next.js with Jest and node-mocks-http

This Gist provides a code example for testing routes in a Next.js application using the Jest testing framework and the node-mocks-http library. Testing your routes is crucial to ensure they work as expected and handle various scenarios gracefully.

Prerequisites

Before you start testing routes, make sure you have the following dependencies installed:

• Jest: A JavaScript testing framework.
• node-mocks-http: A library for mocking HTTP objects.

You can install these dependencies using npm:

npm install --save-dev jest node-mocks-http

hello.js

// Import the route file and the library
import hello from './api/hello'
import { createMocks } from 'node-mocks-http'

// Write a test using Jest
test('should return a greeting message', async () => {
  // Create mock request and response objects
  const { req, res } = createMocks({
    method: 'GET',
  })

  // Call the route function with the mock objects
  await hello(req, res)

  // Assert the expected behavior
  expect(res._getStatusCode()).toBe(200)
  expect(res._getData()).toEqual({ message: 'Hello Next.js' })
})