Refactor to extend junit closeableResource to clean up jms resources (#112)

Co-authored-by: santhosh <santhosh.kotha@hmcts.net>

Author: santhosh-hmcts

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageConsumerClientBuilder.java

@@ -26,13 +26,13 @@ public static JmsMessageConsumerClientBuilder newJmsMessageConsumerClientBuilder
     }
 
     @VisibleForTesting
-    JmsMessageConsumerClientBuilder(final String topicName, final JmsSingletonResourceProvider jmsSingletonResourceProvider) {
+    JmsMessageConsumerClientBuilder(final String topicName, final JmsResourcesContext jmsResourcesContext) {
         this.topicName = topicName;
-        this.jmsMessageClientFactory = jmsSingletonResourceProvider.getJmsMessageClientFactory();
+        this.jmsMessageClientFactory = jmsResourcesContext.getJmsMessageClientFactory();
     }
 
     private JmsMessageConsumerClientBuilder(final String topicName) {
-        this(topicName, new JmsSingletonResourceProvider());
+        this(topicName, new JmsResourcesContextProvider().get());
     }
 
     public JmsMessageConsumerClientBuilder withEventNames(final String eventName, final String...additionalEventNames) {

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageConsumerFactory.java

@@ -30,5 +30,6 @@ MessageConsumer createAndStart(final ActiveMQTopic topic, final String messageSe
 
     void close() {
         jmsSessionFactory.close(); //closes session and underlying connection, connectionFactory
+        this.session = null;
     }
 }

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageConsumerPool.java

@@ -14,7 +14,6 @@
  * Provides method to clear messages from all cached consumers (so that same consumers can be reused across tests)
  * Provides method to close cached consumers without closing underlying session and connection (provides capability to recycle consumers after each Test class)
  * Provides method to close underlying session/connection
- * This class is created through {@link JmsSingletonResourceProvider} which maintains singleton ness
  */
 class JmsMessageConsumerPool {
 

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageProducerClient.java

@@ -13,6 +13,8 @@
 /**
  * Use {@link JmsMessageProducerClientBuilder} to create instance
  * It's safe to create multiple instances of this class with same parameters, as underlying jms producer is cached and it retrieves existing producer
+ *  It's not recommended to cache these classes across Test classes, reusability is recommended only within same Test class. After each Test class all cached producers are closed.
+ *  Hence, don't create instances of this class in Helper/Utility classes and assign it to static class variables. Doing this within a Test class is totally fine though
  * Life cycle of underlying jms producer is not managed by this class (Managed by {@link JmsMessageConsumerPool} through Junit hooks {@link JmsResourceManagementExtension}) and hence these instances can be created without worrying about cleaning underlying jms resources
  * This class provides all various helper methods to send message to underlying topic
  * If there is no convenient method that you are looking for, please enhance this class rather than creating them in context ITs. This approach avoids duplication and promotes reusability across different context Integration tests

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageProducerClientBuilder.java

@@ -15,13 +15,13 @@ public static JmsMessageProducerClientBuilder newPrivateJmsMessageProducerClient
     }
 
     @VisibleForTesting
-    JmsMessageProducerClientBuilder(final String topicName, final JmsSingletonResourceProvider jmsSingletonResourceProvider) {
+    JmsMessageProducerClientBuilder(final String topicName, final JmsResourcesContext jmsResourcesContext) {
         this.topicName = topicName;
-        this.jmsMessageClientFactory = jmsSingletonResourceProvider.getJmsMessageClientFactory();
+        this.jmsMessageClientFactory = jmsResourcesContext.getJmsMessageClientFactory();
     }
 
     private JmsMessageProducerClientBuilder(final String topicName) {
-        this(topicName, new JmsSingletonResourceProvider());
+        this(topicName, new JmsResourcesContextProvider().get());
     }
 
     public JmsMessageProducerClient build() {

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsMessageProducerFactory.java

@@ -9,9 +9,6 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-/**
- * This class need to be singleton and it's maintained by {@link JmsSingletonResourceProvider}
- */
 class JmsMessageProducerFactory {
 
     private Session session;
@@ -34,18 +31,21 @@ Session getSession(String queueUri) {
         return session;
     }
 
-    void close() {
+    void closeProducers() {
         try{
             for(final MessageProducer messageProducer : messageProducers.values()) {
                 messageProducer.close();
             }
             messageProducers.clear();
-            jmsSessionFactory.close(); //closes session and underlying connection, connectionFactory
         } catch (JMSException e) {
             throw new JmsMessagingClientException("Failed to close producers", e);
         }
     }
 
+    void close() {
+        jmsSessionFactory.close(); //closes session and underlying connection, connectionFactory
+    }
+
     private void createSessionIfNull(String queueUri) {
         if (session == null) {
             session = jmsSessionFactory.create(queueUri);

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsResourceManagementExtension.java

@@ -5,65 +5,67 @@
 import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.BeforeEachCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
-import org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource;
+import org.junit.jupiter.api.extension.ExtensionContext.Store;
 
 import static org.junit.jupiter.api.extension.ExtensionContext.Namespace.GLOBAL;
 
 /**
  *  This manages Life cycle of Jms consumers and producers created by a Test class using various junit hooks.
  *  As long as this extension is used by an Integration test, as a developer of writing integration tests you don't need to worry about managing underlying jms resources that are created in Tests
  */
-public class JmsResourceManagementExtension implements BeforeAllCallback, BeforeEachCallback, AfterAllCallback, CloseableResource {
+public class JmsResourceManagementExtension implements BeforeAllCallback, BeforeEachCallback, AfterAllCallback {
 
-    private final JmsMessageConsumerPool jmsMessageConsumerPool;
-
-    private final JmsMessageProducerFactory jmsMessageProducerFactory;
-
-    private static boolean registered = false;
+    static final String TEST_SUITE_SHUTDOWN_JMS_RESOURCE_CLEANUP_HOOK = "JMS_RESOURCE_CLEANUP_HOOK";
+    static final String TEST_SUITE_SHUTDOWN_EXECUTION_TIMER_HOOK = "EXECUTION_TIMER_HOOK";
+    private final JmsResourcesContextProvider jmsResourcesContextProvider;
 
     public JmsResourceManagementExtension() {
-        this(new JmsSingletonResourceProvider().getJmsMessageConsumerPool(),
-                new JmsSingletonResourceProvider().getJmsMessageProducerFactory());
+        this(new JmsResourcesContextProvider());
 
     }
 
     @VisibleForTesting
-    JmsResourceManagementExtension(JmsMessageConsumerPool jmsMessageConsumerPool, JmsMessageProducerFactory jmsMessageProducerFactory) {
-        this.jmsMessageConsumerPool = jmsMessageConsumerPool;
-        this.jmsMessageProducerFactory = jmsMessageProducerFactory;
+    JmsResourceManagementExtension(final JmsResourcesContextProvider jmsResourcesContextProvider) {
+        this.jmsResourcesContextProvider = jmsResourcesContextProvider;
     }
 
     @Override
-    public void beforeAll(final ExtensionContext context) {
-        if (!registered) { //Not a nice way but there is no other elegant way to achieve this i.e. register hook only once
-            registered = true;
-            context.getRoot().getStore(GLOBAL).put("Clean JMS resources", this);
-        }
+    public void beforeAll(final ExtensionContext extensionContext) {
+        final Store globalStore = getGlobalStore(extensionContext);
+        registerTestSuiteShutdownHookForJmsResourceCleanup(globalStore);
+        registerTestSuiteShutdownHookForExecutionTimer(globalStore);
     }
 
     /**
      * Drains all consumer queues created during test, so that message consumers can be reused across other tests within same Test class
      */
     @Override
     public void beforeEach(final ExtensionContext extensionContext) {
-        jmsMessageConsumerPool.clearMessages();
+        jmsResourcesContextProvider.get().clearMessages();
     }
 
     /**
-     * Closes all consumers that are created across all tests within a single Test class.  So, consumers can't be reused across different Test classes (Without this recycling, number of message consumers may outgrow and can cause resource exhaustion)
+     * Closes all consumers/producers that are created across all tests within a single Test class.  So, consumers/producers can't be reused across different Test classes (Without this recycling, number of message consumers may outgrow and can cause resource exhaustion)
      */
     @Override
     public void afterAll(final ExtensionContext extensionContext) {
-        jmsMessageConsumerPool.closeConsumers();
+        jmsResourcesContextProvider.get().closeConsumersAndProducers();
     }
 
-    /**
-     * This is invoked at the end of test suite (through hook registered in beforeAll() method).
-     * This promotes reusing jms session and connection across entire test suite
-     */
-    @Override
-    public void close() {
-        jmsMessageConsumerPool.close();
-        jmsMessageProducerFactory.close();
+    private Store getGlobalStore(ExtensionContext extensionContext) {
+        return extensionContext.getRoot().getStore(GLOBAL);
+    }
+
+    private void registerTestSuiteShutdownHookForJmsResourceCleanup(Store globalStore) {
+        if (globalStore.get(TEST_SUITE_SHUTDOWN_JMS_RESOURCE_CLEANUP_HOOK) == null) {
+            System.out.println("----------Registering test suite shutdown hook (jms resource cleanup)-------------");
+            globalStore.put(TEST_SUITE_SHUTDOWN_JMS_RESOURCE_CLEANUP_HOOK, jmsResourcesContextProvider);
+        }
+    }
+
+    private void registerTestSuiteShutdownHookForExecutionTimer(Store globalStore) {
+        if (globalStore.get(TEST_SUITE_SHUTDOWN_EXECUTION_TIMER_HOOK) == null) {
+            globalStore.put(TEST_SUITE_SHUTDOWN_EXECUTION_TIMER_HOOK, new TestSuiteExecutionTimeCalculator());
+        }
     }
 }

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsResourcesContext.java

@@ -0,0 +1,65 @@
+package uk.gov.justice.services.integrationtest.utils.jms;
+
+import com.google.common.annotations.VisibleForTesting;
+import org.apache.commons.lang3.time.StopWatch;
+import uk.gov.justice.services.integrationtest.utils.jms.converters.ToJsonEnvelopeMessageConverter;
+import uk.gov.justice.services.integrationtest.utils.jms.converters.ToJsonPathMessageConverter;
+import uk.gov.justice.services.integrationtest.utils.jms.converters.ToStringMessageConverter;
+import uk.gov.justice.services.messaging.DefaultJsonObjectEnvelopeConverter;
+
+import java.util.concurrent.TimeUnit;
+
+public class JmsResourcesContext {
+
+    private final JmsMessageConsumerPool jmsMessageConsumerPool;
+    private final JmsMessageProducerFactory jmsMessageProducerFactory;
+    private final JmsMessageClientFactory jmsMessageClientFactory;
+    private final StopWatch stopWatch;
+
+    JmsResourcesContext(final JmsMessageConsumerPool jmsMessageConsumerPool,
+                        final JmsMessageProducerFactory jmsMessageProducerFactory) {
+        this(jmsMessageConsumerPool, jmsMessageProducerFactory,
+                new JmsMessageClientFactory(jmsMessageProducerFactory,
+                        new ToStringMessageConverter(),
+                        new ToJsonEnvelopeMessageConverter(new DefaultJsonObjectEnvelopeConverter()),
+                        new ToJsonPathMessageConverter(),
+                        new JmsMessageReader(),
+                        jmsMessageConsumerPool),
+                new StopWatch());
+    }
+
+    @VisibleForTesting
+    JmsResourcesContext(final JmsMessageConsumerPool jmsMessageConsumerPool,
+                        final JmsMessageProducerFactory jmsMessageProducerFactory,
+                        final JmsMessageClientFactory jmsMessageClientFactory,
+                        final StopWatch stopWatch) {
+        this.jmsMessageConsumerPool = jmsMessageConsumerPool;
+        this.jmsMessageProducerFactory = jmsMessageProducerFactory;
+        this.jmsMessageClientFactory = jmsMessageClientFactory;
+        this.stopWatch = stopWatch;
+    }
+
+    JmsMessageClientFactory getJmsMessageClientFactory() {
+        return jmsMessageClientFactory;
+    }
+
+    void clearMessages() {
+        jmsMessageConsumerPool.clearMessages();
+    }
+
+    void closeConsumersAndProducers() {
+        jmsMessageConsumerPool.closeConsumers();
+        jmsMessageProducerFactory.closeProducers();
+    }
+
+     void close() {
+         System.out.println("----------Closing JMS resources-------------");
+
+         stopWatch.start();
+         jmsMessageConsumerPool.close();
+         jmsMessageProducerFactory.close();
+         stopWatch.stop();
+
+         System.out.printf("----------JMS resources closed in %s secs\n", stopWatch.getTime(TimeUnit.SECONDS));
+    }
+}

test-utils/integration-test-utils-jms/src/main/java/uk/gov/justice/services/integrationtest/utils/jms/JmsResourcesContextProvider.java

@@ -0,0 +1,35 @@
+package uk.gov.justice.services.integrationtest.utils.jms;
+
+import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory;
+import org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource;
+import uk.gov.justice.services.test.utils.core.messaging.TopicFactory;
+
+class JmsResourcesContextProvider implements CloseableResource {
+
+    private static JmsResourcesContext jmsResourcesContext;
+
+    JmsResourcesContext get() {
+        if(jmsResourcesContext == null) {
+            jmsResourcesContext = new JmsResourcesContext(createJmsMessageConsumerPool(), createJmsMessageProducerFactory());
+        }
+
+        return jmsResourcesContext;
+    }
+
+    private JmsMessageConsumerPool createJmsMessageConsumerPool() {
+        return new JmsMessageConsumerPool(new JmsMessageConsumerFactory(new JmsSessionFactory(new ActiveMQConnectionFactory())),
+                new TopicFactory(), new JmsMessageReader());
+    }
+
+    private JmsMessageProducerFactory createJmsMessageProducerFactory() {
+        return new JmsMessageProducerFactory(new JmsSessionFactory(new ActiveMQConnectionFactory()), new TopicFactory());
+    }
+
+    @Override
+    public void close() {
+        if(jmsResourcesContext != null) {
+            jmsResourcesContext.close();
+            jmsResourcesContext = null;
+        }
+    }
+}