Merge pull request #15 from codej99/feature/gracefullyshutdown

Blue / Green Deployment

README.md

@@ -25,8 +25,32 @@
     - Run -> SpringBootApiApplication
 - Swagger
     - http://localhost:8080/swagger-ui.html
+    
+### 3. DDL
+create table user (
+       msrl bigint not null auto_increment,
+        name varchar(100) not null,
+        password varchar(100),
+        provider varchar(100),
+        uid varchar(50) not null,
+        primary key (msrl)
+    ) engine=InnoDB;
+    
+create table user_roles (
+       user_msrl bigint not null,
+        roles varchar(255)
+    ) engine=InnoDB;
+    
+    
+alter table user 
+add constraint UK_a7hlm8sj8kmijx6ucp7wfyt31 unique (uid);
 
-### 3. 목차
+alter table user_roles 
+       add constraint FKel3d4qj41g0sy1mtp4sh055g7 
+       foreign key (user_msrl) 
+       references user (msrl);
+       
+### 4. 목차
 - SpringBoot2로 Rest api 만들기(1) – Intellij Community에서 프로젝트생성
     - Document
         - https://daddyprogrammer.org/post/19/spring-boot1-start-intellij/

build.gradle

@@ -25,6 +25,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-freemarker'
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.boot:spring-boot-starter-security'
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'io.jsonwebtoken:jjwt:0.9.1'
     implementation 'io.springfox:springfox-swagger2:2.6.1'
     implementation 'io.springfox:springfox-swagger-ui:2.6.1'

