밴쿠버 코로노의 개발일지

https://github.com/ozimov/embedded-redis

Embedded Redis를 사용하는 목적은 개발시에 실제 Redis 설치없이 Unit test를 작성하기 위함이다. 

초기 Spring boot Redis dependency를 테스트 하기 위해서 Redis 설치를 하였지만 Unit test를 실제 Redis에 연결해서 할 수 없으니, Embedded Redis를 설치하였다. 

2022.01.12 - [Infrastructure/redis] - Redis 설치하기 in kubernetes

그럼 Embedded Redis를 이용한 Unit test는 어떻게 작성하는지 알아보자. 

Embedded Redis를 Unit test에서 사용하는 범위는 Repository Test로 한정할 예정이다. Embedded Redis의 목적에 맞게 한정시킬 예정이다.Controller, Service의 Unit test는 Mockito를 이용하여 Mocking 해서 작성하면 된다. 

Test 용 RedisConfiguration 추가

TestRedisConfig class는 Emnbedded Redis server를 Test가 시작할 때 start 시키고, Test가 완료될 때 stop 시킨다. 

Application-test.yaml 생성

Test 용 appilcation-test.yaml을 만들고 Embedded Redis로 접속할 수 있는 정보를 입력하였다. 

JwtTokenRepository.java 파일

이 파일은 현재까지 나의 프로젝트에서 작성된 JwtTokenRepository.java 파일이다. 기본적은 save(), getById(), delete()등의 Method는 기본적으로 생성이 되므로 포함되어 있지 않다. 

JwtTokenRepositoryTest.java 파일

기본 CRUD에 대한 Unit test를 추가하였다. 

TestJwtTokenBuilder.java 파일

Unit test를 작성하다보면 반복적으로 Dummy data를 생성하는 경우가 있다. Unit test가 가지는 불편함 중에 하나이다. 이 부분을 간단히 하기 위해서 별도의 Static Class를 만들어서 간단한 호출을 통해서 사용할 수 있도록 하였다. 

Spring Project를 진행하다 보면 `SLF4J: Class path contains multiple SLF4J bindings.` 라는 Warning 메세지를 볼 수 있다. 

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/Users/kimseunghwan/.m2/repository/ch/qos/logback/logback-classic/1.2.9/logback-classic-1.2.9.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/Users/kimseunghwan/.m2/repository/org/slf4j/slf4j-simple/1.7.32/slf4j-simple-1.7.32.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]

이런 Warning 메세지는 Dependecy 내부에서 같은 Dependecy지만 다른 버전을 Dependency 내부에서 참조를 하고 있으면 발생하게 된다. 이를 해결하기 위해서는 아래와 같은 방법을 사용하면 된다. 

Dependecy tree 확인

현재 어떤 Dependecy가 충돌되는 Dependency를 참조하고 있는지 모르기 때문에 `mvn dependecy:tree`로 현재 내가 사용하고 있는 Dependecy를 확인한다. 

$ mvn dependecy:tree

IDE에서 확인하는 방법 (Intellij)

나의 경우에는 아래와 같이 Spring boot 와 Embedded-redis에서 충돌이 발생하고 있다. 

