From 9015729c36d741ce0d0a29abfb26f4f8acc68795 Mon Sep 17 00:00:00 2001
From: Edwin Shin <edwin.shin@yourmediashelf.com>
Date: Fri, 18 Dec 2009 07:25:37 +0000
Subject: [PATCH] NotificationInvocationHandlerTest should behave better now.
 Re-added to configX tests.

---
 fcrepo-integrationtest/pom.xml                |  22 +--
 .../NotificationInvocationHandlerTest.java    | 134 ++++++++++++------
 .../fedora/server/messaging/JMSManager.java   |  18 ++-
 .../fedora/server/messaging/Listener.java     |  17 ++-
 4 files changed, 121 insertions(+), 70 deletions(-)

diff --git a/fcrepo-integrationtest/pom.xml b/fcrepo-integrationtest/pom.xml
index fd2c97791..ffab6e84c 100644
--- a/fcrepo-integrationtest/pom.xml
+++ b/fcrepo-integrationtest/pom.xml
@@ -138,11 +138,7 @@
                   <includes>
 
                     <include>**/AtomAPIMMessageTest.class</include>
-
-                    <!--
-                      Hangs intermittently
-                      <include>**/NotificationInvocationHandlerTest.class</include>
-                    -->
+                    <include>**/NotificationInvocationHandlerTest.class</include>
 
                     <!--
                       Has bug in source-code
@@ -257,17 +253,13 @@
 
                   <includes>
 
-                    <!--
-                      Hangs intermititently
-                      <include>**/NotificationInvocationHandlerTest.class</include>
-                    -->
-
                     <!--
                       Has bug in source-code
                       <include>**/SimpleDeploymentTests.class</include>
                     -->
 
                     <include>**/AtomAPIMMessageTest.class</include>
+                    <include>**/NotificationInvocationHandlerTest.class</include>
                     <include>**/DOTranslationUtilityTest.class</include>
                     <include>**/TestIngest.class</include>
                     <include>**/TestAPIA.class</include>
@@ -377,10 +369,7 @@
 
                   <includes>
 
-                    <!--
-                      Hangs intermittently
-                      <include>**/NotificationInvocationHandlerTest.class</include>
-                    -->
+                    <include>**/NotificationInvocationHandlerTest.class</include>
 
                     <!--
                       Has bug in source-code
@@ -500,10 +489,7 @@
 
                   <includes>
 
-                    <!--
-                      Hangs intermittently
-                      <include>**/NotificationInvocationHandlerTest.class</include>
-                    -->
+                    <include>**/NotificationInvocationHandlerTest.class</include>
 
                     <!--
                       Has bug in source-code
