Merge pull request #60 from hivemq/develop

Version 1.2.0

Author: AcidSepp

build.gradle

@@ -7,7 +7,7 @@ plugins {
 /* ******************** metadata ******************** */
 
 allprojects {
-    version '1.1.1'
+    version '1.2.0'
     group 'com.hivemq'
     description 'Testcontainers for testing HiveMQ Extensions and Java MQTT Applications.'
 
@@ -48,16 +48,16 @@ allprojects {
     }
 
     ext {
-        testContainersVersion = '1.13.0'
-        extensionSDKVersion = '4.3.0'
-        hmcVersion = '1.1.4'
-        junit4Version = '4.12'
-        junit5Version = '5.6.1'
-        commonsIoVersion = '2.6'
+        testContainersVersion = '1.14.3'
+        extensionSDKVersion = '4.4.0'
+        hmcVersion = '1.2.1'
+        junit4Version = '4.13'
+        junit5Version = '5.6.2'
+        commonsIoVersion = '2.7'
         javassistVersion = '3.27.0-GA'
         shrinkWrapVersion = '1.2.6'
         shrinkwrapResolverDepchainVersion = '3.1.4'
-        zip4jVersion = '2.6.1'
+        zip4jVersion = '2.6.2'
 
         // only test
         httpClientVersion = '4.5.12'

core/build.gradle

@@ -9,7 +9,6 @@ ext {
 
 dependencies {
     api group: 'org.testcontainers', name: 'testcontainers', version: testContainersVersion
-    implementation group: 'com.hivemq', name: 'hivemq-mqtt-client', version: hmcVersion
     implementation group: 'commons-io', name: 'commons-io', version: commonsIoVersion
     implementation group: 'org.javassist', name: 'javassist', version: javassistVersion
     implementation group: 'org.jboss.shrinkwrap', name: 'shrinkwrap-api', version: shrinkWrapVersion
@@ -30,6 +29,7 @@ dependencies {
     compileOnly group: 'com.hivemq', name: 'hivemq-extension-sdk', version: extensionSDKVersion
 
     testImplementation group: 'com.hivemq', name: 'hivemq-extension-sdk', version: extensionSDKVersion
+    testImplementation group: 'com.hivemq', name: 'hivemq-mqtt-client', version: hmcVersion
     testImplementation group: 'com.google.dagger', name: 'dagger', version: daggerVersion
     testAnnotationProcessor group: 'com.google.dagger', name: 'dagger-compiler', version: daggerVersion
 }

core/src/main/java/com/hivemq/testcontainer/core/HiveMQTestContainerCore.java

@@ -68,16 +68,18 @@ public class HiveMQTestContainerCore<SELF extends HiveMQTestContainerCore<SELF>>
     private final @NotNull ConcurrentHashMap<String, CountDownLatch> containerOutputLatches = new ConcurrentHashMap<>();
     private volatile boolean silent = false;
 
+    private final @NotNull MultiLogMessageWaitStrategy waitStrategy = new MultiLogMessageWaitStrategy();
+
     public HiveMQTestContainerCore() {
         this(DEFAULT_HIVEMQ_IMAGE, DEFAULT_HIVEMQ_TAG);
     }
 
     public HiveMQTestContainerCore(final @NotNull String image, final @NotNull String tag) {
         super(image + ":" + tag);
-        withExposedPorts(MQTT_PORT);
+        addExposedPort(MQTT_PORT);
 
-        final MqttWaitStrategy mqttWaitStrategy = new MqttWaitStrategy();
-        waitingFor(mqttWaitStrategy);
+        waitStrategy.withRegEx("(.*)Started HiveMQ in(.*)");
+        waitingFor(waitStrategy);
 
         withLogConsumer(outputFrame -> {
             if (!silent) {
@@ -98,6 +100,32 @@ public HiveMQTestContainerCore(final @NotNull String image, final @NotNull Strin
         });
     }
 
+    /**
+     * Adds a wait condition for the extension with this name.
+     * <p>
+     * Must be called before the container is started.
+     *
+     * @param extensionName the extension to wait for
+     * @return self
+     */
+    public @NotNull SELF waitForExtension(final @NotNull String extensionName) {
+        final String regEX = "(.*)Extension \"" + extensionName + "\" version (.*) started successfully(.*)";
+        waitStrategy.withRegEx(regEX);
+        return self();
+    }
+
+    /**
+     * Adds a wait condition for this {@link HiveMQExtension}
+     * <p>
+     * Must be called before the container is started.
+     *
+     * @param extension the extension to wait for
+     * @return self
+     */
+    public @NotNull SELF waitForExtension(final @NotNull HiveMQExtension extension) {
+        return this.waitForExtension(extension.getName());
+    }
+
     /**
      * Enables the possibility for remote debugging clients to connect.
      * <p>
@@ -107,8 +135,8 @@ public HiveMQTestContainerCore(final @NotNull String image, final @NotNull Strin
      * @return self
      */
     public @NotNull SELF withDebugging(final int debuggingPortHost) {
-        withExposedPorts(DEBUGGING_PORT);
-        withFixedExposedPort(debuggingPortHost, DEBUGGING_PORT);
+        addExposedPorts(DEBUGGING_PORT);
+        addFixedExposedPort(debuggingPortHost, DEBUGGING_PORT);
         withEnv("JAVA_OPTS", "-agentlib:jdwp=transport=dt_socket,address=0.0.0.0:" + DEBUGGING_PORT + ",server=y,suspend=n");
         return self();
     }
@@ -582,8 +610,8 @@ private void putSubclassesIntoJar(
      * @return self
      */
     public @NotNull SELF withControlCenter(final int controlCenterPort) {
-        withExposedPorts(CONTROL_CENTER_PORT);
-        withFixedExposedPort(controlCenterPort, CONTROL_CENTER_PORT);
+        addExposedPorts(CONTROL_CENTER_PORT);
+        addFixedExposedPort(controlCenterPort, CONTROL_CENTER_PORT);
         return self();
     }
 

core/src/main/java/com/hivemq/testcontainer/core/MqttWaitStrategy.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2020 HiveMQ and the HiveMQ Community
+ *
+ * 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 com.hivemq.testcontainer.core;
+
+import org.jetbrains.annotations.NotNull;
+import org.testcontainers.DockerClientFactory;
+import org.testcontainers.containers.ContainerLaunchException;
+import org.testcontainers.containers.output.OutputFrame;
+import org.testcontainers.containers.output.WaitingConsumer;
+import org.testcontainers.containers.wait.strategy.AbstractWaitStrategy;
+import org.testcontainers.utility.LogUtils;
+
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import java.util.function.Predicate;
+
+/**
+ * This is a wait strategy to wait for multiple log patterns.
+ * The wait strategy will continue when every log pattern is matched at least once.
+ *
+ * @author Yannick Weber
+ * @since 1.2.0
+ */
+class MultiLogMessageWaitStrategy extends AbstractWaitStrategy {
+
+    private final @NotNull ConcurrentHashMap<String, Boolean> regexes = new ConcurrentHashMap<>();
+
+    @Override
+    protected void waitUntilReady() {
+        WaitingConsumer waitingConsumer = new WaitingConsumer();
+        LogUtils.followOutput(DockerClientFactory.instance().client(), waitStrategyTarget.getContainerId(), waitingConsumer);
+
+        Predicate<OutputFrame> waitPredicate = outputFrame -> {
+            if (regexes.isEmpty()) {
+                return true;
+            }
+            regexes.entrySet().forEach(stringBooleanEntry -> {
+                final boolean matched = outputFrame.getUtf8String().matches("(?s)" + stringBooleanEntry.getKey());
+                if (matched) {
+                    stringBooleanEntry.setValue(true);
+                }
+            });
+            return regexes.values().stream().reduce(Boolean::logicalAnd).orElse(true);
+        };
+
+        try {
+            waitingConsumer.waitUntil(waitPredicate, startupTimeout.getSeconds(), TimeUnit.SECONDS, 1);
+        } catch (TimeoutException e) {
+            throw new ContainerLaunchException("Timed out waiting for log output matching '" + regexes + "'");
+        }
+    }
+
+    public @NotNull MultiLogMessageWaitStrategy withRegEx(final @NotNull String regEx) {
+        regexes.put(regEx, false);
+        return this;
+    }
+}

core/src/main/java/com/hivemq/testcontainer/core/MultiLogMessageWaitStrategy.java

@@ -28,16 +28,19 @@ public class ContainerWithDaggerExtensionIT {
 
     @Test(timeout = 200_000)
     public void test() throws Exception {
+        final HiveMQExtension hiveMQExtension = HiveMQExtension.builder()
+                .id("extension-1")
+                .name("my-extension")
+                .version("1.0")
+                .mainClass(MyExtensionWithDagger.class)
+                .addAdditionalClass(MyModule.class)
+                .addAdditionalClass(Class.forName("com.hivemq.testcontainer.util.dagger.MyModule_ProvidePublishModifierFactory"))
+                .build();
+
         final HiveMQTestContainerRule rule =
                 new HiveMQTestContainerRule()
-                        .withExtension(HiveMQExtension.builder()
-                                .id("extension-1")
-                                .name("my-extension")
-                                .version("1.0")
-                                .mainClass(MyExtensionWithDagger.class)
-                                .addAdditionalClass(MyModule.class)
-                                .addAdditionalClass(Class.forName("com.hivemq.testcontainer.util.dagger.MyModule_ProvidePublishModifierFactory"))
-                                .build());
+                        .waitForExtension(hiveMQExtension)
+                        .withExtension(hiveMQExtension);
 
         rule.start();
 

junit4/src/test/java/com/hivemq/testcontainer/junit4/ContainerWithDaggerExtensionIT.java

@@ -30,6 +30,7 @@ public class ContainerWithExtensionFromDirectoryIT {
     public void test() throws Exception {
         final HiveMQTestContainerRule rule =
                 new HiveMQTestContainerRule()
+                        .waitForExtension("Modifier Extension")
                         .withExtension(new File("src/test/resources/modifier-extension"))
                         .withLogLevel(Level.DEBUG);
 

junit4/src/test/java/com/hivemq/testcontainer/junit4/ContainerWithExtensionFromDirectoryIT.java

@@ -28,13 +28,16 @@ public class ContainerWithExtensionIT {
 
     @Test(timeout = 200_000)
     public void test() throws Exception {
+        final HiveMQExtension hiveMQExtension = HiveMQExtension.builder()
+                .id("extension-1")
+                .name("my-extension")
+                .version("1.0")
+                .mainClass(MyExtension.class).build();
+
         final @NotNull HiveMQTestContainerRule rule =
                 new HiveMQTestContainerRule()
-                        .withExtension(HiveMQExtension.builder()
-                                .id("extension-1")
-                                .name("my-extension")
-                                .version("1.0")
-                                .mainClass(MyExtension.class).build());
+                        .waitForExtension(hiveMQExtension)
+                        .withExtension(hiveMQExtension);
 
         rule.start();
         TestPublishModifiedUtil.testPublishModified(rule.getMqttPort());

junit4/src/test/java/com/hivemq/testcontainer/junit4/ContainerWithExtensionIT.java

@@ -28,15 +28,17 @@ public class ContainerWithExtensionSubclassIT {
 
     @Test(timeout = 200_000)
     public void test() throws Exception {
+        final HiveMQExtension hiveMQExtension = HiveMQExtension.builder()
+                .id("extension-1")
+                .name("my-extension")
+                .version("1.0")
+                .priority(100)
+                .startPriority(1000)
+                .mainClass(MyExtensionWithSubclasses.class).build();
+
         final HiveMQTestContainerRule rule =
                 new HiveMQTestContainerRule()
-                        .withExtension(HiveMQExtension.builder()
-                                .id("extension-1")
-                                .name("my-extension")
-                                .version("1.0")
-                                .priority(100)
-                                .startPriority(1000)
-                                .mainClass(MyExtensionWithSubclasses.class).build())
+                        .withExtension(hiveMQExtension)
                         .withLogLevel(Level.DEBUG);
 
         rule.start();

junit4/src/test/java/com/hivemq/testcontainer/junit4/ContainerWithExtensionSubclassIT.java

@@ -39,13 +39,16 @@ public class ContainerWithFileInExtensionHomeIT {
 
     @Test(timeout = 200_000)
     public void test() throws Exception {
+        final HiveMQExtension hiveMQExtension = HiveMQExtension.builder()
+                .id("extension-1")
+                .name("my-extension")
+                .version("1.0")
+                .mainClass(FileCheckerExtension.class).build();
+
         final HiveMQTestContainerRule rule =
                 new HiveMQTestContainerRule()
-                        .withExtension(HiveMQExtension.builder()
-                                .id("extension-1")
-                                .name("my-extension")
-                                .version("1.0")
-                                .mainClass(FileCheckerExtension.class).build())
+                        .waitForExtension(hiveMQExtension)
+                        .withExtension(hiveMQExtension)
                         .withFileInExtensionHomeFolder(
                                 new File("src/test/resources/additionalFile.txt"),
                                 "extension-1",