Jest or Vitest setup for Express - Step-by-Step Execution

Concept Flow - Jest or Vitest setup for Express

Create Express app

↓

Install Jest or Vitest

↓

Configure test script in package.json

↓

Write test file

↓

Run tests

↓

Check test results

↓

Fix code or tests if needed

↓

Repeat testing cycle

This flow shows how to set up Jest or Vitest to test an Express app step-by-step from app creation to running tests and fixing code.

Execution Sample

Express

import request from 'supertest';
import express from 'express';

const app = express();
app.get('/', (req, res) => res.send('Hello World!'));

test('GET / returns Hello World', async () => {
  const response = await request(app).get('/');
  expect(response.text).toBe('Hello World!');
});

This test checks that the Express app responds with 'Hello World!' on a GET request to '/'.

Execution Table

Step	Action	Evaluation	Result
1	Import express and supertest	Modules loaded	express and supertest ready
2	Create Express app instance	app created	app is an Express server
3	Define GET / route	Route handler set	app responds with 'Hello World!' on GET /
4	Run test function	Test starts	Test environment ready
5	Send GET / request using supertest	Request sent	Response received with text 'Hello World!'
6	Check response text equals 'Hello World!'	Assertion	Pass if equal, fail if not
7	Test ends	Test result recorded	Test passes if assertion true
8	Exit	No more tests	Testing complete

💡 All tests run and passed or failed, testing process ends

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 5	Final
app	undefined	Express app instance	Route handler added	Used in request	Express app with route
response	undefined	undefined	undefined	Response object with text 'Hello World!'	Response object

Key Moments - 3 Insights

Why do we import 'supertest' along with Express?

Supertest lets us simulate HTTP requests to the Express app without starting a real server, as shown in execution_table step 5.

Why do we use async/await in the test function?

Because sending requests and waiting for responses are asynchronous operations, so we wait for the response before asserting, as in step 5 and 6.

What happens if the response text does not match 'Hello World!'?

The assertion in step 6 fails, causing the test to fail, which is recorded in step 7.

Visual Quiz - 3 Questions

Look at the execution table, what is the value of 'response.text' after step 5?

A undefined

B 'Hello World!'

C An error message

D null

💡 Hint

Check the 'Result' column in step 5 where the response is received.

At which step does the test check if the response text matches 'Hello World!'?

A Step 4

B Step 5

C Step 6

D Step 7

💡 Hint

Look at the 'Action' column for the assertion step.

If the route handler was missing, which step would fail?

A Step 6

B Step 5

C Step 3

D Step 7

💡 Hint

Without a route handler, the response text would not match, causing assertion failure.

Concept Snapshot

Setup Jest or Vitest for Express:
1. Install Jest or Vitest and supertest.
2. Create Express app and define routes.
3. Write test files importing app and supertest.
4. Use async tests to send requests and assert responses.
5. Run tests with npm script.
6. Fix code/tests based on results.

Full Transcript

To set up Jest or Vitest for testing an Express app, first create your Express app and define routes. Then install Jest or Vitest along with supertest, which helps simulate HTTP requests. Configure your package.json to run tests. Write test files that import your Express app and use supertest to send requests. Use async functions to wait for responses and assert expected results. Run your tests and check results. If tests fail, fix your code or tests and repeat. This process helps ensure your Express app works as expected.

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