blob: 0804757dceda0646ffb5ccfbb38306e29d510eb5 (
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
|
/*
*
* 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.junit.extensions;
import junit.framework.Test;
/**
* An InstrumentedTest is one which can supply some additional instrumentation on top of the pass/fail/error behaviour
* of normal junit tests. Tests implementing this interface must additionally supply information about how long they
* took to run and how much memory they used.
*
* <p><table id="crc"><caption>CRC Card</caption>
* <tr><th> Responsibilities
* <tr><td> Report test run time.
* <tr><td> Report test memory usage.
* </table>
*
* @author Rupert Smith
*/
public interface InstrumentedTest extends Test
{
/**
* Reports how long the test took to run.
*
* @return The time in milliseconds that the test took to run.
*/
public long getTestTime();
/**
* Reports the memory usage at the start of the test.
*
* @return The memory usage at the start of the test.
*/
public long getTestStartMemory();
/**
* Reports the memory usage at the end of the test.
*
* @return The memory usage at the end of the test.
*/
public long getTestEndMemory();
/**
* Resets the instrumentation values to zero, and nulls any references to held measurements so that the memory
* can be reclaimed.
*/
public void reset();
}
|
