Test database setup and teardown in Express

Introduction

Setting up and tearing down a test database helps keep tests clean and reliable. It makes sure each test starts fresh without leftover data.

When you want to test API routes that read or write data.

When you need to isolate tests so they don't affect each other.

When you want to reset the database state before each test.

When you want to clean up resources after tests finish.

Syntax

Express

beforeAll(async () => {
  // Connect to test database
});
afterAll(async () => {
  // Disconnect and clean up
});
beforeEach(async () => {
  // Prepare fresh data
});
afterEach(async () => {
  // Clear data
});

beforeAll runs once before all tests start.

afterAll runs once after all tests finish.

Examples

Connects to a MongoDB test database before running tests.

Express

beforeAll(async () => {
  await db.connect('mongodb://localhost/testdb');
});

Disconnects from the database after all tests complete.

Express

afterAll(async () => {
  await db.disconnect();
});

Clears all data before each test to start fresh.

Express

beforeEach(async () => {
  await db.clearCollections();
});

Sample Program

This example uses an in-memory MongoDB to run tests without a real database. It connects before tests, clears data before each test, and disconnects after all tests. It shows adding and fetching users to confirm setup works.

Express

import express from 'express';
import request from 'supertest';
import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';

const app = express();
app.use(express.json());

const userSchema = new mongoose.Schema({ name: String });
const User = mongoose.model('User', userSchema);

app.post('/users', async (req, res) => {
  const user = new User({ name: req.body.name });
  await user.save();
  res.status(201).json(user);
});

app.get('/users', async (req, res) => {
  const users = await User.find();
  res.json(users);
});

let mongoServer;
beforeAll(async () => {
  mongoServer = await MongoMemoryServer.create();
  const uri = mongoServer.getUri();
  await mongoose.connect(uri);
});

afterAll(async () => {
  await mongoose.disconnect();
  await mongoServer.stop();
});

beforeEach(async () => {
  await User.deleteMany();
});

// Example test
(async () => {
  // Add a user
  await request(app).post('/users').send({ name: 'Alice' }).expect(201);

  // Get users
  const res = await request(app).get('/users').expect(200);
  console.log(res.body);

  // Clear users
  await User.deleteMany();

  // Get users again
  const res2 = await request(app).get('/users').expect(200);
  console.log(res2.body);
})();

Important Notes

Use an in-memory database like mongodb-memory-server for fast, isolated tests.

Always clear data before each test to avoid test interference.

Disconnect and stop the database after tests to free resources.

Summary

Setup and teardown keep tests independent and reliable.

Use beforeAll and afterAll to manage database connection.

Use beforeEach and afterEach to reset data.

Practice

1. What is the main purpose of setting up a test database connection before running tests in an Express app?

easy

A. To speed up the app by using a faster database

B. To ensure tests run against a separate database without affecting real data

C. To automatically deploy the app after tests

D. To backup the production database

Solution

1. Step 1: Understand test database role

   The test database is used to isolate test data from real production data to avoid accidental changes.

2. Step 2: Purpose of setup connection

   Setting up a connection before tests ensures all tests use this separate database environment.

3. Final Answer:

   To ensure tests run against a separate database without affecting real data -> Option B

4. Quick Check:

   Test DB isolates data = A [OK]

Hint: Test DB isolates data from production [OK]

Common Mistakes:

• Confusing test DB with production DB
• Thinking setup speeds app
• Assuming setup deploys app

2. Which of the following is the correct way to close a MongoDB connection in an Express test teardown using Mongoose?

easy

A. mongoose.close()

B. mongoose.stop()

C. mongoose.end()

D. mongoose.disconnect()

Solution

1. Step 1: Recall Mongoose connection methods

   Mongoose uses the method disconnect() to close the connection properly.

2. Step 2: Verify method names

   Methods like close(), end(), or stop() do not exist on the mongoose object for disconnecting.

3. Final Answer:

   mongoose.disconnect() -> Option D

4. Quick Check:

   Disconnect method is disconnect() = B [OK]

Hint: Use mongoose.disconnect() to close connection [OK]

Common Mistakes:

• Using nonexistent methods like close()
• Confusing disconnect() with close()
• Forgetting to await disconnect in async tests

3. Given this Express test setup code snippet using Jest and Mongoose:

beforeAll(async () => {
  await mongoose.connect('mongodb://localhost/testdb');
});
afterAll(async () => {
  await mongoose.disconnect();
});
test('database is empty before test', async () => {
  const count = await User.countDocuments();
  expect(count).toBe(0);
});

What will the test output if the test database has leftover users from previous tests?

medium

A. Test fails because count is not zero

B. Test passes because count is always zero

C. Test throws a connection error

D. Test skips because no users collection

Solution

1. Step 1: Analyze test setup and test code

   The test connects to the test database but does not clear data before running the test.

2. Step 2: Effect of leftover data

   If leftover users exist, User.countDocuments() returns a number greater than zero, causing expect(count).toBe(0) to fail.

3. Final Answer:

   Test fails because count is not zero -> Option A

4. Quick Check:

   Leftover data causes count > 0 = D [OK]

Hint: Leftover data breaks zero count tests [OK]

Common Mistakes:

• Assuming test DB auto-clears data
• Expecting count to be zero without cleanup
• Ignoring async connection setup

4. You wrote this teardown code in your Express test:

afterEach(async () => {
  await mongoose.connection.dropDatabase();
  await mongoose.disconnect();
});

What is the main problem with this teardown approach?

medium

A. afterEach should be beforeAll for teardown

B. dropDatabase() does not clear collections

C. Disconnecting after each test causes connection errors in next tests

D. Missing await before dropDatabase()

Solution

1. Step 1: Understand teardown timing

   Calling mongoose.disconnect() after each test closes the connection, but next tests expect it open.

2. Step 2: Effect on subsequent tests

   Subsequent tests will fail because the database connection is closed and not reopened automatically.

3. Final Answer:

   Disconnecting after each test causes connection errors in next tests -> Option C

4. Quick Check:

   Disconnect once after all tests = C [OK]

Hint: Disconnect once after all tests, not after each [OK]

Common Mistakes:

• Disconnecting inside afterEach instead of afterAll
• Assuming dropDatabase clears connection
• Forgetting async/await keywords

5. You want to ensure each test in your Express app runs with a clean test database. Which setup and teardown pattern is best?

1. Connect once before all tests
2. Clear data before each test
3. Disconnect once after all tests

Why is this pattern preferred?

hard

A. It keeps connection open for speed and clears data to isolate tests

B. It reconnects for each test to avoid stale connections

C. It disconnects before each test to reset state

D. It clears data only after all tests to save time

Solution

1. Step 1: Analyze connection management

   Connecting once before all tests avoids overhead of reconnecting repeatedly, improving speed.

2. Step 2: Analyze data clearing strategy

   Clearing data before each test ensures tests do not affect each other, keeping them isolated and reliable.

3. Step 3: Analyze disconnect timing

   Disconnecting once after all tests properly closes resources without interrupting test flow.

4. Final Answer:

   It keeps connection open for speed and clears data to isolate tests -> Option A

5. Quick Check:

   Connect once, clear each test, disconnect once = A [OK]

Hint: Connect once, clear before each test, disconnect once [OK]

Common Mistakes:

• Disconnecting too often causing errors
• Not clearing data between tests
• Reconnecting for every test slowing tests