Add @CloudConfigUri

Closes gh-74

Author: rwinch

README.adoc

@@ -267,6 +267,16 @@ The value is calculated as `http://{host}:{port}{contextRoot}`.
 * port - a valid SpEL expression that determines the port to use for the URL (default port)
 * contextRoot - the context root to use (default is empty String)
 
+==== @CloudConfigUri
+
+This simplifies mapping the to the property `spring.cloud.config.uri`.
+The value is calculated as `http://{host}:{port}{contextRoot}` such that:
+
+* host - the host to use (default is `localhost`)
+* port - a valid SpEL expression that determines the port to use for the URL (default port)
+* contextRoot - the context root to use (default is empty String)
+
+
 ==== @OAuth2ClientProviderIssuerUri
 
 This provides a mapping to issuer-uri of https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.security.spring.security.oauth2.client.provider[the OAuth provider details].

spring-boot-testjars/src/main/java/org/springframework/experimental/boot/test/context/CloudConfigUri.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2023 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
+ *
+ *      https://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.experimental.boot.test.context;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.core.annotation.AliasFor;
+
+/**
+ * A composed annotation for {@link DynamicProperty} for specifying the property name
+ * "spring.cloud.config.uri" to the value "http://{host}:{port}{contextRoot}" such that:
+ *
+ * <ul>
+ * <li>port - the</li>
+ * </ul>
+ *
+ *
+ * <code>
+ * &#64;Bean
+ * &#64;CloudConfigUri
+ * CommonsExecWebServerFactoryBean configServer() {
+ *     return CommonsExecWebServerFactoryBean.builder()
+ *       // ...
+ *       .classpath((cp) -> cp
+ *         .entries(springBootStarter("web"))
+ *         .entries(new MavenClasspathEntry("org.springframework.cloud:spring-cloud-config-server:4.2.0"))
+ *       );
+ * }
+ * </code>
+ *
+ * @author Rob Winch
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@DynamicPortUrl(name = "spring.cloud.config.uri")
+public @interface CloudConfigUri {
+
+	/**
+	 * Allows overriding the value of the property. The default is "localhost".
+	 * @return the value of the property.
+	 */
+	@AliasFor(annotation = DynamicPortUrl.class)
+	String host() default "localhost";
+
+	/**
+	 * Allows specifying a context root. The default is to have no context root.
+	 * @return the name of the provider used in the property name.
+	 */
+	@AliasFor(annotation = DynamicPortUrl.class)
+	String contextRoot() default "";
+
+}

spring-boot-testjars/src/test/java/org/springframework/experimental/boot/test/context/DynamicPropertyRegistryPropertyFactoryTests.java

@@ -98,6 +98,24 @@ void dynamicPortUrlWhenOverride() throws Exception {
 		assertThat(registryProperty.value().get()).isEqualTo("http://127.0.0.1:1234/messages");
 	}
 
+	@Test
+	void cloudConfigUriWhenDefault() throws Exception {
+		MergedAnnotation<DynamicProperty> dynamicProperty = dynamicPropertyFrom("cloudConfigUriWithDefault");
+		DynamicPropertyRegistryProperty registryProperty = this.propertyFactory.createRegistryProperty(dynamicProperty,
+				() -> new WebServer());
+		assertThat(registryProperty.name()).isEqualTo("spring.cloud.config.uri");
+		assertThat(registryProperty.value().get()).isEqualTo("http://localhost:1234");
+	}
+
+	@Test
+	void cloudConfigUriWhenOverride() throws Exception {
+		MergedAnnotation<DynamicProperty> dynamicProperty = dynamicPropertyFrom("cloudConfigUriWithOverride");
+		DynamicPropertyRegistryProperty registryProperty = this.propertyFactory.createRegistryProperty(dynamicProperty,
+				() -> new WebServer());
+		assertThat(registryProperty.name()).isEqualTo("spring.cloud.config.uri");
+		assertThat(registryProperty.value().get()).isEqualTo("http://127.0.0.1:1234/config");
+	}
+
 	private MergedAnnotation<DynamicProperty> dynamicPropertyFrom(String methodName) throws NoSuchMethodException {
 		MergedAnnotations mergedAnnotations = MergedAnnotations.from(getClass().getDeclaredMethod(methodName));
 		return mergedAnnotations.get(DynamicProperty.class);
@@ -136,6 +154,14 @@ static void dynamicPortUrlWithDefault() {
 	static void dynamicPortUrlWithOverride() {
 	}
 
+	@CloudConfigUri
+	static void cloudConfigUriWithDefault() {
+	}
+
+	@CloudConfigUri(host = "127.0.0.1", contextRoot = "/config")
+	static void cloudConfigUriWithOverride() {
+	}
+
 	@Retention(RetentionPolicy.RUNTIME)
 	@DynamicProperty(name = "message", value = "'Hello {firstName}'")
 	@interface ValueWithVariable {