summaryrefslogtreecommitdiff
path: root/qpid/java/perftests/src/main/java/org/apache/qpid/test/testcases/MessageThroughputPerf.java
blob: e2e97ab6f82c941e53a4523d874562ee8e793692 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
 *
 * 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.test.testcases;

import junit.framework.Test;
import junit.framework.TestSuite;

import org.apache.log4j.Logger;
import org.apache.log4j.NDC;

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 org.apache.qpid.junit.extensions.TestThreadAware;
import org.apache.qpid.junit.extensions.TimingController;
import org.apache.qpid.junit.extensions.TimingControllerAware;
import org.apache.qpid.junit.extensions.util.ParsedProperties;
import org.apache.qpid.junit.extensions.util.TestContextProperties;

import java.util.LinkedList;

/**
 * MessageThroughputPerf 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.
 *
 * <p/><table id="crc"><caption>CRC Card</caption>
 * <tr><th> Responsibilities <th> Collaborations
 * <tr><td> Measure message throughput accross a test circuit. <td> {@link Circuit}
 * </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.
 *
 * @todo Set this up to run with zero sized tests. Size zero means send forever. Continuous sending to be interrupted
 *       by completion of the test duration, or shutdown hook when the user presses Ctrl-C.
 */
public class MessageThroughputPerf extends FrameworkBaseCase implements TimingControllerAware, TestThreadAware
{
    /** Used for debugging. */
    private static final Logger log = Logger.getLogger(MessageThroughputPerf.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 MessageThroughputPerf(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 org.apache.qpid.junit.extensions.TimingController} to set the
     * controller on an aware test.
     *
     * @param controller The timing controller.
     */
    public void setTimingController(TimingController controller)
    {
        timingController = controller;
    }

    /**
     * Overrides the parent setUp method so that the in-vm broker creation is not done on a per test basis.
     *
     * @throws Exception Any exceptions allowed to fall through and fail the test.
     */
    protected void setUp() throws Exception
    {
        NDC.push(getName());

        setTestProps(TestContextProperties.getInstance(MessagingTestConfigProperties.defaults));
    }

    /**
     * Overrides the parent setUp method so that the in-vm broker clean-up is not done on a per test basis.
     */
    protected void tearDown()
    {
        NDC.pop();
    }

    /**
     * Performs test fixture creation on a per thread basis. This will only be called once for each test thread.
     */
    public void threadSetUp()
    {
        // Run the test setup tasks. This may create an in-vm broker, if a decorator has injected a task for this.
        getTaskHandler().runSetupTasks();

        // 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(null, testProps);

        // Store the test configuration for the thread.
        PerThreadSetup setup = new PerThreadSetup();
        setup.testCircuit = testCircuit;
        threadSetup.set(setup);
    }

    /**
     * Called after all threads have completed their setup.
     */
    public void postThreadSetUp()
    {
        //Nothing to do here, potentially implement preFill as per PingTestPerf.
    }

    /**
     * Called when a test thread is destroyed.
     */
    public void threadTearDown()
    {
        // Run the test teardown tasks. This may destroy the in-vm broker, if a decorator has injected a task for this.
        getTaskHandler().runSetupTasks();
    }

    /**
     * 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 MessageThroughputPerf("testThroughput"));

        return suite;
    }
}