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
208
209
210
|
/*
*
* 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.framework;
import junit.framework.TestCase;
import org.apache.log4j.NDC;
import org.apache.qpid.client.transport.TransportConnection;
import org.apache.qpid.interop.coordinator.sequencers.TestCaseSequencer;
import org.apache.qpid.server.registry.ApplicationRegistry;
import uk.co.thebadgerset.junit.extensions.util.ParsedProperties;
import javax.jms.JMSException;
import javax.jms.Message;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
/**
* FrameworkBaseCase provides a starting point for writing test cases against the test framework. Its main purpose is
* to provide some convenience methods for testing.
*
* <p/><table id="crc"><caption>CRC Card</caption>
* <tr><th> Responsibilities <th> Collaborations
* <tr><td> Create and clean up in-vm brokers on every test case.
* <tr><td> Produce lists of assertions from assertion creation calls.
* <tr><td> Produce JUnit failures from assertion failures.
* <tr><td> Convert failed assertions to error messages.
* </table>
*/
public class FrameworkBaseCase extends TestCase
{
/** Holds the test sequencer to create and run test circuits with. */
protected TestCaseSequencer testSequencer = new DefaultTestSequencer();
/**
* Creates a new test case with the specified name.
*
* @param name The test case name.
*/
public FrameworkBaseCase(String name)
{
super(name);
}
/**
* Returns the test case sequencer that provides test circuit, and test sequence implementations. The sequencer
* that this base case returns by default is suitable for running a test circuit with both circuit ends colocated
* on the same JVM.
*
* @return The test case sequencer.
*/
protected TestCaseSequencer getTestSequencer()
{
return testSequencer;
}
/**
* Overrides the default test sequencer. Test decorators can use this to supply distributed test sequencers or other
* test sequencer specializations.
*
* @param sequencer The new test sequencer.
*/
public void setTestSequencer(TestCaseSequencer sequencer)
{
this.testSequencer = sequencer;
}
/**
* Creates a list of assertions.
*
* @param asserts The assertions to compile in a list.
*
* @return A list of assertions.
*/
protected List<Assertion> assertionList(Assertion... asserts)
{
List<Assertion> result = new ArrayList<Assertion>();
for (Assertion assertion : asserts)
{
result.add(assertion);
}
return result;
}
/**
* Generates a JUnit assertion exception (failure) if any assertions are passed into this method, also concatenating
* all of the error messages in the assertions together to form an error message to diagnose the test failure with.
*
* @param asserts The list of failed assertions.
*/
protected void assertNoFailures(List<Assertion> asserts)
{
// Check if there are no assertion failures, and return without doing anything if so.
if ((asserts == null) || asserts.isEmpty())
{
return;
}
// Compile all of the assertion failure messages together.
String errorMessage = assertionsToString(asserts);
// Fail with the error message from all of the assertions.
fail(errorMessage);
}
/**
* Converts a list of failed assertions into an error message.
*
* @param asserts The failed assertions.
*
* @return The error message.
*/
protected String assertionsToString(List<Assertion> asserts)
{
String errorMessage = "";
for (Assertion assertion : asserts)
{
errorMessage += assertion.toString() + "\n";
}
return errorMessage;
}
/**
* Ensures that the in-vm broker is created and initialized.
*
* @throws Exception Any exceptions allowed to fall through and fail the test.
*/
protected void setUp() throws Exception
{
NDC.push(getName());
// Ensure that the in-vm broker is created.
TransportConnection.createVMBroker(1);
}
/**
* Ensures that the in-vm broker is cleaned up after each test run.
*/
protected void tearDown()
{
try
{
// Ensure that the in-vm broker is cleaned up so that the next test starts afresh.
TransportConnection.killVMBroker(1);
ApplicationRegistry.remove(1);
}
finally
{
NDC.pop();
}
}
/**
* DefaultTestSequencer is a test sequencer that creates test circuits with publishing and receiving ends rooted
* on the same JVM.
*/
public class DefaultTestSequencer implements TestCaseSequencer
{
/**
* Holds a test coordinating conversation with the test clients. This should consist of assigning the test roles,
* begining the test and gathering the test reports from the participants.
*
* @param testCircuit The test circuit.
* @param assertions The list of assertions to apply to the test circuit.
* @param testProperties The test case definition.
*/
public void sequenceTest(Circuit testCircuit, List<Assertion> assertions, Properties testProperties)
{
assertNoFailures(testCircuit.test(1, assertions));
}
/**
* Creates a test circuit for the test, configered by the test parameters specified.
*
* @param testProperties The test parameters.
* @return A test circuit.
*/
public Circuit createCircuit(ParsedProperties testProperties)
{
return CircuitImpl.createCircuit(testProperties);
}
}
}
|
