Update to run tests against a containerized broker

(cherry picked from commit 4864e83)

Conflicts:
	RUNNING_TESTS.md

Author: acogoluegnes

README.md

@@ -69,6 +69,67 @@ c.close()
 /exit
 ```
 
+## Building from Source
+
+### Getting the Project and its Dependencies
+
+```
+git clone [email protected]:rabbitmq/rabbitmq-java-client.git
+cd rabbitmq-java-client
+make deps
+```
+
+### Building the JAR File
+
+```
+./mvnw clean package -Dmaven.test.skip -P '!setup-test-cluster'
+```
+
+### Launching Tests with the Broker Running In a Docker Container
+
+Run the broker:
+
+```
+docker run -it --rm --name rabbitmq -p 5672:5672 rabbitmq:3.8
+```
+
+Launch "essential" tests (takes about 10 minutes):
+
+```
+./mvnw verify -P '!setup-test-cluster' \
+    -Drabbitmqctl.bin=DOCKER:rabbitmq \
+    -Dit.test=ClientTests,FunctionalTests,ServerTests
+```
+
+Launch a single test:
+
+```
+./mvnw verify -P '!setup-test-cluster' \
+    -Drabbitmqctl.bin=DOCKER:rabbitmq \
+    -Dit.test=DeadLetterExchange
+```
+
+### Launching Tests with a Local Broker
+
+The tests can run against a local broker as well. The `rabbitmqctl.bin`
+system property must point to the `rabbitmqctl` program:
+
+```
+./mvnw verify -P '!setup-test-cluster' \
+       -Dtest-broker.A.nodename=rabbit@$(hostname) \
+       -Drabbitmqctl.bin=/path/to/rabbitmqctl \
+       -Dit.test=ClientTests,FunctionalTests,ServerTests
+```
+
+To launch a single test:
+
+```
+./mvnw verify -P '!setup-test-cluster' \
+       -Dtest-broker.A.nodename=rabbit@$(hostname) \
+       -Drabbitmqctl.bin=/path/to/rabbitmqctl \
+       -Dit.test=DeadLetterExchange
+```
+
 ## Contributing
 
 See [Contributing](./CONTRIBUTING.md) and [How to Run Tests](./RUNNING_TESTS.md).

RUNNING_TESTS.md

@@ -166,6 +166,7 @@ Tests run: 121, Failures: 0, Errors: 0, Skipped: 0
 
 Test reports can be found in `target/failsafe-reports`.
 
+<<<<<<< HEAD
 
 ## Running tests against an externally provided broker or cluster
 
@@ -183,3 +184,22 @@ mvn verify -P '!setup-test-cluster'
 
 Note that by doing so some tests will fail as they require `rabbitmqctl` to
 control the running nodes.
+
+## Running Against a Broker in a Docker Container
+
+Run the broker:
+
+```
+docker run -it --rm --name rabbitmq -p 5672:5672 rabbitmq:3.8
+```
+
+Launch the tests:
+
+```
+./mvnw verify -P '!setup-test-cluster' \
+    -Drabbitmqctl.bin=DOCKER:rabbitmq \
+    -Dit.test=ClientTests,FunctionalTests,ServerTests
+```
+
+Note the `rabbitmqctl.bin` system property uses the syntax
+`DOCKER:{containerId}`.

src/test/java/com/rabbitmq/client/test/AbstractRMQTestSuite.java

@@ -43,35 +43,9 @@ public abstract class AbstractRMQTestSuite {
   }
 
   public static boolean requiredProperties() {
-    /* GNU Make. */
-    String make = Host.makeCommand();
-    boolean isGNUMake = false;
-    if (make != null) {
-      try {
-        Process makeProc = Host.executeCommandIgnoringErrors(make + " --version");
-        String makeVersion = Host.capture(makeProc.getInputStream());
-        isGNUMake = makeVersion.startsWith("GNU Make");
-      } catch (IOException e) {}
-    }
-    if (!isGNUMake) {
-      System.err.println(
-          "GNU Make required; please set \"make.bin\" system property" +
-          " or \"$MAKE\" environment variable");
-      return false;
-    }
-
-    /* Path to RabbitMQ. */
-    String rabbitmq = Host.rabbitmqDir();
-    if (rabbitmq == null || !new File(rabbitmq).isDirectory()) {
-      System.err.println(
-          "RabbitMQ required; please set \"rabbitmq.dir\" system" +
-          " property");
-      return false;
-    }
-
     /* Path to rabbitmqctl. */
     String rabbitmqctl = Host.rabbitmqctlCommand();
-    if (rabbitmqctl == null || !new File(rabbitmqctl).isFile()) {
+    if (rabbitmqctl == null) {
       System.err.println(
           "rabbitmqctl required; please set \"rabbitmqctl.bin\" system" +
           " property");

src/test/java/com/rabbitmq/client/test/BrokerTestCase.java

@@ -148,7 +148,7 @@ protected void bareRestart()
     public void openConnection()
             throws IOException, TimeoutException {
         if (connection == null) {
-            connection = connectionFactory.newConnection();
+            connection = connectionFactory.newConnection(UUID.randomUUID().toString());
         }
     }
 

src/test/java/com/rabbitmq/client/test/NoAutoRecoveryWhenTcpWindowIsFullTest.java

@@ -29,6 +29,7 @@
 import com.rabbitmq.client.impl.recovery.AutorecoveringConnection;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.ClassRule;
 import org.junit.Test;
 
 import java.io.IOException;
@@ -41,6 +42,7 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
+import org.junit.rules.TestRule;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -66,6 +68,9 @@
  */
 public class NoAutoRecoveryWhenTcpWindowIsFullTest {
 
+    @ClassRule
+    public static TestRule brokerOnDockerTestRule = TestUtils.brokerIsNotRunningOnDocker();
+
     private static final int NUM_MESSAGES_TO_PRODUCE = 50000;
     private static final int MESSAGE_PROCESSING_TIME_MS = 3000;
     private static final byte[] MESSAGE_CONTENT = ("MESSAGE CONTENT " + NUM_MESSAGES_TO_PRODUCE).getBytes();

src/test/java/com/rabbitmq/client/test/RpcTest.java

@@ -217,7 +217,7 @@ public void givenConsumerNotRecoveredCanCreateNewClientOnSameChannelAfterConnect
         cf.setNetworkRecoveryInterval(1000);
         Connection connection = null;
         try {
-            connection = cf.newConnection();
+            connection = cf.newConnection(UUID.randomUUID().toString());
             Channel channel = connection.createChannel();
             RpcClient client = new RpcClient(new RpcClientParams()
                     .channel(channel).exchange("").routingKey(queue).timeout(1000));
@@ -265,7 +265,7 @@ public void givenConsumerIsRecoveredCanNotCreateNewClientOnSameChannelAfterConne
         cf.setNetworkRecoveryInterval(1000);
         Connection connection = null;
         try {
-            connection = cf.newConnection();
+            connection = cf.newConnection(UUID.randomUUID().toString());
             Channel channel = connection.createChannel();
             RpcClient client = new RpcClient(new RpcClientParams()
                     .channel(channel).exchange("").routingKey(queue).timeout(1000));

src/test/java/com/rabbitmq/client/test/TestUtils.java

@@ -114,6 +114,10 @@ public static TestRule atLeast38() {
         return new BrokerVersionTestRule("3.8.0");
     }
 
+    public static TestRule brokerIsNotRunningOnDocker() {
+        return new BrokerIsNotOnDocker();
+    }
+
     public static boolean isVersion37orLater(Connection connection) {
         return atLeastVersion("3.7.0", connection);
     }
@@ -312,6 +316,27 @@ public void evaluate() throws Throwable {
         }
     }
 
+    private static class BrokerIsNotOnDocker implements TestRule {
+
+
+        @Override
+        public Statement apply(Statement base, Description description) {
+            return new Statement() {
+                @Override
+                public void evaluate() throws Throwable {
+                    try {
+                        if (Host.isOnDocker()) {
+                            throw new AssumptionViolatedException("Broker is running on Docker");
+                        }
+                    } catch (Exception e) {
+                        throw new AssumptionViolatedException("Could not check whether broker is running on Docker or not", e);
+                    }
+                    base.evaluate();
+                }
+            };
+        }
+    }
+
     @FunctionalInterface
     public interface CallableFunction<T, R> {
 

src/test/java/com/rabbitmq/client/test/functional/ConnectionRecovery.java

@@ -57,7 +57,7 @@ public class ConnectionRecovery extends BrokerTestCase {
 
     @Test public void namedConnectionRecovery()
             throws IOException, InterruptedException, TimeoutException  {
-        String connectionName = "custom name";
+        String connectionName = "custom-name";
         RecoverableConnection c = newRecoveringConnection(connectionName);
         try {
             assertThat(c.isOpen()).isTrue();
@@ -151,7 +151,7 @@ public String getPassword() {
                 return password;
             }
         });
-        RecoverableConnection c = (RecoverableConnection) cf.newConnection();
+        RecoverableConnection c = (RecoverableConnection) cf.newConnection(UUID.randomUUID().toString());
         try {
             assertThat(c.isOpen()).isTrue();
             assertThat(usernameRequested.get()).isEqualTo(1);
@@ -802,7 +802,7 @@ public void handleDelivery(String consumerTag,
     @Test public void recoveryWithExponentialBackoffDelayHandler() throws Exception {
         ConnectionFactory connectionFactory = TestUtils.connectionFactory();
         connectionFactory.setRecoveryDelayHandler(new RecoveryDelayHandler.ExponentialBackoffDelayHandler());
-        Connection testConnection = connectionFactory.newConnection();
+        Connection testConnection = connectionFactory.newConnection(UUID.randomUUID().toString());
         try {
             assertThat(testConnection.isOpen()).isTrue();
             TestUtils.closeAndWaitForRecovery((RecoverableConnection) testConnection);
@@ -820,7 +820,9 @@ public void handleDelivery(String consumerTag,
         assertThat(connectionFactory.getTopologyRecoveryExecutor()).isNull();
         connectionFactory.setTopologyRecoveryExecutor(executor);
         assertThat(connectionFactory.getTopologyRecoveryExecutor()).isEqualTo(executor);
-        RecoverableConnection testConnection = (RecoverableConnection) connectionFactory.newConnection();
+        RecoverableConnection testConnection = (RecoverableConnection) connectionFactory.newConnection(
+            UUID.randomUUID().toString()
+        );
         try {
             final List<Channel> channels = new ArrayList<Channel>();
             final List<String> exchanges = new ArrayList<String>();
@@ -975,20 +977,20 @@ protected ConnectionFactory newConnectionFactory() {
     private static RecoverableConnection newRecoveringConnection(boolean disableTopologyRecovery)
             throws IOException, TimeoutException {
         ConnectionFactory cf = buildConnectionFactoryWithRecoveryEnabled(disableTopologyRecovery);
-        return (AutorecoveringConnection) cf.newConnection();
+        return (AutorecoveringConnection) cf.newConnection(UUID.randomUUID().toString());
     }
 
     private static RecoverableConnection newRecoveringConnection(Address[] addresses)
             throws IOException, TimeoutException {
         ConnectionFactory cf = buildConnectionFactoryWithRecoveryEnabled(false);
         // specifically use the Address[] overload
-        return (AutorecoveringConnection) cf.newConnection(addresses);
+        return (AutorecoveringConnection) cf.newConnection(addresses, UUID.randomUUID().toString());
     }
 
     private static RecoverableConnection newRecoveringConnection(boolean disableTopologyRecovery, List<Address> addresses)
             throws IOException, TimeoutException {
         ConnectionFactory cf = buildConnectionFactoryWithRecoveryEnabled(disableTopologyRecovery);
-        return (AutorecoveringConnection) cf.newConnection(addresses);
+        return (AutorecoveringConnection) cf.newConnection(addresses, UUID.randomUUID().toString());
     }
 
     private static RecoverableConnection newRecoveringConnection(List<Address> addresses)

src/test/java/com/rabbitmq/client/test/functional/Metrics.java

@@ -30,6 +30,7 @@
 import com.rabbitmq.client.test.BrokerTestCase;
 import com.rabbitmq.client.test.TestUtils;
 import com.rabbitmq.tools.Host;
+import java.util.UUID;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.Parameterized;
@@ -414,7 +415,7 @@ protected void releaseResources() throws IOException {
 
         Connection connection = null;
         try {
-            connection = connectionFactory.newConnection();
+            connection = connectionFactory.newConnection(UUID.randomUUID().toString());
 
             Collection<?> shutdownHooks = getShutdownHooks(connection);
             assertThat(shutdownHooks.size()).isEqualTo(0);
@@ -444,7 +445,7 @@ protected void releaseResources() throws IOException {
 
         Connection connection = null;
         try {
-            connection = connectionFactory.newConnection();
+            connection = connectionFactory.newConnection(UUID.randomUUID().toString());
 
             Channel channel1 = connection.createChannel();
             AtomicInteger ackedMessages = new AtomicInteger(0);

src/test/java/com/rabbitmq/client/test/functional/TopologyRecoveryFiltering.java

@@ -29,6 +29,7 @@
 import com.rabbitmq.client.impl.recovery.TopologyRecoveryFilter;
 import com.rabbitmq.client.test.BrokerTestCase;
 import com.rabbitmq.client.test.TestUtils;
+import java.util.UUID;
 import org.junit.Test;
 
 import java.io.IOException;
@@ -66,7 +67,7 @@ protected ConnectionFactory newConnectionFactory() {
     @Override
     protected void createResources() throws IOException, TimeoutException {
         super.createResources();
-        c = connectionFactory.newConnection();
+        c = connectionFactory.newConnection(UUID.randomUUID().toString());
         deleteExchanges(exchangesToDelete);
         deleteQueues(queuesToDelete);
     }