Merge pull request #141 from aguibert/quarkus-module

Add Quarkus module

Author: aguibert

.travis.yml

@@ -1,5 +1,12 @@
 language: java
 jdk:
     - oraclejdk11
+services:
+  - docker
+cache:
+  directories:
+  - $HOME/.m2
+  - $HOME/.gradle/caches/modules-2/files/2.1/
+  - $HOME/.gradle/wrapper/
 script:
     - ./gradlew clean build

core/src/main/java/org/microshed/testing/ApplicationEnvironment.java

@@ -23,6 +23,9 @@
 import java.util.ServiceLoader;
 import java.util.Set;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Defines an approach for configuring and starting the test enviornment. Examples of a test environment might be:
  * <ul>
@@ -81,10 +84,17 @@ public static ApplicationEnvironment load() {
             }
         }
 
+        Logger LOG = LoggerFactory.getLogger(ApplicationEnvironment.class);
+
         // If nothing explicitly defined in sysprops or env, check ServiceLoader
         Set<ApplicationEnvironment> envs = new HashSet<>();
         ServiceLoader.load(ApplicationEnvironment.class).forEach(envs::add);
         Optional<ApplicationEnvironment> selectedEnv = envs.stream()
+                        .map(env -> {
+                            if (LOG.isDebugEnabled())
+                                LOG.debug("Found ApplicationEnvironment " + env.getClass() + " with priority=" + env.getPriority() + ", available=" + env.isAvailable());
+                            return env;
+                        })
                         .filter(env -> env.isAvailable())
                         .sorted((c1, c2) -> c1.getClass().getCanonicalName().compareTo(c2.getClass().getCanonicalName()))
                         .sorted((c1, c2) -> Integer.compare(c2.getPriority(), c1.getPriority()))
@@ -139,4 +149,8 @@ public default int getPriority() {
      */
     public String getApplicationURL();
 
+    public default boolean configureRestAssured() {
+        return true;
+    }
+
 }

core/src/main/java/org/microshed/testing/ManuallyStartedConfiguration.java

