merge: Company 통합테스트, 단위테스트 작성

[Feature/web company crud test] Company 통합테스트, 단위테스트 작성

Author: yyysolhhh

.github/workflows/cicd.yml

@@ -6,14 +6,23 @@ on:
 
 jobs:
   build:
+    env:
+      MYSQL_HOST: localhost
+      MYSQL_PORT: 3306
+      MYSQL_DB: charlee
+      MYSQL_USER: root
+      MYSQL_PASSWORD: root1234!!
+      MYSQL_SSL: false
+      MYSQL_UNICODE: true
+      MYSQL_KEY: true
     name: Build
     runs-on: ubuntu-latest
     services:
       mysql:
         image: mysql:8.0
         env:
           MYSQL_ROOT_PASSWORD: root1234!!
-          MYSQL_DATABASE: test_db
+          MYSQL_DATABASE: charlee
           MYSQL_USER: user
           MYSQL_PASSWORD: 1234
         ports:

build.gradle

@@ -46,6 +46,7 @@ subprojects {
         implementation 'org.springframework.boot:spring-boot-starter-actuator:3.4.3'
         runtimeOnly 'org.springframework.cloud:spring-cloud-starter-vault-config'
         testImplementation 'org.springframework.boot:spring-boot-starter-test'
+        testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
         testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
     }
 

charlee-web/build.gradle

