Merge pull request #9 from pavelfomin/feature/custom-actuator

custom actuator

build.gradle

@@ -33,7 +33,6 @@ dependencies {
 
  testImplementation "org.springframework.boot:spring-boot-starter-test"
  testImplementation "org.springframework.security:spring-security-test"
- testImplementation "org.hamcrest:hamcrest:2.2"
 }
 
 repositories {

gradle.properties

@@ -1,4 +1,4 @@
-version=2.5.9.2
+version=2.5.9.3
 
 springBootVersion=2.5.9
 springBootDependencyManagement=1.0.11.RELEASE

pom.xml

@@ -4,7 +4,7 @@
 
  <groupId>com.droidablebee</groupId>
  <artifactId>spring-boot-rest-example</artifactId>
- <version>2.5.9.2</version>
+ <version>2.5.9.3</version>
  <name>Spring boot example with REST and spring data JPA</name>
 
  <packaging>jar</packaging>

src/main/java/com/droidablebee/springboot/rest/config/WebConfiguration.java

@@ -5,10 +5,11 @@
 import org.springframework.http.MediaType;
 import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
 import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
 @Configuration
-public class WebConfiguration extends WebMvcConfigurerAdapter {
+public class WebConfiguration implements WebMvcConfigurer {
 
  @Override
  public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {

src/main/java/com/droidablebee/springboot/rest/endpoint/CustomActuatorEndpoint.java

@@ -0,0 +1,29 @@
+package com.droidablebee.springboot.rest.endpoint;
+
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Component;
+import org.springframework.util.LinkedMultiValueMap;
+
+/**
+ * Custom actuator endpoint.
+ */
+@Component
+@Endpoint(id = CustomActuatorEndpoint.CUSTOM)
+public class CustomActuatorEndpoint {
+
+ static final String CUSTOM = "custom";
+
+ @ReadOperation
+ public ResponseEntity<?> custom() {
+
+ return ResponseEntity.ok(createCustomMap());
+ }
+
+ protected LinkedMultiValueMap<String, Number> createCustomMap() {
+
+ return new LinkedMultiValueMap<>();
+ }
+
+}

src/main/java/com/droidablebee/springboot/rest/endpoint/InfoWebEndpointExtension.java

@@ -0,0 +1,38 @@
+package com.droidablebee.springboot.rest.endpoint;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
+import org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension;
+import org.springframework.boot.actuate.info.InfoEndpoint;
+import org.springframework.stereotype.Component;
+import org.springframework.util.LinkedMultiValueMap;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Component
+@EndpointWebExtension(endpoint = InfoEndpoint.class)
+public class InfoWebEndpointExtension {
+
+ @Autowired
+ private InfoEndpoint delegate;
+
+ @ReadOperation
+ public WebEndpointResponse<Map<String, ?>> info() {
+
+ Map<String, Object> info = new HashMap<>();
+
+ //add existing values from unmodifiable map
+ info.putAll(this.delegate.info());
+
+ info.putAll(createCustomMap());
+
+ return new WebEndpointResponse<>(info);
+ }
+
+ protected LinkedMultiValueMap<String, Number> createCustomMap() {
+
+ return new LinkedMultiValueMap<>();
+ }
+}

src/test/java/com/droidablebee/springboot/rest/endpoint/ActuatorEndpointStubbedTest.java

@@ -0,0 +1,70 @@
+package com.droidablebee.springboot.rest.endpoint;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.SpyBean;
+import org.springframework.util.LinkedMultiValueMap;
+
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.isA;
+import static org.mockito.Mockito.when;
+import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.jwt;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest
+public class ActuatorEndpointStubbedTest extends BaseEndpointTest {
+
+ @SpyBean
+ private CustomActuatorEndpoint customActuatorEndpoint;
+
+ @SpyBean
+ private InfoWebEndpointExtension infoWebEndpointExtension;
+
+ @Test
+ public void getCustomAuthorized() throws Exception {
+
+ LinkedMultiValueMap<String, Number> custom = new LinkedMultiValueMap<>();
+ custom.add("custom1", 11);
+ custom.add("custom1", 12);
+ custom.add("custom2", 21);
+
+ when(customActuatorEndpoint.createCustomMap()).thenReturn(custom);
+
+ mockMvc.perform(get("/actuator/" + CustomActuatorEndpoint.CUSTOM).with(jwt()))
+ .andDo(print())
+ .andExpect(status().isOk())
+ .andExpect(content().contentType(JSON_MEDIA_TYPE))
+ .andExpect(jsonPath("$.custom1", is(custom.get("custom1"))))
+ .andExpect(jsonPath("$.custom2", is(custom.get("custom2"))))
+ ;
+ }
+
+ @Test
+ public void getInfoExtended() throws Exception {
+
+ LinkedMultiValueMap<String, Number> custom = new LinkedMultiValueMap<>();
+ custom.add("custom1", 11);
+ custom.add("custom1", 12);
+ custom.add("custom2", 21);
+
+ when(infoWebEndpointExtension.createCustomMap()).thenReturn(custom);
+
+ mockMvc.perform(get("/actuator/info"))
+ .andDo(print())
+ .andExpect(status().isOk())
+ .andExpect(content().contentType(JSON_MEDIA_TYPE))
+ .andExpect(jsonPath("$.build", isA(Object.class)))
+ .andExpect(jsonPath("$.build.version", isA(String.class)))
+ .andExpect(jsonPath("$.build.artifact", is("spring-boot-rest-example")))
+ .andExpect(jsonPath("$.build.group", is("com.droidablebee")))
+ .andExpect(jsonPath("$.build.time", isA(Number.class)))
+ .andExpect(jsonPath("$.custom1", is(custom.get("custom1"))))
+ .andExpect(jsonPath("$.custom2", is(custom.get("custom2"))))
+ ;
+ }
+
+}

src/test/java/com/droidablebee/springboot/rest/endpoint/ActuatorEndpointTest.java

@@ -93,4 +93,24 @@ public void getEnvAuthorized() throws Exception {
  ;
  }
 
+ @Test
+ public void getCustom() throws Exception {
+
+ mockMvc.perform(get("/actuator/"+ CustomActuatorEndpoint.CUSTOM))
+ .andDo(print())
+ .andExpect(status().isUnauthorized())
+ ;
+ }
+
+ @Test
+ public void getCustomAuthorized() throws Exception {
+
+ mockMvc.perform(get("/actuator/"+ CustomActuatorEndpoint.CUSTOM).with(jwt()))
+ .andDo(print())
+ .andExpect(status().isOk())
+ .andExpect(content().contentType(JSON_MEDIA_TYPE))
+ .andExpect(content().string("{}"))
+ ;
+ }
+
 }

src/test/java/com/droidablebee/springboot/rest/endpoint/PersonEndpointMockedTest.java → src/test/java/com/droidablebee/springboot/rest/endpoint/PersonEndpointStubbedTest.java

@@ -20,7 +20,7 @@
 
 @SpringBootTest
 @Transactional
-public class PersonEndpointMockedTest extends BaseEndpointTest {
+public class PersonEndpointStubbedTest extends BaseEndpointTest {
 
  @MockBean
  private PersonService personService;

src/test/resources/application-default.yml

@@ -3,4 +3,4 @@ management:
  endpoints:
  web:
  exposure:
- include: info,health,env
+ include: info,health,env,custom