[INFO] io.coolexplorer:spring-boot-session:war:0.0.1-SNAPSHOT
[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:2.6.2:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:2.6.2:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-starter-logging:jar:2.6.2:compile
[INFO] |  |  |  +- ch.qos.logback:logback-classic:jar:1.2.9:compile
[INFO] |  |  |  |  \- ch.qos.logback:logback-core:jar:1.2.9:compile
[INFO] |  |  |  +- org.apache.logging.log4j:log4j-to-slf4j:jar:2.17.0:compile
[INFO] |  |  |  |  \- org.apache.logging.log4j:log4j-api:jar:2.17.0:compile
[INFO] |  |  |  \- org.slf4j:jul-to-slf4j:jar:1.7.32:compile
...
[INFO] \- it.ozimov:embedded-redis:jar:0.7.3:test
[INFO]    +- com.google.guava:guava:jar:21.0:test
[INFO]    +- commons-io:commons-io:jar:2.5:test
[INFO]    +- org.slf4j:slf4j-simple:jar:1.7.32:test
[INFO]    \- commons-logging:commons-logging:jar:1.2:test

Dependency 제외

해결 방법은 충돌하고 있는 두 Dependency중 한 부분에서 제외를 시켜주는 것이다. 나의 경우에는 Embedded-redis에서 제외를 시켜 주었다. 

변경된 pom.xml - <exclusions> 블럭이 추가되었다. 

<dependency>
    <groupId>it.ozimov</groupId>
    <artifactId>embedded-redis</artifactId>
    <version>${embedded.redis.version}</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
        </exclusion>
    </exclusions>
</dependency>

간단하게 해결!

Dockerize는 이제 더이상 선택이 아니라 필수라고 생각한다. 너무나 많이 사용되고 있고 Microservice Architecture에서는 Docker container는 필수라고 생각된다. 특히 Kubernetes 와 같은 좋은 툴이 나와서 Container orchestration도 쉽게할 수 있으니 사용하지 않을 수가 없다. 

Docker is an open platform for developing, shipping, and running applications. Docker enables you to separate your applications from your infrastructure so you can deliver software quickly. With Docker, you can manage your infrastructure in the same ways you manage your applications. By taking advantage of Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.

특히, 혼자서 1대의 Laptop 또는 Desktop으로 개발을 진행한다면 반드시 써야 한다. 나의 개인 프로젝트의 목표가 MSA 서버를 만드는 것이니 지금 개발 중인 Spring 기반의 서버도 Docker로 빌드를 해야한다. 

Docker는 Documentation이 아주 잘되어 있다. 자세한 설명을 보고 싶으면 여기로 가면 된다. 여기에서는 Spring 서버를 간단하게 빌드하고 띄워보는 방법을 공유하고자 한다. 

Docker container를 만들고 띄우기 위해서는 당연히 Docker가 필요하다. Docker 설치는 아래 문서를 참고하자. (Docker Desktop 설치)

2022.01.12 - [Infrastructure/kubernetes] - kubernetes 설치하기 with Docker desktop

Dockerfile

Docker container를 실행하기 위해서는 Docker image를 만들어야 한다. 우리가 Virtual Machine을 띄우기 위해 OS image가 필요한 것과 같은 원리이다. 대신 Container의 경우 머신의 OS를 그대로 사용하기 때문에 VM보다는 가볍다라고 보면된다. 그래서 이미지도 OS보다 용량이 적다. 

이 이미지를 만들기 위해서는 Dockerfile이라고 하는 image build script가 필요하다. 

아래는 간단한 Spring 용 Dockerfile이다. 

FROM adoptopenjdk:11-jre-hotspot

ARG WAR_FILE=./target/*.war
ARG PROFILE

ENV SPRING_PROFILE=$PROFILE
COPY ${WAR_FILE} webapp.war

CMD ["java", "-Dspring.profiles.active=${SPRING_PROFILE}", "-jar", "webapp.war"]

나의 프로젝트의 경우 `war` 파일로 빌드를 하기 때문에 위와 같은 Commad를 사용하였다. 

그리고 현재 Project에 Profile을 추가해 둔 상태기 때문에 Profile에 따라 서버를 실행한다. 

Docker build

$ docker build --build-arg PROFILE=local --no-cache . -t spring-micro-session:latest

[+] Building 1.5s (7/7) FINISHED                                                                                                                                                                                                                        
 => [internal] load build definition from Dockerfile                                                                                                                                                                                               0.0s
 => => transferring dockerfile: 256B                                                                                                                                                                                                               0.0s
 => [internal] load .dockerignore                                                                                                                                                                                                                  0.0s
 => => transferring context: 2B                                                                                                                                                                                                                    0.0s
 => [internal] load metadata for docker.io/library/adoptopenjdk:11-jre-hotspot                                                                                                                                                                     0.0s
 => [internal] load build context                                                                                                                                                                                                                  1.2s
 => => transferring context: 42.15MB                                                                                                                                                                                                               1.2s
 => CACHED [1/2] FROM docker.io/library/adoptopenjdk:11-jre-hotspot                                                                                                                                                                                0.0s
 => [2/2] COPY ./target/*.war webapp.war                                                                                                                                                                                                           0.2s
 => exporting to image                                                                                                                                                                                                                             0.1s
 => => exporting layers                                                                                                                                                                                                                            0.1s
 => => writing image sha256:58639db680aa854a72685b1a1846036cc46f9cae59d3ec7d1e91e3b0230be9f0                                                                                                                                                       0.0s
 => => naming to docker.io/library/spring-micro-session:latest

위와 같이 Docker를 빌드하면 이미지가 생성된다. 

`--no-cache`는 빌드시에 cache되어 있는 정보를 사용하는 것이 아니라 매번 새롭게 빌드하는 옵션이다. 

`-t`는 이미지의 이름과 Tag를 정의해주는 옵션이다. 여기에서 이미지 이름은 spring-micro-session 이고 tag는 latest이다. 

Docker Run

`docker run` 명령어는 Container를 실행하는 명령어이다. 방금 생성한 이미지로 실행을 해보았다. 실행이 잘된다. 

docker run --rm --name session spring-micro-session:latest                                                                                       ✔  6045  21:32:57

 ,---.                           ,--.
'   .-'   ,---.   ,---.   ,---.  `--'  ,---.  ,--,--,
`.  `-.  | .-. : (  .-'  (  .-'  ,--. | .-. | |      \
.-'    | \   --. .-'  `) .-'  `) |  | ' '-' ' |  ||  |
`-----'   `----' `----'  `----'  `--'  `---'  `--''--'

spring-micro-session 0.0.1-SNAPSHOT
Powered by Spring Boot 2.6.2

2022-01-15 05:33:19.070  INFO 1 --- [           main] i.c.session.SessionApplication           : Starting SessionApplication v0.0.1-SNAPSHOT using Java 11.0.11 on b1f2c1d52bff with PID 1 (/webapp.war started by root in /)
2022-01-15 05:33:19.072 DEBUG 1 --- [           main] i.c.session.SessionApplication           : Running with Spring Boot v2.6.2, Spring v5.3.14
2022-01-15 05:33:19.072  INFO 1 --- [           main] i.c.session.SessionApplication           : The following profiles are active: local
2022-01-15 05:33:19.393  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Multiple Spring Data modules found, entering strict repository configuration mode!
2022-01-15 05:33:19.393  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Bootstrapping Spring Data Redis repositories in DEFAULT mode.
2022-01-15 05:33:19.405  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Finished Spring Data repository scanning in 3 ms. Found 0 Redis repository interfaces.
2022-01-15 05:33:19.528  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Multiple Spring Data modules found, entering strict repository configuration mode!
2022-01-15 05:33:19.528  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Bootstrapping Spring Data Redis repositories in DEFAULT mode.
2022-01-15 05:33:19.616  INFO 1 --- [           main] .s.d.r.c.RepositoryConfigurationDelegate : Finished Spring Data repository scanning in 88 ms. Found 1 Redis repository interfaces.
2022-01-15 05:33:19.923  INFO 1 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8180 (http)
2022-01-15 05:33:19.931  INFO 1 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2022-01-15 05:33:19.931  INFO 1 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.56]
2022-01-15 05:33:20.536  INFO 1 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2022-01-15 05:33:20.536  INFO 1 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1426 ms
2022-01-15 05:33:21.708  INFO 1 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8180 (http) with context path ''
2022-01-15 05:33:21.719  INFO 1 --- [           main] i.c.session.SessionApplication           : Started SessionApplication in 3.026 seconds (JVM running for 3.32)

`--rm` 옵션은 Container 실행을 중지하면 자동으로 Container를 삭제해주는 명령어이다. 

`--name`은 Container의 이름을 지정한다.

`-d` 옵션으로 주면 daemon 형태로 실행할 수 있다. 

$ docker run -d --rm --name session spring-micro-session:latest

Docker ps

`docker ps` 명령어는 현재 수행되는 Container의 정보를 확인할 수 있다. 

$ docker ps

CONTAINER ID   IMAGE                         COMMAND                  CREATED         STATUS         PORTS                           NAMES
3b8bf1923dca   spring-micro-session:latest   "java -Dspring.profi…"   2 minutes ago   Up 2 minutes                                   session

Docker stop

`docker stop` 명령어는 현재 동작 중인 docker container를 중지시킨다. container id와 함께 실행하면 된다. 

$ docker stop 3b8bf1923dca                                                                                                                     ✔  6053  21:42:12
3b8bf1923dca

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification

Open API는 간단하게 Restful API를 작성하여 테스트할 수 있는 툴이다. 하지만 Open API의 더 강력한 점은 개발하고 있는 웹서버와 통합하여 웹서버상의 Restful API의 문서 겸 테스트를 할 수 있는 환경을 제공한다는 것이다. 

즉, Open API Document는 Restful API 개발을 할 때 Client 개발자가 참조할 수 있는 문서를 자동으로 만들어준다. 이 문서를 통해서 API URL, Request body schema, and Responce body schema 를 확인할 수 있다. 아래의 예제를 확인하면 이해가 바로 될 것이다. 

(Open API Document 는 Swagger UI를 사용한다.)

이 문서에는 간단한 설정으로 문서를 작성해 보겠다. 

Example

Open API 설정은 Dependency 추가, application.yml에 Configuration 추가, Annotation 추가. 이 세가지만 하면 완료된다. 

Dependency 추가

아래와 같이 open api dependency를 추가해준다. 

<properties>
	<openapi.version>1.6.3</openapi.version>
</properties>

<!-- Documentation-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>${openapi.version}</version>
</dependency>

Configuration 추가

아래 Configuration은 swagger ui의 path를 설정한다. 

# documentation
springdoc:
  swagger-ui:
    path: /swagger-ui.html

Annotation 추가

API Document의 내용을 추가하기 위해서 보통 아래와 같은 Annotation을 추가한다. Request와 Successfult Response의 경우는 코드를 분석하여 추가를 하지만 Error 상태의 응답은 Annotation을 추가하여 문서에 추가할 수 있다. 

@Operation(summary = "Token Cache Creation", description = "Token Cache Creation", responses = {
        @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = JwtTokenDTO.JwtTokenInfo.class))),
        @ApiResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(example = ""))),
        @ApiResponse(responseCode = "404", description = "Not Found", content = @Content(schema = @Schema(example = "")))
})
@PostMapping("/token")
public JwtTokenDTO.JwtTokenInfo createToken(@RequestBody JwtTokenDTO.JwtTokenCreateRequest request) {
    JwtToken jwtToken = modelMapper.map(request, JwtToken.class);
    JwtToken createdToken = jwtTokenService.create(jwtToken);

    return JwtTokenDTO.JwtTokenInfo.from(createdToken, modelMapper);
}

DTO의 각 항목에 예제를 추가하여 이해를 도울 수 있다. 

@Getter
@Setter
@Accessors(chain = true)
@AllArgsConstructor
@NoArgsConstructor
@ToString
@Schema(description = "JwtToken Info")
public static class JwtTokenInfo {
    @Schema(example = "ff6681f0-50f8-4110-bf96-ef6cec45780e")
    private String id;
    @Schema(example = "1L")
    private Long accountId;
    @Schema(example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....")
    private String jwtToken;
    @Schema(example = "2021-01-01T00:00:00")
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss")
    private LocalDateTime updatedAt;

    public static JwtTokenInfo from(JwtToken jwtToken, ModelMapper modelMapper) {
        return modelMapper.map(jwtToken, JwtTokenInfo.class);
    }
}

추가된 결과 

설정이 완료되고 서버를 실행한 후 http://localhost:8080/swagger-ui.html 로 접속으로 하면 아래와 같이 자동 생성된 문서를 볼 수 있다. 

아래와 같이 API Request를 테스트 할 수도 있다. 

Execute 버튼을 누르면 아래와 같이 응답을 받을 수 있다. 

Schema