@@ -1,3 +1,11 @@
+plugins {
+    id 'org.asciidoctor.jvm.convert' version '3.3.2'
+}
+
+configurations {
+    asciidoctorExt
+}
+
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
@@ -14,9 +22,26 @@ dependencies {
     annotationProcessor 'org.projectlombok:lombok'
     annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
     implementation 'org.springframework.boot:spring-boot-starter-validation'
+
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'com.h2database:h2'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
+}
+
+asciidoctor {
+    baseDirFollowsSourceDir()
+    configurations "asciidoctorExt"
+
+    dependsOn test
+
+    doLast {
+        copy {
+            from file("build/docs/asciidoc")
+            into file("src/main/resources/static")
+        }
+    }
 }
 
 bootJar {

charlee-web/src/docs/asciidoc/company.adoc

@@ -0,0 +1,47 @@
+== Create Company API
+
+새 업체를 생성합니다.
+
+.Request
+include::{snippets}/create-company/http-request.adoc[]
+include::{snippets}/create-company/request-fields.adoc[]
+
+.Response
+include::{snippets}/create-company/http-response.adoc[]
+include::{snippets}/create-company/response-fields.adoc[]
+
+== Get Company API
+
+업체의 상세 정보를 조회합니다.
+
+.Request Body
+include::{snippets}/get-company/http-request.adoc[]
+include::{snippets}/get-company/path-parameters.adoc[]
+
+.Response Body
+include::{snippets}/get-company/http-response.adoc[]
+include::{snippets}/get-company/response-fields.adoc[]
+
+== Update Company API
+
+업체의 정보를 수정합니다.
+
+.Request Body
+include::{snippets}/update-company/http-request.adoc[]
+include::{snippets}/update-company/path-parameters.adoc[]
+include::{snippets}/update-company/request-fields.adoc[]
+
+.Response Body
+include::{snippets}/update-company/http-response.adoc[]
+include::{snippets}/update-company/response-fields.adoc[]
+
+== Delete Company API
+
+업체의 정보를 삭제합니다.
+
+.Request Body
+include::{snippets}/delete-company/http-request.adoc[]
+include::{snippets}/delete-company/path-parameters.adoc[]
+
+.Response Body
+include::{snippets}/delete-company/http-response.adoc[]

charlee-web/src/docs/asciidoc/index.adoc

@@ -0,0 +1,3 @@
+== API List
+
+include::company.adoc[]

charlee-web/src/main/java/com/efa73/charleeweb/CharleeWebApplication.java

@@ -13,5 +13,4 @@ public class CharleeWebApplication {
     public static void main(String[] args) {
         SpringApplication.run(CharleeWebApplication.class, args);
     }
-
 }

…/charleeweb/user/domain/entity/User.java …eeweb/account/domain/entity/Account.javacharlee-web/src/main/java/com/efa73/charleeweb/user/domain/entity/User.java renamed to charlee-web/src/main/java/com/efa73/charleeweb/account/domain/entity/Account.java charlee-web/src/main/java/com/efa73/charleeweb/user/domain/entity/User.java renamed to charlee-web/src/main/java/com/efa73/charleeweb/account/domain/entity/Account.java

@@ -1,4 +1,4 @@
-package com.efa73.charleeweb.user.domain.entity;
+package com.efa73.charleeweb.account.domain.entity;
 
 import com.efa73.charleeweb.common.Common;
 import jakarta.persistence.Column;
@@ -13,40 +13,38 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+@Entity
+@Table(name = "account")
 @Getter
-@Table(name = "\"user\"") //TODO: 테스트 통과하기 위해 임시로 추가
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
-@Entity
-public class User extends Common {
+public class Account extends Common {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
 
-    @Column(nullable = false)
-    private String name;
-
-    @Column(nullable = false)
+    @Column(nullable = false, unique = true)
     private String email;
 
     @Column(nullable = false)
     private String password;
 
-    private String phone;
-
     @Column(nullable = false)
     @Enumerated(EnumType.STRING)
     private Role role;
 
-    public static User of(String name, String email, String password, String phone, Role role) {
-        return new User(name, email, password, phone, role);
+    private Account(String email, String password, Role role) {
+        this.email = email;
+        this.password = password;
+        this.role = role;
     }
 
-    private User(String name, String email, String password, String phone, Role role) {
-        this.name = name;
+    public static Account createEntity(String email, String password, Role role) {
+        return new Account(email, password, role);
+    }
+
+    public void updateEntity(String email, String password) {
         this.email = email;
         this.password = password;
-        this.phone = phone;
-        this.role = role;
     }
 }

charlee-web/src/main/java/com/efa73/charleeweb/account/domain/entity/Role.java

@@ -0,0 +1,5 @@
+package com.efa73.charleeweb.account.domain.entity;
+
+public enum Role {
+    ADMIN, COMPANY
+}

charlee-web/src/main/java/com/efa73/charleeweb/account/domain/repository/AccountRepository.java

@@ -0,0 +1,14 @@
+package com.efa73.charleeweb.account.domain.repository;
+
+import com.efa73.charleeweb.account.domain.entity.Account;
+import com.efa73.charleeweb.account.domain.entity.Role;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface AccountRepository extends JpaRepository<Account, Long> {
+
+    boolean existsByRole(Role role);
+
+    boolean existsByEmail(String email);
+}

charlee-web/src/main/java/com/efa73/charleeweb/account/domain/service/AccountService.java

@@ -0,0 +1,29 @@
+package com.efa73.charleeweb.account.domain.service;
+
+import com.efa73.charleeweb.account.domain.entity.Account;
+import com.efa73.charleeweb.account.domain.entity.Role;
+import com.efa73.charleeweb.account.domain.repository.AccountRepository;
+import com.efa73.charleeweb.common.exception.CharleeException;
+import com.efa73.charleeweb.common.exception.CommonErrorCode;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+@Service
+@RequiredArgsConstructor
+public class AccountService {
+
+    private final AccountRepository accountRepository;
+
+    public Account create(String email, String password, Role role) {
+        existsByEmail(email);
+        Account account = Account.createEntity(email, password, role);
+
+        return accountRepository.save(account);
+    }
+
+    private void existsByEmail(String email) {
+        if (accountRepository.existsByEmail(email)) {
+            throw new CharleeException(CommonErrorCode.EMAIL_ALREADY_EXISTS);
+        }
+    }
+}