From b5022e3660516e4fd7c5f3f9d4ff7e1bdcb3a3b2 Mon Sep 17 00:00:00 2001
From: Tommy Ludwig <thomas.ludwig@rakuten.com>
Date: Mon, 6 Nov 2017 19:03:58 +0900
Subject: [PATCH] Make CompositeConfiguration conditional on missing bean

Previously, `CompositeConfiguration` (which is imported by `ConfigServerAutoConfiguration`) would unconditionally create a `CompositeEnvironmentRepository` bean marked as `@Primary`. This makes it difficult for users, in their code, to provide their own `CompositeEnvironmentRepository` bean to be used in various places. This adds a `ConditionalOnMissingBean` condition to the `Configuration` to make it easy to provide a primary `CompositeEnvironmentRepository` in user code.
---
 .../server/config/CompositeConfiguration.java |  1 +
 .../CompositeEnvironmentRepositoryTests.java  | 26 ++++++++++++++++++-
 2 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/CompositeConfiguration.java b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/CompositeConfiguration.java
index c4792adb..8b06bb87 100644
--- a/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/CompositeConfiguration.java
+++ b/spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/config/CompositeConfiguration.java
@@ -32,6 +32,7 @@ import org.springframework.context.annotation.Primary;
  * @author Ryan Baxter
  */
 @Configuration
+@ConditionalOnMissingBean(CompositeEnvironmentRepository.class)
 public class CompositeConfiguration {
 
 	private List<EnvironmentRepository> environmentRepos = new ArrayList<>();
diff --git a/spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/CompositeEnvironmentRepositoryTests.java b/spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/CompositeEnvironmentRepositoryTests.java
index 138f9f56..c455b62f 100644
--- a/spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/CompositeEnvironmentRepositoryTests.java
+++ b/spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/environment/CompositeEnvironmentRepositoryTests.java
@@ -16,10 +16,17 @@
 package org.springframework.cloud.config.server.environment;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import org.junit.Test;
 import org.springframework.cloud.config.environment.Environment;
 import org.springframework.cloud.config.environment.PropertySource;
+import org.springframework.cloud.config.server.config.CompositeConfiguration;
+import org.springframework.cloud.config.server.config.ConfigServerHealthIndicator;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
 import org.springframework.core.Ordered;
 
 import static org.junit.Assert.assertEquals;
@@ -31,7 +38,7 @@ import static org.mockito.Mockito.mock;
  */
 public class CompositeEnvironmentRepositoryTests {
 
-	private class TestOrderedEnvironmentRepository implements EnvironmentRepository, SearchPathLocator, Ordered {
+	private static class TestOrderedEnvironmentRepository implements EnvironmentRepository, SearchPathLocator, Ordered {
 
 		private Environment env;
 		private Locations locations;
@@ -144,4 +151,21 @@ public class CompositeEnvironmentRepositoryTests {
 		assertEquals(null, multiEnv.getState());
 
 	}
+
+	@Test
+	public void overridingCompositeEnvRepo_contextLoads() {
+		try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext()) {
+			context.register(OverrideCompositeConfig.class, CompositeConfiguration.class, ConfigServerHealthIndicator.class);
+			context.refresh();
+		}
+	}
+
+	@Configuration
+	static class OverrideCompositeConfig {
+		@Bean
+		@Primary
+		CompositeEnvironmentRepository customCompositeEnvironmentRepository() {
+			return new CompositeEnvironmentRepository(Arrays.<EnvironmentRepository>asList(new TestOrderedEnvironmentRepository(1, new Environment("app", "dev"), null)));
+		}
+	}
 }