Skip to main content

EnvModel: Use env model and config model

Обзор

Тесты проверяют EnvModel в nestjs-mod: чтение переменных окружения, валидацию обязательных полей и передачу значений в сервисы через DI.

Что делаем и что проверяем

  • Проверяем, как configTransform и декораторы ConfigModel/ConfigModelProperty обрабатывают входные параметры.

  • Фиксируем контракт валидации и формат ошибок для потребителей модуля конфигурации.

  • Подтверждаем, что модуль/сервис получает корректно подготовленные значения конфигурации.

  • Отдельно проверяем контракт ошибок: не только факт падения, но и содержание/тип ошибки, важные для потребителей модуля.

  • Подтверждаем корректный lifecycle в тестовом окружении: инициализация, готовность зависимостей и штатное завершение приложения/модулей.

Ссылка на GitHub

Подготовительный код

/* eslint-disable no-useless-escape */
import { Injectable } from '@nestjs/common';
import { IsNotEmpty } from 'class-validator';
import { ConfigModel, ConfigModelProperty } from '../config-model/decorators';
import { EnvModel, EnvModelProperty } from '../env-model/decorators';
import {
import { DefaultNestApplicationInitializer } from '../modules/system/default-nest-application/default-nest-application-initializer';
import { DefaultNestApplicationListener } from '../modules/system/default-nest-application/default-nest-application-listener';
import { InjectableFeatureConfigurationType } from '../nest-module/types';
import { createNestModule, getNestModuleDecorators } from '../nest-module/utils';
import { bootstrapNestApplication } from './utils';

describe('NestJS application: Utils', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let originalExit: any;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let exitStatus: any;

beforeAll(() => {
originalExit = process.exit;
process.exit = (status) => {
exitStatus = status;
return null as never;
};
});

afterAll(() => {
process.exit = originalExit;
});

afterEach(() => {
exitStatus = null;
});

describe('NestJS application with env model', () => {

});

describe('NestJS application with config model', () => {

});
describe('NestJS application with anv and config model', () => {
// полный тест в блоке ниже
});
describe('NestJS application with multi-providing options', () => {
});
describe('NestJS application get markdown of infrastructure', () => {
});
});

Код теста

it('should use env model and config model', async () => {
@ConfigModel()
class AppConfig {
@ConfigModelProperty()
@IsNotEmpty()
optionConfig!: string;
}

@EnvModel()
class AppEnv {
@EnvModelProperty()
@IsNotEmpty()
optionEnv!: string;
}

@Injectable()
class AppService {
constructor(
private readonly appConfig: AppConfig,
private readonly appEnv: AppEnv,
) {}

getEnv() {
return this.appEnv;
}

getConfig() {
return this.appConfig;
}
}

const { AppModule } = createNestModule({
moduleName: 'AppModule',
providers: [AppService],
configurationModel: AppConfig,
environmentsModel: AppEnv,
});

process.env['TEST_APP_OPTION_ENV'] = 'optionEnv1';

const app = await bootstrapNestApplication({
project: { name: 'TestApp', description: 'Test application' },
modules: {
system: [DefaultNestApplicationInitializer.forRoot()],
feature: [
AppModule.forRoot({
configuration: { optionConfig: 'optionConfig1' },
}),
],
},
});

const appService = app.get(AppService);

expect(appService.getConfig()).toMatchObject({
optionConfig: 'optionConfig1',
});
expect(appService.getEnv()).toMatchObject({ optionEnv: 'optionEnv1' });
});