You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/06 22:43:46 UTC

svn commit: r1198572 - in /tomcat/tc7.0.x/trunk: ./ test/org/apache/catalina/startup/LoggingBaseTest.java test/org/apache/catalina/startup/TomcatBaseTest.java webapps/docs/changelog.xml

Author: kkolinko
Date: Sun Nov  6 21:43:45 2011
New Revision: 1198572

URL: http://svn.apache.org/viewvc?rev=1198572&view=rev
Log:
Merged revision 1197261 from tomcat/trunk:
Introduce a new class LoggingBaseTest and move the following features from TomcatBaseTest there:
setting up logging, creating temporary directory, deleting files on tear down.
This allows to use the same logging configuration in tests that do not use Tomcat.

Added:
    tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/LoggingBaseTest.java
      - copied unchanged from r1197261, tomcat/trunk/test/org/apache/catalina/startup/LoggingBaseTest.java
Modified:
    tomcat/tc7.0.x/trunk/   (props changed)
    tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/TomcatBaseTest.java
    tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml

Propchange: tomcat/tc7.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sun Nov  6 21:43:45 2011
@@ -1 +1 @@
-/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166693,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172556,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096
 ,1173241,1173256,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175798,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178684,1178721,1179268,1179274,1180261,1180865,1180891,1180894,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183142,1183328,1183339-1183340,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200,1185588,1185626,1185756,1185758,1186011,1186042-1186045,1186104,1186123,1186137,1186153,1186254,1186257,1186377-1186379,1186479-1186480,1186712,1186743,1186750,1186763,1186890-1186892,1186894,1186949,1187018,1187027-1187028,1187381,1187
 755,1187775,1187806,1187827,1188301,1188303-1188305,1188399,1188822,1188930-1188931,1189116,1189129,1189183,1189240,1189256,1189386,1189413-1189414,1189477,1189685,1189805,1189857,1189864,1189882,1190034,1190185,1190279,1190339,1190371,1190388-1190389,1190474,1190481,1194915,1195222-1195223,1195531,1195899,1195905,1195943,1195949,1195953,1195955,1195965,1195968,1196175,1196212,1196223,1196304-1196305,1196735,1196825,1196827,1197158,1197299-1197300,1197339-1197340,1197343,1197382,1197386-1197387,1197480,1197578,1198497,1198528,1198552
+/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166693,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172556,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096
 ,1173241,1173256,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175798,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178684,1178721,1179268,1179274,1180261,1180865,1180891,1180894,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183142,1183328,1183339-1183340,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200,1185588,1185626,1185756,1185758,1186011,1186042-1186045,1186104,1186123,1186137,1186153,1186254,1186257,1186377-1186379,1186479-1186480,1186712,1186743,1186750,1186763,1186890-1186892,1186894,1186949,1187018,1187027-1187028,1187381,1187
 755,1187775,1187806,1187827,1188301,1188303-1188305,1188399,1188822,1188930-1188931,1189116,1189129,1189183,1189240,1189256,1189386,1189413-1189414,1189477,1189685,1189805,1189857,1189864,1189882,1190034,1190185,1190279,1190339,1190371,1190388-1190389,1190474,1190481,1194915,1195222-1195223,1195531,1195899,1195905,1195943,1195949,1195953,1195955,1195965,1195968,1196175,1196212,1196223,1196304-1196305,1196735,1196825,1196827,1197158,1197261,1197299-1197300,1197339-1197340,1197343,1197382,1197386-1197387,1197480,1197578,1198497,1198528,1198552

Modified: tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/TomcatBaseTest.java
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/TomcatBaseTest.java?rev=1198572&r1=1198571&r2=1198572&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/TomcatBaseTest.java (original)
+++ tomcat/tc7.0.x/trunk/test/org/apache/catalina/startup/TomcatBaseTest.java Sun Nov  6 21:43:45 2011
@@ -24,7 +24,6 @@ import java.io.OutputStream;
 import java.io.PrintWriter;
 import java.net.HttpURLConnection;
 import java.net.URL;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 
@@ -54,16 +53,13 @@ import org.apache.tomcat.util.buf.ByteCh
  * Base test case that provides a Tomcat instance for each test - mainly so we
  * don't have to keep writing the cleanup code.
  */
-public abstract class TomcatBaseTest {
+public abstract class TomcatBaseTest extends LoggingBaseTest {
     private Tomcat tomcat;
-    private File tempDir;
     private boolean accessLogEnabled = false;
     private static int port = 8000;
 
     public static final String TEMP_DIR = System.getProperty("java.io.tmpdir");
 
-    private List<File> deleteOnTearDown = new ArrayList<File>();
-
     /**
      * Make Tomcat instance accessible to sub-classes.
      */
@@ -87,67 +83,21 @@ public abstract class TomcatBaseTest {
     }
 
     /**
-     * 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;
-    }
-
-    /**
-     * 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"));
-    }
-
-    /**
      * Sub-classes may want to check, whether an AccessLogValve is active
      */
     public boolean isAccessLogEnabled() {
         return accessLogEnabled;
     }
 
-    /**
-     * 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
+    @Override
     public void setUp() throws Exception {
-        // Need to use JULI so log messages from the tests are visible
-        System.setProperty("java.util.logging.manager",
-                "org.apache.juli.ClassLoaderLogManager");
-        System.setProperty("java.util.logging.config.file", new File(
-                getBuildDirectory(), "conf/logging.properties").toString());
-
-        tempDir = new File(System.getProperty("tomcat.test.temp", "output/tmp"));
-        if (!tempDir.mkdirs() && !tempDir.isDirectory()) {
-            fail("Unable to create temporary directory for test");
-        }
+        super.setUp();
 
-        System.setProperty("catalina.base", tempDir.getAbsolutePath());
         // Trigger loading of catalina.properties
         CatalinaProperties.getProperty("foo");
 
-        File appBase = new File(tempDir, "webapps");
+        File appBase = new File(getTemporaryDirectory(), "webapps");
         if (!appBase.exists() && !appBase.mkdir()) {
             fail("Unable to create appBase for test");
         }
@@ -173,7 +123,8 @@ public abstract class TomcatBaseTest {
             connector.setAttribute("pollerThreadCount", Integer.valueOf(1));
         }
 
-        tomcat.setBaseDir(tempDir.getAbsolutePath());
+        File catalinaBase = getTemporaryDirectory();
+        tomcat.setBaseDir(catalinaBase.getAbsolutePath());
         tomcat.getHost().setAppBase(appBase.getAbsolutePath());
 
         accessLogEnabled = Boolean.parseBoolean(
@@ -184,6 +135,11 @@ public abstract class TomcatBaseTest {
             alv.setPattern("%h %l %u %t \"%r\" %s %b %I %D");
             tomcat.getHost().getPipeline().addValve(alv);
         }
+
+        // Cannot delete the whole tempDir, because logs are there,
+        // but delete known subdirectories of it.
+        addDeleteOnTearDown(new File(catalinaBase, "webapps"));
+        addDeleteOnTearDown(new File(catalinaBase, "work"));
     }
 
     protected String getProtocol() {
@@ -199,30 +155,26 @@ public abstract class TomcatBaseTest {
     }
 
     @After
+    @Override
     public void tearDown() throws Exception {
-        // Speed up Tomcat shutdown
-        if (tomcat.connector != null) {
-            tomcat.connector.setProperty("fastShutdown", "true");
-        }
-        // Some tests may call tomcat.destroy(), some tests may just call
-        // tomcat.stop(), some not call either method. Make sure that stop() &
-        // destroy() are called as necessary.
-        if (tomcat.server != null &&
-                tomcat.server.getState() != LifecycleState.DESTROYED) {
-            if (tomcat.server.getState() != LifecycleState.STOPPED) {
-                tomcat.stop();
+        try {
+            // Speed up Tomcat shutdown
+            if (tomcat.connector != null) {
+                tomcat.connector.setProperty("fastShutdown", "true");
             }
-            tomcat.destroy();
-        }
-        // Cannot delete the whole tempDir, because logs are there,
-        // and they might be open for writing.
-        // Delete known subdirectories of it.
-        deleteOnTearDown.add(new File(tempDir, "webapps"));
-        deleteOnTearDown.add(new File(tempDir, "work"));
-        for (File file : deleteOnTearDown) {
-            ExpandWar.delete(file);
+            // Some tests may call tomcat.destroy(), some tests may just call
+            // tomcat.stop(), some not call either method. Make sure that stop()
+            // & destroy() are called as necessary.
+            if (tomcat.server != null
+                    && tomcat.server.getState() != LifecycleState.DESTROYED) {
+                if (tomcat.server.getState() != LifecycleState.STOPPED) {
+                    tomcat.stop();
+                }
+                tomcat.destroy();
+            }
+        } finally {
+            super.tearDown();
         }
-        deleteOnTearDown.clear();
     }
 
     /**

Modified: tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml?rev=1198572&r1=1198571&r2=1198572&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Sun Nov  6 21:43:45 2011
@@ -320,6 +320,11 @@
       <update>
         Update optional Checkstyle library to 5.5. (kkolinko)
       </update>
+      <add>
+        In test suite: add <code>LoggingBaseTest</code> class to allow
+        use of Tomcat logging configuration in tests that do not start Tomcat.
+        (kkolinko)
+      </add>
     </changelog>
   </subsection>
 </section>



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org