QPID-2681 : Refactor existing SCD tests to make Topic Testing easier

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@960543 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 288 insertions, 248 deletions

diff --git a/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalQueuesTest.java b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalQueuesTest.java
index 513bafa8ad..ca89df391d 100644
--- a/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalQueuesTest.java
+++ b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalQueuesTest.java
@@ -21,25 +21,10 @@
 package org.apache.qpid.systest;
 
 import org.apache.commons.configuration.ConfigurationException;
-import org.apache.qpid.AMQChannelClosedException;
-import org.apache.qpid.AMQException;
-import org.apache.qpid.client.AMQSession_0_10;
-import org.apache.qpid.jms.ConnectionListener;
-import org.apache.qpid.protocol.AMQConstant;
-import org.apache.qpid.test.utils.QpidBrokerTestCase;
-
-import javax.jms.Connection;
-import javax.jms.Destination;
-import javax.jms.ExceptionListener;
-import javax.jms.JMSException;
-import javax.jms.MessageConsumer;
-import javax.jms.MessageProducer;
+
 import javax.jms.Session;
-import javax.jms.Topic;
 import javax.naming.NamingException;
 import java.io.IOException;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.TimeUnit;
 
 /**
  * QPID-1447 : Add slow consumer detection and disconnection.
@@ -47,201 +32,44 @@ import java.util.concurrent.TimeUnit;
  * Slow consumers should on a topic should expect to receive a
  * 506 : Resource Error if the hit a predefined threshold.
  */
