This util is designed to simplify integration tests for nestjs/typeorm/postgres projects
it replace postgres DB connection with sqlite in memory DB for test environment
Since sqlite and postgres have different sets of data type and typeorm does not support easy way to redefine those types for test environment, so this lib contains wrappers for @Column, @CreateDateColumn, @UpdateDateColumn annotations.
If your entity contains incompatible with sqlite fields, then you should use those wrappers:
import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
import {CreateDateColumnEx, UpdateDateColumnEx, ColumnEx} from 'nestjs-db-unit'
@Entity({ name: 'users' })
export class User {
@PrimaryGeneratedColumn('uuid')
id!: string;
@Index('email')
@Column({ unique: true})
email!: string;
@ColumnEx({type: 'json', nullable: true})
meta!: object;
@CreateDateColumnEx({ name: 'created_at', type: 'timestamptz' })
createdAt!: Date;
@UpdateDateColumnEx({ name: 'updated_at', type: 'timestamptz' })
updatedAt!: Date;
}This is example of service under test:
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './entities/users';
@Injectable()
export class AppService {
constructor(
@InjectRepository(User)
private readonly userRepository: Repository<User>,
) {}
async getUser(id: string) {
return this.userRepository.findOne(id);
}
}This is example of test:
import { Test, TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
import { getRepository, Repository } from 'typeorm';
import { DbUnit } from 'nestjs-db-unit';
import { AppService } from './app.service';
import { User } from './entities/users';
const data = {
User: [{
id: 'test',
email: '[email protected]'
}]
}
describe('AppController', () => {
let service: AppService;
let db = new DbUnit();
let userRepo: Repository<User>;
beforeEach(async () => {
const conn = await db.initDb({ entities: [User] });
userRepo = getRepository(User);
const app: TestingModule = await Test.createTestingModule({
controllers: [],
providers: [
{
provide: getRepositoryToken(User, conn),
useValue: userRepo,
},
AppService,
],
}).compile();
await db.load(data)
service = app.get<AppService>(AppService);
});
afterEach(() => db.closeDb());
it('should get user"', async () => {
const ID = 'test'
const user = await service.getUser(ID);
expect(user.email).toEqual('[email protected]');
});
});npm i nestjs-db-unitimport {CreateDateColumnEx, UpdateDateColumnEx, ColumnEx} from 'nestjs-db-unit'they wrap CreateDateColumn, UpdateDateColumn, Column respectively
you should use ColumnEx instead of Column if it has types: timestamptz, timestamp, json
the list could be extended in future
import {DbUnit} from 'nestjs-db-unit'-
constructor(options?: Options)
optionscould be{debug:true}optionalit used to add more logs from DB
-
DbUnit::initDb(config)
configmandatory param, it should contain list of entities, e.g.{entities: [User]}it returns
Promiseresolved as DB connection -
DbUnit::closeDb()
close DB connection (clean sqlite in-memory DB)
-
DbUnit::load(data)
it load data into DB
data format must be like this:
{ <Entity1 name>:[ <entity1_1 data>, <entity1_2 data>, ], <Entity2 name>:[ <entity2_1 data>, <entity2_2 data>, ] }the data schema support relations, you can specify entity id and use it in followup entity data
You can find more examples for Integration and End to End tests at /test folder
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent