Merge pull request #55 from PBTP/test/image

test: ImageService, ImageConsumer, 테스트 코드 작성

Author: emibgo2

src/common/cloud/aws/sqs/presentation/s3-image-created-event-message.dto.ts

@@ -7,13 +7,13 @@ import {
 } from 'class-validator';
 import { Type } from 'class-transformer';
 
-class S3Bucket {
+export class S3Bucket {
   @IsString()
   @IsNotEmpty()
   name: string;
 }
 
-class S3Object {
+export class S3Object {
   @IsString()
   @IsNotEmpty()
   key: string;
@@ -31,7 +31,7 @@ class S3Object {
   sequencer: string;
 }
 
-class S3Detail {
+export class S3Detail {
   @IsString()
   @IsNotEmpty()
   version: string;

src/common/image/port/image.repository.ts

@@ -9,6 +9,8 @@ export const IMAGE_REPOSITORY = Symbol('IImageRepository');
 export interface IImageRepository {
   create(image: Partial<Image>): Image;
 
+  getOne(image: Partial<Image>): Promise<Image>;
+
   findOne(image: Partial<Image>): Promise<Image | undefined>;
 
   save(image: Image): Promise<Image>;
@@ -22,6 +24,12 @@ export class ImageRepository implements IImageRepository {
     return this.imageDB.create(image).toModel();
   }
 
+  async getOne(image: Partial<ImageDto>): Promise<Image> {
+    return this.imageDB
+      .findOneOrFail({ where: { imageUrl: image.imageUrl } })
+      .then((v) => v?.toModel());
+  }
+
   async findOne(image: Partial<ImageDto>): Promise<Image | undefined> {
     return this.imageDB
       .findOne({ where: { imageUrl: image.imageUrl } })

src/common/sender/sms/application/sms.service.ts

@@ -1,6 +1,7 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { SolapiMessageService } from 'solapi';
+import { BadRequestException } from '@nestjs/common/exceptions';
 export const SMS_SERVICE = Symbol('SMS_SERVICE');
 
 export interface ISmsService {
@@ -24,6 +25,10 @@ export class SmsService implements ISmsService {
   }
 
   async send(phoneNumber: string, message: string): Promise<boolean> {
+    if (!phoneNumber || !message) {
+      throw new BadRequestException('전화번호 또는 메시지가 없습니다.');
+    }
+
     return await this.solapiMessageService
       .sendOne({
         to: phoneNumber,

test/mock/fake.cloud-storage.service.ts test/mock/fake.cloud-storage.tstest/mock/fake.cloud-storage.service.ts renamed to test/mock/fake.cloud-storage.ts

@@ -5,7 +5,7 @@ import {
   PresignedUrlDto,
 } from '../../src/common/cloud/aws/s3/presentation/presigned-url.dto';
 
-export class FakeCloudStorageService implements ICloudStorage {
+export class FakeCloudStorage implements ICloudStorage {
   async generatePreSignedUrl(
     key: string,
     metadata: ImageMetaDataDto,

test/mock/fake.image.repository.ts

@@ -7,13 +7,18 @@ export class FakeImageRepository implements IImageRepository {
   create(image: Partial<Image>): Image {
     return image as Image;
   }
-  async findOne(image: Partial<Image>): Promise<Image> {
+  async getOne(image: Partial<Image>): Promise<Image> {
     const findImage = this.images.find((i) => i.imageUrl === image.imageUrl);
     if (!findImage) {
       throw new Error('존재하지 않는 이미지입니다.');
     }
     return findImage;
   }
+
+  async findOne(image: Partial<Image>): Promise<Image | undefined> {
+    return this.images.find((i) => i.imageUrl === image.imageUrl);
+  }
+
   async save(image: Image): Promise<Image> {
     this.images.push(image);
     return image;

test/unit/auth/application/auth.service.test.ts

@@ -2,7 +2,7 @@ import { AuthService } from '../../../../src/auth/application/auth.service';
 import { CustomerService } from '../../../../src/customer/application/customer.service';
 import { FakeCustomerRepository } from '../../../mock/fake.customer.repository';
 import { ImageService } from '../../../../src/common/image/application/image.service';
-import { FakeCloudStorageService } from '../../../mock/fake.cloud-storage.service';
+import { FakeCloudStorage } from '../../../mock/fake.cloud-storage';
 import { FakeImageRepository } from '../../../mock/fake.image.repository';
 import { JwtService, TokenExpiredError } from '@nestjs/jwt';
 import { FakeConfigService } from '../../../mock/fake.config.service';
@@ -54,10 +54,7 @@ describe('AuthService', () => {
     customerService = new CustomerService(
       new FakeCustomerRepository(),
       new SecurityService(new FakeConfigService()),
-      new ImageService(
-        new FakeCloudStorageService(),
-        new FakeImageRepository(),
-      ),
+      new ImageService(new FakeCloudStorage(), new FakeImageRepository()),
       new FakeUuidHolder(),
       new FakeDateHolder(date),
     );

test/unit/common/image/image.consumer.test.ts

@@ -0,0 +1,107 @@
+import { ImageConsumer } from '../../../../src/common/image/application/image.consumer';
+import { ImageService } from '../../../../src/common/image/application/image.service';
+import { Message } from 'aws-sdk/clients/sqs';
+import { BadRequestException } from '@nestjs/common/exceptions';
+import { FakeConfigService } from '../../../mock/fake.config.service';
+import { FakeCloudStorage } from '../../../mock/fake.cloud-storage';
+import { FakeImageRepository } from '../../../mock/fake.image.repository';
+
+describe('ImageConsumer', () => {
+  let consumer: ImageConsumer;
+
+  beforeEach(() => {
+    consumer = new ImageConsumer(
+      new ImageService(new FakeCloudStorage(), new FakeImageRepository()),
+      new FakeConfigService(),
+    );
+  });
+
+  test('consumeMessage', async () => {
+    // given
+    const uuid = 'test-uuid';
+    const env = `test`;
+
+    const message = {
+      Body: JSON.stringify({
+        version: '2.0',
+        id: 'test-id',
+        source: 'aws:s3',
+        account: '123456789012',
+        time: '2023-10-01T12:00:00Z',
+        region: 'us-east-1',
+        resources: ['arn:aws:s3:::example-bucket'],
+        detail: {
+          version: '2.0',
+          bucket: {
+            name: 'example-bucket',
+          },
+          object: {
+            key: `${env}/images/${uuid}/image.jpg`,
+            size: 1024,
+            etag: 'd41d8cd98f00b204e9800998ecf8427e',
+            sequencer: '0055AED6DCD90281E5',
+          },
+          requester: 'arn:aws:iam::123456789012:user/test-user',
+          reason: 'PutObject',
+        },
+      }),
+    } as unknown as Message;
+
+    // when
+    const result = await consumer.consumeMessage(message);
+
+    // then
+    console.table(result);
+    expect(result).toEqual({
+      imageUrl: `https://image.mgmg.life/${env}/images/${uuid}/image.jpg`,
+      uuid: uuid,
+    });
+  });
+
+  test('consumeMessage with empty message body', async () => {
+    // given
+    const message = {
+      Body: '',
+    } as unknown as Message;
+
+    // when && then
+    await expect(consumer.consumeMessage(message)).rejects.toThrow(
+      BadRequestException,
+    );
+  });
+
+  test('Message 안 object key에 대해 /images 와 파일명 사이에 uuid가 존재하지 않으면 BadRequestException 발생 ', async () => {
+    // given
+    const env = 'test';
+    const message = {
+      Body: JSON.stringify({
+        version: '2.0',
+        id: 'test-id',
+        source: 'aws:s3',
+        account: '123456789012',
+        time: '2023-10-01T12:00:00Z',
+        region: 'us-east-1',
+        resources: ['arn:aws:s3:::example-bucket'],
+        detail: {
+          version: '2.0',
+          bucket: {
+            name: 'example-bucket',
+          },
+          object: {
+            key: `${env}/images//image.jpg`,
+            size: 1024,
+            etag: 'd41d8cd98f00b204e9800998ecf8427e',
+            sequencer: '0055AED6DCD90281E5',
+          },
+          requester: 'arn:aws:iam::123456789012:user/test-user',
+          reason: 'PutObject',
+        },
+      }),
+    } as unknown as Message;
+
+    // when && then
+    await expect(consumer.consumeMessage(message)).rejects.toThrow(
+      BadRequestException,
+    );
+  });
+});

test/unit/common/image/image.service.test.ts

@@ -0,0 +1,49 @@
+import { ImageService } from '../../../../src/common/image/application/image.service';
+import { FakeCloudStorage } from '../../../mock/fake.cloud-storage';
+import { FakeImageRepository } from '../../../mock/fake.image.repository';
+
+describe('ImageService', () => {
+  let service: ImageService;
+  let repo: FakeImageRepository;
+
+  beforeEach(() => {
+    repo = new FakeImageRepository();
+    service = new ImageService(new FakeCloudStorage(), repo);
+  });
+
+  test('PreSignedUrl을 발급한다 ', async () => {
+    // given
+    const key = 'key';
+    const metadata = [{ fileName: 'fileName', fileSize: 1 }];
+
+    // when
+    const result = await service.generatePreSignedUrls(key, metadata);
+
+    // then
+    console.table(result);
+    expect(result).toEqual([
+      {
+        url: key,
+        expiredTime: 60,
+        fileName: 'fileName',
+        fileSize: 1,
+      },
+    ]);
+  });
+
+  test('이미지를 저장한다.', async () => {
+    // given
+    const saveUrl = 'imageUrl';
+    const dto = { imageUrl: saveUrl };
+
+    // when
+    const result = await service.create(dto);
+
+    // then
+    expect(result).toEqual({ imageUrl: saveUrl });
+    repo.getOne({ imageUrl: saveUrl }).then((v) => {
+      console.table(v);
+      expect(v).toEqual({ imageUrl: saveUrl });
+    });
+  });
+});

test/unit/customer/application/customer.service.test.ts

@@ -4,7 +4,7 @@ import { FakeConfigService } from '../../../mock/fake.config.service';
 import { FakeCustomerRepository } from '../../../mock/fake.customer.repository';
 import { SecurityService } from '../../../../src/auth/application/security.service';
 import { ImageService } from '../../../../src/common/image/application/image.service';
-import { FakeCloudStorageService } from '../../../mock/fake.cloud-storage.service';
+import { FakeCloudStorage } from '../../../mock/fake.cloud-storage';
 import { FakeImageRepository } from '../../../mock/fake.image.repository';
 import { CustomerDto } from '../../../../src/customer/presentation/customer.dto';
 import { Builder } from 'builder-pattern';
@@ -23,10 +23,7 @@ describe('CustomerService', () => {
     service = new CustomerService(
       new FakeCustomerRepository(),
       new SecurityService(configService),
-      new ImageService(
-        new FakeCloudStorageService(),
-        new FakeImageRepository(),
-      ),
+      new ImageService(new FakeCloudStorage(), new FakeImageRepository()),
       new FakeUuidHolder(),
       new FakeDateHolder(date),
     );

test/unit/customer/presentation/customer.controller.test.ts

@@ -3,14 +3,13 @@ import { CustomerService } from '../../../../src/customer/application/customer.s
 import { FakeCustomerRepository } from '../../../mock/fake.customer.repository';
 import { FakeSecurityService } from '../../../mock/fake.security.service';
 import { ImageService } from '../../../../src/common/image/application/image.service';
-import { FakeCloudStorageService } from '../../../mock/fake.cloud-storage.service';
+import { FakeCloudStorage } from '../../../mock/fake.cloud-storage';
 import { FakeImageRepository } from '../../../mock/fake.image.repository';
 import { FakeDateHolder, FakeUuidHolder } from '../../../mock/fake.holder';
 import { Builder } from 'builder-pattern';
 import { CustomerDto } from '../../../../src/customer/presentation/customer.dto';
 import { AuthProvider } from '../../../../src/auth/presentation/user.dto';
 
-
 describe('CustomerController', () => {
   let customerController: CustomerController;
   const date = new Date();
@@ -19,10 +18,7 @@ describe('CustomerController', () => {
     const customerService = new CustomerService(
       new FakeCustomerRepository(),
       new FakeSecurityService(),
-      new ImageService(
-        new FakeCloudStorageService(),
-        new FakeImageRepository(),
-      ),
+      new ImageService(new FakeCloudStorage(), new FakeImageRepository()),
       new FakeUuidHolder(),
       new FakeDateHolder(date),
     );