-
Notifications
You must be signed in to change notification settings - Fork 40.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add direct WebFlux and WebMvc endpoint support
Add `@ControllerEndpoint` and `@RestControllerEndpoint` annotations that can be used to develop a Spring-only request mapped endpoint. Both Spring MVC and Spring WebFlux are supported. This feature is primarily for use when deeper Spring integration is required or when existing Spring Boot 1.5 projects want to migrate to Spring Boot 2.0 without re-writing existing endpoints. It comes at the expense of portability, since such endpoints will be missing from Jersey. Fixes gh-10257
- Loading branch information
Showing
33 changed files
with
1,882 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
...boot/actuate/autoconfigure/integrationtest/ControllerEndpointWebFluxIntegrationTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * Copyright 2012-2018 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.boot.actuate.autoconfigure.integrationtest; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Test; | ||
|
|
||
| import org.springframework.boot.actuate.autoconfigure.audit.AuditAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.beans.BeansEndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.web.reactive.ReactiveManagementContextAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.web.server.ManagementContextAutoConfiguration; | ||
| import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpoint; | ||
| import org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint; | ||
| import org.springframework.boot.autoconfigure.ImportAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration; | ||
| import org.springframework.boot.test.util.TestPropertyValues; | ||
| import org.springframework.boot.web.reactive.context.AnnotationConfigReactiveWebApplicationContext; | ||
| import org.springframework.security.authentication.TestingAuthenticationToken; | ||
| import org.springframework.security.test.context.TestSecurityContextHolder; | ||
| import org.springframework.test.web.reactive.server.WebTestClient; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
|
|
||
| /** | ||
| * Integration tests for the Actuator's WebFlux {@link ControllerEndpoint controller | ||
| * endpoints}. | ||
| * | ||
| * @author Phillip Webb | ||
| */ | ||
| public class ControllerEndpointWebFluxIntegrationTests { | ||
|
|
||
| private AnnotationConfigReactiveWebApplicationContext context; | ||
|
|
||
| @After | ||
| public void close() { | ||
| TestSecurityContextHolder.clearContext(); | ||
| this.context.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void endpointsCanBeAccessed() throws Exception { | ||
| TestSecurityContextHolder.getContext().setAuthentication( | ||
| new TestingAuthenticationToken("user", "N/A", "ROLE_ACTUATOR")); | ||
| this.context = new AnnotationConfigReactiveWebApplicationContext(); | ||
| this.context.register(DefaultConfiguration.class, ExampleController.class); | ||
| TestPropertyValues.of("management.endpoints.web.expose=*").applyTo(this.context); | ||
| this.context.refresh(); | ||
| WebTestClient webClient = WebTestClient.bindToApplicationContext(this.context) | ||
| .build(); | ||
| webClient.get().uri("/actuator/example").exchange().expectStatus().isOk(); | ||
| } | ||
|
|
||
| @ImportAutoConfiguration({ JacksonAutoConfiguration.class, | ||
| HttpMessageConvertersAutoConfiguration.class, EndpointAutoConfiguration.class, | ||
| WebEndpointAutoConfiguration.class, | ||
| ReactiveManagementContextAutoConfiguration.class, | ||
| AuditAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class, | ||
| WebFluxAutoConfiguration.class, ManagementContextAutoConfiguration.class, | ||
| AuditAutoConfiguration.class, DispatcherServletAutoConfiguration.class, | ||
| BeansEndpointAutoConfiguration.class }) | ||
| static class DefaultConfiguration { | ||
|
|
||
| } | ||
|
|
||
| @RestControllerEndpoint(id = "example") | ||
| static class ExampleController { | ||
|
|
||
| @GetMapping("/") | ||
| public String example() { | ||
| return "Example"; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
134 changes: 134 additions & 0 deletions
134
.../boot/actuate/autoconfigure/integrationtest/ControllerEndpointWebMvcIntegrationTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * Copyright 2012-2018 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.boot.actuate.autoconfigure.integrationtest; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Test; | ||
|
|
||
| import org.springframework.boot.actuate.autoconfigure.audit.AuditAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.beans.BeansEndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.web.server.ManagementContextAutoConfiguration; | ||
| import org.springframework.boot.actuate.autoconfigure.web.servlet.ServletManagementContextAutoConfiguration; | ||
| import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpoint; | ||
| import org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint; | ||
| import org.springframework.boot.autoconfigure.ImportAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration; | ||
| import org.springframework.boot.test.util.TestPropertyValues; | ||
| import org.springframework.context.annotation.Import; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.mock.web.MockServletContext; | ||
| import org.springframework.security.authentication.TestingAuthenticationToken; | ||
| import org.springframework.security.test.context.TestSecurityContextHolder; | ||
| import org.springframework.test.web.servlet.MockMvc; | ||
| import org.springframework.test.web.servlet.setup.DefaultMockMvcBuilder; | ||
| import org.springframework.test.web.servlet.setup.MockMvcBuilders; | ||
| import org.springframework.test.web.servlet.setup.MockMvcConfigurer; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.context.support.AnnotationConfigWebApplicationContext; | ||
|
|
||
| import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity; | ||
| import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; | ||
| import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; | ||
|
|
||
| /** | ||
| * Integration tests for the Actuator's MVC {@link ControllerEndpoint controller | ||
| * endpoints}. | ||
| * | ||
| * @author Phillip Webb | ||
| * @author Andy Wilkinson | ||
| */ | ||
| public class ControllerEndpointWebMvcIntegrationTests { | ||
|
|
||
| private AnnotationConfigWebApplicationContext context; | ||
|
|
||
| @After | ||
| public void close() { | ||
| TestSecurityContextHolder.clearContext(); | ||
| this.context.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void endpointsAreSecureByDefault() throws Exception { | ||
| this.context = new AnnotationConfigWebApplicationContext(); | ||
| this.context.register(SecureConfiguration.class, ExampleController.class); | ||
| MockMvc mockMvc = createSecureMockMvc(); | ||
| mockMvc.perform(get("/actuator/example").accept(MediaType.APPLICATION_JSON)) | ||
| .andExpect(status().isUnauthorized()); | ||
| } | ||
|
|
||
| @Test | ||
| public void endpointsCanBeAccessed() throws Exception { | ||
| TestSecurityContextHolder.getContext().setAuthentication( | ||
| new TestingAuthenticationToken("user", "N/A", "ROLE_ACTUATOR")); | ||
| this.context = new AnnotationConfigWebApplicationContext(); | ||
| this.context.register(SecureConfiguration.class, ExampleController.class); | ||
| TestPropertyValues.of("management.endpoints.web.base-path:/management", | ||
| "management.endpoints.web.expose=*").applyTo(this.context); | ||
| MockMvc mockMvc = createSecureMockMvc(); | ||
| mockMvc.perform(get("/management/example")).andExpect(status().isOk()); | ||
| } | ||
|
|
||
| private MockMvc createSecureMockMvc() { | ||
| return doCreateMockMvc(springSecurity()); | ||
| } | ||
|
|
||
| private MockMvc doCreateMockMvc(MockMvcConfigurer... configurers) { | ||
| this.context.setServletContext(new MockServletContext()); | ||
| this.context.refresh(); | ||
| DefaultMockMvcBuilder builder = MockMvcBuilders.webAppContextSetup(this.context); | ||
| for (MockMvcConfigurer configurer : configurers) { | ||
| builder.apply(configurer); | ||
| } | ||
| return builder.build(); | ||
| } | ||
|
|
||
| @ImportAutoConfiguration({ JacksonAutoConfiguration.class, | ||
| HttpMessageConvertersAutoConfiguration.class, EndpointAutoConfiguration.class, | ||
| WebEndpointAutoConfiguration.class, | ||
| ServletManagementContextAutoConfiguration.class, AuditAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class, WebMvcAutoConfiguration.class, | ||
| ManagementContextAutoConfiguration.class, AuditAutoConfiguration.class, | ||
| DispatcherServletAutoConfiguration.class, | ||
| BeansEndpointAutoConfiguration.class }) | ||
| static class DefaultConfiguration { | ||
|
|
||
| } | ||
|
|
||
| @Import(DefaultConfiguration.class) | ||
| @ImportAutoConfiguration({ SecurityAutoConfiguration.class }) | ||
| static class SecureConfiguration { | ||
|
|
||
| } | ||
|
|
||
| @RestControllerEndpoint(id = "example") | ||
| static class ExampleController { | ||
|
|
||
| @GetMapping("/") | ||
| public String example() { | ||
| return "Example"; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.