Browse Source
Previously, only invocations of /metricName/ would honour the enabled property and return a not found (404) response. For endpoints which support nested paths, access to /metricName/foo would ignore the enabled flag and return an OK (200) response. Furthermore, there was a comment in EndpointMvcAdapter that suggested that an endpoint shouldn’t be called when it is disabled, however this was not the case. This commit updates EndpointWebMvcAutoConfiguration and JolokiaAutoConfiguration to only register their MvcEndpoint beans if the underlying endpoint is enabled. This means that an EndpointMvcAdapter should not be called if its delegate is disabled, making the comment described above accurate. The check for the delegate being enabled has been retained so as not to rely upon the auto-configurations’ behaviour. The methods which handle nested paths (MetricsMvcEndpoint.value() and EnvironmentMvcEndpoint.value()) have been updated to add the same check for the enablement of their delegate. Fixes gh-2767pull/2842/head
Andy Wilkinson
11 years ago
11 changed files with 338 additions and 46 deletions
@ -0,0 +1,124 @@
@@ -0,0 +1,124 @@
|
||||
/* |
||||
* Copyright 2012-2015 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.endpoint.mvc; |
||||
|
||||
import java.util.Arrays; |
||||
import java.util.Collection; |
||||
|
||||
import org.junit.Before; |
||||
import org.junit.Test; |
||||
import org.junit.runner.RunWith; |
||||
import org.springframework.beans.factory.annotation.Autowired; |
||||
import org.springframework.boot.actuate.autoconfigure.EndpointWebMvcAutoConfiguration; |
||||
import org.springframework.boot.actuate.autoconfigure.ManagementServerPropertiesAutoConfiguration; |
||||
import org.springframework.boot.actuate.endpoint.MetricsEndpoint; |
||||
import org.springframework.boot.actuate.endpoint.PublicMetrics; |
||||
import org.springframework.boot.actuate.endpoint.mvc.MetricsMvcEndpointTests.TestConfiguration; |
||||
import org.springframework.boot.actuate.metrics.Metric; |
||||
import org.springframework.boot.test.SpringApplicationConfiguration; |
||||
import org.springframework.context.annotation.Bean; |
||||
import org.springframework.context.annotation.Configuration; |
||||
import org.springframework.context.annotation.Import; |
||||
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; |
||||
import org.springframework.test.context.web.WebAppConfiguration; |
||||
import org.springframework.test.web.servlet.MockMvc; |
||||
import org.springframework.test.web.servlet.setup.MockMvcBuilders; |
||||
import org.springframework.web.context.WebApplicationContext; |
||||
import org.springframework.web.servlet.config.annotation.EnableWebMvc; |
||||
|
||||
import static org.hamcrest.Matchers.containsString; |
||||
import static org.hamcrest.Matchers.equalTo; |
||||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; |
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; |
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; |
||||
|
||||
/** |
||||
* Tests for {@link MetricsMvcEndpoint} |
||||
* |
||||
* @author Andy Wilkinson |
||||
*/ |
||||
@RunWith(SpringJUnit4ClassRunner.class) |
||||
@SpringApplicationConfiguration(classes = { TestConfiguration.class }) |
||||
@WebAppConfiguration |
||||
public class MetricsMvcEndpointTests { |
||||
|
||||
@Autowired |
||||
private WebApplicationContext context; |
||||
|
||||
private MockMvc mvc; |
||||
|
||||
@Before |
||||
public void setUp() { |
||||
this.context.getBean(MetricsEndpoint.class).setEnabled(true); |
||||
this.mvc = MockMvcBuilders.webAppContextSetup(this.context).build(); |
||||
} |
||||
|
||||
@Test |
||||
public void home() throws Exception { |
||||
this.mvc.perform(get("/metrics")).andExpect(status().isOk()) |
||||
.andExpect(content().string(containsString("\"foo\":1"))); |
||||
} |
||||
|
||||
@Test |
||||
public void homeWhenDisabled() throws Exception { |
||||
this.context.getBean(MetricsEndpoint.class).setEnabled(false); |
||||
this.mvc.perform(get("/metrics")).andExpect(status().isNotFound()); |
||||
} |
||||
|
||||
@Test |
||||
public void specificMetric() throws Exception { |
||||
this.mvc.perform(get("/metrics/foo")).andExpect(status().isOk()) |
||||
.andExpect(content().string(equalTo("1"))); |
||||
} |
||||
|
||||
@Test |
||||
public void specificMetricWhenDisabled() throws Exception { |
||||
this.context.getBean(MetricsEndpoint.class).setEnabled(false); |
||||
this.mvc.perform(get("/metrics/foo")).andExpect(status().isNotFound()); |
||||
} |
||||
|
||||
@Test |
||||
public void specificMetricThatDoesNotExist() throws Exception { |
||||
this.mvc.perform(get("/metrics/bar")).andExpect(status().isNotFound()); |
||||
} |
||||
|
||||
@Import({ EndpointWebMvcAutoConfiguration.class, |
||||
ManagementServerPropertiesAutoConfiguration.class }) |
||||
@EnableWebMvc |
||||
@Configuration |
||||
public static class TestConfiguration { |
||||
|
||||
@Bean |
||||
public MetricsEndpoint endpoint() { |
||||
return new MetricsEndpoint(new PublicMetrics() { |
||||
|
||||
@Override |
||||
public Collection<Metric<?>> metrics() { |
||||
return Arrays.<Metric<?>> asList(new Metric<Integer>("foo", 1)); |
||||
} |
||||
|
||||
}); |
||||
} |
||||
|
||||
@Bean |
||||
public MetricsMvcEndpoint mvcEndpoint() { |
||||
return new MetricsMvcEndpoint(endpoint()); |
||||
} |
||||
|
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue