EnvModel: Returns model info in error if option of env not set
Overview
These tests validate nestjs-mod EnvModel: environment variable reading, required field validation, and DI value propagation into services.
What We Do And Verify
-
We verify how
configTransformandConfigModel/ConfigModelPropertydecorators process input parameters. -
We lock the validation contract and error shape expected by configuration consumers.
-
We confirm that modules/services receive properly prepared configuration values.
-
We explicitly validate the error contract: not only failure itself, but also error shape/content expected by module consumers.
GitHub Reference
- File: utils.spec.ts
- Line: 33
Setup Code
import { Injectable, Module } from '@nestjs/common';
import { Test, TestingModule } from '@nestjs/testing';
import { IsNotEmpty } from 'class-validator';
import { BehaviorSubject } from 'rxjs';
import { setTimeout } from 'timers/promises';
import { ConfigModel, ConfigModelProperty } from '../config-model/decorators';
import { EnvModel, EnvModelProperty } from '../env-model/decorators';
import { InjectableFeatureConfigurationType } from './types';
import { createNestModule, getNestModuleDecorators } from './utils';
describe('NestJS modules: Utils', () => {
describe('NestJS modules with env model', () => {
// full test in the block below
});
describe('NestJS modules with config model', () => {
});
describe('NestJS modules with anv and config model', () => {
});
describe('NestJS modules with multi-providing options', () => {
});
describe('NestJS modules with useObservable (configurationStream)', () => {
});
describe('NestJS modules with featureConfigurationClass', () => {
});
});
Test Code
it('should return model info in error if option of env not set', async () => {
@EnvModel({ name: 'model name', description: 'model description' })
class AppEnv {
@EnvModelProperty({ description: 'option description' })
@IsNotEmpty()
option!: string;
}
const { AppModule } = createNestModule({
moduleName: 'AppModule',
environmentsModel: AppEnv,
});
await expect(
Test.createTestingModule({
imports: [AppModule.forRoot({})],
}).compile(),
).rejects.toMatchObject({
info: {
modelPropertyOptions: [{ description: 'option description', originalName: 'option' }],
modelOptions: {
name: 'model name',
description: 'model description',
originalName: 'AppEnv',
},
validations: {
option: {
constraints: { isNotEmpty: 'option should not be empty' },
},
},
},
});
});