Extensive refactoring of the distributed test framework.

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/branches/M2@561855 13f79535-47bb-0310-9956-ffa450edef68

5 files changed, 257 insertions, 41 deletions

diff --git a/java/perftests/jar-with-dependencies.xml b/java/perftests/jar-with-dependencies.xml
index 3e95e7ab22..959473f535 100644
--- a/java/perftests/jar-with-dependencies.xml
+++ b/java/perftests/jar-with-dependencies.xml
@@ -16,32 +16,51 @@
     specific language governing permissions and limitations

     under the License.

 -->

-<!-- This is an assembly descriptor that produces a jar file that contains all the

-     dependencies, fully expanded into a single jar, required to run the tests of

-     a maven project. 

- -->

+<!-- This is an assembly descriptor that produces a distribution that contains all the

+     dependencies, with a manifest only jar that references them, required to run the 

+     tests of a maven project. 

+-->

 <assembly>

-  <id>all-test-deps</id>

-  <formats>

-    <format>jar</format>

-  </formats>

-  <includeBaseDirectory>false</includeBaseDirectory>

-  <dependencySets>

-    <dependencySet>

-      <outputDirectory></outputDirectory>

-      <outputFileNameMapping></outputFileNameMapping>

-      <unpack>true</unpack>

-      <scope>test</scope>

-    </dependencySet>

-  </dependencySets>

-  <fileSets>

-    <fileSet>

-      <directory>target/classes</directory>

-      <outputDirectory></outputDirectory>

-    </fileSet>

-    <fileSet>

-      <directory>target/test-classes</directory>

-      <outputDirectory></outputDirectory>

-    </fileSet>

-  </fileSets>

+    <id>all-test-deps</id>

+    <formats>

+        <format>tar.gz</format>

+        <format>zip</format>

+    </formats>

+    <includeBaseDirectory>false</includeBaseDirectory>

+    <dependencySets>

+        <dependencySet>

+            <outputDirectory>/</outputDirectory>

+            <unpack>false</unpack>

+            <scope>test</scope>

+        </dependencySet>

+    </dependencySets>

+    <fileSets>

+        <fileSet>

+            <directory>target/classes</directory>

+            <outputDirectory></outputDirectory>

+        </fileSet>

+        <fileSet>

+            <directory>target/test-classes</directory>

+            <outputDirectory></outputDirectory>

+        </fileSet>

+

+        <!-- Include the build artifact. -->

+        <fileSet>

+            <directory>target</directory>

+            <outputDirectory></outputDirectory>

+            <includes>

+                <include>qpid-perftests-1.0-incubating-M2-SNAPSHOT.jar</include>

+            </includes>

+        </fileSet>

+

+        <!-- Include the classpath only jar. -->

+        <fileSet>

+            <directory>target</directory>

+            <outputDirectory></outputDirectory>

+            <includes>

+                <include>qpid-perftests-1.0-incubating-M2-SNAPSHOT-tests.jar</include>

+            </includes>

+        </fileSet>

+        

+    </fileSets>

 </assembly>

diff --git a/java/perftests/pom.xml b/java/perftests/pom.xml
index e07b0696e5..41bd6c1a84 100644
--- a/java/perftests/pom.xml
+++ b/java/perftests/pom.xml
@@ -72,6 +72,11 @@
         </dependency>
 
         <dependency>
+            <groupId>org.apache.qpid</groupId>
+            <artifactId>qpid-systests</artifactId>
+        </dependency>
+
+        <dependency>
             <groupId>log4j</groupId>
             <artifactId>log4j</artifactId>
         </dependency>
@@ -85,9 +90,10 @@
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
+            <scope>compile</scope>
         </dependency>
 
-        <dependency>  
+        <dependency>
             <groupId>org.slf4j</groupId> 
             <artifactId>slf4j-log4j12</artifactId>  
             <version>1.4.0</version>  
@@ -354,13 +360,34 @@
                 <configuration>
                     <descriptors>
                         <descriptor>jar-with-dependencies.xml</descriptor>
-                        <descriptor>dist-zip.xml</descriptor>
+                        <!--<descriptor>dist-zip.xml</descriptor>-->
                     </descriptors>
                     <outputDirectory>target</outputDirectory>
                     <workDirectory>target/assembly/work</workDirectory>
                 </configuration>
             </plugin>
 
+            <!-- Build a manifest only jar with all the required jars for the broker in its classpath. -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <executions>                   
+                    <execution>
+                        <id>test_jar</id>
+                        <configuration>
+                            <archive>
+                                <manifest>
+                                    <addClasspath>true</addClasspath>                           
+                                </manifest>
+                            </archive>
+                        </configuration>      
+                        <goals>
+                            <goal>test-jar</goal>
+                        </goals>
+                    </execution>
+                </executions>          
+            </plugin>
+
         </plugins>
 
         <resources>