deploy.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+PROFILE=$1
+PROJECT=SpringRestApi
+PROJECT_HOME=/home/happydaddy/${PROJECT}
+JAR_PATH=${PROJECT_HOME}/build/libs/api-0.0.1-SNAPSHOT.jar
+SVR_LIST=server_${PROFILE}.list
+SERVERS=`cat $SVR_LIST`
+DEPLOY_PATH=/home/ec2-user/app
+AWS_ID=ec2-user
+DATE=`date +%Y-%m-%d-%H-%M-%S`
+JAVA_OPTS="-XX:MaxMetaspaceSize=128m -XX:+UseG1GC -Xss1024k -Xms128m -Xmx128m -Dfile.encoding=UTF-8"
+PEM=AwsFreetierKeyPair.pem
+PORT=8083
+
+echo Deploy Start
+for server in $SERVERS; do
+    echo Target server - $server
+    # Target Server에 배포 디렉터리 생성
+    ssh -i $PEM $AWS_ID@$server "mkdir -p $DEPLOY_PATH/dist"
+    # Target Server에 jar 이동
+    echo 'Executable Jar Copying...'
+    scp -i $PEM $JAR_PATH $AWS_ID@$server:~/app/dist/$PROJECT-$DATE.jar
+    # 이동한 jar파일의 바로가기(SymbolicLink)생성
+    ssh -i $PEM $AWS_ID@$server "ln -Tfs $DEPLOY_PATH/dist/$PROJECT-$DATE.jar $DEPLOY_PATH/$PROJECT"
+    # 현재 실행중인 서버 PID 조회
+    runPid=$(ssh -i $PEM $AWS_ID@$server pgrep -f $PROJECT)
+    if [ -z $runPid ]; then
+        echo "No servers are running"
+    fi
+    # 현재 실행중인 서버의 포트를 조회. 추가로 실행할 서버의 포트 선정
+    runPortCount=$(ssh -i $PEM $AWS_ID@$server ps -ef | grep $PROJECT | grep -v grep | grep $PORT | wc -l)
+    if [ $runPortCount -gt 0 ]; then
+        PORT=8084
+    fi
+    echo "Server $PORT Starting..."
+    # 새로운 서버 실행
+    ssh -i $PEM $AWS_ID@$server "nohup java -jar -Dserver.port=$PORT -Dspring.profiles.active=$PROFILE $JAVA_OPTS $DEPLOY_PATH/$PROJECT < /dev/null > std.out 2> std.err &"
+    # 새롭게 실행한 서버의 health check
+    echo "Health check $PORT"
+    for retry in {1..10}
+    do
+        health=$(ssh -i $PEM $AWS_ID@$server curl -s http://localhost:$PORT/actuator/health)
+        checkCount=$(echo $health | grep 'UP' | wc -l)
+        if [ $checkCount -ge 1 ]; then
+           echo "Server $PORT Started Normaly"
+           # 기존 서버 Stop / Nginx 포트 변경 후 리스타트
+           if [ $runPid -gt 0 ]; then
+                echo "Server $runPid Stop"
+                ssh -i $PEM $AWS_ID@$server "kill -TERM $runPid"
+                sleep 5
+                echo "Nginx Port Change"
+		ssh -i $PEM $AWS_ID@$server "echo 'set \$service_addr http://127.0.0.1:$PORT;' | sudo tee /etc/nginx/conf.d/service_addr.inc"
+                echo "Nginx reload"
+		ssh -i $PEM $AWS_ID@$server "sudo service nginx reload"
+           fi
+           break;
+	else
+	    echo "Check - false"
+        fi
+        sleep 5
+    done
+    if [ $retry -eq 10 ]; then
+	   echo "Deploy Fail"
+    fi
+done
+echo Deploy End

src/main/java/com/rest/api/SpringRestApiApplication.java

@@ -1,7 +1,10 @@
 package com.rest.api;
 
+import com.rest.api.config.GracefulShutdown;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
+import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
 import org.springframework.context.annotation.Bean;
 import org.springframework.security.crypto.factory.PasswordEncoderFactories;
 import org.springframework.security.crypto.password.PasswordEncoder;
@@ -22,4 +25,16 @@ public class SpringRestApiApplication {
     public RestTemplate getRestTemplate() {
         return new RestTemplate();
     }
+
+    @Bean
+    public GracefulShutdown gracefulShutdown() {
+        return new GracefulShutdown();
+    }
+
+    @Bean
+    public ConfigurableServletWebServerFactory webServerFactory(final GracefulShutdown gracefulShutdown) {
+        TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
+        factory.addConnectorCustomizers(gracefulShutdown);
+        return factory;
+    }
 }

src/main/java/com/rest/api/config/GracefulShutdown.java

@@ -0,0 +1,50 @@
+package com.rest.api.config;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.catalina.connector.Connector;
+import org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.event.ContextClosedEvent;
+
+import java.util.concurrent.Executor;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
+
+@Slf4j
+public class GracefulShutdown implements TomcatConnectorCustomizer, ApplicationListener<ContextClosedEvent> {
+
+    private static final int TIMEOUT = 30;
+
+    private volatile Connector connector;
+
+    @Override
+    public void customize(Connector connector) {
+        this.connector = connector;
+    }
+
+    @Override
+    public void onApplicationEvent(ContextClosedEvent event) {
+        this.connector.pause();
+        Executor executor = this.connector.getProtocolHandler().getExecutor();
+        if (executor instanceof ThreadPoolExecutor) {
+            try {
+                ThreadPoolExecutor threadPoolExecutor = (ThreadPoolExecutor) executor;
+                threadPoolExecutor.shutdown();
+                if (!threadPoolExecutor.awaitTermination(TIMEOUT, TimeUnit.SECONDS)) {
+                    log.warn("Tomcat thread pool did not shut down gracefully within "
+                            + TIMEOUT + " seconds. Proceeding with forceful shutdown");
+
+                    threadPoolExecutor.shutdownNow();
+
+                    if (!threadPoolExecutor.awaitTermination(TIMEOUT, TimeUnit.SECONDS)) {
+                        log.error("Tomcat thread pool did not terminate");
+                    }
+                } else {
+                    log.info("Tomcat thread pool has been gracefully shutdown");
+                }
+            } catch (InterruptedException ex) {
+                Thread.currentThread().interrupt();
+            }
+        }
+    }
+}

src/main/java/com/rest/api/config/security/JwtTokenProvider.java

@@ -22,7 +22,7 @@ import java.util.List;
 @Component
 public class JwtTokenProvider { // JWT 토큰을 생성 및 검증 모듈
 
-    @Value("spring.jwt.secret")
+    @Value("${spring.jwt.secret}")
     private String secretKey;
 
     private long tokenValidMilisecond = 1000L * 60 * 60; // 1시간만 토큰 유효

src/main/java/com/rest/api/config/security/SecurityConfiguration.java

@@ -32,8 +32,8 @@ public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
             .and()
                 .authorizeRequests() // 다음 리퀘스트에 대한 사용권한 체크
                     .antMatchers("/*/signin", "/*/signin/**", "/*/signup", "/*/signup/**", "/social/**").permitAll() // 가입 및 인증 주소는 누구나 접근가능
-                    .antMatchers(HttpMethod.GET, "/helloworld/**", "/favicon.ico").permitAll() // 등록한 GET요청 리소스는 누구나 접근가능
-                .anyRequest().hasRole("USER") // 그외 나머지 요청은 모두 인증된 회원만 접근 가능
+                    .antMatchers(HttpMethod.GET, "/helloworld/**","/actuator/health").permitAll() // hellowworld로 시작하는 GET요청 리소스는 누구나 접근가능
+                    .anyRequest().hasRole("USER") // 그외 나머지 요청은 모두 인증된 회원만 접근 가능
             .and()
                 .exceptionHandling().accessDeniedHandler(new CustomAccessDeniedHandler())
             .and()

src/main/java/com/rest/api/controller/HelloController.java

@@ -2,10 +2,13 @@ package com.rest.api.controller;
 
 import lombok.Getter;
 import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
 
+@Slf4j
 @Controller
 public class HelloController {
 
@@ -20,6 +23,8 @@ public class HelloController {
     @GetMapping(value = "/helloworld/string")
     @ResponseBody
     public String helloworldString() {
+        log.debug("Helloworld");
+        log.info("Helloworld");
         return HELLO;
     }
 
@@ -33,6 +38,13 @@ public class HelloController {
 
     @GetMapping(value = "/helloworld/page")
     public String helloworld() {
-        return "helloworld";
+        return HELLO;
+    }
+
+    @GetMapping("/helloworld/long-process")
+    @ResponseBody
+    public String pause() throws InterruptedException {
+        Thread.sleep(10000);
+        return "Process finished";
     }
 }

src/main/resources/application-alpha.yml

@@ -0,0 +1,24 @@
+logging:
+  level:
+    root: warn
+    com.rest.api: info
+  path: /home/ec2-user/app/log
+  file:
+    max-history: 7
+
+spring:
+  profiles: alpha
+  datasource:
+    url: jdbc:mysql://127.0.0.1:33060/daddyprogrammer?useUnicode=true&autoReconnect=true&characterEncoding=utf8&allowMultiQueries=true&useSSL=false&serverTimezone=UTC
+    driver-class-name: com.mysql.cj.jdbc.Driver
+    username: happydaddy
+    password: daddy!@#1004
+  jpa:
+    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
+    properties.hibernate:
+      hbm2ddl.auto: none
+      format_sql: true
+    showSql: true
+    generate-ddl: false
+  url:
+    base: http://dev-api.daddyprogrammer.org

src/main/resources/application-local.yml

@@ -0,0 +1,20 @@
+logging:
+  level:
+    root: warn
+    com.rest.api: debug
+
+spring:
+  profiles: local
+  datasource:
+    url: jdbc:h2:tcp://localhost/~/test
+    driver-class-name: org.h2.Driver
+    username: sa
+  jpa:
+    database-platform: org.hibernate.dialect.H2Dialect
+    properties.hibernate:
+      hbm2ddl.auto: update
+      format_sql: true
+    showSql: true
+    generate-ddl: true
+  url:
+    base: http://localhost:8080

src/main/resources/application.yml

@@ -1,20 +1,9 @@
-server:
-  port: 8080
-
 spring:
-  datasource:
-    url: jdbc:h2:tcp://localhost/~/test
-    driver-class-name: org.h2.Driver
-    username: sa
-  jpa:
-    database-platform: org.hibernate.dialect.H2Dialect
-    properties.hibernate.hbm2ddl.auto: update
-    showSql: true
+  profiles:
+    active: local # 디폴트 환경
   messages:
     basename: i18n/exception
     encoding: UTF-8
-  jwt:
-    secret: govlepel@$&
   social:
     kakao:
       client_id: XXXXXXXXXXXXXXXXXXXXXXXXXX # 앱생성시 받은 REST API 키
@@ -23,5 +12,5 @@ spring:
         login: https://kauth.kakao.com/oauth/authorize
         token: https://kauth.kakao.com/oauth/token
         profile: https://kapi.kakao.com/v2/user/me
-  url:
-    base: http://localhost:8080
+  jwt:
+    secret: govlepel@$&

src/test/java/com/rest/api/controller/v1/SignControllerTest.java

@@ -1,11 +1,15 @@
 package com.rest.api.controller.v1;
 
+import com.rest.api.entity.User;
+import com.rest.api.repo.UserJpaRepo;
+import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.security.crypto.password.PasswordEncoder;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.transaction.annotation.Transactional;
@@ -14,6 +18,7 @@ import org.springframework.util.MultiValueMap;
 
 import java.time.LocalDateTime;
 import java.time.ZoneId;
+import java.util.Collections;
 
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
@@ -29,6 +34,17 @@ public class SignControllerTest {
     @Autowired
     private MockMvc mockMvc;
 
+    @Autowired
+    private UserJpaRepo userJpaRepo;
+
+    @Autowired
+    private PasswordEncoder passwordEncoder;
+
+    @Before
+    public void setUp() throws Exception {
+        userJpaRepo.save(User.builder().uid("happydaddy@naver.com").name("happydaddy").password(passwordEncoder.encode("1234")).roles(Collections.singletonList("ROLE_USER")).build());
+    }
+
     @Test
     public void signin() throws Exception {
         MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
@@ -95,8 +111,8 @@ public class SignControllerTest {
                 .andExpect(jsonPath("$.code").value(-1004));
     }
 
-    @Test
-    public void signUpProvider() throws Exception {
+    @Test @Ignore
+    public void signUpSocial() throws Exception {
         MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
         params.add("accessToken", "HizF3ir9522bMW3shkO0x0T9zBdXFCW1WsF56Qo9dVsAAAFqMwTqHw");
         params.add("name", "kakaoKing!");
@@ -107,8 +123,8 @@ public class SignControllerTest {
                 .andExpect(jsonPath("$.code").value(0));
     }
 
-    @Test
-    public void signInProvider() throws Exception {
+    @Test @Ignore
+    public void signInSocial() throws Exception {
         MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
         params.add("accessToken", "HizF3ir9522bMW3shkO0x0T9zBdXFCW1WsF56Qo9dVsAAAFqMwTqHw");
         mockMvc.perform(post("/v1/signin/kakao").params(params))

src/test/java/com/rest/api/controller/v1/UserControllerTest.java

@@ -1,5 +1,8 @@
 package com.rest.api.controller.v1;
 
+import com.rest.api.entity.User;
+import com.rest.api.repo.UserJpaRepo;
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -7,6 +10,7 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.json.JacksonJsonParser;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.security.crypto.password.PasswordEncoder;
 import org.springframework.security.test.context.support.WithMockUser;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MockMvc;
@@ -16,6 +20,10 @@ import org.springframework.transaction.annotation.Transactional;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
 
+import java.util.Collections;
+import java.util.Optional;
+
+import static org.junit.Assert.assertTrue;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
@@ -29,10 +37,17 @@ public class UserControllerTest {
     @Autowired
     private MockMvc mockMvc;
 
+    @Autowired
+    private UserJpaRepo userJpaRepo;
+
+    @Autowired
+    private PasswordEncoder passwordEncoder;
+
     private String token;
 
     @Before
     public void setUp() throws Exception {
+        userJpaRepo.save(User.builder().uid("happydaddy@naver.com").name("happydaddy").password(passwordEncoder.encode("1234")).roles(Collections.singletonList("ROLE_USER")).build());
         MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
         params.add("id", "happydaddy@naver.com");
         params.add("password", "1234");
@@ -50,6 +65,10 @@ public class UserControllerTest {
         token = jsonParser.parseMap(resultString).get("data").toString();
     }
 
+    @After
+    public void tearDown() throws Exception {
+    }
+
     @Test
     public void invalidToken() throws Exception {
         mockMvc.perform(MockMvcRequestBuilders
@@ -109,8 +128,10 @@ public class UserControllerTest {
 
     @Test
     public void delete() throws Exception {
+        Optional<User> user = userJpaRepo.findByUid("happydaddy@naver.com");
+        assertTrue(user.isPresent());
         mockMvc.perform(MockMvcRequestBuilders
-                .delete("/v1/user/2")
+                .delete("/v1/user/" + user.get().getMsrl())
                 .header("X-AUTH-TOKEN", token))
                 .andDo(print())
                 .andExpect(status().isOk())

src/test/java/com/rest/api/service/social/KakaoServiceTest.java

@@ -1,6 +1,7 @@
 package com.rest.api.service.social;
 
 import com.rest.api.model.social.KakaoProfile;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -16,7 +17,7 @@ public class KakaoServiceTest {
     @Autowired
     private KakaoService kakaoService;
 
-    @Test
+    @Test @Ignore
     public void whenGetKakaoProfile_thenReturnProfile() {
 
         String accessToken = "xjsMzpQtIr4w13FIQvL3R7BW7X4yvm1KmzXCTwopyWAAAAFqMxEcwA";