diff --git a/fcrepo-integrationtest/src/test/java/fedora/server/messaging/NotificationInvocationHandlerTest.java b/fcrepo-integrationtest/src/test/java/fedora/server/messaging/NotificationInvocationHandlerTest.java
index e30ffd905..170c7fea6 100644
--- a/fcrepo-integrationtest/src/test/java/fedora/server/messaging/NotificationInvocationHandlerTest.java
+++ b/fcrepo-integrationtest/src/test/java/fedora/server/messaging/NotificationInvocationHandlerTest.java
@@ -2,6 +2,7 @@
  * detailed in the license directory at the root of the source tree (also
  * available online at http://fedora-commons.org/license/).
  */
+
 package fedora.server.messaging;
 
 import java.util.ArrayList;
@@ -9,23 +10,25 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.concurrent.CountDownLatch;
 
+import javax.jms.Message;
+import javax.jms.MessageListener;
+import javax.jms.TextMessage;
 import javax.naming.Context;
 
-import javax.jms.TextMessage;
+import junit.framework.JUnit4TestAdapter;
 
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 
-import junit.framework.JUnit4TestAdapter;
-
 import fedora.server.MockContext;
+import fedora.server.errors.MessagingException;
 import fedora.server.management.Management;
 import fedora.server.management.MockManagementDelegate;
 import fedora.server.messaging.Messaging.MessageType;
 import fedora.server.proxy.ProxyFactory;
-
 import fedora.test.FedoraTestCase;
 
 /**
@@ -39,13 +42,19 @@ public class NotificationInvocationHandlerTest
 
     private JMSManager jmsMgr;
 
+    public static junit.framework.Test suite() {
+        return new JUnit4TestAdapter(NotificationInvocationHandlerTest.class);
+    }
+
     @Override
     @Before
     public void setUp() throws Exception {
         Properties props = new Properties();
-        props.setProperty(Context.INITIAL_CONTEXT_FACTORY,
+        props
+                .setProperty(Context.INITIAL_CONTEXT_FACTORY,
                              "org.apache.activemq.jndi.ActiveMQInitialContextFactory");
-        props.setProperty(Context.PROVIDER_URL,
+        props
+                .setProperty(Context.PROVIDER_URL,
                              "vm://localhost?broker.useShutdownHook=false&broker.persistent=false");
         props.setProperty(JMSManager.CONNECTION_FACTORY_NAME,
                           "ConnectionFactory");
@@ -63,42 +72,87 @@ public void tearDown() throws Exception {
     }
 
     @Test
-    public void testAPIMMessages() throws Exception {
-
-        new Thread() {
-
-            @Override
-            public void run() {
-                try {
-                    Map<String, List<String>> mdMap =
-                            new HashMap<String, List<String>>();
-                    List<String> destinations = new ArrayList<String>();
-                    destinations.add("fedora.apim.update");
-                    mdMap.put(MessageType.apimUpdate.toString(), destinations);
-                    Messaging msg =
-                            new MessagingImpl(getBaseURL(), mdMap, jmsMgr);
-                    Object[] invocationHandlers =
-                            {new NotificationInvocationHandler(msg)};
-                    Management mgmt = new MockManagementDelegate();
-                    Management proxy =
-                            (Management) ProxyFactory
-                                    .getProxy(mgmt, invocationHandlers);
-                    proxy.purgeObject(new MockContext(),
-                                      "demo:test",
-                                      null,
-                                      false);
-                } catch (Exception e) {
-                    fail(e.getMessage());
-                }
+    public void testAPIMPubAndReceipt() throws Exception {
+
+        // Create a listener
+        CountDownLatch listeningSignal = new CountDownLatch(1);
+        CountDownLatch doneSignal = new CountDownLatch(1);
+        Thread listener = new ListenerThread(listeningSignal, doneSignal);
+        listener.start();
+        listeningSignal.await();
+
+        // Publish an APIM event
+        try {
+            Map<String, List<String>> mdMap =
+                    new HashMap<String, List<String>>();
+            List<String> destinations = new ArrayList<String>();
+            destinations.add("fedora.apim.update");
+            mdMap.put(MessageType.apimUpdate.toString(), destinations);
+            Messaging msg = new MessagingImpl(getBaseURL(), mdMap, jmsMgr);
+            Object[] invocationHandlers =
+                    {new NotificationInvocationHandler(msg)};
+            Management mgmt = new MockManagementDelegate();
+            Management proxy =
+                    (Management) ProxyFactory
+                            .getProxy(mgmt, invocationHandlers);
+            proxy.purgeObject(new MockContext(), "demo:test", null, false);
+        } catch (Exception e) {
+            listener.interrupt();
+            throw e;
+        }
+        // await message receipt & evaluation
+        doneSignal.await();
+    }
+
+    class ListenerThread
+            extends Thread
+            implements MessageListener {
+
+        private final CountDownLatch listeningSignal;
+
+        private final CountDownLatch doneSignal;
+
+        ListenerThread(CountDownLatch listeningSignal, CountDownLatch doneSignal) {
+            this.listeningSignal = listeningSignal;
+            this.doneSignal = doneSignal;
+        }
+
+        @Override
+        public void run() {
+            try {
+                jmsMgr.listen("fedora.apim.update", this);
+            } catch (MessagingException e) {
+                fail(e.getMessage());
+            } finally {
+                listeningSignal.countDown();
             }
-        }.start();
+        }
 
-        TextMessage message = (TextMessage) jmsMgr.listen("fedora.apim.update");
-        APIMMessage apim = new AtomAPIMMessage(message.getText());
-        assertEquals("demo:test", apim.getPID());
-    }
+        @Override
+        public void interrupt() {
+            try {
+                jmsMgr.close();
+            } catch (MessagingException e) {
+                fail(e.getMessage());
+            } finally {
+                super.interrupt();
+            }
+        }
 
-    public static junit.framework.Test suite() {
-        return new JUnit4TestAdapter(NotificationInvocationHandlerTest.class);
+        /**
+         *
+         * {@inheritDoc}
+         */
+        public void onMessage(Message msg) {
+            try {
+                TextMessage message = (TextMessage) msg;
+                APIMMessage apim = new AtomAPIMMessage(message.getText());
+                assertEquals("demo:test", apim.getPID());
+            } catch (Exception e) {
+                fail(e.getMessage());
+            } finally {
+                doneSignal.countDown();
+            }
+        }
     }
 }
