Testing module setup in NestJS

Introduction

Testing module setup helps you create a small, safe space to check if parts of your NestJS app work correctly. It keeps tests organized and easy to run.

When you want to test a service or controller in isolation.

When you need to mock dependencies to avoid real database or API calls.

When you want to check if your module's providers are correctly wired.

When you want to run automated tests during development.

When you want to ensure your code changes don't break existing features.

Syntax

NestJS

import { Test, TestingModule } from '@nestjs/testing';

let module: TestingModule;

beforeEach(async () => {
  module = await Test.createTestingModule({
    imports: [],
    controllers: [],
    providers: [],
  }).compile();
});

The Test.createTestingModule method creates a test module similar to your app module.

You can add imports, controllers, and providers to mimic your real module.

Examples

This sets up a test module with only one service provider.

NestJS

const module = await Test.createTestingModule({
  providers: [MyService],
}).compile();

This sets up a test module with a controller and its service.

NestJS

const module = await Test.createTestingModule({
  controllers: [MyController],
  providers: [MyService],
}).compile();

This includes another module to provide dependencies like database connections.

NestJS

const module = await Test.createTestingModule({
  imports: [DatabaseModule],
  providers: [MyService],
}).compile();

Sample Program

This test sets up a module with HelloService. It checks if the getHello method returns the expected greeting.

NestJS

import { Test, TestingModule } from '@nestjs/testing';
import { Injectable } from '@nestjs/common';

@Injectable()
class HelloService {
  getHello(): string {
    return 'Hello, NestJS!';
  }
}

describe('HelloService', () => {
  let service: HelloService;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [HelloService],
    }).compile();

    service = module.get<HelloService>(HelloService);
  });

  it('should return greeting message', () => {
    expect(service.getHello()).toBe('Hello, NestJS!');
  });
});

Important Notes

Always call compile() to finalize the test module before using it.

Use module.get() to retrieve instances of your providers for testing.

You can mock providers by replacing them in the providers array with custom objects.

Summary

Testing module setup creates a mini version of your app module for safe testing.

You add controllers, providers, and imports to match what you want to test.

Compile the module and get instances to run your tests easily.

Practice

1. What is the main purpose of using Test.createTestingModule() in NestJS testing?

easy

A. To create a small test version of your app module with needed parts

B. To start the full application server for integration testing

C. To generate database seed data automatically

D. To deploy the app to production environment

Solution

1. Step 1: Understand the role of Test.createTestingModule()

   This method creates a lightweight module for testing, including only what you add (controllers, providers, imports).

2. Step 2: Compare with other options

   Starting the full app server or deploying is not the purpose of this method. It is only for isolated testing setup.

3. Final Answer:

   To create a small test version of your app module with needed parts -> Option A

4. Quick Check:

   Testing module setup = small test module [OK]

Hint: Testing module creates mini app for safe isolated tests [OK]

Common Mistakes:

• Thinking it starts the full app server
• Confusing with deployment or seeding
• Assuming it runs tests automatically

2. Which of the following is the correct way to compile a testing module in NestJS?

easy

A. await compileTestingModule(Test.createTestingModule({}));

B. Test.createTestingModule({}).compile();

C. Test.compileTestingModule({});

D. await Test.createTestingModule({}).compile();

Solution

1. Step 1: Recall the async nature of compile()

   The compile() method returns a Promise, so it must be awaited.

2. Step 2: Check syntax correctness

   Only await Test.createTestingModule({}).compile(); correctly uses await with Test.createTestingModule({}).compile(). Others are either missing await or use invalid methods.

3. Final Answer:

   await Test.createTestingModule({}).compile(); -> Option D

4. Quick Check:

   Compile returns Promise, so use await [OK]

Hint: Always await compile() on testing module [OK]

Common Mistakes:

• Forgetting to await compile()
• Using non-existent compileTestingModule method
• Calling compile without parentheses

3. Given this test setup code snippet, what will service.getData() return?

const moduleRef = await Test.createTestingModule({
  providers: [{
    provide: 'DataService',
    useValue: { getData: () => 'mocked data' },
  }],
}).compile();
const service = moduleRef.get('DataService');
return service.getData();

medium

A. Throws runtime error

B. undefined

C. 'mocked data'

D. 'real data'

Solution

1. Step 1: Identify the provider mock

   The provider 'DataService' is mocked with an object whose getData method returns 'mocked data'.

2. Step 2: Understand the get call

   Calling moduleRef.get('DataService') returns the mocked object, so service.getData() returns 'mocked data'.

3. Final Answer:

   'mocked data' -> Option C

4. Quick Check:

   Mock provider method returns 'mocked data' [OK]

Hint: Mocked provider returns its defined value [OK]

Common Mistakes:

• Expecting real data instead of mock
• Assuming get returns undefined without provider
• Confusing provider token with class

4. What is wrong with this NestJS testing module setup?

const moduleRef = await Test.createTestingModule({
  controllers: [AppController],
  providers: [AppService],
});
const controller = moduleRef.get(AppController);

medium

A. Controllers should not be added in testing modules

B. Missing call to compile() before getting controller

C. Providers array should be empty

D. Cannot get controller by class reference

Solution

1. Step 1: Check testing module lifecycle

   After creating the testing module, you must call compile() to finalize it before retrieving instances.

2. Step 2: Identify missing compile call

   The code does not call await moduleRef.compile(), so moduleRef.get() will fail or behave unexpectedly.

3. Final Answer:

   Missing call to compile() before getting controller -> Option B

4. Quick Check:

   Always compile testing module before get() [OK]

Hint: Always await compile() before accessing module instances [OK]

Common Mistakes:

• Forgetting to compile testing module
• Thinking controllers can't be added
• Trying to get by string token instead of class

5. You want to test a service that depends on another service. How do you set up the testing module to replace the dependency with a mock implementation?

hard

A. Add the service and provide a mock using useValue for the dependency in providers array

B. Only add the main service, NestJS auto-mocks dependencies

C. Add both services without mocks, real implementations are always used

D. Use imports to load the dependency module instead of mocking

Solution

1. Step 1: Understand dependency injection in testing

   To replace a dependency, you provide a mock object using useValue in the providers array.

2. Step 2: Setup providers correctly

   Add the main service normally and add the dependency with provide and useValue to inject the mock.

3. Final Answer:

   Add the service and provide a mock using useValue for the dependency in providers array -> Option A

4. Quick Check:

   Mock dependencies with useValue in providers [OK]

Hint: Mock dependencies by providing useValue in providers [OK]

Common Mistakes:

• Assuming NestJS auto-mocks dependencies
• Not providing mock for dependency
• Using imports instead of mocking for isolated tests