web-dev-qa-db-ja.com

TypeORMとNestjs、およびモックを使用したjestでテストするプロセスは?

この質問は、サービス内のリポジトリのスタブ化と、この質問のコンテキストでカバレッジを適切にテストおよび提供する方法に一般化できます。

私はテストの詳細を学んでいますが、DBを含むテストを適切に実行する方法に固執しています。

列といくつかの初期検証ロジックを定義するUserエンティティがあります。

    import { IsAlphanumeric, IsEmail, MinLength } from 'class-validator';
    import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
    @Entity()
    export class User {
      @PrimaryGeneratedColumn()
      public id!: number;

      @Column()
      public name!: string;

      @IsEmail()
      @Column()
      public email!: string;

      @MinLength(8)
      @Column()
      public password!: string;
    }

そして、エンティティのリポジトリを注入するUserServiceがあります。

    import { Injectable } from '@nestjs/common';
    import { InjectRepository } from '@nestjs/typeorm';
    import { validateOrReject } from 'class-validator';
    import { Repository } from 'typeorm';
    import { CreateUserDTO } from './dto/create-user.dto';
    import { User } from './user.entity';

    @Injectable()
    export class UserService {
      constructor(
        @InjectRepository(User) private readonly userRepository: Repository<User>
      ) {}

      public async create(dto: CreateUserDTO) {
        const user = this.userRepository.create(dto);
        await validateOrReject(user);
        await this.userRepository.save(user);
      }

      public async findAll(): Promise<User[]> {
        return await this.userRepository.find();
      }

      public async findByEmail(email: string): Promise<User | undefined> {
        return await this.userRepository.findOne({
          where: {
            email,
          },
        });
      }
    }

そして、ここに私の予備テストがありますので、私の思考の流れをたどることができます.

    import { Test, TestingModule } from '@nestjs/testing';
    import { getRepositoryToken } from '@nestjs/typeorm';
    import { User } from './user.entity';
    import { UserService } from './user.service';

    const createMock = jest.fn((dto: any) => {
      return dto;
    });

    const saveMock = jest.fn((dto: any) => {
      return dto;
    });

    const MockRepository = jest.fn().mockImplementation(() => {
      return {
        create: createMock,
        save: saveMock,
      };
    });
    const mockRepository = new MockRepository();

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

      beforeAll(async () => {
        const module: TestingModule = await Test.createTestingModule({
          providers: [
            UserService,
            {
              provide: getRepositoryToken(User),
              useValue: mockRepository,
            },
          ],
        }).compile();
        service = module.get<UserService>(UserService);
      });

      it('should be defined', () => {
        expect(service).toBeDefined();
      });

      it('should not create invalid user', async () => {
        // ??
      });
    });

そのため、テストをすべて実行することはできますが、実際にテストすることになっているものがわかりません。作成時に検証することを明らかにテストできますが、findAllのような他の事柄については、データベースをjust笑しているように感じますか?これを適切にテストするには、適切なデータが返されることを確認できるように、データベースに接続する必要がありますか?

ネスト文書には「通常はデータベース接続を避けたい」と書かれていますが、機能をテストしていない /ではないので、目的を達成することはできませんか?保存によって値が返されることをモックできますが、一意の列、null許容データ、設定する値の増分などで発生する可能性のあるエラーをテストしていません。

6
kyle

多くの人は、データベースに対してテストするのは悪い習慣だと考えています。しかし、あなたが言及した正確な理由から、モックとスタブを管理する手間を省くために、ほとんどの場合、専用のテストデータベースに対してテストを実行します。

私の趣味のスタートアップでは、すべてのテーブルを消去し、必要に応じてリレーションを持つエンティティを作成するのに役立つヘルパーを使用して、テストがアトミックであることを確認します。

8
AyKarsi