diff --git a/fcrepo-server/src/main/java/fedora/server/messaging/JMSManager.java b/fcrepo-server/src/main/java/fedora/server/messaging/JMSManager.java
index e8e17f67c..da77b7726 100644
--- a/fcrepo-server/src/main/java/fedora/server/messaging/JMSManager.java
+++ b/fcrepo-server/src/main/java/fedora/server/messaging/JMSManager.java
@@ -5,7 +5,6 @@
 package fedora.server.messaging;
 
 import java.io.Serializable;
-
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Hashtable;
@@ -15,10 +14,6 @@
 import java.util.Properties;
 import java.util.Set;
 
-import javax.naming.Context;
-import javax.naming.InitialContext;
-import javax.naming.NamingException;
-
 import javax.jms.BytesMessage;
 import javax.jms.Connection;
 import javax.jms.ConnectionFactory;
@@ -33,6 +28,9 @@
 import javax.jms.Session;
 import javax.jms.TextMessage;
 import javax.jms.Topic;
+import javax.naming.Context;
+import javax.naming.InitialContext;
+import javax.naming.NamingException;
 
 import org.apache.log4j.Logger;
 
@@ -60,7 +58,7 @@ public class JMSManager {
     public static final String CONNECTION_FACTORY_NAME = "connection.factory.name";
 
     // Default connection factory name, used if no connection factory name is specified
-    private String defaultConnectionFactoryName = "ConnectionFactory";
+    private final String defaultConnectionFactoryName = "ConnectionFactory";
 
     // JNDI related data
     protected Context jndi = null;
@@ -77,7 +75,7 @@ public class JMSManager {
     protected Map<String, MessageConsumer> durableSubscriptions =
             new HashMap<String, MessageConsumer>();
 
-    private Properties jndiProps;
+    private final Properties jndiProps;
 
     // Destination type determines the method by which messages are transferred
     public static enum DestinationType {
@@ -564,7 +562,7 @@ public void stop(String destName) throws MessagingException {
             // Look for an existing destination for the given destination
             //
             JMSDestination jmsDest =
-                    (JMSDestination) jmsDestinations.get(destName);
+                    jmsDestinations.get(destName);
             if (jmsDest != null) {
                 // Close out all JMS related state
                 //
@@ -825,13 +823,13 @@ protected JMSDestination getJMSDestination(String name)
             throws MessagingException {
         // Look for an existing Destination for the given name
         //
-        JMSDestination jmsDest = (JMSDestination) jmsDestinations.get(name);
+        JMSDestination jmsDest = jmsDestinations.get(name);
 
         // If not found, create it now
         //
         if (jmsDest == null) {
             this.createDestination(name, defaultDestinationType);
-            jmsDest = (JMSDestination) jmsDestinations.get(name);
+            jmsDest = jmsDestinations.get(name);
         }
 
         return jmsDest;
diff --git a/fcrepo-server/src/test/java/fedora/server/messaging/Listener.java b/fcrepo-server/src/test/java/fedora/server/messaging/Listener.java
index a5248e95b..5394b2e78 100644
--- a/fcrepo-server/src/test/java/fedora/server/messaging/Listener.java
+++ b/fcrepo-server/src/test/java/fedora/server/messaging/Listener.java
@@ -6,18 +6,31 @@
 
 import java.util.Properties;
 
-import javax.naming.Context;
-
 import javax.jms.JMSException;
 import javax.jms.Message;
 import javax.jms.MessageListener;
 import javax.jms.TextMessage;
+import javax.naming.Context;
 
+/**
+ * Test class for listening to a JMS topic.
+ *
+ * @author Edwin Shin
+ * @version $Id$
+ */
 public class Listener
         implements MessageListener {
 
     private final JMSManager jmsMgr;
 
+    /**
+     * Create a Listener object for the specified JMS topic.
+     *
+     * @param topicName the JMS topic to listen to, e.g. "fedora.apim.update"
+     * @param jndiProps Properties file that contains, at a minimum, values for
+     * Context.INITIAL_CONTEXT_FACTORY and Context.PROVIDER_URL
+     * @throws Exception
+     */
     public Listener(String topicName, Properties jndiProps)
             throws Exception {
         jmsMgr = new JMSManager(jndiProps);