Let Spring search for us

getting a list of beans instead of searching in context

Author: Tristan-WorkGH

pom.xml

@@ -150,6 +150,13 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.projectreactor</groupId>
+            <artifactId>reactor-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- compile time only -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>

src/main/java/org/gridsuite/gateway/GatewayConfig.java

@@ -6,15 +6,15 @@
  */
 package org.gridsuite.gateway;
 
-import org.gridsuite.gateway.endpoints.CgmesGlServer;
-import org.gridsuite.gateway.endpoints.*;
+import org.gridsuite.gateway.endpoints.EndPointServer;
 import org.springframework.cloud.gateway.route.RouteLocator;
 import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
-import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.PropertySource;
 
+import java.util.List;
+
 /**
  * @author Chamseddine Benhamed <chamseddine.benhamed at rte-france.com>
  * @author Slimane Amar <slimane.amar at rte-france.com>
@@ -30,36 +30,11 @@ public class GatewayConfig {
     public static final String HEADER_CLIENT_ID = "clientId";
 
     @Bean
-    public RouteLocator myRoutes(RouteLocatorBuilder builder, ApplicationContext context) {
-        return builder.routes()
-            .route(p -> context.getBean(StudyServer.class).getRoute(p))
-            .route(p -> context.getBean(CaseServer.class).getRoute(p))
-            .route(p -> context.getBean(MergeServer.class).getRoute(p))
-            .route(p -> context.getBean(StudyNotificationServer.class).getRoute(p))
-            .route(p -> context.getBean(MergeNotificationServer.class).getRoute(p))
-            .route(p -> context.getBean(DirectoryNotificationServer.class).getRoute(p))
-            .route(p -> context.getBean(ContingencyServer.class).getRoute(p))
-            .route(p -> context.getBean(ConfigServer.class).getRoute(p))
-            .route(p -> context.getBean(ConfigNotificationServer.class).getRoute(p))
-            .route(p -> context.getBean(DirectoryServer.class).getRoute(p))
-            .route(p -> context.getBean(ExploreServer.class).getRoute(p))
-            .route(p -> context.getBean(CgmesBoundaryServer.class).getRoute(p))
-            .route(p -> context.getBean(DynamicMappingServer.class).getRoute(p))
-            .route(p -> context.getBean(FilterServer.class).getRoute(p))
-            .route(p -> context.getBean(ReportServer.class).getRoute(p))
-            .route(p -> context.getBean(NetworkModificationServer.class).getRoute(p))
-            .route(p -> context.getBean(NetworkConversionServer.class).getRoute(p))
-            .route(p -> context.getBean(OdreServer.class).getRoute(p))
-            .route(p -> context.getBean(GeoDataServer.class).getRoute(p))
-            .route(p -> context.getBean(UserAdminServer.class).getRoute(p))
-            .route(p -> context.getBean(CgmesGlServer.class).getRoute(p))
-            .route(p -> context.getBean(SensitivityAnalysisServer.class).getRoute(p))
-            .route(p -> context.getBean(LoadFlowServer.class).getRoute(p))
-            .route(p -> context.getBean(SecurityAnalysisServer.class).getRoute(p))
-            .route(p -> context.getBean(DynamicSimulationServer.class).getRoute(p))
-            .route(p -> context.getBean(CaseImportServer.class).getRoute(p))
-            .route(p -> context.getBean(VoltageInitServer.class).getRoute(p))
-            .route(p -> context.getBean(ShortCircuitServer.class).getRoute(p))
-            .build();
+    public RouteLocator myRoutes(RouteLocatorBuilder builder, List<EndPointServer> servers) {
+        final RouteLocatorBuilder.Builder routes = builder.routes();
+        for (final EndPointServer server : servers) {
+            routes.route(server.getClass().getName(), server::getRoute);
+        }
+        return routes.build();
     }
 }

src/test/java/org/gridsuite/gateway/GatewayApplicationTest.java

@@ -0,0 +1,69 @@
+package org.gridsuite.gateway;
+
+import org.assertj.core.api.InstanceOfAssertFactories;
+import org.assertj.core.api.WithAssertions;
+import org.gridsuite.gateway.endpoints.*;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cloud.gateway.route.RouteLocator;
+import org.springframework.context.ApplicationContext;
+import reactor.test.StepVerifier;
+
+import java.util.Map;
+
+@SpringBootTest
+class GatewayApplicationTest implements WithAssertions {
+    @Autowired
+    private ApplicationContext applicationContext;
+
+    @Autowired
+    private RouteLocator myRoutes;
+
+    @Test
+    void testAllEndpointServersFound() {
+        assertThat(applicationContext.getBeansOfType(EndPointServer.class)).as("found EndPointServer beans")
+            .allSatisfy((name, srv) -> assertThat(name).isEqualTo(srv.getEndpointName()))
+            .extracting(Map::values, InstanceOfAssertFactories.collection(EndPointServer.class)).as("EndPointServer beans")
+            .doesNotHaveDuplicates()
+            .extracting(EndPointServer::getClass).as("EndPointServer classes")
+            .containsExactlyInAnyOrder(
+                CaseImportServer.class,
+                CaseServer.class,
+                CgmesBoundaryServer.class,
+                CgmesGlServer.class,
+                ConfigNotificationServer.class,
+                ConfigServer.class,
+                ContingencyServer.class,
+                DirectoryNotificationServer.class,
+                DirectoryServer.class,
+                DynamicMappingServer.class,
+                DynamicSimulationServer.class,
+                ExploreServer.class,
+                FilterServer.class,
+                GeoDataServer.class,
+                LoadFlowServer.class,
+                MergeNotificationServer.class,
+                MergeServer.class,
+                NetworkConversionServer.class,
+                NetworkModificationServer.class,
+                OdreServer.class,
+                ReportServer.class,
+                SecurityAnalysisServer.class,
+                SensitivityAnalysisServer.class,
+                ShortCircuitServer.class,
+                StudyNotificationServer.class,
+                StudyServer.class,
+                UserAdminServer.class,
+                VoltageInitServer.class
+        );
+    }
+
+    @Test
+    void testRoutesInitialized() {
+        StepVerifier.create(myRoutes.getRoutes())
+                    .as("routes found")
+                    .expectNextCount(28)
+                    .verifyComplete();
+    }
+}