1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski package lib; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import java.io.PrintWriter; 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski import lib.TestParameters; 29*b1cdbd2cSJim Jagielski /** 30*b1cdbd2cSJim Jagielski * <code>TestCase</code> represent a factory for <code>TestEnvironment</code>s 31*b1cdbd2cSJim Jagielski * creation and disposing for a given implementation object. The 32*b1cdbd2cSJim Jagielski * <code>TestEnvironment</code> contains an instance of the implementation 33*b1cdbd2cSJim Jagielski * object and all additional objects needed to perform tests on the object. 34*b1cdbd2cSJim Jagielski * 35*b1cdbd2cSJim Jagielski * <p>The <code>TestCase</code> provides four methods for its subclasses to 36*b1cdbd2cSJim Jagielski * define its functionality: <code>initialize()</code>, <code>cleanup()</code>, 37*b1cdbd2cSJim Jagielski * <code>createTestEnvironment()</code> and <code>disposeTestEnvironment()</code>. 38*b1cdbd2cSJim Jagielski * The first two are intended to initialize and cleanup common objects shared 39*b1cdbd2cSJim Jagielski * among all instances of <code>TestEnvironment</code> produced by the 40*b1cdbd2cSJim Jagielski * <code>TestCase</code>, and they are called at the beginning and at the end of 41*b1cdbd2cSJim Jagielski * the <code>TestCase</code> lifecycle accordingly. 42*b1cdbd2cSJim Jagielski * 43*b1cdbd2cSJim Jagielski * <p>The other two are intended to produce and dispose 44*b1cdbd2cSJim Jagielski * <code>TestEnvironment</code> instances. The 45*b1cdbd2cSJim Jagielski * <code>createTestEnvironment()</code> is called to create a 46*b1cdbd2cSJim Jagielski * <code>TestEnvironment</code> instance and the 47*b1cdbd2cSJim Jagielski * <code>disposeTestEnvironment()</code> is called when the instane is not used 48*b1cdbd2cSJim Jagielski * anymore. 49*b1cdbd2cSJim Jagielski * 50*b1cdbd2cSJim Jagielski * @see lib.TestEnvironment 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski public abstract class TestCase { 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** 55*b1cdbd2cSJim Jagielski * Specifies the PrintWriter to log information. 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski public PrintWriter log; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski //public static TestCase tCase; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** 62*b1cdbd2cSJim Jagielski * Sets the log to write information during testing. 63*b1cdbd2cSJim Jagielski */ setLogWriter( PrintWriter log )64*b1cdbd2cSJim Jagielski public void setLogWriter( PrintWriter log ) { 65*b1cdbd2cSJim Jagielski this.log = log; 66*b1cdbd2cSJim Jagielski } 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** 69*b1cdbd2cSJim Jagielski * Initializes the <code>TestCase</code>. Calls <code>initialize()</code> 70*b1cdbd2cSJim Jagielski * method. 71*b1cdbd2cSJim Jagielski * 72*b1cdbd2cSJim Jagielski * @param tParam test parameters. 73*b1cdbd2cSJim Jagielski */ initializeTestCase( TestParameters tParam )74*b1cdbd2cSJim Jagielski public void initializeTestCase( TestParameters tParam ) { 75*b1cdbd2cSJim Jagielski initialize( tParam, log ); 76*b1cdbd2cSJim Jagielski } 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** 79*b1cdbd2cSJim Jagielski * Called while the <code>TestCase</code> initialization. In the 80*b1cdbd2cSJim Jagielski * implementation does nothing. Subclasses can override to initialize 81*b1cdbd2cSJim Jagielski * objects shared among all <code>TestEnvironment</code>s. 82*b1cdbd2cSJim Jagielski * 83*b1cdbd2cSJim Jagielski * @param tParam test parameters 84*b1cdbd2cSJim Jagielski * @param log writer to log information while testing 85*b1cdbd2cSJim Jagielski * 86*b1cdbd2cSJim Jagielski * @see #initializeTestCase 87*b1cdbd2cSJim Jagielski */ initialize( TestParameters tParam, PrintWriter log )88*b1cdbd2cSJim Jagielski protected void initialize( TestParameters tParam, PrintWriter log ) { 89*b1cdbd2cSJim Jagielski } 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski /** 93*b1cdbd2cSJim Jagielski * Cleans up the <code>TestCase</code>. Calls <code>cleanup()</code>. 94*b1cdbd2cSJim Jagielski * 95*b1cdbd2cSJim Jagielski * @param tParam test parameters 96*b1cdbd2cSJim Jagielski */ cleanupTestCase( TestParameters tParam )97*b1cdbd2cSJim Jagielski public void cleanupTestCase( TestParameters tParam ) { 98*b1cdbd2cSJim Jagielski cleanup( tParam, log ); 99*b1cdbd2cSJim Jagielski } 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski /** 102*b1cdbd2cSJim Jagielski * Called while the <code>TestCase</code> cleanup. In the implementation 103*b1cdbd2cSJim Jagielski * does nothing. Subclasses can override to cleanup objects shared among 104*b1cdbd2cSJim Jagielski * all <code>TestEnvironment</code>s. 105*b1cdbd2cSJim Jagielski * 106*b1cdbd2cSJim Jagielski * @param tParam test parameters 107*b1cdbd2cSJim Jagielski * @param log writer to log information while testing 108*b1cdbd2cSJim Jagielski * 109*b1cdbd2cSJim Jagielski * @see #cleanupTestCase 110*b1cdbd2cSJim Jagielski */ cleanup( TestParameters tParam, PrintWriter log )111*b1cdbd2cSJim Jagielski protected void cleanup( TestParameters tParam, PrintWriter log ) { 112*b1cdbd2cSJim Jagielski } 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski /** 115*b1cdbd2cSJim Jagielski * Creates a <code>TestEnvironment</code> containing an instance of the 116*b1cdbd2cSJim Jagielski * implementation object and related objects needed to perform test. 117*b1cdbd2cSJim Jagielski * 118*b1cdbd2cSJim Jagielski * @param tParam test parameters 119*b1cdbd2cSJim Jagielski * 120*b1cdbd2cSJim Jagielski * @return the created <code>TestEnvironment</code> 121*b1cdbd2cSJim Jagielski * 122*b1cdbd2cSJim Jagielski * @see #createTestEnvironment 123*b1cdbd2cSJim Jagielski * @see lib.TestEnvironment 124*b1cdbd2cSJim Jagielski */ getTestEnvironment( TestParameters tParam )125*b1cdbd2cSJim Jagielski public synchronized TestEnvironment getTestEnvironment( TestParameters tParam ) { 126*b1cdbd2cSJim Jagielski TestEnvironment tEnv = null; 127*b1cdbd2cSJim Jagielski try { 128*b1cdbd2cSJim Jagielski tEnv = createTestEnvironment( tParam, log ); 129*b1cdbd2cSJim Jagielski System.out.println("Environment created"); 130*b1cdbd2cSJim Jagielski if (tEnv != null) { 131*b1cdbd2cSJim Jagielski tEnv.setTestCase(this); 132*b1cdbd2cSJim Jagielski } 133*b1cdbd2cSJim Jagielski } catch (Exception e) { 134*b1cdbd2cSJim Jagielski String message = e.getMessage(); 135*b1cdbd2cSJim Jagielski if (message == null) 136*b1cdbd2cSJim Jagielski message = e.toString(); 137*b1cdbd2cSJim Jagielski System.out.println("Exception while getting Environment "+message); 138*b1cdbd2cSJim Jagielski e.printStackTrace(); 139*b1cdbd2cSJim Jagielski cleanup(tParam, log); 140*b1cdbd2cSJim Jagielski } 141*b1cdbd2cSJim Jagielski return tEnv; 142*b1cdbd2cSJim Jagielski } 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski /** 145*b1cdbd2cSJim Jagielski * Disposes the <code>TestEnvironment</code> when it is not needed anymore. 146*b1cdbd2cSJim Jagielski * 147*b1cdbd2cSJim Jagielski * @param tEnv the environment to dispose 148*b1cdbd2cSJim Jagielski * @param tParam test parameters 149*b1cdbd2cSJim Jagielski */ disposeTestEnvironment( TestEnvironment tEnv, TestParameters tParam )150*b1cdbd2cSJim Jagielski public synchronized void disposeTestEnvironment( TestEnvironment tEnv, 151*b1cdbd2cSJim Jagielski TestParameters tParam ) { 152*b1cdbd2cSJim Jagielski cleanup( tParam, log ); 153*b1cdbd2cSJim Jagielski } 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski /** 156*b1cdbd2cSJim Jagielski * Called to create an instance of <code>TestEnvironment</code> with an 157*b1cdbd2cSJim Jagielski * object to test and related objects. Subclasses should implement this 158*b1cdbd2cSJim Jagielski * method to provide the implementation and related objects. The method is 159*b1cdbd2cSJim Jagielski * called from <code>getTestEnvironment()</code>. 160*b1cdbd2cSJim Jagielski * 161*b1cdbd2cSJim Jagielski * @param tParam test parameters 162*b1cdbd2cSJim Jagielski * @param log writer to log information while testing 163*b1cdbd2cSJim Jagielski * 164*b1cdbd2cSJim Jagielski * @see TestEnvironment 165*b1cdbd2cSJim Jagielski * @see #getTestEnvironment 166*b1cdbd2cSJim Jagielski */ createTestEnvironment( TestParameters tParam, PrintWriter log )167*b1cdbd2cSJim Jagielski protected abstract TestEnvironment createTestEnvironment( 168*b1cdbd2cSJim Jagielski TestParameters tParam, PrintWriter log ); 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski /** 171*b1cdbd2cSJim Jagielski * @return the name of the object 172*b1cdbd2cSJim Jagielski */ getObjectName()173*b1cdbd2cSJim Jagielski public String getObjectName() { 174*b1cdbd2cSJim Jagielski String clName = this.getClass().getName(); 175*b1cdbd2cSJim Jagielski return clName.substring( clName.lastIndexOf('.') + 1 ); 176*b1cdbd2cSJim Jagielski } 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski } 179