Merge pull request #118 from aguibert/mpRestClient13-baseUri-support

Enhance withMpRestClient to account for configKey on MP Rest Client

Author: aguibert

core/src/main/java/org/microshed/testing/jupiter/MicroShedTestExtension.java

@@ -102,8 +102,10 @@ private static String createJwtIfNeeded(Field restClientField) {
     @SuppressWarnings("unchecked")
     private static Optional<Class<? extends Annotation>> getMpRestClient() {
         try {
-            return Optional.of((Class<? extends Annotation>) Class.forName("org.eclipse.microprofile.rest.client.inject.RestClient"));
-        } catch (ClassNotFoundException e) {
+            return Optional.of((Class<? extends Annotation>) Class.forName("org.eclipse.microprofile.rest.client.inject.RestClient",
+                                                                           false,
+                                                                           MicroShedTestExtension.class.getClassLoader()));
+        } catch (ClassNotFoundException | LinkageError e) {
             return Optional.empty();
         }
     }

modules/testcontainers/build.gradle

@@ -4,6 +4,7 @@ description = "Extensions for using MicroShed Testing with Testcontainers for ma
 dependencies {
   compile project(':microshed-testing-core')
   compile 'org.testcontainers:junit-jupiter:1.12.4'
+  testCompile 'org.eclipse.microprofile.rest.client:microprofile-rest-client-api:1.3.4'
   testCompile 'org.slf4j:slf4j-log4j12:1.7.29'
   testCompile 'org.testcontainers:mockserver:1.12.3'
   testImplementation 'org.junit.jupiter:junit-jupiter:5.5.2'

modules/testcontainers/src/main/java/org/microshed/testing/testcontainers/ApplicationContainer.java

@@ -20,6 +20,9 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.net.URL;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -40,6 +43,7 @@
 import java.util.stream.Collectors;
 
 import org.junit.jupiter.api.extension.ExtensionConfigurationException;
+import org.junit.platform.commons.support.AnnotationSupport;
 import org.microshed.testing.ApplicationEnvironment;
 import org.microshed.testing.testcontainers.config.HollowTestcontainersConfiguration;
 import org.microshed.testing.testcontainers.config.TestcontainersConfiguration;
@@ -373,7 +377,45 @@ public void setWaitStrategy(WaitStrategy waitStrategy) {
      * @return the current instance
      */
     public ApplicationContainer withMpRestClient(Class<?> restClientClass, String hostUrl) {
-        return withMpRestClient(restClientClass.getCanonicalName(), hostUrl);
+        String configToken = readMpRestClientConfigKey(restClientClass);
+        if (configToken == null || configToken.isEmpty())
+            configToken = restClientClass.getCanonicalName();
+        return withMpRestClient(configToken, hostUrl);
+    }
+
+    /**
+     * Checks to see if the given restClientClass is annotated with
+     * <code>@RegisterRestClient(configKey = "...")</code>
+     */
+    @SuppressWarnings("unchecked")
+    private String readMpRestClientConfigKey(Class<?> restClientClass) {
+        Class<? extends Annotation> RegisterRestClient = null;
+        try {
+            RegisterRestClient = (Class<? extends Annotation>) Class.forName("org.eclipse.microprofile.rest.client.inject.RegisterRestClient",
+                                                                             false,
+                                                                             getClass().getClassLoader());
+        } catch (ClassNotFoundException | LinkageError notFound) {
+            return null;
+        }
+
+        Method getConfigKey = null;
+        try {
+            getConfigKey = RegisterRestClient.getMethod("configKey");
+        } catch (NoSuchMethodException | SecurityException e) {
+            // Using a version of MP Rest Client that does not support configKey
+            return null;
+        }
+
+        Optional<Annotation> foundAnno = (Optional<Annotation>) AnnotationSupport.findAnnotation(restClientClass, RegisterRestClient);
+        if (!foundAnno.isPresent())
+            return null;
+
+        Annotation anno = foundAnno.get();
+        try {
+            return (String) getConfigKey.invoke(anno);
+        } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+            return null;
+        }
     }
 
     /**
@@ -385,10 +427,9 @@ public ApplicationContainer withMpRestClient(Class<?> restClientClass, String ho
      * @return the current instance
      */
     public ApplicationContainer withMpRestClient(String restClientClass, String hostUrl) {
-        String envName = restClientClass//
-                        .replaceAll("\\.", "_")
-                        .replaceAll("\\$", "_") +
-                         "_mp_rest_url";
+        // Sanitize environment variable name using Environment Variables Mapping Rules defined in MP Config:
+        // https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules
+        String envName = restClientClass.replaceAll("[^a-zA-Z0-9_]", "_") + "_mp_rest_url";
         return withEnv(envName, hostUrl);
     }
 

modules/testcontainers/src/test/java/org/microshed/testing/testcontainers/ApplicationContainerTest.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2019 IBM Corporation and others
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * 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
+ *
+ *     http://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.microshed.testing.testcontainers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Map;
+
+import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
+import org.junit.jupiter.api.Test;
+import org.microshed.testing.testcontainers.config.TestServerAdapter;
+
+public class ApplicationContainerTest {
+
+    // Base uri configured with: com_example_StringRestClient_mp_rest_url
+    @RegisterRestClient
+    public static class SampleRestClient1 {
+    }
+
+    // Base uri configured with: rc_config_key_mp_rest_url
+    @RegisterRestClient(configKey = "rc-config-key")
+    public static class SampleRestClient2 {
+    }
+
+    // Base uri configured with: CLIENT_CONFIG_KEY_mp_rest_url
+    @RegisterRestClient(configKey = "CLIENT_CONFIG_KEY")
+    public static class SampleRestClient3 {
+    }
+
+    @Test
+    public void testMpRestClient() {
+        final String clientUrl = "http://example.com";
+
+        @SuppressWarnings("resource")
+        ApplicationContainer app = new ApplicationContainer("alpine:3.5")
+                        .withMpRestClient("com.example.StringRestClient", clientUrl)
+                        .withMpRestClient(SampleRestClient1.class, clientUrl)
+                        .withMpRestClient(SampleRestClient2.class, clientUrl)
+                        .withMpRestClient(SampleRestClient3.class, clientUrl);
+
+        Map<String, String> appEnv = app.getEnvMap();
+        assertEquals(clientUrl, appEnv.get("com_example_StringRestClient_mp_rest_url"));
+        assertEquals(clientUrl, appEnv.get("org_microshed_testing_testcontainers_ApplicationContainerTest_SampleRestClient1_mp_rest_url"));
+        assertEquals(clientUrl, appEnv.get("rc_config_key_mp_rest_url"));
+        assertEquals(clientUrl, appEnv.get("CLIENT_CONFIG_KEY_mp_rest_url"));
+    }
+
+    @Test
+    public void testCorrectServerAdapter() {
+        @SuppressWarnings("resource")
+        ApplicationContainer app = new ApplicationContainer("alpine:3.5");
+        assertEquals(TestServerAdapter.class, app.getServerAdapter().getClass());
+    }
+
+}