Commit 332f23a0 authored by Dave Syer's avatar Dave Syer Committed by Phillip Webb

Add parent properties to config props endpoint

parent bbac4ea9
...@@ -34,8 +34,9 @@ import com.fasterxml.jackson.databind.ObjectMapper; ...@@ -34,8 +34,9 @@ import com.fasterxml.jackson.databind.ObjectMapper;
* annotated classes. * annotated classes.
* *
* <p> * <p>
* To protect sensitive information from being exposed, configure property names by using * To protect sensitive information from being exposed, certain property values are masked
* <code>endpoints.configprops.keys_to_sanitize</code>. * if their names end with a set of configurable values (default "password" and "secret").
* Configure property names by using {@link #setKeysToSanitize(String[])}.
* *
* @author Christian Dupuis * @author Christian Dupuis
*/ */
...@@ -66,12 +67,17 @@ public class ConfigurationPropertiesReportEndpoint extends ...@@ -66,12 +67,17 @@ public class ConfigurationPropertiesReportEndpoint extends
this.keysToSanitize = keysToSanitize; this.keysToSanitize = keysToSanitize;
} }
@Override
@SuppressWarnings("unchecked")
@RequestMapping @RequestMapping
@ResponseBody @ResponseBody
public Map<String, Object> invoke() { public Map<String, Object> invoke() {
Map<String, Object> beans = this.context Map<String, Object> beans = extract(this.context);
return beans;
}
@SuppressWarnings("unchecked")
private Map<String, Object> extract(ApplicationContext context) {
Map<String, Object> beans = context
.getBeansWithAnnotation(ConfigurationProperties.class); .getBeansWithAnnotation(ConfigurationProperties.class);
// Serialize beans into map structure and sanitize values // Serialize beans into map structure and sanitize values
...@@ -81,6 +87,10 @@ public class ConfigurationPropertiesReportEndpoint extends ...@@ -81,6 +87,10 @@ public class ConfigurationPropertiesReportEndpoint extends
beans.put(entry.getKey(), sanitize(value)); beans.put(entry.getKey(), sanitize(value));
} }
if (context.getParent() != null) {
beans.put("parent", extract(context.getParent()));
}
return beans; return beans;
} }
......
/*
* Copyright 2013 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;
import java.util.Map;
import org.junit.After;
import org.junit.Test;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
public class ConfigurationPropertiesReportEndpointParentTests {
private AnnotationConfigApplicationContext context;
@After
public void close() {
if (this.context != null) {
this.context.close();
if (this.context.getParent() != null) {
((ConfigurableApplicationContext) this.context.getParent()).close();
}
}
}
@Test
public void testInvoke() throws Exception {
AnnotationConfigApplicationContext parent = new AnnotationConfigApplicationContext();
parent.register(Parent.class);
parent.refresh();
this.context = new AnnotationConfigApplicationContext();
this.context.setParent(parent);
this.context.register(Config.class);
this.context.refresh();
ConfigurationPropertiesReportEndpoint endpoint = this.context
.getBean(ConfigurationPropertiesReportEndpoint.class);
Map<String, Object> result = endpoint.invoke();
assertTrue(result.containsKey("parent"));
assertEquals(3, result.size()); // the endpoint, the test props and the parent
// System.err.println(result);
}
@Configuration
@EnableConfigurationProperties
public static class Parent {
@Bean
public TestProperties testProperties() {
return new TestProperties();
}
}
@Configuration
@EnableConfigurationProperties
public static class Config {
@Bean
public ConfigurationPropertiesReportEndpoint endpoint() {
return new ConfigurationPropertiesReportEndpoint();
}
@Bean
public TestProperties testProperties() {
return new TestProperties();
}
}
@ConfigurationProperties(name = "test")
public static class TestProperties {
private String myTestProperty = "654321";
public String getMyTestProperty() {
return this.myTestProperty;
}
public void setMyTestProperty(String myTestProperty) {
this.myTestProperty = myTestProperty;
}
}
}
...@@ -68,6 +68,15 @@ public class ConfigurationPropertiesReportEndpointTests extends ...@@ -68,6 +68,15 @@ public class ConfigurationPropertiesReportEndpointTests extends
assertEquals("******", nestedProperties.get("myTestProperty")); assertEquals("******", nestedProperties.get("myTestProperty"));
} }
@Configuration
@EnableConfigurationProperties
public static class Parent {
@Bean
public TestProperties testProperties() {
return new TestProperties();
}
}
@Configuration @Configuration
@EnableConfigurationProperties @EnableConfigurationProperties
public static class Config { public static class Config {
...@@ -82,29 +91,30 @@ public class ConfigurationPropertiesReportEndpointTests extends ...@@ -82,29 +91,30 @@ public class ConfigurationPropertiesReportEndpointTests extends
return new TestProperties(); return new TestProperties();
} }
@ConfigurationProperties(name = "test") }
public static class TestProperties {
private String dbPassword = "123456"; @ConfigurationProperties(name = "test")
public static class TestProperties {
private String myTestProperty = "654321"; private String dbPassword = "123456";
public String getDbPassword() { private String myTestProperty = "654321";
return this.dbPassword;
}
public void setDbPassword(String dbPassword) { public String getDbPassword() {
this.dbPassword = dbPassword; return this.dbPassword;
} }
public String getMyTestProperty() { public void setDbPassword(String dbPassword) {
return this.myTestProperty; this.dbPassword = dbPassword;
} }
public void setMyTestProperty(String myTestProperty) { public String getMyTestProperty() {
this.myTestProperty = myTestProperty; return this.myTestProperty;
} }
public void setMyTestProperty(String myTestProperty) {
this.myTestProperty = myTestProperty;
} }
} }
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment