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
|
/*
* 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.catalina.startup;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import static org.junit.Assert.fail;
import org.junit.After;
import org.junit.Before;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
/**
* Base class that provides logging support for test cases that respects the
* standard conf/logging.properties configuration file.
*
* <p>
* It also provides support for cleaning up temporary files after shutdown. See
* {@link #addDeleteOnTearDown(File)}.
*
* <p>
* <em>Note</em> that the logging configuration uses
* <code>${catalina.base}</code> value and thus we take care about that property
* even if the tests do not use Tomcat.
*/
public abstract class LoggingBaseTest {
protected Log log;
private File tempDir;
private List<File> deleteOnTearDown = new ArrayList<File>();
/**
* Helper method that returns the directory where Tomcat build resides. It
* is used to access resources that are part of default Tomcat deployment.
* E.g. the examples webapp.
*/
public File getBuildDirectory() {
return new File(System.getProperty("tomcat.test.tomcatbuild",
"output/build"));
}
/**
* Helper method that returns the path of the temporary directory used by
* the test runs. The directory is configured during {@link #setUp()}.
*
* <p>
* It is used as <code>${catalina.base}</code> for the instance of Tomcat
* that is being started, but can be used to store other temporary files as
* well. Its <code>work</code> and <code>webapps</code> subdirectories are
* deleted at {@link #tearDown()}. If you have other files or directories
* that have to be deleted on cleanup, register them with
* {@link #addDeleteOnTearDown(File)}.
*/
public File getTemporaryDirectory() {
return tempDir;
}
/**
* Schedule the given file or directory to be deleted during after-test
* cleanup.
*
* @param file
* File or directory
*/
public void addDeleteOnTearDown(File file) {
deleteOnTearDown.add(file);
}
@Before
public void setUp() throws Exception {
// Create catalina.base directory
tempDir = new File(System.getProperty("tomcat.test.temp", "output/tmp"));
if (!tempDir.mkdirs() && !tempDir.isDirectory()) {
fail("Unable to create temporary directory for test");
}
System.setProperty("catalina.base", tempDir.getAbsolutePath());
// Configure logging
System.setProperty("java.util.logging.manager",
"org.apache.juli.ClassLoaderLogManager");
System.setProperty("java.util.logging.config.file", new File(
getBuildDirectory(), "conf/logging.properties").toString());
// Get log instance after logging has been configured
log = LogFactory.getLog(getClass());
}
@After
public void tearDown() throws Exception {
for (File file : deleteOnTearDown) {
ExpandWar.delete(file);
}
deleteOnTearDown.clear();
}
}
|
