Utilizing NestJS to efficiently share an end-to-end server across multiple test suites

Question

Utilizing NestJS to efficiently share an end-to-end server across multiple test suites

Currently, I'm utilizing the NestJS test module to simulate the nest app for testing purposes and my goal is to make this app accessible across various test suites.
Here is how I have set it up:

test
  |_ helpers
    |_ testApp.ts
  |_ e2e
    |_ users.e2e-test.ts
  |_ beforeAll.e2e-test.ts

testApp.ts

import { Test } from '@nestjs/testing';
import { DatabaseModule } from '../../src/database/database.module';
import { UserModule } from '../../src/user/user.module';

let app: any;
export async function initServer() {
  const fixture = await Test.createTestingModule({
    imports: [
      DatabaseModule,
      UserModule,
    ],
  }).compile();
  app = fixture.createNestApplication();

  await app.init();
}
export default app;

beforeAll.e2e-test.ts

import { initServer } from './helpers/testApp';

before(async () => {
  await initServer();
});

users.e2e-test.ts

import * as request from 'supertest';
import * as chai from 'chai';
const expect = chai.expect;

import { UserType } from '../../src/user/enum/user-types.enm';
import app from '../helpers/testApp';

const admin = {
  email: '<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="3c5d585155527c59445d514c5059125f5351">[email protected]</a>',
  password: '123',
  type: UserType.ADMIN
};
describe.only('Creating User with customized permissions', async () => {
  it('User should be able to sign in', async () => {
    request(app.getHttpServer())
      .post('/auth/signin')
      .send({ email: admin.email, password: '123' })
      .end((_, res) => {
        expect(res.status).to.equal(200);
      });
  });
});

My main objective is to share the NestApplication instance among different test suites. However, I am encountering an issue where the app is showing up as undefined in the test case, resulting in the error message:

TypeError: Cannot read property 'getHttpServer' of undefined

Is there a solution or workaround for this problem? Should I initialize a new NestApplication for each test suite?

Just to give you more context, I am utilizing mocha as my test runner.

typescript mocha.js nestjs

Answer 1

Answer №1

I encountered a similar problem, and here is how I resolved it:

Here is my jest-e2e.json:

{
  "moduleFileExtensions": ["js", "json", "ts"],
  "rootDir": ".",
  "testEnvironment": "node",
  "testRegex": ".e2e-spec.ts$",
  "transform": {
    "^.+\\.(t|j)s$": "ts-jest"
  },
  "setupFilesAfterEnv": ["<rootDir>/setup.ts"]
}

This is my setup.ts file:

export let app: NestExpressApplication;

async function initializeServer() {
  const moduleRef = await Test.createTestingModule({
    imports: [
      AppModule,
      AuthModule,
      UsersModule
    ],

  }).compile();

  app = moduleRef.createNestApplication<NestExpressApplication>();
  app.useGlobalInterceptors(new TransformationInterceptor);
  app.useGlobalInterceptors(new TransformError);
  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true,
      transform: true,
      forbidNonWhitelisted: true,
      transformOptions: {
        enableImplicitConversion: true,
      },
    }),
  );

  const configService = app.get(ConfigService);
  // added for custom validator
  useContainer(app.select(AppModule), { fallbackOnErrors: true });
  await app.init();
  await app.listen(3002); 
}

global.beforeAll(async () => { 
  await initializeServer();  
});

Lastly, here is my test code in auth.e2e-spec.ts:

import {app} from '../setup';

Answer 2

I encountered a similar problem, and here is how I resolved it:

Here is my jest-e2e.json:

{
  "moduleFileExtensions": ["js", "json", "ts"],
  "rootDir": ".",
  "testEnvironment": "node",
  "testRegex": ".e2e-spec.ts$",
  "transform": {
    "^.+\\.(t|j)s$": "ts-jest"
  },
  "setupFilesAfterEnv": ["<rootDir>/setup.ts"]
}

This is my setup.ts file:

export let app: NestExpressApplication;

async function initializeServer() {
  const moduleRef = await Test.createTestingModule({
    imports: [
      AppModule,
      AuthModule,
      UsersModule
    ],

  }).compile();

  app = moduleRef.createNestApplication<NestExpressApplication>();
  app.useGlobalInterceptors(new TransformationInterceptor);
  app.useGlobalInterceptors(new TransformError);
  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true,
      transform: true,
      forbidNonWhitelisted: true,
      transformOptions: {
        enableImplicitConversion: true,
      },
    }),
  );

  const configService = app.get(ConfigService);
  // added for custom validator
  useContainer(app.select(AppModule), { fallbackOnErrors: true });
  await app.init();
  await app.listen(3002); 
}

global.beforeAll(async () => { 
  await initializeServer();  
});

Lastly, here is my test code in auth.e2e-spec.ts:

import {app} from '../setup';

Answer 3

Answer №2

Give this a shot.

beforeAll(async () => {
  const module = await Test.createTestingModule({
    providers: [
      MyTestsService,
      {
        provide: getRepositoryToken(Warehouse),
        useValue: myTestsService
      }
    ],
    controllers: [MyTestsController], // <-- including this line will solve the issue with getHttpServer
  })
    .overrideProvider(MyTestsService)
    .useValue(myTestsService)
    .compile();

  app = module.createNestApplication();
  await app.init();
});

Answer 4

Give this a shot.

