Move shell.* to management.shell.*

This commit moves the `shell` namespace to `management.shell`

Closes spring-projectsgh-5703

Author: snicoll

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java

@@ -88,16 +88,17 @@
  * The default shell authentication method uses a username and password combination. If no
  * configuration is provided the default username is 'user' and the password will be
  * printed to console during application startup. Those default values can be overridden
- * by using {@code shell.auth.simple.username} and {@code shell.auth.simple.password}.
+ * by using {@code management.shell.auth.simple.username} and
+ * {@code management.shell.auth.simple.password}.
  * <p>
  * If a Spring Security {@link AuthenticationManager} is detected, this configuration will
  * create a {@link CRaSHPlugin} to forward shell authentication requests to Spring
- * Security. This authentication method will get enabled if {@code shell.auth} is set to
- * {@code spring} or if no explicit {@code shell.auth} is provided and a
- * {@link AuthenticationManager} is available. In the latter case shell access will be
- * restricted to users having roles that match those configured in
+ * Security. This authentication method will get enabled if {@code management.shell.auth.type}
+ * is set to {@code spring} or if no explicit {@code management.shell.auth} is provided
+ * and a {@link AuthenticationManager} is available. In the latter case shell access will
+ * be restricted to users having roles that match those configured in
  * {@link ManagementServerProperties}. Required roles can be overridden by
- * {@code shell.auth.spring.roles}.
+ * {@code management.shell.auth.spring.roles}.
  * <p>
  * To add customizations to the shell simply define beans of type {@link CRaSHPlugin} in
  * the application context. Those beans will get auto detected during startup and