diff --git a/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongBouncer.java b/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongBouncer.java
index 78ab7c4c73..82b36bf233 100644
--- a/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongBouncer.java
+++ b/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongBouncer.java
@@ -92,10 +92,10 @@ public class PingPongBouncer implements MessageListener
     /** The producer for sending replies with. */

     private MessageProducer _replyProducer;

 

-    /** The consumer session. */

+    /** The consumer controlSession. */

     private Session _consumerSession;

 

-    /** The producer session. */

+    /** The producer controlSession. */

     private Session _producerSession;

 

     /** Holds the connection to the broker. */

@@ -149,7 +149,7 @@ public class PingPongBouncer implements MessageListener
         // Set up the failover notifier.

         getConnection().setConnectionListener(new FailoverNotifier());

 

-        // Create a session to listen for messages on and one to send replies on, transactional depending on the

+        // Create a controlSession to listen for messages on and one to send replies on, transactional depending on the

         // command line option.

         _consumerSession = (Session) getConnection().createSession(transacted, Session.AUTO_ACKNOWLEDGE);

         _producerSession = (Session) getConnection().createSession(transacted, Session.AUTO_ACKNOWLEDGE);

@@ -323,8 +323,8 @@ public class PingPongBouncer implements MessageListener
     }

 

     /**

-     * Convenience method to commit the transaction on the specified session. If the session to commit on is not

-     * a transactional session, this method does nothing.

+     * Convenience method to commit the transaction on the specified controlSession. If the controlSession to commit on is not

+     * a transactional controlSession, this method does nothing.

      *

      * <p/>If the {@link #_failBeforeCommit} flag is set, this will prompt the user to kill the broker before the

      * commit is applied. If the {@link #_failAfterCommit} flag is set, this will prompt the user to kill the broker

diff --git a/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongProducer.java b/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongProducer.java
index 03f5f0549d..140e3bad1c 100644
--- a/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongProducer.java
+++ b/java/perftests/src/main/java/org/apache/qpid/requestreply/PingPongProducer.java
@@ -395,10 +395,10 @@ public class PingPongProducer implements Runnable, MessageListener, ExceptionLis
     /** Holds the connection to the broker. */

     protected Connection _connection;

 

-    /** Holds the session on which ping replies are received. */

+    /** Holds the controlSession on which ping replies are received. */

     protected Session _consumerSession;

 

-    /** Holds the producer session, needed to create ping messages. */

+    /** Holds the producer controlSession, needed to create ping messages. */

     protected Session _producerSession;

 

     /** Holds the destination where the response messages will arrive. */

