OZG-4814 Simplified implementation of cloud config server /w mongodb using a MongoRepository

src/main/java/de/ozgcloud/admin/environment/MongoEnvironmentRepository.java → src/main/java/de/ozgcloud/admin/environment/AdminEnvironmentRepository.java

@@ -6,42 +6,25 @@ import java.util.stream.Collectors;
 import org.springframework.cloud.config.environment.Environment;
 import org.springframework.cloud.config.environment.PropertySource;
 import org.springframework.cloud.config.server.environment.EnvironmentRepository;
-import org.springframework.data.mongodb.core.MongoOperations;
-import org.springframework.data.mongodb.core.query.Criteria;
-import org.springframework.data.mongodb.core.query.Query;
 
-public class MongoEnvironmentRepository implements EnvironmentRepository {
-	public static final String COLLECTION_NAME = "configuration_properties";
-	private static final String APPLICATION = "application";
-	private static final String PROFILE = "profile";
+import lombok.RequiredArgsConstructor;
 
-	private MongoOperations mongoOperations;
+@RequiredArgsConstructor
+public class AdminEnvironmentRepository implements EnvironmentRepository {
+	public static final String COLLECTION_NAME = "configuration_properties";
 
-	public MongoEnvironmentRepository(MongoOperations mongoOperations) {
-		this.mongoOperations = mongoOperations;
-	}
+	private final PropertyRepository propertyRepository;
 
 	@Override
 	public Environment findOne(String application, String profile, String label) {
-		String[] profiles = splitInputProfileIntoArray(profile);
-		Query query = buildMongoQuery(application, profiles);
-		List<MongoPropertySource> matchingPropertyEntries = findMatchingEntriesInMongoDB(query, COLLECTION_NAME);
-		Environment environment = new Environment(application, profiles, null, null, null);
+		String[] profiles = profile.split(",");
+		List<MongoPropertySource> properties = propertyRepository.findAllByApplication(application);
 
-		environment.addAll(matchingPropertyEntries.stream().map(this::transformMonPropertySourceToPropertySource).collect(Collectors.toList()));
-
-		return environment;
-	}
+		var environment = new Environment(application, profiles, null, null, null);
 
-	private String[] splitInputProfileIntoArray(String profile) {
-		return (profile).split(",");
-	}
+		environment.addAll(properties.stream().map(this::transformMonPropertySourceToPropertySource).collect(Collectors.toList()));
 
-	private Query buildMongoQuery(String application, String[] profiles) {
-		Query query = new Query();
-		query.addCriteria(Criteria.where(APPLICATION).in(application));
-		query.addCriteria(Criteria.where(PROFILE).in((Object[]) profiles));
-		return query;
+		return environment;
 	}
 
 	private PropertySource transformMonPropertySourceToPropertySource(MongoPropertySource mongoPropertySource) {
@@ -49,8 +32,4 @@ public class MongoEnvironmentRepository implements EnvironmentRepository {
 		return new PropertySource(sourceName, mongoPropertySource.getSource());
 	}
 
-	private List<MongoPropertySource> findMatchingEntriesInMongoDB(Query query, String collectionName) {
-		return mongoOperations.find(query, MongoPropertySource.class, collectionName);
-	}
-
 }

src/main/java/de/ozgcloud/admin/environment/MongoEnvironmentRepositoryConfiguration.java → src/main/java/de/ozgcloud/admin/environment/AdminEnvironmentRepositoryConfiguration.java

@@ -3,17 +3,16 @@ package de.ozgcloud.admin.environment;
 import org.springframework.cloud.config.server.environment.EnvironmentRepository;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.data.mongodb.core.MongoOperations;
 
-import lombok.AllArgsConstructor;
+import lombok.RequiredArgsConstructor;
 
 @Configuration
-@AllArgsConstructor
-public class MongoEnvironmentRepositoryConfiguration {
-	private MongoOperations mongoOperations;
+@RequiredArgsConstructor
+public class AdminEnvironmentRepositoryConfiguration {
+    final PropertyRepository propertyRepository;
 
     @Bean
-	public EnvironmentRepository environmentRepository() {
-		return new MongoEnvironmentRepository(mongoOperations);
+    EnvironmentRepository environmentRepository() {
+        return new AdminEnvironmentRepository(propertyRepository);
     }
 }

src/main/java/de/ozgcloud/admin/environment/EnableMongoConfigServer.java

@@ -6,14 +6,14 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 import org.springframework.cloud.config.server.EnableConfigServer;
-import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
 
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-@Import(MongoEnvironmentRepositoryConfiguration.class)
+@Import(AdminEnvironmentRepositoryConfiguration.class)
 @EnableConfigServer
-@Configuration
+@EnableMongoRepositories
 public @interface EnableMongoConfigServer {
 
 }

src/main/java/de/ozgcloud/admin/environment/MongoPropertySource.java

@@ -2,6 +2,8 @@ package de.ozgcloud.admin.environment;
 
 import java.util.Map;
 
+import org.springframework.data.mongodb.core.mapping.Document;
+
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Setter;
@@ -9,6 +11,7 @@ import lombok.Setter;
 @Getter
 @Setter
 @Builder
+@Document(AdminEnvironmentRepository.COLLECTION_NAME)
 public class MongoPropertySource {
 	private String application;
 	private String profile;

src/main/java/de/ozgcloud/admin/environment/PropertyRepository.java

+package de.ozgcloud.admin.environment;
+
+import java.util.List;
+
+import org.springframework.data.mongodb.repository.MongoRepository;
+
+public interface PropertyRepository extends MongoRepository<MongoPropertySource, String> {
+
+    List<MongoPropertySource> findAllByApplication(String application);
+
+}
\ No newline at end of file

src/main/resources/application.properties

-

src/test/java/de/ozgcloud/admin/environment/MongoConfigServerITCase.java

@@ -21,7 +21,7 @@ class MongoConfigServerITCase {
 	@Test
 	@SneakyThrows
 	void shouldHaveHttpEndpoint() {
-		var result = mockMvc.perform(get("/" + MongoPropertySourceTestFactory.APPNAME + "/" + MongoPropertySourceTestFactory.PROFILE));
+		var result = mockMvc.perform(get("/example/path"));
 
 		result.andExpect(status().isOk());
 	}

src/test/java/de/ozgcloud/admin/environment/MongoEnvironmentRepositoryITCase.java

@@ -10,7 +10,6 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest;
 import org.springframework.cloud.config.environment.Environment;
 import org.springframework.cloud.config.server.environment.EnvironmentRepository;
-import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.ContextConfiguration;
 
@@ -21,59 +20,51 @@ import de.ozgcloud.common.test.DbInitializer;
 @ActiveProfiles({ "itcase", "with_db" })
 class MongoEnvironmentRepositoryITCase {
 
-	@Autowired
-	private MongoOperations mongoOperations;
 	@Autowired
 	private EnvironmentRepository repository;
+	@Autowired
+	private PropertyRepository propertyRepository;
 
 	private MongoPropertySource mongoPropertySource;
 
-	@BeforeEach
-	public void prepareExampleData() {
-		mongoPropertySource = MongoPropertySourceTestFactory.create();
-	}
-
 	@AfterEach
 	public void clearData() {
-		mongoOperations.dropCollection(MongoEnvironmentRepository.COLLECTION_NAME);
+		propertyRepository.deleteAll();
 	}
 
-	private void saveMongoSource() {
-		mongoOperations.save(mongoPropertySource, MongoEnvironmentRepository.COLLECTION_NAME);
+	private void saveMongoSource(MongoPropertySource mongoPropertySource) {
+		propertyRepository.save(mongoPropertySource);
 	}
 
 	@Nested
 	class TestEnvironmentFindMethod {
-		@Test
-		void shouldFindEnvironmentWithCorrectAppName() {
-			saveMongoSource();
-
-			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
-
-			assertEquals(MongoPropertySourceTestFactory.APPNAME, environment.getName());
+		@BeforeEach
+		public void addExampleDataToDatabase() {
+			mongoPropertySource = MongoPropertySourceTestFactory.create();
+			saveMongoSource(mongoPropertySource);
 		}
 
 		@Test
-		void shouldFindEnvironmentWithCorrectProfile() {
-			saveMongoSource();
+		void shouldFindEnvironmentWithOneCorrectPropertySource() {
 
 			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
-			assertEquals(MongoPropertySourceTestFactory.PROFILE, environment.getProfiles()[0]);
+			assertEquals(1, environment.getPropertySources().size());
 		}
 
 		@Test
-		void shouldFindEnvironmentWithCorrectNumberOfPropertySources() {
-			saveMongoSource();
+		void shouldFindEnvironmentWithTwoCorrectPropertySource() {
+			var mongoPropertySource2 = MongoPropertySourceTestFactory.create();
+			mongoPropertySource2.setProfile("other");
+			saveMongoSource(mongoPropertySource);
 
 			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
-			assertEquals(1, environment.getPropertySources().size());
+			assertEquals(2, environment.getPropertySources().size());
 		}
 
 		@Test
 		void shouldFindEnvironmentWithCorrectPropertySource() {
-			saveMongoSource();
 
 			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
@@ -83,7 +74,6 @@ class MongoEnvironmentRepositoryITCase {
 
 		@Test
 		void shouldFindCorrectEnvironment() {
-			saveMongoSource();
 
 			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
@@ -93,36 +83,57 @@ class MongoEnvironmentRepositoryITCase {
 	}
 
 	@Nested
-	class TestMultipleProfilesInput {
+	class TestEnvironment {
 		@Test
-		void shouldFindEnvironmentWithCorrectNumberOfPropertySources() {
-			saveMongoSource();
+		void shouldHaveCorrectAppName() {
 
-			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME,
-					MongoPropertySourceTestFactory.PROFILE + "," + "SecondProfile", null);
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
-			assertEquals(1, environment.getPropertySources().size());
+			assertEquals(MongoPropertySourceTestFactory.APPNAME, environment.getName());
 		}
 
 		@Test
-		void shouldFindEnvironmentWithCorrectFirstProfile() {
-			saveMongoSource();
+		void shouldHaveCorrectProfileNumber() {
 
-			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME,
-					MongoPropertySourceTestFactory.PROFILE + "," + "SecondProfile", null);
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
+
+			assertEquals(1, environment.getProfiles().length);
+		}
+
+		@Test
+		void shouldHaveCorrectProfileEntry() {
+
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE, null);
 
 			assertEquals(MongoPropertySourceTestFactory.PROFILE, environment.getProfiles()[0]);
 		}
 
 		@Test
-		void shouldFindEnvironmentWithCorrectSecondProfile() {
-			saveMongoSource();
+		void shouldHaveArrayOfProfiles() {
+
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE + ",Second",
+					null);
+
+			assertEquals(2, environment.getProfiles().length);
+		}
+
+		@Test
+		void shouldHaveCorrectFirstProfileEntry() {
 
-			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME,
-					MongoPropertySourceTestFactory.PROFILE + "," + "SecondProfile", null);
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE + ",Second",
+					null);
 
-			assertEquals("SecondProfile", environment.getProfiles()[1]);
+			assertEquals(MongoPropertySourceTestFactory.PROFILE, environment.getProfiles()[0]);
 		}
 
+		@Test
+		void shouldHaveCorrectSecondProfileEntry() {
+
+			Environment environment = repository.findOne(MongoPropertySourceTestFactory.APPNAME, MongoPropertySourceTestFactory.PROFILE + ",Second",
+					null);
+
+			assertEquals("Second", environment.getProfiles()[1]);
 		}
 	}
+
+}