@@ -109,7 +110,7 @@
  * <a href="http://www.crashub.org">crashub.org</a>. By default Boot will search for
  * commands using the following classpath scanning pattern {@code classpath*:/commands/**}
  * . To add different locations or override the default use
- * {@code shell.command_path_patterns} in your application configuration.
+ * {@code management.shell.command-path-patterns} in your application configuration.
  *
  * @author Christian Dupuis
  * @author Matt Benson
@@ -122,6 +123,8 @@
 		ManagementWebSecurityAutoConfiguration.class })
 public class CrshAutoConfiguration {
 
+	public static final String AUTH_PREFIX = ShellProperties.SHELL_PREFIX + ".auth";
+
 	private final ShellProperties properties;
 
 	public CrshAutoConfiguration(ShellProperties properties) {
@@ -140,21 +143,21 @@ public CrshBootstrapBean shellBootstrap() {
 	static class CrshAdditionalPropertiesConfiguration {
 
 		@Bean
-		@ConditionalOnProperty(prefix = "shell", name = "auth", havingValue = "jaas")
+		@ConditionalOnProperty(prefix = AUTH_PREFIX, name = "type", havingValue = "jaas")
 		@ConditionalOnMissingBean(CrshShellAuthenticationProperties.class)
 		public JaasAuthenticationProperties jaasAuthenticationProperties() {
 			return new JaasAuthenticationProperties();
 		}
 
 		@Bean
-		@ConditionalOnProperty(prefix = "shell", name = "auth", havingValue = "key")
+		@ConditionalOnProperty(prefix = AUTH_PREFIX, name = "type", havingValue = "key")
 		@ConditionalOnMissingBean(CrshShellAuthenticationProperties.class)
 		public KeyAuthenticationProperties keyAuthenticationProperties() {
 			return new KeyAuthenticationProperties();
 		}
 
 		@Bean
-		@ConditionalOnProperty(prefix = "shell", name = "auth", havingValue = "simple", matchIfMissing = true)
+		@ConditionalOnProperty(prefix = AUTH_PREFIX, name = "type", havingValue = "simple", matchIfMissing = true)
 		@ConditionalOnMissingBean(CrshShellAuthenticationProperties.class)
 		public SimpleAuthenticationProperties simpleAuthenticationProperties() {
 			return new SimpleAuthenticationProperties();
@@ -166,7 +169,7 @@ public SimpleAuthenticationProperties simpleAuthenticationProperties() {
 	 * Class to configure CRaSH to authenticate against Spring Security.
 	 */
 	@Configuration
-	@ConditionalOnProperty(prefix = "shell", name = "auth", havingValue = "spring", matchIfMissing = true)
+	@ConditionalOnProperty(prefix = AUTH_PREFIX, name = "type", havingValue = "spring", matchIfMissing = true)
 	@ConditionalOnBean(AuthenticationManager.class)
 	public static class AuthenticationManagerAdapterConfiguration {
 
@@ -185,12 +188,12 @@ public AuthenticationManagerAdapter shellAuthenticationManager() {
 		@Bean
 		@ConditionalOnMissingBean(CrshShellAuthenticationProperties.class)
 		public SpringAuthenticationProperties springAuthenticationProperties() {
-			// In case no shell.auth.type property is provided fall back to Spring Security
-			// based authentication and get role to access shell from
+			// In case no management.shell.auth.type property is provided fall back to
+			// Spring Security based authentication and get role to access shell from
 			// ManagementServerProperties.
-			// In case shell.auth.type is set to spring and roles are configured using
-			// shell.auth.spring.roles the below default role will be overridden by
-			// ConfigurationProperties.
+			// In case management.shell.auth.type is set to spring and roles are
+			// configured using shell.auth.spring.roles the below default role will be
+			// overridden by ConfigurationProperties.
 			SpringAuthenticationProperties authenticationProperties = new SpringAuthenticationProperties();
 			if (this.management != null) {
 				authenticationProperties.setRoles(

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java

@@ -37,10 +37,13 @@
  * @author Christian Dupuis
  * @author Phillip Webb
  * @author Eddú Meléndez
+ * @author Stephane Nicoll
  */
-@ConfigurationProperties(prefix = "shell", ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = ShellProperties.SHELL_PREFIX, ignoreUnknownFields = true)
 public class ShellProperties {
 
+	public static final String SHELL_PREFIX = "management.shell";
+
 	private static final Log logger = LogFactory.getLog(ShellProperties.class);
 
 	private final Auth auth = new Auth();
@@ -372,7 +375,7 @@ public Integer getPort() {
 	/**
 	 * Auth specific properties for JAAS authentication.
 	 */
-	@ConfigurationProperties(prefix = "shell.auth.jaas", ignoreUnknownFields = false)
+	@ConfigurationProperties(prefix = SHELL_PREFIX + ".auth.jaas", ignoreUnknownFields = false)
 	public static class JaasAuthenticationProperties
 			extends CrshShellAuthenticationProperties {
 
@@ -401,7 +404,7 @@ public String getDomain() {
 	/**
 	 * Auth specific properties for key authentication.
 	 */
-	@ConfigurationProperties(prefix = "shell.auth.key", ignoreUnknownFields = false)
+	@ConfigurationProperties(prefix = SHELL_PREFIX + ".auth.key", ignoreUnknownFields = false)
 	public static class KeyAuthenticationProperties
 			extends CrshShellAuthenticationProperties {
 
@@ -432,7 +435,7 @@ public String getPath() {
 	/**
 	 * Auth specific properties for simple authentication.
 	 */
-	@ConfigurationProperties(prefix = "shell.auth.simple", ignoreUnknownFields = false)
+	@ConfigurationProperties(prefix = SHELL_PREFIX + ".auth.simple", ignoreUnknownFields = false)
 	public static class SimpleAuthenticationProperties
 			extends CrshShellAuthenticationProperties {
 
@@ -508,7 +511,7 @@ public void setPassword(String password) {
 	/**
 	 * Auth specific properties for Spring authentication.
 	 */
-	@ConfigurationProperties(prefix = "shell.auth.spring", ignoreUnknownFields = false)
+	@ConfigurationProperties(prefix = SHELL_PREFIX + ".auth.spring", ignoreUnknownFields = false)
 	public static class SpringAuthenticationProperties
 			extends CrshShellAuthenticationProperties {
 

spring-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -255,7 +255,7 @@
     ]
   },
   {
-    "name": "shell.auth.type",
+    "name": "management.shell.auth.type",
     "values": [
       {
         "value": "simple",

spring-boot-actuator/src/test/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfigurationTests.java

@@ -37,6 +37,7 @@
 import org.junit.Test;
 
 import org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration;
+import org.springframework.boot.test.util.EnvironmentTestUtils;
 import org.springframework.boot.testutil.Matched;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -64,6 +65,7 @@
  * @author Andreas Ahlenstorf
  * @author Eddú Meléndez
  * @author Matt Benson
+ * @author Stephane Nicoll
  */
 @SuppressWarnings({ "rawtypes", "unchecked" })
 public class CrshAutoConfigurationTests {
@@ -79,10 +81,8 @@ public void close() {
 
 	@Test
 	public void testDisabledPlugins() throws Exception {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.disabled_plugins",
+		load("management.shell.disabled_plugins=" +
 				"termIOHandler, org.crsh.auth.AuthenticationPlugin, javaLanguage");
-		load(env);
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		assertThat(lifeCycle).isNotNull();
 		assertThat(lifeCycle.getContext().getPlugins(TermIOHandler.class))
@@ -98,9 +98,7 @@ public void testDisabledPlugins() throws Exception {
 
 	@Test
 	public void testAttributes() throws Exception {
-		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.register(CrshAutoConfiguration.class);
-		this.context.refresh();
+		load();
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		Map<String, Object> attributes = lifeCycle.getContext().getAttributes();
 		assertThat(attributes.containsKey("spring.version")).isTrue();
@@ -111,11 +109,8 @@ public void testAttributes() throws Exception {
 
 	@Test
 	public void testSshConfiguration() {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.ssh.enabled", "true");
-		env.setProperty("shell.ssh.port", "3333");
-		load(env);
-
+		load("management.shell.ssh.enabled=true",
+				"management.shell.ssh.port=3333");
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		assertThat(lifeCycle.getConfig().getProperty("crash.ssh.port")).isEqualTo("3333");
 		assertThat(lifeCycle.getConfig().getProperty("crash.ssh.auth_timeout"))
@@ -126,41 +121,29 @@ public void testSshConfiguration() {
 
 	@Test
 	public void testSshConfigurationWithKeyPath() {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.ssh.enabled", "true");
-		env.setProperty("shell.ssh.key_path", "~/.ssh/id.pem");
-		load(env);
+		load("management.shell.ssh.enabled=true",
+				"management.shell.ssh.key_path=~/.ssh/id.pem");
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		assertThat(lifeCycle.getConfig().getProperty("crash.ssh.keypath"))
 				.isEqualTo("~/.ssh/id.pem");
 	}
 
 	@Test
 	public void testSshConfigurationCustomTimeouts() {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.ssh.enabled", "true");
-		env.setProperty("shell.ssh.auth-timeout", "300000");
-		env.setProperty("shell.ssh.idle-timeout", "400000");
-		load(env);
+		load("management.shell.ssh.enabled=true",
+				"management.shell.ssh.auth-timeout=300000",
+				"management.shell.ssh.idle-timeout=400000");
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		assertThat(lifeCycle.getConfig().getProperty("crash.ssh.auth_timeout"))
 				.isEqualTo("300000");
 		assertThat(lifeCycle.getConfig().getProperty("crash.ssh.idle_timeout"))
 				.isEqualTo("400000");
 	}
 
-	private void load(MockEnvironment env) {
-		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.setEnvironment(env);
-		this.context.register(CrshAutoConfiguration.class);
-		this.context.refresh();
-	}
 
 	@Test
 	public void testCommandResolution() {
-		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.register(CrshAutoConfiguration.class);
-		this.context.refresh();
+		load();
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		int count = 0;
 		Iterator<Resource> resources = lifeCycle.getContext()
@@ -182,9 +165,7 @@ public void testCommandResolution() {
 
 	@Test
 	public void testDisabledCommandResolution() {
-		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.register(CrshAutoConfiguration.class);
-		this.context.refresh();
+		load();
 		PluginLifeCycle lifeCycle = this.context.getBean(PluginLifeCycle.class);
 		int count = 0;
 		Iterator<Resource> resources = lifeCycle.getContext()
@@ -229,11 +210,10 @@ public void testDefaultAuthenticationProvider() {
 
 	@Test
 	public void testJaasAuthenticationProvider() {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.auth.type", "jaas");
-		env.setProperty("shell.auth.jaas.domain", "my-test-domain");
 		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.setEnvironment(env);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"management.shell.auth.type=jaas",
+				"management.shell.auth.jaas.domain=my-test-domain");
 		this.context.setServletContext(new MockServletContext());
 		this.context.register(SecurityConfiguration.class);
 		this.context.register(CrshAutoConfiguration.class);
@@ -246,11 +226,10 @@ public void testJaasAuthenticationProvider() {
 
 	@Test
 	public void testKeyAuthenticationProvider() {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.auth.type", "key");
-		env.setProperty("shell.auth.key.path", "~/test.pem");
 		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.setEnvironment(env);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"management.shell.auth.type=key",
+				"management.shell.auth.key.path=~/test.pem");
 		this.context.setServletContext(new MockServletContext());
 		this.context.register(SecurityConfiguration.class);
 		this.context.register(CrshAutoConfiguration.class);
@@ -263,12 +242,11 @@ public void testKeyAuthenticationProvider() {
 
 	@Test
 	public void testSimpleAuthenticationProvider() throws Exception {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.auth.type", "simple");
-		env.setProperty("shell.auth.simple.user.name", "user");
-		env.setProperty("shell.auth.simple.user.password", "password");
 		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.setEnvironment(env);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"management.shell.auth.type=simple",
+				"management.shell.auth.simple.user.name=user",
+				"management.shell.auth.simple.user.password=password");
 		this.context.setServletContext(new MockServletContext());
 		this.context.register(SecurityConfiguration.class);
 		this.context.register(CrshAutoConfiguration.class);
@@ -293,10 +271,9 @@ public void testSimpleAuthenticationProvider() throws Exception {
 
 	@Test
 	public void testSpringAuthenticationProvider() throws Exception {
-		MockEnvironment env = new MockEnvironment();
-		env.setProperty("shell.auth.type", "spring");
 		this.context = new AnnotationConfigWebApplicationContext();
-		this.context.setEnvironment(env);
+		EnvironmentTestUtils.addEnvironment(this.context,
+				"management.shell.auth.type=spring");
 		this.context.setServletContext(new MockServletContext());
 		this.context.register(SecurityConfiguration.class);
 		this.context.register(CrshAutoConfiguration.class);
@@ -345,6 +322,14 @@ public void testSpringAuthenticationProviderAsDefaultConfiguration()
 				SecurityConfiguration.PASSWORD)).isFalse();
 	}
 
+	private void load(String... environment) {
+		this.context = new AnnotationConfigWebApplicationContext();
+		EnvironmentTestUtils.addEnvironment(this.context, environment);
+		this.context.register(CrshAutoConfiguration.class);
+		this.context.refresh();
+	}
+
+
 	@Configuration
 	public static class SecurityConfiguration {