@@ -1305,8 +1305,8 @@ public class PingPongProducer implements Runnable, MessageListener, ExceptionLis
     }

 

     /**

-     * Convenience method to commit the transaction on the specified session. If the session to commit on is not a

-     * transactional session, this method does nothing (unless the failover after send flag is set).

+     * Convenience method to commit the transaction on the specified controlSession. If the controlSession to commit on is not a

+     * transactional controlSession, this method does nothing (unless the failover after send flag is set).

      *

      * <p/>If the {@link #_failAfterSend} flag is set, this will prompt the user to kill the broker before the commit is

      * applied. This flag applies whether the pinger is transactional or not.

@@ -1315,9 +1315,9 @@ public class PingPongProducer implements Runnable, MessageListener, ExceptionLis
      * is applied. If the {@link #_failAfterCommit} flag is set, this will prompt the user to kill the broker after the

      * commit is applied. These flags will only apply if using a transactional pinger.

      *

-     * @param session The session to commit

+     * @param session The controlSession to commit

      *

-     * @return <tt>true</tt> if the session was committed, <tt>false</tt> if it was not.

+     * @return <tt>true</tt> if the controlSession was committed, <tt>false</tt> if it was not.

      *

      * @throws javax.jms.JMSException If the commit fails and then the rollback fails.

      *

@@ -1327,7 +1327,7 @@ public class PingPongProducer implements Runnable, MessageListener, ExceptionLis
      */

     protected boolean commitTx(Session session) throws JMSException

     {

-        // log.debug("protected void commitTx(Session session): called");

+        // log.debug("protected void commitTx(Session controlSession): called");

 

         boolean committed = false;

 

diff --git a/java/perftests/src/test/java/org/apache/qpid/perftests/QpidTestThroughputPerf.java b/java/perftests/src/test/java/org/apache/qpid/perftests/QpidTestThroughputPerf.java
new file mode 100644
index 0000000000..760d1c84a4
--- /dev/null
+++ b/java/perftests/src/test/java/org/apache/qpid/perftests/QpidTestThroughputPerf.java
@@ -0,0 +1,170 @@
+/*

+ *

+ * 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.perftests;

+

+import junit.framework.Test;

+import junit.framework.TestSuite;

+

+import org.apache.log4j.Logger;

+

+import org.apache.qpid.test.framework.Assertion;

+import org.apache.qpid.test.framework.Circuit;

+import org.apache.qpid.test.framework.FrameworkBaseCase;

+import org.apache.qpid.test.framework.MessagingTestConfigProperties;

+import org.apache.qpid.test.framework.sequencers.CircuitFactory;

+

+import uk.co.thebadgerset.junit.extensions.TestThreadAware;

+import uk.co.thebadgerset.junit.extensions.TimingController;

+import uk.co.thebadgerset.junit.extensions.TimingControllerAware;

+import uk.co.thebadgerset.junit.extensions.util.ParsedProperties;

+import uk.co.thebadgerset.junit.extensions.util.TestContextProperties;

+

+import java.util.LinkedList;

+

+/**

+ * QpidTestThroughputPerf runs a test over a {@link Circuit} controlled by the test parameters. It logs timings of

+ * the time required to receive samples consisting of batches of messages. As the time samples is taken over a reasonable

+ * sized message batch, it measures message throughput.

+ *

+ * <p/><table id="crc"><caption>CRC Card</caption>

+ * <tr><th> Responsibilities <th> Collaborations

+ * <tr><td>

+ * </table>

+ *

+ * @todo Check that all of the messages were sent. Check that the receiving end got the same number of messages as

+ *       the publishing end.

+ */

+public class QpidTestThroughputPerf extends FrameworkBaseCase implements TimingControllerAware, TestThreadAware

+{

+    /** Used for debugging. */

+    private static final Logger log = Logger.getLogger(QpidTestThroughputPerf.class);

+

+    /** Holds the timing controller, used to log test timings from self-timed tests. */

+    private TimingController timingController;

+

+    /** Thread local to hold the per-thread test setup fields. */

+    ThreadLocal<PerThreadSetup> threadSetup = new ThreadLocal<PerThreadSetup>();

+

+    /**

+     * Creates a new test case with the specified name.

+     *

+     * @param name The test case name.

+     */

+    public QpidTestThroughputPerf(String name)

+    {

+        super(name);

+    }

+

+    /**

+     * Performs the a basic P2P test case.

+     *

+     * @param numMessages The number of messages to send in the test.

+     */

+    public void testThroughput(int numMessages)

+    {

+        log.debug("public void testThroughput(): called");

+

+        PerThreadSetup setup = threadSetup.get();

+        assertNoFailures(setup.testCircuit.test(numMessages, new LinkedList<Assertion>()));

+    }

+

+    /**

+     * Should provide a translation from the junit method name of a test to its test case name as known to the test

+     * clients that will run the test. The purpose of this is to convert the JUnit method name into the correct test

+     * case name to place into the test invite. For example the method "testP2P" might map onto the interop test case

+     * name "TC2_BasicP2P".

+     *

+     * @param methodName The name of the JUnit test method.

+     *

+     * @return The name of the corresponding interop test case.

+     */

+    public String getTestCaseNameForTestMethod(String methodName)

+    {

+        log.debug("public String getTestCaseNameForTestMethod(String methodName = " + methodName + "): called");

+

+        return "DEFAULT_CIRCUIT_TEST";

+    }

+

+    /**

+     * Used by test runners that can supply a {@link uk.co.thebadgerset.junit.extensions.TimingController} to set the

+     * controller on an aware test.

+     *

+     * @param controller The timing controller.

+     */

+    public void setTimingController(TimingController controller)

+    {

+        timingController = controller;

+    }

+

+    /**

+     * Performs test fixture creation on a per thread basis. This will only be called once for each test thread.

+     */

+    public void threadSetUp()

+    {

+        // Get the test parameters, any overrides on the command line will have been applied.

+        ParsedProperties testProps = TestContextProperties.getInstance(MessagingTestConfigProperties.defaults);

+

+        // Customize the test parameters.

+        testProps.setProperty("TEST_NAME", "DEFAULT_CIRCUIT_TEST");

+        testProps.setProperty(MessagingTestConfigProperties.SEND_DESTINATION_NAME_ROOT_PROPNAME, "testqueue");

+

+        // Get the test circuit factory to create test circuits and run the standard test procedure through.

+        CircuitFactory circuitFactory = getCircuitFactory();

+

+        // Create the test circuit. This projects the circuit onto the available test nodes and connects it up.

+        Circuit testCircuit = circuitFactory.createCircuit(testProps);

+

+        // Store the test configuration for the thread.

+        PerThreadSetup setup = new PerThreadSetup();

+        setup.testCircuit = testCircuit;

+        threadSetup.set(setup);

+    }

+

+    /**

+     * Called when a test thread is destroyed.

+     */

+    public void threadTearDown()

+    { }

+

+    /**

+     * Holds the per-thread test configurations.

+     */

+    protected static class PerThreadSetup

+    {

+        /** Holds the test circuit to run tests on. */

+        Circuit testCircuit;

+    }

+

+    /**

+     * Compiles all the tests in this class into a suite.

+     *

+     * @return The test suite.

+     */

+    public static Test suite()

+    {

+        // Build a new test suite

+        TestSuite suite = new TestSuite("Qpid Throughput Performance Tests");

+

+        suite.addTest(new QpidTestThroughputPerf("testThroughput"));

+

+        return suite;

+    }

+}