beforeAll(async () => {
  const module = await Test.createTestingModule({
    providers: [
      MyTestsService,
      {
        provide: getRepositoryToken(Warehouse),
        useValue: myTestsService
      }
    ],
    controllers: [MyTestsController], // <-- including this line will solve the issue with getHttpServer
  })
    .overrideProvider(MyTestsService)
    .useValue(myTestsService)
    .compile();

  app = module.createNestApplication();
  await app.init();
});

Answer 5

Answer №3

After struggling with this folder structure in my testing process, I finally figured out how to efficiently export my app across different test suites. Hopefully, this solution will save you time and frustration, as I spent a good half hour battling the same issue.

    __test__
  |_ category.e2e-test.ts
  |_ test-conf.ts

**test-conf.ts**

   export default async function initializeTestServer() {
   let app: INestApplication;

  const moduleRef = await Test.createTestingModule({
    imports: [AppModule],
  }).compile();

  return moduleRef.createNestApplication();
}

**category.e2e-test.ts**

describe('CategoryController', () => {
    let app: INestApplication;

    beforeAll(async () => {
        app = await initializeTestServer();
        await app.init();
    });

    it('/ (GET)', async () => {
        const response = await request(app.getHttpServer())
            .get('/category')
            .expect(200)
        expect(response.body.length).toBeGreaterThan(0);
        expect(typeof response.body).toBeDefined();
        expect(response.body).toBeInstanceOf(Object);
        expect(Array.isArray(response.body)).toBeTruthy();
    });

    afterAll(async () => {
        await app.close()
    })
});

This solution has resolved my issue for now, but please note that my tests currently run against my development database. If you need to conduct tests against your testing database, be sure to configure your testing database settings within the moduleRef of the test-conf.ts file. Feel free to reach out if you need guidance on this! Now, feel free to utilize the initializeTestServer() function in any test suite you require.

I hope you find this information helpful!

Answer 6

After struggling with this folder structure in my testing process, I finally figured out how to efficiently export my app across different test suites. Hopefully, this solution will save you time and frustration, as I spent a good half hour battling the same issue.

    __test__
  |_ category.e2e-test.ts
  |_ test-conf.ts

**test-conf.ts**

   export default async function initializeTestServer() {
   let app: INestApplication;

  const moduleRef = await Test.createTestingModule({
    imports: [AppModule],
  }).compile();

  return moduleRef.createNestApplication();
}

**category.e2e-test.ts**

describe('CategoryController', () => {
    let app: INestApplication;

    beforeAll(async () => {
        app = await initializeTestServer();
        await app.init();
    });

    it('/ (GET)', async () => {
        const response = await request(app.getHttpServer())
            .get('/category')
            .expect(200)
        expect(response.body.length).toBeGreaterThan(0);
        expect(typeof response.body).toBeDefined();
        expect(response.body).toBeInstanceOf(Object);
        expect(Array.isArray(response.body)).toBeTruthy();
    });

    afterAll(async () => {
        await app.close()
    })
});

This solution has resolved my issue for now, but please note that my tests currently run against my development database. If you need to conduct tests against your testing database, be sure to configure your testing database settings within the moduleRef of the test-conf.ts file. Feel free to reach out if you need guidance on this! Now, feel free to utilize the initializeTestServer() function in any test suite you require.

I hope you find this information helpful!

Answer 7

Answer №4

No way! You must run each tests suite in its own process! Sharing a NestApplication between different test suites is not feasible. The goal is to keep each test suite's environment separate. Even if you utilize global.beforeAll(), it simply means the code will execute at the beginning of each test suite. So, the more test suites you have, the more times it will run. If you really need to share NestApplication, consider writing all your test suites in a single file (even though it may not look pretty).

Answer 8

No way! You must run each tests suite in its own process! Sharing a NestApplication between different test suites is not feasible. The goal is to keep each test suite's environment separate. Even if you utilize global.beforeAll(), it simply means the code will execute at the beginning of each test suite. So, the more test suites you have, the more times it will run. If you really need to share NestApplication, consider writing all your test suites in a single file (even though it may not look pretty).

Utilizing NestJS to efficiently share an end-to-end server across multiple test suites

Answer №1

Answer №2

Answer №3

Answer №4

Similar questions

What is the most efficient way to iterate through an array to push properties into an object nested within another array?

Guide on generating a request through iteration using Javascript

Encountering a problem with Vue StripeCheckout while navigating to a different component

How can one dynamically update a page in Angular when the path is changed?

Angular - Automatically hide sidebar menu upon selecting a menu item

Creating a dynamic multi-line list in Ionic application is a breeze!

Having trouble getting a constructor to function properly when passing a parameter in

Working with an arbitrary number of arguments in TypeScript

Using Angular 2 with Typescript to call a JavaScript function

Registering modules with System.js in a typescript project involves a specific process

What is the best way to extract a nested array of objects and merge them into the main array?

Executing an animation in Angular 4 using a Directive

Discovering Angular2 Heroes: Exploring the Purpose of the Colon in onSelect(hero: Hero)

The element is implicitly assigned an 'any' type due to the fact that an expression of type 'any' cannot be used to index types in nodejs and solidity

Tips on transferring information to the graphical user interface

Generating a unique serial ID using Angular/JS

The scenario involving TypeScript, MySQL, and Socket.IO where re-emitting occurs after a failed login attempt

Changing setState in React does not update the current state

Angular 2 - Troubleshooting Issues with Nested Components and @Input Propagation

Navigating through pages: How can I retrieve the current page value for implementing next and previous functions in Angular 7?