#32 : Started work on restart endpoint

gazbert · gazbert · commit 55e3c676a988 · 2019-06-02T17:57:27.000+01:00
diff --git a/bxbot-core/src/main/java/com/gazbert/bxbot/BXBot.java b/bxbot-core/src/main/java/com/gazbert/bxbot/BXBot.java
@@ -20,7 +20,6 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-
 package com.gazbert.bxbot;
 
 import com.gazbert.bxbot.core.engine.TradingEngine;
@@ -30,7 +29,7 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 /**
- * BX-bot - here be the main boot app.
+ * The BX-bot application.
  *
  * @author gazbert
  */
diff --git a/bxbot-rest-api/pom.xml b/bxbot-rest-api/pom.xml
@@ -57,6 +57,14 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-log4j2</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
@@ -90,6 +98,28 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>jacoco-check</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <rule>
+                                    <element>PACKAGE</element>
+                                    <limits>
+                                        <limit>
+                                            <counter>LINE</counter>
+                                            <value>COVEREDRATIO</value>
+                                            <minimum>0.8</minimum>
+                                        </limit>
+                                    </limits>
+                                </rule>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
             </plugin>
         </plugins>
     </build>
diff --git a/bxbot-rest-api/src/main/java/com/gazbert/bxbot/rest/api/v1/runtime/BotRestartController.java b/bxbot-rest-api/src/main/java/com/gazbert/bxbot/rest/api/v1/runtime/BotRestartController.java
@@ -0,0 +1,73 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 gazbert
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.gazbert.bxbot.rest.api.v1.runtime;
+
+import com.gazbert.bxbot.services.runtime.BotRestartService;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.security.core.userdetails.User;;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import static com.gazbert.bxbot.rest.api.v1.runtime.AbstractRuntimeController.RUNTIME_ENDPOINT_BASE_URI;
+
+/**
+ * Controller for directing Bot restart requests.
+ *
+ * @author gazbert
+ * @since 1.0
+ */
+@RestController
+@RequestMapping(RUNTIME_ENDPOINT_BASE_URI)
+public class BotRestartController extends AbstractRuntimeController {
+
+    private static final Logger LOG = LogManager.getLogger();
+    private static final String RESTART_RESOURCE_PATH = "/restart";
+    private final BotRestartService botRestartService;
+
+    @Autowired
+    public BotRestartController(BotRestartService botRestartService) {
+        this.botRestartService = botRestartService;
+    }
+
+    /**
+     * Restarts the bot.
+     *
+     * @param user the authenticated user making the request.
+     * @return 200 OK on success, some other HTTP status code otherwise.
+     */
+    @RequestMapping(value = RESTART_RESOURCE_PATH, method = RequestMethod.POST)
+    public ResponseEntity<?> restart(@AuthenticationPrincipal User user) {
+
+        LOG.info("POST " + RESTART_RESOURCE_PATH + " - restart() - caller: " + user.getUsername());
+
+        botRestartService.restart();
+        return buildResponseEntity(null, HttpStatus.OK);
+    }
+}
+
diff --git a/bxbot-rest-api/src/main/java/com/gazbert/bxbot/rest/api/v1/runtime/BotStatusController.java b/bxbot-rest-api/src/main/java/com/gazbert/bxbot/rest/api/v1/runtime/BotStatusController.java
@@ -37,7 +37,7 @@
 import static com.gazbert.bxbot.rest.api.v1.runtime.AbstractRuntimeController.RUNTIME_ENDPOINT_BASE_URI;
 
 /**
- * Controller for directing Bot Status requests.
+ * Controller for directing Bot status requests.
  *
  * @author gazbert
  * @since 1.0
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestEmailAlertsConfigController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestEmailAlertsConfigController.java
@@ -31,6 +31,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -73,6 +74,10 @@ public class TestEmailAlertsConfigController extends AbstractConfigControllerTes
     @MockBean
     private TradingEngine tradingEngine;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
+
     @Before
     public void setupBeforeEachTest() {
         mockMvc = MockMvcBuilders.webAppContextSetup(ctx).addFilter(springSecurityFilterChain).build();
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestEngineConfigController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestEngineConfigController.java
@@ -31,6 +31,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -77,6 +78,10 @@ public class TestEngineConfigController extends AbstractConfigControllerTest {
     @MockBean
     private EmailAlerter emailAlerter;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
+
     @Before
     public void setupBeforeEachTest() {
         mockMvc = MockMvcBuilders.webAppContextSetup(ctx).addFilter(springSecurityFilterChain).build();
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestExchangeConfigController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestExchangeConfigController.java
@@ -32,6 +32,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -95,6 +96,10 @@ public class TestExchangeConfigController extends AbstractConfigControllerTest {
     @MockBean
     private EmailAlerter emailAlerter;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
+
     @Before
     public void setupBeforeEachTest() {
         mockMvc = MockMvcBuilders.webAppContextSetup(ctx).addFilter(springSecurityFilterChain).build();
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestMarketConfigController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestMarketConfigController.java
@@ -31,6 +31,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -89,6 +90,9 @@ public class TestMarketConfigController extends AbstractConfigControllerTest {
     @MockBean
     private TradingEngine tradingEngine;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
 
     @Before
     public void setupBeforeEachTest() {
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestStrategyConfigController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/config/TestStrategyConfigController.java
@@ -31,6 +31,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -92,6 +93,10 @@ public class TestStrategyConfigController extends AbstractConfigControllerTest {
     @MockBean
     private EmailAlerter emailAlerter;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
+
     @Before
     public void setupBeforeEachTest() {
         mockMvc = MockMvcBuilders.webAppContextSetup(ctx).addFilter(springSecurityFilterChain).build();
diff --git a/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/runtime/TestBotStatusController.java b/bxbot-rest-api/src/test/java/com/gazbert/bxbot/rest/api/v1/runtime/TestBotStatusController.java
@@ -32,6 +32,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.cloud.context.restart.RestartEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.context.web.WebAppConfiguration;
@@ -78,6 +79,10 @@ public class TestBotStatusController extends AbstractRuntimeControllerTest {
     @MockBean
     private EmailAlerter emailAlerter;
 
+    // Need this even though not used in the test directly because Spring loads it on startup...
+    @MockBean
+    private RestartEndpoint restartEndpoint;
+
     @Before
     public void setupBeforeEachTest() {
         mockMvc = MockMvcBuilders.webAppContextSetup(ctx).addFilter(springSecurityFilterChain).build();
diff --git a/bxbot-services/pom.xml b/bxbot-services/pom.xml
@@ -44,6 +44,14 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-log4j2</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
diff --git a/bxbot-services/src/main/java/com/gazbert/bxbot/services/impl/EngineConfigServiceImpl.java b/bxbot-services/src/main/java/com/gazbert/bxbot/services/impl/EngineConfigServiceImpl.java
@@ -20,7 +20,6 @@
  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-
 package com.gazbert.bxbot.services.impl;
 
 import com.gazbert.bxbot.domain.engine.EngineConfig;
diff --git a/bxbot-services/src/main/java/com/gazbert/bxbot/services/runtime/BotRestartService.java b/bxbot-services/src/main/java/com/gazbert/bxbot/services/runtime/BotRestartService.java
@@ -0,0 +1,33 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 gazbert
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.gazbert.bxbot.services.runtime;
+
+/**
+ * The Bot restart service.
+ *
+ * @author gazbert
+ */
+public interface BotRestartService {
+
+    void restart();
+}
diff --git a/bxbot-services/src/main/java/com/gazbert/bxbot/services/runtime/impl/BotRestartServiceImpl.java b/bxbot-services/src/main/java/com/gazbert/bxbot/services/runtime/impl/BotRestartServiceImpl.java
@@ -0,0 +1,54 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 gazbert
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.gazbert.bxbot.services.runtime.impl;
+
+import com.gazbert.bxbot.services.runtime.BotRestartService;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cloud.context.restart.RestartEndpoint;
+import org.springframework.stereotype.Service;
+
+/**
+ * Implementation of the Bot restart service.
+ *
+ * @author gazbert
+ */
+@Service("botRestartService")
+public class BotRestartServiceImpl implements BotRestartService {
+
+    private static final Logger LOG = LogManager.getLogger();
+
+    private RestartEndpoint restartEndpoint;
+
+    @Autowired
+    public BotRestartServiceImpl(RestartEndpoint restartEndpoint) {
+        this.restartEndpoint = restartEndpoint;
+    }
+
+    @Override
+    public void restart() {
+        final Object result = restartEndpoint.restart();
+        LOG.info(() -> "Restart result: " + result);
+    }
+}
diff --git a/config/application.properties b/config/application.properties
@@ -7,7 +7,7 @@
 # The port the Spring Boot container will listen on for incoming HTTP requests.
 # Defaults to 8080 if not set. Setting it to -1 disables the port.
 # REST API not ready for production yet, so port is disabled.
-server.port=-1
+server.port=8080
 
 # The Spring Boot management port.
 # Setting it to -1 disables the port.
@@ -25,8 +25,11 @@ logging.config=./config/log4j2.xml
 
 # Used to access the bot's REST API.
 # REST API not ready for production yet, so security is disabled.
-spring.security.user.name=bxbot-ui-server
+spring.security.user.name=bxbot-ui
 spring.security.user.password=changeme
+management.endpoint.restart.enabled=true
+
+# TODO - what do we *really* need enabled?
 #management.security.enabled=true
 #management.security.roles=ACTUATOR
 
diff --git a/pom.xml b/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`import static com.gazbert.bxbot.rest.api.v1.runtime.AbstractRuntimeController.RUNTIME_ENDPOINT_BASE_URI;`
`38`	`38`
`39`	`39`	`/**`
`40`		`- * Controller for directing Bot Status requests.`
	`40`	`+ * Controller for directing Bot status requests.`
`41`	`41`	`*`
`42`	`42`	`* @author gazbert`
`43`	`43`	`* @since 1.0`