feat: template control front page (#49)

* dev: temporary require false set

* dev: add UNKNOWN status

* dev: template Information model add

* dev: random TestResult stubbing

* dev: front-page for template runner

* dev: add template with json body indentation

* chore: edit table css

* dev: add enum AgentStatus in TemplateResult model

* dev: add enum AgentStatus in TemplateResult model

* chore: clarify specific import

* test: dto serializer test

* dev: remove test randomized TestResult response

* fix: failed UserContext test

* dev: testing added and gradle setting

* dev: test code for sse emitter

* dev: undo unused template test

Author: ghkdqhrbals

bm-agent/build.gradle

@@ -11,6 +11,7 @@ version = '0.0.1-SNAPSHOT'
 
 def excludeJacocoTestCoverageReport = [
         // bmagent
+        'org/benchmarker/bmagent/BmAgentApplication**',
 //        'org/benchmarker/bmagent/**',
 ]
 
@@ -41,6 +42,8 @@ dependencies {
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework.boot:spring-boot-testcontainers'
     testImplementation 'org.testcontainers:junit-jupiter'
+    testImplementation 'com.squareup.okhttp3:mockwebserver:4.9.1'
+
     implementation project(':bm-common')
 }
 
@@ -56,6 +59,7 @@ jacocoTestReport {
     reports {
         xml.required = true
     }
+
     // Set the path to the source files
     classDirectories.setFrom(files(classDirectories.files.collect {
         fileTree(dir: it, exclude: excludeJacocoTestCoverageReport)

bm-agent/src/main/java/org/benchmarker/bmagent/controller/AgentApiController.java

@@ -36,8 +36,8 @@ public class AgentApiController {
      * @return SseEmitter
      */
     @PostMapping("/templates/{template_id}")
-    public SseEmitter startSSE(@PathVariable("template_id") Long templateId,
-        @RequestParam("action") String action, @RequestBody TemplateInfo templateInfo) {
+    public SseEmitter manageSSE(@PathVariable("template_id") Long templateId,
+        @RequestParam("action") String action, @RequestBody(required = false) TemplateInfo templateInfo) {
 
         if (action.equals("start")) {
             return sseManageService.start(templateId, templateInfo);

bm-agent/src/main/java/org/benchmarker/bmagent/sse/SseManageService.java

@@ -58,6 +58,7 @@ public SseEmitter start(Long id, TemplateInfo templateInfo) {
 
         // 1초마다 TestResult 를 보내는 스케줄러 시작
         scheduledTaskService.start(id, () -> {
+//            resultManagerService.save(id, RandomUtils.generateRandomTestResult());
             send(id, resultManagerService.find(id));
         }, 0, 1, TimeUnit.SECONDS);
 

bm-agent/src/test/java/org/benchmarker/bmagent/TestBmAgentApplication.java

@@ -0,0 +1,108 @@
+package org.benchmarker.bmagent.controller;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import org.benchmarker.bmagent.schedule.SchedulerStatus;
+import org.benchmarker.bmagent.service.ISseManageService;
+import org.benchmarker.util.MockServer;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.web.reactive.function.client.WebClient;
+import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
+
+@ExtendWith(MockitoExtension.class)
+public class AgentApiControllerTest extends MockServer {
+
+    @Mock
+    private ISseManageService sseManageService;
+
+    @InjectMocks
+    private AgentApiController agentApiController;
+
+    @Captor
+    private ArgumentCaptor<String> messageCaptor;
+
+    private MockMvc mockMvc;
+
+    @Test
+    @DisplayName("SSE start 통신 테스트")
+    public void testStartSSE() throws IOException {
+        // given
+        SseEmitter mockSseEmitter = Mockito.mock(SseEmitter.class);
+
+        // when
+        // sseManageService.start() 메서드의 행동을 설정하는 스텁 설정
+        doAnswer(invocation -> {
+            // 클라이언트로 데이터를 보내는 stub
+            mockSseEmitter.send("Data 1");
+            mockSseEmitter.send("Data 2");
+            mockSseEmitter.complete();
+            return null;
+        }).when(sseManageService).start(eq(1L), any());
+
+        // 호출
+        agentApiController.manageSSE(1L, "start", null);
+
+        // then
+        // SseEmitter 로 전송된 메시지 모두 캡처
+        Mockito.verify(mockSseEmitter, times(2)).send(messageCaptor.capture());
+        assertEquals("Data 1", messageCaptor.getAllValues().get(0));
+        assertEquals("Data 2", messageCaptor.getAllValues().get(1));
+    }
+
+    @Test
+    @DisplayName("SSE stop 통신 테스트")
+    public void testStopSSE() throws IOException {
+        // given
+        Long templateId = 1L;
+
+        // when
+        agentApiController.manageSSE(templateId, "stop", null);
+
+        // then
+        // sseManageService.stop() 메서드가 호출되었는지 검증
+        verify(sseManageService, times(1)).stop(eq(templateId));
+    }
+
+    @Test
+    @DisplayName("스케줄러 상태 체크 테스트")
+    public void testCheckSchedulerStatus() throws Exception {
+        // given
+        WebClient webClient = WebClient.create(mockServer.url("/api/status").toString());
+        Map<Long, SchedulerStatus> schedulerStatusMap = new HashMap<>();
+        schedulerStatusMap.put(1L, SchedulerStatus.RUNNING);
+        schedulerStatusMap.put(2L, SchedulerStatus.SHUTDOWN);
+        addMockResponse(schedulerStatusMap);
+
+        // when
+        Map<Long, SchedulerStatus> response = webClient.get()
+            .uri("/api/status")
+            .retrieve()
+            .bodyToMono(new ParameterizedTypeReference<Map<Long, SchedulerStatus>>() {
+            })
+            .log()
+            .block();
+
+        // then
+        assertThat(response.get(1L)).isEqualTo(SchedulerStatus.RUNNING);
+        assertThat(response.get(2L)).isEqualTo(SchedulerStatus.SHUTDOWN);
+    }
+}

bm-agent/src/test/java/org/benchmarker/bmagent/controller/AgentApiControllerTest.java

@@ -0,0 +1,33 @@
+package org.benchmarker.bmagent.controller;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+
+import java.io.IOException;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.context.request.WebRequest;
+
+@ExtendWith(MockitoExtension.class)
+public class GlobalExceptionHandlerTest {
+
+    @InjectMocks
+    private GlobalExceptionHandler globalExceptionHandler;
+
+    @Test
+    public void testHandleIOException() {
+        // Arrange
+        IOException mockException = mock(IOException.class);
+        WebRequest mockRequest = mock(WebRequest.class);
+
+        // Act
+        ResponseEntity<Object> responseEntity = globalExceptionHandler.handleIOException(mockException, mockRequest);
+
+        // Assert
+        assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, responseEntity.getStatusCode());
+    }
+}

bm-agent/src/test/java/org/benchmarker/bmagent/controller/GlobalExceptionHandlerTest.java

@@ -1,22 +1,21 @@
 package org.benchmarker.bmagent.sse;
 
-import org.benchmarker.bmcommon.dto.TemplateInfo;
-import org.benchmarker.bmcommon.dto.TestResult;
-import org.benchmarker.bmcommon.util.RandomUtils;
+import static org.assertj.core.api.Assertions.assertThat;
+
 import org.benchmarker.bmagent.pref.ResultManagerService;
 import org.benchmarker.bmagent.schedule.ScheduledTaskService;
 import org.benchmarker.bmagent.schedule.SchedulerStatus;
 import org.benchmarker.bmagent.service.IScheduledTaskService;
+import org.benchmarker.bmcommon.dto.TemplateInfo;
+import org.benchmarker.bmcommon.dto.TestResult;
+import org.benchmarker.bmcommon.util.RandomUtils;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
 
-import static java.lang.Thread.sleep;
-import static org.assertj.core.api.Assertions.assertThat;
-
 @ExtendWith(MockitoExtension.class)
 class SseManageServiceTest {
     private IScheduledTaskService scheduledTaskService;
@@ -49,4 +48,22 @@ void start_ShouldStartSseEmitterAndScheduledTask() throws InterruptedException {
         sseManageService.stop(id);
         assertThat(scheduledTaskService.getStatus().get(id)).isNull();
     }
+
+    @Test
+    @DisplayName("sse 시작 시, id 가 중복된다면(기존 emitter 가 존재하면) null 를 즉시 반환한다")
+    void startAndShutdown() throws InterruptedException {
+        // given
+        Long id = 1L;
+        TestResult resultStub = RandomUtils.generateRandomTestResult();
+        resultManagerService.save(id, resultStub);
+        SseEmitter result = sseManageService.start(id, new TemplateInfo());
+
+        // when
+        SseEmitter res = sseManageService.start(id, new TemplateInfo());
+
+        // then
+        assertThat(res).isNull();
+        sseManageService.stop(id);
+    }
+
 }

…agent/pref/ResultManagerServiceTest.java …agent/pref/ResultManagerServiceTest.javabm-controller/src/test/java/org/benchmarker/bmagent/pref/ResultManagerServiceTest.java renamed to bm-agent/src/test/java/org/benchmarker/bmagent/pref/ResultManagerServiceTest.java bm-controller/src/test/java/org/benchmarker/bmagent/pref/ResultManagerServiceTest.java renamed to bm-agent/src/test/java/org/benchmarker/bmagent/pref/ResultManagerServiceTest.java

@@ -0,0 +1,84 @@
+package org.benchmarker.util;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+
+/**
+ * webClient 요청을 받을 mock 서버를 생성합니다
+ */
+public class MockServer {
+
+    /**
+     * Mock server instance
+     */
+    public static MockWebServer mockServer;
+    /**
+     * Opened mock server url
+     */
+    public String backendUrl;
+    private ObjectMapper objectMapper = new ObjectMapper();
+
+    @BeforeEach
+    void setUp() throws IOException {
+        // webClient 요청을 받을 mock 서버를 생성합니다
+        mockServer = new MockWebServer();
+        mockServer.start();
+        backendUrl = String.format(mockServer.url("/").toString());
+        System.out.println("Mock server url: " + backendUrl);
+    }
+
+    @AfterEach
+    void tearDown() throws IOException {
+        mockServer.shutdown();
+    }
+
+    /**
+     * Mock server에 응답을 추가합니다
+     *
+     * <p> 만약 Object 를 Json String 으로 변환할 수 없다면 "" 값이 응답으로 반환됩니다</p>
+     *
+     * @param object
+     */
+    public void addMockResponse(Object object) {
+        String json = "";
+        try {
+            json = objectMapper.writeValueAsString(object);
+        } catch (JsonProcessingException e) {
+            e.printStackTrace();
+        }
+
+        MockResponse response = new MockResponse()
+            .setHeader("Content-Type", "application/json")
+            .setBody(json);
+        mockServer.enqueue(response);
+    }
+
+    /**
+     * Mock server에 응답을 추가합니다. 반복 횟수를 지정할 수 있습니다.
+     *
+     * <p> 만약 Object 를 Json String 으로 변환할 수 없다면 "" 값이 응답으로 반환됩니다</p>
+     *
+     * @param object
+     * @param repeatCount
+     */
+    public void addMockResponse(Object object, int repeatCount) {
+        String json = "";
+        try {
+            json = objectMapper.writeValueAsString(object);
+        } catch (JsonProcessingException e) {
+            e.printStackTrace();
+        }
+
+        MockResponse response = new MockResponse()
+            .setHeader("Content-Type", "application/json")
+            .setBody(json);
+        for (int i = 0; i < repeatCount; i++) {
+            mockServer.enqueue(response);
+        }
+    }
+}