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
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
package lib;
import java.io.PrintWriter;
/**
* <code>TestCase</code> represent a factory for <code>TestEnvironment</code>s
* creation and disposing for a given implementation object. The
* <code>TestEnvironment</code> contains an instance of the implementation
* object and all additional objects needed to perform tests on the object.
*
* <p>The <code>TestCase</code> provides four methods for its subclasses to
* define its functionality: <code>initialize()</code>, <code>cleanup()</code>,
* <code>createTestEnvironment()</code> and <code>disposeTestEnvironment()</code>.
* The first two are intended to initialize and cleanup common objects shared
* among all instances of <code>TestEnvironment</code> produced by the
* <code>TestCase</code>, and they are called at the beginning and at the end of
* the <code>TestCase</code> lifecycle accordingly.
*
* <p>The other two are intended to produce and dispose
* <code>TestEnvironment</code> instances. The
* <code>createTestEnvironment()</code> is called to create a
* <code>TestEnvironment</code> instance and the
* <code>disposeTestEnvironment()</code> is called when the instane is not used
* anymore.
*
* @see lib.TestEnvironment
*/
public abstract class TestCase {
/**
* Specifies the PrintWriter to log information.
*/
protected PrintWriter log;
/**
* Sets the log to write information during testing.
*/
public void setLogWriter( PrintWriter log ) {
this.log = log;
}
/**
* Initializes the <code>TestCase</code>. Calls <code>initialize()</code>
* method.
*
* @param tParam test parameters.
*/
public final void initializeTestCase( TestParameters tParam ) throws Exception {
initialize( tParam, log );
}
/**
* Called while the <code>TestCase</code> initialization. In the
* implementation does nothing. Subclasses can override to initialize
* objects shared among all <code>TestEnvironment</code>s.
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see #initializeTestCase
*/
protected void initialize( TestParameters tParam, PrintWriter log ) throws Exception {
}
/**
* Cleans up the <code>TestCase</code>. Calls <code>cleanup()</code>.
*
* @param tParam test parameters
*/
public final void cleanupTestCase( TestParameters tParam ) {
cleanup( tParam, log );
}
/**
* Called while the <code>TestCase</code> cleanup. In the implementation
* does nothing. Subclasses can override to cleanup objects shared among
* all <code>TestEnvironment</code>s.
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see #cleanupTestCase
*/
protected void cleanup( TestParameters tParam, PrintWriter log ) {
}
/**
* Creates a <code>TestEnvironment</code> containing an instance of the
* implementation object and related objects needed to perform test.
*
* @param tParam test parameters
*
* @return the created <code>TestEnvironment</code>
*
* @see #createTestEnvironment
* @see lib.TestEnvironment
*/
public synchronized TestEnvironment getTestEnvironment( TestParameters tParam ) {
TestEnvironment tEnv = null;
try {
tEnv = createTestEnvironment( tParam, log );
System.out.println("Environment created");
if (tEnv != null) {
tEnv.setTestCase(this);
}
} catch (Exception e) {
String message = e.getMessage();
if (message == null)
message = e.toString();
System.out.println("Exception while getting Environment "+message);
e.printStackTrace();
cleanup(tParam, log);
}
return tEnv;
}
/**
* Disposes the <code>TestEnvironment</code> when it is not needed anymore.
*
* @param tEnv the environment to dispose
* @param tParam test parameters
*/
public synchronized void disposeTestEnvironment( TestEnvironment tEnv,
TestParameters tParam ) {
cleanup( tParam, log );
}
/**
* Called to create an instance of <code>TestEnvironment</code> with an
* object to test and related objects. Subclasses should implement this
* method to provide the implementation and related objects. The method is
* called from <code>getTestEnvironment()</code>.
*
* @param tParam test parameters
* @param log writer to log information while testing
*
* @see TestEnvironment
* @see #getTestEnvironment
*/
protected abstract TestEnvironment createTestEnvironment(
TestParameters tParam, PrintWriter log ) throws Exception;
/**
* @return the name of the object
*/
public String getObjectName() {
String clName = this.getClass().getName();
return clName.substring( clName.lastIndexOf('.') + 1 );
}
}
|