@@ -30,6 +30,8 @@ public class ManuallyStartedConfiguration implements ApplicationEnvironment {
 //    public static final String RUNTIME_URL_PROPERTY = "MICROSHED_TEST_RUNTIME_URL";
     public static final String MANUAL_ENALBED = "microshed_manual_env";
 
+    private static String runtimeURL;
+
     @Override
     public boolean isAvailable() {
         if (!Boolean.valueOf(resolveProperty(MANUAL_ENALBED)))
@@ -45,13 +47,21 @@ public int getPriority() {
         return ApplicationEnvironment.DEFAULT_PRIORITY - 10;
     }
 
+    public static void setRuntimeURL(String url) {
+        runtimeURL = url;
+    }
+
     public static String getRuntimeURL() {
+        if (runtimeURL != null)
+            return runtimeURL;
+
         String host = resolveProperty(MICROSHED_HOSTNAME);
         String httpPort = resolveProperty(MICROSHED_HTTP_PORT);
         String httpsPort = resolveProperty(MICROSHED_HTTPS_PORT);
-        if (host.isEmpty() && (httpPort.isEmpty() || httpsPort.isEmpty()))
+        if (host.isEmpty() && (httpPort.isEmpty() || httpsPort.isEmpty())) {
             throw new IllegalStateException("The properties '" + MICROSHED_HOSTNAME + "' and '" + MICROSHED_HTTP_PORT + "' or '" +
                                             MICROSHED_HTTPS_PORT + "' must be set in order to use this ApplicationEnvironment");
+        }
 
         // Prefer HTTPS if set
         if (!httpsPort.isEmpty()) {

core/src/main/java/org/microshed/testing/jaxrs/RestClientBuilder.java

@@ -54,6 +54,7 @@ public class RestClientBuilder {
      * @param appContextRoot The protocol, hostname, port, and application root path for the REST Client
      *            For example, <code>http://localhost:8080/myapp/</code>. If unspecified, the app context
      *            root will be automatically detected by {@link ApplicationEnvironment#getApplicationURL()}
+     * @return The same builder instance
      */
     public RestClientBuilder withAppContextRoot(String appContextRoot) {
         Objects.requireNonNull(appContextRoot, "Supplied 'appContextRoot' must not be null");
@@ -66,6 +67,7 @@ public RestClientBuilder withAppContextRoot(String appContextRoot) {
      *            endpoint is deployed at <code>http://localhost:8080/myapp/hello</code> and the app context root
      *            is <code>http://localhost:8080/myapp/</code>, then the jaxrsPath is <code>hello</code>. If
      *            unspecified, the JAX-RS path will be automatically detected by annotation scanning.
+     * @return The same builder instance
      */
     public RestClientBuilder withJaxrsPath(String jaxrsPath) {
         Objects.requireNonNull(jaxrsPath, "Supplied 'jaxrsPath' must not be null");
@@ -75,6 +77,7 @@ public RestClientBuilder withJaxrsPath(String jaxrsPath) {
 
     /**
      * @param jwt The JWT (Json Web Token) to apply as an Authorization header
+     * @return The same builder instance
      */
     public RestClientBuilder withJwt(String jwt) {
         Objects.requireNonNull(jwt, "Supplied 'jwt' must not be null");
@@ -86,6 +89,7 @@ public RestClientBuilder withJwt(String jwt) {
      * @param providers One or more providers to apply. Providers typically implement
      *            {@link MessageBodyReader} and/or {@link MessageBodyWriter}. If unspecified,
      *            the {@link JsonBProvider} will be applied.
+     * @return The same builder instance
      */
     public RestClientBuilder withProviders(Class<?>... providers) {
         this.providers = Arrays.asList(providers);

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

@@ -103,6 +103,9 @@ private static String createJwtIfNeeded(Field restClientField) {
 
     @SuppressWarnings({ "unchecked", "rawtypes" })
     private static void configureRestAssured(ApplicationEnvironment config) {
+        if (!config.configureRestAssured())
+            return;
+
         Class<?> RestAssured = tryLoad("io.restassured.RestAssured");
         if (RestAssured == null)
             return;
@@ -139,7 +142,7 @@ private static void configureRestAssured(ApplicationEnvironment config) {
             LOG.debug("Regsitered JSONB ObjectMapper for REST Assured");
         } catch (IllegalArgumentException e) {
             // Prior to RestAssured 4.2.0 the ObjectMapperType.JSONB enum is not available
-            LOG.debug("Unable to configure JSON-B object mapper for REST Assured", e);
+            LOG.debug("Unable to configure JSON-B object mapper for REST Assured due to: " + e.getMessage());
         } catch (Exception e) {
             LOG.warn("Unable to configure JSON-B object mapper for REST Assured", e);
         }

core/src/main/java/org/microshed/testing/jwt/JwtBuilder.java

@@ -46,7 +46,6 @@ public class JwtBuilder {
     private JwtClaims claims = null;
     private JsonWebSignature jws = null;
     static RsaJsonWebKey rsajwk = null;
-    static JwtBuilder me = null;
 
     // init the single public:private key pair that we will re-use.
     private static void init() {
@@ -72,38 +71,38 @@ private static String pemEncode(Key publicKey) {
     }
 
     public static String buildJwt(String subject, String issuer, String[] claims) throws JoseException, MalformedClaimException {
-        me = new JwtBuilder();
+        JwtBuilder builder = new JwtBuilder();
         init();
-        me.claims = new JwtClaims();
-        me.jws = new JsonWebSignature();
+        builder.claims = new JwtClaims();
+        builder.jws = new JsonWebSignature();
 
-        me.jws.setKeyIdHeaderValue(rsajwk.getKeyId());
-        me.jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.RSA_USING_SHA256);
+        builder.jws.setKeyIdHeaderValue(rsajwk.getKeyId());
+        builder.jws.setAlgorithmHeaderValue(AlgorithmIdentifiers.RSA_USING_SHA256);
         // The JWT is signed using the private key, get the key we'll use every time.
-        me.jws.setKey(rsajwk.getPrivateKey());
+        builder.jws.setKey(rsajwk.getPrivateKey());
         if (subject != null) {
-            me.claims.setClaim("sub", subject);
-            me.claims.setClaim("upn", subject);
+            builder.claims.setClaim("sub", subject);
+            builder.claims.setClaim("upn", subject);
         }
-        me.claims.setIssuer(issuer == null ? JwtConfig.DEFAULT_ISSUER : issuer);
-        me.claims.setExpirationTimeMinutesInTheFuture(60);
-        setClaims(claims);
-        if (me.claims.getIssuedAt() == null) {
-            me.claims.setIssuedAtToNow();
+        builder.claims.setIssuer(issuer == null ? JwtConfig.DEFAULT_ISSUER : issuer);
+        builder.claims.setExpirationTimeMinutesInTheFuture(60);
+        setClaims(builder, claims);
+        if (builder.claims.getIssuedAt() == null) {
+            builder.claims.setIssuedAtToNow();
         }
-        me.jws.setPayload(me.claims.toJson());
-        return me.jws.getCompactSerialization();
+        builder.jws.setPayload(builder.claims.toJson());
+        return builder.jws.getCompactSerialization();
     }
 
-    private static void setClaims(String[] claims) throws MalformedClaimException {
+    private static void setClaims(JwtBuilder builder, String[] claims) throws MalformedClaimException {
         for (String claim : claims) {
             if (!claim.contains("="))
                 throw new MalformedClaimException("Claim did not contain an equals sign (=). Each claim must be of the form 'key=value'");
             int loc = claim.indexOf('=');
             String claimName = claim.substring(0, loc);
             Object claimValue = claim.substring(loc + 1);
             claimValue = handleArrays((String) claimValue);
-            setClaim(claimName, claimValue);
+            builder.claims.setClaim(claimName, claimValue);
         }
     }
 
@@ -115,7 +114,4 @@ private static Object handleArrays(String claimValue) {
         return elements;
     }
 
-    private static void setClaim(String name, Object value) {
-        me.claims.setClaim(name, value);
-    }
 }

docs/features/01_SupportedRuntimes.md

@@ -80,3 +80,29 @@ Example Dockerfile:
 FROM jboss/wildfly
 ADD build/libs/myservice.war /opt/jboss/wildfly/standalone/deployments/
 ```
+
+## [Quarkus](https://quarkus.io/)
+
+INFO: The Quarkus module does not require the application to be tested with a container like the other
+runtime modules do. Instead, it is mainly used for integrating other services with Quarkus.
+
+Maven Dependency:
+
+```xml
+<dependency>
+    <groupId>org.microshed</groupId>
+    <artifactId>microshed-testing-quarkus</artifactId>
+    <version>0.6.2</version>
+</dependency>
+```
+
+Java test class:
+
+```java
+import org.microshed.testing.jupiter.MicroShedTest;
+import io.quarkus.test.junit.QuarkusTest;
+
+@MicroShedTest
+@QuarkusTest
+public class ExampleResourceTest {
+```

docs/features/98_Examples.md

@@ -19,4 +19,5 @@ Sometimes code is worth a thousand words. Here are some pointers to working exam
 
 - [Testing an application with OpenLiberty](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/liberty-app)
 - [Testing an application with Payara Micro](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/payara-app)
-- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/wildfly-app)
+- [Testing an application with Wildfly](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/wildfly-app)
+- [Testing an application with Quarkus](https://github.com/MicroShed/microshed-testing/tree/master/sample-apps/quarkus-app)