-public class GlobalQueuesTest extends QpidBrokerTestCase implements ExceptionListener, ConnectionListener
+public class GlobalQueuesTest extends TestingBaseCase
 {
-    Topic _destination;
-    private CountDownLatch _disconnectionLatch = new CountDownLatch(1);
-    private int MAX_QUEUE_MESSAGE_COUNT;
-    private int MESSAGE_SIZE = DEFAULT_MESSAGE_SIZE;
-
-    private Thread _publisher;
-    private static final long DISCONNECTION_WAIT = 5;
-    private Exception _publisherError = null;
-    private JMSException _connectionException = null;
-    private static final long JOIN_WAIT = 5000;
-    protected String CONFIG_SECTION = ".queues";
-
-    @Override
-    public void setUp() throws IOException, ConfigurationException, NamingException
-    {
-        setConfigurationProperty("virtualhosts.virtualhost."
-                                 + getConnectionURL().getVirtualHost().substring(1) +
-                                 ".slow-consumer-detection.delay", "1");
-
-        setConfigurationProperty("virtualhosts.virtualhost."
-                                 + getConnectionURL().getVirtualHost().substring(1) +
-                                 ".slow-consumer-detection.timeunit", "SECONDS");
-
-        /**
-         *  Queue Configuration
-
-         <slow-consumer-detection>
-         <!-- The depth before which the policy will be applied-->
-         <depth>4235264</depth>
-
-         <!-- The message age before which the policy will be applied-->
-         <messageAge>600000</messageAge>
-
-         <!-- The number of message before which the policy will be applied-->
-         <messageCount>50</messageCount>
-
-         <!-- Policies configuration -->
-         <policy>
-         <name>TopicDelete</name>
-         <topicDelete>
-         <delete-persistent/>
-         </topicDelete>
-         </policy>
-         </slow-consumer-detection>
 
-         */
-
-        /**
-         *  VirtualHost Plugin Configuration
-
-         <slow-consumer-detection>
-         <delay>1</delay>
-         <timeunit>MINUTES</timeunit>
-         </slow-consumer-detection>
-
-         */
-    }
+    protected String CONFIG_SECTION = ".queues";
 
     /**
-     * Perform the Main test of a topic Consumer with the given AckMode.
-     *
-     * Test creates a new connection and sets up the connection to prevent
-     * failover
-     *
-     * A new consumer is connected and started so that it will prefetch msgs.
-     *
-     * An asynchrounous publisher is started to fill the broker with messages.
-     *
-     * We then wait to be notified of the disconnection via the ExceptionListener
-     *
-     * 0-10 does not have the same notification paths but sync() apparently should
-     * give us the exception, currently it doesn't, so the test is excluded from 0-10
-     *
-     * We should ensure that this test has the same path for all protocol versions.
-     *
-     * Clients should not have to modify their code based on the protocol in use.
-     *
-     * @param ackMode @see javax.jms.Session
-     *
-     * @throws Exception
-     */
-    public void topicConsumer(int ackMode, boolean durable) throws Exception
-    {
-        Connection connection = getConnection();
-
-        connection.setExceptionListener(this);
-
-        Session session = connection.createSession(ackMode == Session.SESSION_TRANSACTED, ackMode);
-
-        _destination = session.createTopic(getName());
+     *  Queue Configuration
 
-        MessageConsumer consumer;
+     <slow-consumer-detection>
+     <!-- The depth before which the policy will be applied-->
+     <depth>4235264</depth>
 
-        if (durable)
-        {
-            consumer = session.createDurableSubscriber(_destination, getTestQueueName());
-        }
-        else
-        {
-            consumer = session.createConsumer(_destination);
-        }
-
-        connection.start();
-
-        // Start the consumer pre-fetching
-        // Don't care about response as we will fill the broker up with messages
-        // after this point and ensure that the client is disconnected at the
-        // right point.
-        consumer.receiveNoWait();
-        startPublisher(_destination);
-
-        boolean disconnected = _disconnectionLatch.await(DISCONNECTION_WAIT, TimeUnit.SECONDS);
-
-        if (!disconnected && isBroker010())
-        {
-            try
-            {
-                ((AMQSession_0_10) session).sync();
-            }
-            catch (AMQException amqe)
-            {
-                JMSException jmsException = new JMSException(amqe.getMessage());
-                jmsException.setLinkedException(amqe);
-                jmsException.initCause(amqe);
-                _connectionException = jmsException;
-            }
-        }
+     <!-- The message age before which the policy will be applied-->
+     <messageAge>600000</messageAge>
 
-        assertTrue("Client was not disconnected.", _connectionException != null);
+     <!-- The number of message before which the policy will be applied-->
+     <messageCount>50</messageCount>
 
-        Exception linked = _connectionException.getLinkedException();
+     <!-- Policies configuration -->
+     <policy>
+     <name>TopicDelete</name>
+     <topicDelete>
+     <delete-persistent/>
+     </topicDelete>
+     </policy>
+     </slow-consumer-detection>
 
-        _publisher.join(JOIN_WAIT);
-
-        assertFalse("Publisher still running", _publisher.isAlive());
-
-        //Validate publishing occurred ok
-        if (_publisherError != null)
-        {
-            throw _publisherError;
-        }
-
-        // NOTE these exceptions will need to be modeled so that they are not
-        // 0-8 specific. e.g. JMSSessionClosedException
-
-        assertNotNull("No error received onException listener.", _connectionException);
-
-        assertNotNull("No linked exception set on:" + _connectionException.getMessage(), linked);
-
-        assertEquals("Incorrect linked exception received.", AMQChannelClosedException.class, linked.getClass());
+     */
 
-        AMQChannelClosedException ccException = (AMQChannelClosedException) linked;
+    /**
+     *  VirtualHost Plugin Configuration
 
-        assertEquals("Channel was not closed with correct code.", AMQConstant.RESOURCE_ERROR, ccException.getErrorCode());
-    }
+     <slow-consumer-detection>
+     <delay>1</delay>
+     <timeunit>MINUTES</timeunit>
+     </slow-consumer-detection>
 
-    /**
-     * Create and start an asynchrounous publisher that will send MAX_QUEUE_MESSAGE_COUNT
-     * messages to the provided destination. Messages are sent in a new connection
-     * on a transaction. Any error is captured and the test is signalled to exit.
-     *
-     * @param destination
      */
-    private void startPublisher(final Destination destination)
-    {
-        _publisher = new Thread(new Runnable()
-        {
-
-            public void run()
-            {
-                try
-                {
-                    Connection connection = getConnection();
-                    Session session = connection.createSession(true, Session.SESSION_TRANSACTED);
-
-                    MessageProducer publisher = session.createProducer(destination);
-
-                    for (int count = 0; count < MAX_QUEUE_MESSAGE_COUNT; count++)
-                    {
-                        publisher.send(createNextMessage(session, count));
-                        session.commit();
-                    }
-                }
-                catch (Exception e)
-                {
-                    _publisherError = e;
-                    _disconnectionLatch.countDown();
-                }
-            }
-        });
-
-        _publisher.start();
-    }
 
     /**
      * Test to write: Check that exclusive Transient Queues are not
@@ -258,22 +86,16 @@ public class GlobalQueuesTest extends QpidBrokerTestCase implements ExceptionLis
 
     public void setConfig(String property, String value, boolean deleteDurable) throws NamingException, IOException, ConfigurationException
     {
-        setConfigurationProperty("virtualhosts.virtualhost."
-                                 + getConnectionURL().getVirtualHost().substring(1) +
-                                 CONFIG_SECTION + ".slow-consumer-detection." +
-                                 "policy.name", "TopicDelete");
+        setProperty(CONFIG_SECTION + ".slow-consumer-detection." +
+                    "policy.name", "TopicDelete");
 
-        setConfigurationProperty("virtualhosts.virtualhost." +
-                                 getConnectionURL().getVirtualHost().substring(1) +
-                                 CONFIG_SECTION + ".slow-consumer-detection." +
-                                 property, value);
+        setProperty(CONFIG_SECTION + ".slow-consumer-detection." +
+                    property, value);
 
         if (deleteDurable)
         {
-            setConfigurationProperty("virtualhosts.virtualhost."
-                                     + getConnectionURL().getVirtualHost().substring(1) +
-                                     CONFIG_SECTION + ".slow-consumer-detection." +
-                                     "policy.topicdelete.delete-persistent", "");
+            setProperty(CONFIG_SECTION + ".slow-consumer-detection." +
+                        "policy.topicdelete.delete-persistent", "");
         }
     }
 
@@ -410,41 +232,4 @@ public class GlobalQueuesTest extends QpidBrokerTestCase implements ExceptionLis
         topicConsumer(Session.AUTO_ACKNOWLEDGE, true);
     }
 
-    // Exception Listener
-
-    public void onException(JMSException e)
-    {
-        _connectionException = e;
-
-        System.out.println("***** SCT Received Exception: " + e);
-        e.printStackTrace();
-
-        _disconnectionLatch.countDown();
-    }
-
-
-    /// Connection Listener
-
-    public void bytesSent(long count)
-    {
-    }
-
-    public void bytesReceived(long count)
-    {
-    }
-
-    public boolean preFailover(boolean redirect)
-    {
-        // Prevent Failover
-        return false;
-    }
-
-    public boolean preResubscribe()
-    {
-        return false;
-    }
-
-    public void failoverComplete()
-    {
-    }
 }
diff --git a/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalTopicsTest.java b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalTopicsTest.java
index 1f8103fa3c..aff5d1b1b8 100644
--- a/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalTopicsTest.java
+++ b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/GlobalTopicsTest.java
@@ -28,7 +28,7 @@ import java.io.IOException;
 public class GlobalTopicsTest extends GlobalQueuesTest
 {
     @Override
-    public void setUp() throws NamingException, IOException, ConfigurationException
+    public void setUp() throws Exception
     {
         CONFIG_SECTION = ".topics";
         super.setUp();
diff --git a/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/TestingBaseCase.java b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/TestingBaseCase.java
new file mode 100644
index 0000000000..9831c74574
--- /dev/null
+++ b/qpid/java/broker-plugins/experimental/slowconsumerdetection/src/test/java/org/apache/qpid/systest/TestingBaseCase.java
@@ -0,0 +1,255 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.qpid.systest;
+
+import org.apache.commons.configuration.ConfigurationException;
+import org.apache.qpid.AMQChannelClosedException;
+import org.apache.qpid.AMQException;
+import org.apache.qpid.client.AMQSession_0_10;
+import org.apache.qpid.jms.ConnectionListener;
+import org.apache.qpid.protocol.AMQConstant;
+import org.apache.qpid.test.utils.QpidBrokerTestCase;
+
+import javax.jms.Connection;
+import javax.jms.Destination;
+import javax.jms.ExceptionListener;
+import javax.jms.JMSException;
+import javax.jms.MessageConsumer;
+import javax.jms.MessageProducer;
+import javax.jms.Session;
+import javax.jms.Topic;
+import javax.naming.NamingException;
+import java.io.IOException;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class TestingBaseCase extends QpidBrokerTestCase implements ExceptionListener, ConnectionListener
+{
+
+    Topic _destination;
+    protected CountDownLatch _disconnectionLatch = new CountDownLatch(1);
+    protected int MAX_QUEUE_MESSAGE_COUNT;
+    protected int MESSAGE_SIZE = DEFAULT_MESSAGE_SIZE;
+
+    private Thread _publisher;
+    protected static final long DISCONNECTION_WAIT = 5;
+    protected Exception _publisherError = null;
+    protected JMSException _connectionException = null;
+    private static final long JOIN_WAIT = 5000;
+
+    @Override
+    public void setUp() throws Exception
+    {
+
+        setConfigurationProperty("virtualhosts.virtualhost."
+                                 + getConnectionURL().getVirtualHost().substring(1) +
+                                 ".slow-consumer-detection.delay", "1");
+
+        setConfigurationProperty("virtualhosts.virtualhost."
+                                 + getConnectionURL().getVirtualHost().substring(1) +
+                                 ".slow-consumer-detection.timeunit", "SECONDS");
+
+    }
+
+
+    protected void setProperty(String property, String value) throws NamingException, IOException, ConfigurationException
+    {
+        setConfigurationProperty("virtualhosts.virtualhost." +
+                                 getConnectionURL().getVirtualHost().substring(1) +
+                                 property, value);
+    }
+
+
+    /**
+     * Create and start an asynchrounous publisher that will send MAX_QUEUE_MESSAGE_COUNT
+     * messages to the provided destination. Messages are sent in a new connection
+     * on a transaction. Any error is captured and the test is signalled to exit.
+     *
+     * @param destination
+     */
+    private void startPublisher(final Destination destination)
+    {
+        _publisher = new Thread(new Runnable()
+        {
+
+            public void run()
+            {
+                try
+                {
+                    Connection connection = getConnection();
+                    Session session = connection.createSession(true, Session.SESSION_TRANSACTED);
+
+                    MessageProducer publisher = session.createProducer(destination);
+
+                    for (int count = 0; count < MAX_QUEUE_MESSAGE_COUNT; count++)
+                    {
+                        publisher.send(createNextMessage(session, count));
+                        session.commit();
+                    }
+                }
+                catch (Exception e)
+                {
+                    _publisherError = e;
+                    _disconnectionLatch.countDown();
+                }
+            }
+        });
+
+        _publisher.start();
+    }
+
+
+
+    /**
+     * Perform the Main test of a topic Consumer with the given AckMode.
+     *
+     * Test creates a new connection and sets up the connection to prevent
+     * failover
+     *
+     * A new consumer is connected and started so that it will prefetch msgs.
+     *
+     * An asynchrounous publisher is started to fill the broker with messages.
+     *
+     * We then wait to be notified of the disconnection via the ExceptionListener
+     *
+     * 0-10 does not have the same notification paths but sync() apparently should
+     * give us the exception, currently it doesn't, so the test is excluded from 0-10
+     *
+     * We should ensure that this test has the same path for all protocol versions.
+     *
+     * Clients should not have to modify their code based on the protocol in use.
+     *
+     * @param ackMode @see javax.jms.Session
+     *
+     * @throws Exception
+     */
+    protected void topicConsumer(int ackMode, boolean durable) throws Exception
+    {
+        Connection connection = getConnection();
+
+        connection.setExceptionListener(this);
+
+        Session session = connection.createSession(ackMode == Session.SESSION_TRANSACTED, ackMode);
+
+        _destination = session.createTopic(getName());
+
+        MessageConsumer consumer;
+
+        if (durable)
+        {
+            consumer = session.createDurableSubscriber(_destination, getTestQueueName());
+        }
+        else
+        {
+            consumer = session.createConsumer(_destination);
+        }
+
+        connection.start();
+
+        // Start the consumer pre-fetching
+        // Don't care about response as we will fill the broker up with messages
+        // after this point and ensure that the client is disconnected at the
+        // right point.
+        consumer.receiveNoWait();
+        startPublisher(_destination);
+
+        boolean disconnected = _disconnectionLatch.await(DISCONNECTION_WAIT, TimeUnit.SECONDS);
+
+        if (!disconnected && isBroker010())
+        {
+            try
+            {
+                ((AMQSession_0_10) session).sync();
+            }
+            catch (AMQException amqe)
+            {
+                JMSException jmsException = new JMSException(amqe.getMessage());
+                jmsException.setLinkedException(amqe);
+                jmsException.initCause(amqe);
+                _connectionException = jmsException;
+            }
+        }
+
+        assertTrue("Client was not disconnected.", _connectionException != null);
+
+        Exception linked = _connectionException.getLinkedException();
+
+        _publisher.join(JOIN_WAIT);
+
+        assertFalse("Publisher still running", _publisher.isAlive());
+
+        //Validate publishing occurred ok
+        if (_publisherError != null)
+        {
+            throw _publisherError;
+        }
+
+        // NOTE these exceptions will need to be modeled so that they are not
+        // 0-8 specific. e.g. JMSSessionClosedException
+
+        assertNotNull("No error received onException listener.", _connectionException);
+
+        assertNotNull("No linked exception set on:" + _connectionException.getMessage(), linked);
+
+        assertEquals("Incorrect linked exception received.", AMQChannelClosedException.class, linked.getClass());
+
+        AMQChannelClosedException ccException = (AMQChannelClosedException) linked;
+
+        assertEquals("Channel was not closed with correct code.", AMQConstant.RESOURCE_ERROR, ccException.getErrorCode());
+    }
+
+
+    // Exception Listener
+
+    public void onException(JMSException e)
+    {
+        _connectionException = e;
+
+        e.printStackTrace();
+
+        _disconnectionLatch.countDown();
+    }
+
+    /// Connection Listener
+
+    public void bytesSent(long count)
+    {
+    }
+
+    public void bytesReceived(long count)
+    {
+    }
+
+    public boolean preFailover(boolean redirect)
+    {
+        // Prevent Failover
+        return false;
+    }
+
+    public boolean preResubscribe()
+    {
+        return false;
+    }
+
+    public void failoverComplete()
+    {
+    }
+}