create notice board post, getAll apis

migrations/1701328900610-notice-board-history.ts

@@ -0,0 +1,247 @@
+import {
+  MigrationInterface,
+  QueryRunner,
+  Table,
+  TableColumnOptions,
+} from 'typeorm';
+
+const generatePrimaryColumn = (
+  comment: string = '고유 ID',
+): TableColumnOptions => {
+  return {
+    name: 'id',
+    type: 'int',
+    unsigned: true,
+    isPrimary: true,
+    isNullable: false,
+    isGenerated: true,
+    generationStrategy: 'increment',
+    comment,
+  };
+};
+
+const generateCreatedAtColumn = (
+  comment: string = '생성 일자',
+): TableColumnOptions => {
+  return {
+    name: 'created_at',
+    type: 'timestamp',
+    isNullable: false,
+    default: 'CURRENT_TIMESTAMP',
+    comment,
+  };
+};
+
+export class NoticeBoardHistory1701328900610 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // 공지게시글 히스토리
+    await queryRunner.createTable(
+      new Table({
+        name: 'notice_board_history',
+        columns: [
+          generatePrimaryColumn('공지 게시글 히스토리 고유 ID'),
+          {
+            name: 'notice_board_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '공지 게시글 고유 ID',
+          },
+          {
+            name: 'user_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '게시글 작성 유저 고유 ID',
+          },
+          {
+            name: 'title',
+            type: 'varchar',
+            length: '255',
+            isNullable: false,
+            comment: '공지게시글 제목',
+          },
+          {
+            name: 'description',
+            type: 'text',
+            isNullable: false,
+            comment: '공지게시글 내용',
+          },
+          {
+            name: 'allow_comment',
+            type: 'tinyint',
+            length: '1',
+            unsigned: true,
+            default: 1,
+            isNullable: false,
+            comment: '댓글 허용 여부 (0: 비활성화, 1: 허용)',
+          },
+          generateCreatedAtColumn(),
+        ],
+        foreignKeys: [
+          {
+            referencedTableName: 'notice_board',
+            referencedColumnNames: ['id'],
+            columnNames: ['notice_board_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+          {
+            referencedTableName: 'user',
+            referencedColumnNames: ['id'],
+            columnNames: ['user_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+        ],
+      }),
+    );
+    await queryRunner.query(
+      'ALTER TABLE notice_board_history COMMENT = "공지 게시판 수정이력"',
+    );
+
+    // 공지게시글 댓글 수정이력
+    await queryRunner.createTable(
+      new Table({
+        name: 'notice_board_comment_history',
+        columns: [
+          generatePrimaryColumn('공지게시글 댓글 수정이력 고유 ID'),
+          {
+            name: 'user_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '댓글 작성 유저 고유 ID',
+          },
+          {
+            name: 'notice_board_history_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '게시글 고유 ID',
+          },
+          {
+            name: 'description',
+            type: 'varchar',
+            length: '255',
+            isNullable: false,
+            comment: '댓글 본문',
+          },
+          {
+            name: 'isAnonymous',
+            type: 'tinyint',
+            length: '1',
+            default: 0,
+            unsigned: true,
+            isNullable: false,
+            comment: '작성자 익명 여부 (0: 실명, 1: 익명)',
+          },
+          generateCreatedAtColumn(),
+        ],
+        foreignKeys: [
+          {
+            referencedTableName: 'user',
+            referencedColumnNames: ['id'],
+            columnNames: ['user_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+          {
+            referencedTableName: 'notice_board_history',
+            referencedColumnNames: ['id'],
+            columnNames: ['notice_board_history_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+        ],
+      }),
+    );
+    await queryRunner.query(
+      'ALTER TABLE notice_board_comment_history COMMENT = "공지 게시글 댓글 수정이력"',
+    );
+
+    // 공지 게시글 대댓글
+    await queryRunner.createTable(
+      new Table({
+        name: 'notice_board_reply_comment_history',
+        columns: [
+          generatePrimaryColumn('공지 게시글 대댓글 고유 ID'),
+          {
+            name: 'notice_board_history_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '게시글 고유 ID',
+          },
+          {
+            name: 'notice_board_comment_history_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '공지 게시글 댓글 고유 ID',
+          },
+          {
+            name: 'user_id',
+            type: 'int',
+            unsigned: true,
+            isNullable: false,
+            comment: '대댓글 작성 유저 고유 ID',
+          },
+          {
+            name: 'description',
+            type: 'varchar',
+            length: '255',
+            isNullable: false,
+            comment: '대댓글 본문',
+          },
+          {
+            name: 'isAnonymous',
+            type: 'tinyint',
+            length: '1',
+            default: 0,
+            unsigned: true,
+            isNullable: false,
+            comment: '작성자 익명 여부 (0: 실명, 1: 익명)',
+          },
+          generateCreatedAtColumn(),
+        ],
+        foreignKeys: [
+          {
+            referencedTableName: 'user',
+            referencedColumnNames: ['id'],
+            columnNames: ['user_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+          {
+            referencedTableName: 'notice_board_history',
+            referencedColumnNames: ['id'],
+            columnNames: ['notice_board_history_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+          {
+            referencedTableName: 'notice_board_comment_history',
+            referencedColumnNames: ['id'],
+            columnNames: ['notice_board_comment_history_id'],
+            onDelete: 'NO ACTION',
+            onUpdate: 'NO ACTION',
+          },
+        ],
+      }),
+    );
+    await queryRunner.query(
+      'ALTER TABLE notice_board_reply_comment_history COMMENT = "공지 게시판 대댓글 수정이력"',
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.dropTable(
+      new Table({ name: 'notice_board_reply_comment_history' }),
+    );
+    await queryRunner.dropTable(
+      new Table({ name: 'notice_board_comment_history' }),
+    );
+    await queryRunner.dropTable(new Table({ name: 'notice_board_history' }));
+  }
+}

src/apis/api.module.ts

@@ -2,9 +2,16 @@ import { Module } from '@nestjs/common';
 import { AuthModule } from './auth/auth.module';
 import { FreeBoardsModule } from './free-boards/free-boards.module';
 import { UsersModule } from './users/users.module';
+import { NoticeBoardsModule } from './notice-boards/notice-boards.module';
 import { MajorModule } from './major/major.module';
 
 @Module({
-  imports: [AuthModule, UsersModule, FreeBoardsModule, MajorModule],
+  imports: [
+    AuthModule,
+    UsersModule,
+    FreeBoardsModule,
+    MajorModule,
+    NoticeBoardsModule,
+  ],
 })
 export class ApiModule {}

src/apis/notice-boards/constants/notice-board.constant.ts

@@ -0,0 +1,21 @@
+import { NoticeBoardDto } from '../dto/notice-board.dto';
+
+export const NOTICE_BOARD_ORDER_FIELD: readonly (keyof NoticeBoardDto)[] = [
+  'id',
+  'userId',
+  'title',
+  'hit',
+  'allowComment',
+  'createdAt',
+  'updatedAt',
+] as const;
+
+export const NOTICE_BOARD_TITLE_LENGTH = {
+  MIN: 1,
+  MAX: 255,
+} as const;
+
+export const NOTICE_BOARD_ALLOW_COMMENT_LENGTH = {
+  MIN: 0,
+  MAX: 1,
+};

src/apis/notice-boards/controllers/notice-boards.controller.spec.ts

@@ -0,0 +1,75 @@
+import { faker } from '@faker-js/faker';
+import { Test, TestingModule } from '@nestjs/testing';
+import { UserDto } from '@src/apis/users/dto/user.dto';
+import { mockNoticeBoardsService } from '@test/mock/mock.service';
+import { CreateNoticeBoardDto } from '../dto/create-notice-board.dto';
+import { FindNoticeBoardListQueryDto } from '../dto/find-notice-board-list-query.dto';
+import { NoticeBoardDto } from '../dto/notice-board.dto';
+import { NoticeBoardsService } from '../services/notice-boards.service';
+import { NoticeBoardsController } from './notice-boards.controller';
+
+describe(NoticeBoardsController.name, () => {
+  let controller: NoticeBoardsController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [NoticeBoardsController],
+      providers: [
+        {
+          provide: NoticeBoardsService,
+          useValue: mockNoticeBoardsService,
+        },
+      ],
+    }).compile();
+
+    controller = module.get<NoticeBoardsController>(NoticeBoardsController);
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+
+  describe(NoticeBoardsController.prototype.create.name, () => {
+    let user: UserDto;
+    let createNoticeBoardDto: CreateNoticeBoardDto;
+
+    let newNoticeBoard: NoticeBoardDto;
+
+    beforeEach(() => {
+      user = new UserDto();
+      createNoticeBoardDto = new CreateNoticeBoardDto();
+
+      newNoticeBoard = new NoticeBoardDto();
+    });
+
+    it('create notice board', async () => {
+      user.id = faker.number.int();
+
+      mockNoticeBoardsService.create.mockResolvedValue(newNoticeBoard);
+
+      await expect(
+        controller.create(user, createNoticeBoardDto),
+      ).resolves.toEqual(newNoticeBoard);
+    });
+  });
+
+  describe(NoticeBoardsController.prototype.findAllAndCount.name, () => {
+    let findNoticeBoardListQueryDto: FindNoticeBoardListQueryDto;
+
+    beforeEach(() => {
+      findNoticeBoardListQueryDto = new FindNoticeBoardListQueryDto();
+    });
+
+    it('find all and count', async () => {
+      mockNoticeBoardsService.findAllAndCount.mockResolvedValue([[], 0]);
+
+      await expect(
+        controller.findAllAndCount(findNoticeBoardListQueryDto),
+      ).resolves.toEqual([[], 0]);
+    });
+  });
+});