Jest or Vitest setup for Express - Mini Project: Build & Apply

Jest Setup for Testing an Express Server

📖 Scenario: You are building a simple Express server and want to test its routes using Jest. Testing helps you catch errors early and ensures your server works as expected.

🎯 Goal: Set up Jest testing for an Express server by creating the server, configuring Jest, writing a test for a route, and completing the test setup.

📋 What You'll Learn

Create a basic Express server with one GET route

Add a Jest configuration variable

Write a Jest test to check the GET route response

Complete the test file with necessary imports and exports

💡 Why This Matters

🌍 Real World

Testing Express servers is essential in real projects to ensure routes work correctly and to prevent bugs before deployment.

💼 Career

Many backend developer roles require writing tests for APIs using Jest or Vitest to maintain code quality and reliability.

1

Create a basic Express server

Create a file app.js and write code to import express, create an app, and add a GET route at '/' that sends 'Hello World'. Export the app using module.exports = app.

Express

// Your code here

Hint

Use express() to create the app and app.get to add a route.

2

Add Jest test configuration

Create a file jest.config.js and add a configuration object that sets testEnvironment to 'node'.

Express

// Your code here

Hint

Jest needs testEnvironment: 'node' to test Express servers.

3

Write a Jest test for the GET route

Create a test file app.test.js. Import request from 'supertest' and import the app from './app'. Write a test using test that sends a GET request to '/' and expects the response text to be 'Hello World'.

Express

// Your code here

Hint

Use supertest to send a GET request and check the response text.

4

Complete the test setup

Add module.exports = app at the end of app.js if missing, and ensure the test file imports app correctly. Confirm the test file includes the test function with the async callback and expect assertion.

Express

// Your code here

Hint

Make sure the app is exported and the test imports it correctly to run the test.

Practice

1. What is the main reason to separate the Express app export from the server start when setting up Jest or Vitest tests?

easy

A. It allows tests to import the app without starting the server.

B. It improves the app's performance in production.

C. It enables automatic server restarts during development.

D. It prevents the app from logging errors during tests.

Solution

1. Step 1: Understand app export and server start roles

   The Express app handles routes and middleware, while server start listens on a port.

2. Step 2: Why separate for testing?

   Separating lets tests import the app to simulate requests without starting a real server, avoiding conflicts and port issues.

3. Final Answer:

   It allows tests to import the app without starting the server. -> Option A

4. Quick Check:

   Separate app export = test-friendly import [OK]

Hint: Separate app and server start to test without running server [OK]

Common Mistakes:

• Thinking separation improves production speed
• Confusing server restart with test setup
• Assuming separation stops error logs

2. Which of the following is the correct way to import and use Supertest with Jest for testing an Express app exported as app?

easy

A. import request from 'supertest'; const req = request(app);

B. const request = require('supertest')(app);

C. const req = supertest(app);

D. import { supertest } from 'supertest'; const req = supertest(app);

Solution

1. Step 1: Check import syntax for Supertest in ES modules

   Supertest is imported as default export, so use import request from 'supertest';.

2. Step 2: Create request instance with app

   Call request(app) to create a test client for the Express app.

3. Final Answer:

   import request from 'supertest'; const req = request(app); -> Option A

4. Quick Check:

   Supertest import + request(app) = correct [OK]

Hint: Use default import then call request(app) for Supertest [OK]

Common Mistakes:

• Using require with ES module import style
• Calling supertest without import
• Incorrect named import from 'supertest'

3. Given this Jest test code for an Express app, what will be the test result?

import request from 'supertest';
import app from './app';

test('GET /hello returns 200 and message', async () => {
  const response = await request(app).get('/hello');
  expect(response.status).toBe(200);
  expect(response.body.message).toBe('Hello World');
});

Assuming the Express app has a route /hello that sends { message: 'Hello World' }, what happens?

medium

A. Test throws an error because app is not imported correctly.

B. Test fails because response.body is undefined.

C. Test fails with 404 status because route is missing.

D. Test passes because status is 200 and message matches.

Solution

1. Step 1: Confirm route and response

   The app has /hello route returning JSON with { message: 'Hello World' } and status 200.

2. Step 2: Analyze test expectations

   The test checks status 200 and message string, which matches the route response.

3. Final Answer:

   Test passes because status is 200 and message matches. -> Option D

4. Quick Check:

   Matching route and response = test pass [OK]

Hint: Match route response and test expectations for pass [OK]

Common Mistakes:

• Assuming response.body is undefined without JSON middleware
• Expecting 404 if route exists
• Thinking import errors happen without evidence

4. You wrote this Vitest test for your Express app:

import request from 'supertest';
import app from './app';

test('POST /data returns 201', async () => {
  const res = await request(app).post('/data').send({ name: 'Test' });
  expect(res.status).toBe(201);
});

But the test fails with TypeError: request(app).post is not a function. What is the likely cause?

medium

A. The Express app does not have a POST /data route.

B. You imported Supertest incorrectly or did not install it.

C. You forgot to export the app from your Express file.

D. Vitest does not support async tests.

Solution

1. Step 1: Understand the error meaning

   post is not a function means request(app) is not returning a Supertest object.

2. Step 2: Check import and installation

   This usually happens if Supertest is not imported correctly or missing from dependencies.

3. Final Answer:

   You imported Supertest incorrectly or did not install it. -> Option B

4. Quick Check:

   post() missing = import or install issue [OK]

Hint: Check Supertest import and install if post() missing [OK]

Common Mistakes:

• Blaming missing route for method error
• Assuming app export causes this error
• Thinking Vitest can't handle async

5. You want to write a Vitest test that runs multiple requests to your Express app without starting the server each time. Which setup is best practice to achieve this?

hard

A. Run the server manually before tests and use fetch to call endpoints.

B. Start the server in a beforeAll hook and close it in afterAll for each test file.

C. Export the Express app from app.js and import it in tests; use Supertest to call routes directly.

D. Use a global variable to store the server instance and restart it before each test.

Solution

1. Step 1: Understand server start impact on tests

   Starting the server for each test slows tests and can cause port conflicts.

2. Step 2: Use app export with Supertest

   Exporting the app lets Supertest simulate requests without real server, making tests faster and isolated.

3. Final Answer:

   Export the Express app from app.js and import it in tests; use Supertest to call routes directly. -> Option C

4. Quick Check:

   App export + Supertest = efficient test setup [OK]

Hint: Export app and test with Supertest, avoid real server start [OK]

Common Mistakes:

• Starting server for every test causing slow tests
• Using fetch instead of Supertest in tests
• Restarting server unnecessarily before each test