Test database setup and teardown in Express - Mini Project: Build & Apply

Test database setup and teardown

📖 Scenario: You are building an Express.js application that uses a test database. To keep tests reliable, you need to set up the test database before tests run and clean it up after tests finish.This project guides you to write code that connects to a test database, configures setup and teardown functions, and integrates them with your test framework.

🎯 Goal: Create an Express.js test setup that connects to a test database before tests and disconnects after tests, ensuring a clean environment for each test run.

📋 What You'll Learn

Create a connection to a test database using a variable named testDb

Add a configuration variable testDbUrl with the test database URL string

Write an async function setupTestDb that connects to testDbUrl

Write an async function teardownTestDb that disconnects testDb

💡 Why This Matters

🌍 Real World

In real projects, tests need a clean database environment. Setting up and tearing down a test database ensures tests do not interfere with each other and results are reliable.

💼 Career

Knowing how to manage test databases is important for backend developers and QA engineers to write maintainable and trustworthy automated tests.

1

Create the test database connection variable

Create a variable called testDb and assign it the result of calling require('some-db-library').createConnection().

Express

// Create the testDb connection variable
// Your code here

Hint

Use require('some-db-library').createConnection() to create the connection.

2

Add the test database URL configuration

Add a constant called testDbUrl and set it to the string 'mongodb://localhost:27017/testdb'.

Express

const testDb = require('some-db-library').createConnection();

// Add the testDbUrl constant with the test database URL string
// Your code here

Hint

Use a string with the exact URL 'mongodb://localhost:27017/testdb'.

3

Write the setup function to connect to the test database

Write an async function called setupTestDb that calls await testDb.connect(testDbUrl) inside its body.

Express

const testDb = require('some-db-library').createConnection();
const testDbUrl = 'mongodb://localhost:27017/testdb';

// Write async function setupTestDb to connect testDb to testDbUrl
// Your code here

Hint

Define an async function and use await testDb.connect(testDbUrl) inside.

4

Write the teardown function to disconnect the test database

Write an async function called teardownTestDb that calls await testDb.disconnect() inside its body.

Express

const testDb = require('some-db-library').createConnection();
const testDbUrl = 'mongodb://localhost:27017/testdb';

async function setupTestDb() {
    await testDb.connect(testDbUrl);
}

// Write async function teardownTestDb to disconnect testDb
// Your code here

Hint

Define an async function and use await testDb.disconnect() inside.

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