Clover Coverage Report - Internal Test Tools 2.0.0-SNAPSHOT
Coverage timestamp: Wed Dec 31 1969 19:00:00 EST
Overview   Package   File
    FRAMES   NO FRAMES     
../../../../img/srcFileCovDistChart0.png 0% of files have more coverage
121   426   48   3.9
26   265   0.4   31
31     1.55  
1    
 
  RiceTestCase       Line # 62 121 0% 48 178 0% 0.0
 
No Tests
 
1    /*
2    * Copyright 2006-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10    * Unless required by applicable law or agreed to in writing, software
11    * distributed under the License is distributed on an "AS IS" BASIS,
12    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13    * See the License for the specific language governing permissions and
14    * limitations under the License.
15    */
16   
17    package org.kuali.rice.test;
18   
19    import org.apache.commons.lang.StringUtils;
20    import org.apache.log4j.Logger;
21    import org.apache.log4j.PropertyConfigurator;
22    import org.junit.After;
23    import org.junit.Before;
24    import org.kuali.rice.core.api.config.property.Config;
25    import org.kuali.rice.core.api.config.property.ConfigContext;
26    import org.kuali.rice.core.api.lifecycle.BaseLifecycle;
27    import org.kuali.rice.core.api.lifecycle.Lifecycle;
28    import org.kuali.rice.core.impl.config.property.JAXBConfigImpl;
29    import org.kuali.rice.core.api.lifecycle.BaseLifecycle;
30    import org.kuali.rice.core.api.lifecycle.Lifecycle;
31    import org.kuali.rice.core.impl.resourceloader.SpringResourceLoader;
32    import org.kuali.rice.test.data.PerSuiteUnitTestData;
33    import org.kuali.rice.test.lifecycles.PerSuiteDataLoaderLifecycle;
34    import org.springframework.core.io.FileSystemResourceLoader;
35    import org.springframework.core.io.Resource;
36    import org.springframework.core.io.ResourceLoader;
37   
38    import javax.xml.namespace.QName;
39    import java.io.File;
40    import java.io.IOException;
41    import java.util.ArrayList;
42    import java.util.Collections;
43    import java.util.HashSet;
44    import java.util.LinkedList;
45    import java.util.List;
46    import java.util.Properties;
47    import java.util.Set;
48   
49    import static org.junit.Assert.assertNotNull;
50    import static org.junit.Assert.fail;
51   
52   
53    /**
54    * Useful superclass for all Rice test cases. Handles setup of test utilities and a test environment. Configures the
55    * Spring test environment providing a template method for custom context files in test mode. Also provides a template method
56    * for running custom transactional setUp. Tear down handles automatic tear down of objects created inside the test
57    * environment.
58    *
59    * @author Kuali Rice Team (rice.collab@kuali.org)
60    * @since 0.9
61    */
 
62    public abstract class RiceTestCase extends BaseRiceTestCase {
63   
64    private static final Logger LOG = Logger.getLogger(RiceTestCase.class);
65   
66    private static final String ALT_LOG4J_CONFIG_LOCATION_PROP = "alt.log4j.config.location";
67    private static final String DEFAULT_LOG4J_CONFIG = "classpath:rice-testharness-default-log4j.properties";
68    protected static final String DEFAULT_TEST_HARNESS_SPRING_BEANS = "classpath:TestHarnessSpringBeans.xml";
69    protected static boolean SUITE_LIFE_CYCLES_RAN = false;
70    protected static boolean SUITE_LIFE_CYCLES_FAILED = false;
71    protected static String failedSuiteTestName;
72   
73    protected List<Lifecycle> perTestLifeCycles = new LinkedList<Lifecycle>();
74   
75    protected List<Lifecycle> suiteLifeCycles = new LinkedList<Lifecycle>();
76   
77    private static Set<String> perSuiteDataLoaderLifecycleNamesRun = new HashSet<String>();
78   
79    private List<String> reports = new ArrayList<String>();
80   
81    private SpringResourceLoader testHarnessSpringResourceLoader;
82    private boolean clearTables = true;
83   
 
84  0 toggle @Override
85    @Before
86    public void setUp() throws Exception {
87  0 try {
88  0 configureLogging();
89  0 logBeforeRun();
90   
91  0 final long initTime = System.currentTimeMillis();
92   
93  0 setUpInternal();
94   
95  0 report("Time to start all Lifecycles: " + (System.currentTimeMillis() - initTime));
96    } catch (Throwable e) {
97  0 e.printStackTrace();
98  0 tearDown();
99  0 throw new RuntimeException(e);
100    }
101    }
102   
103    /**
104    * Internal setUp() implementation which is invoked by the main setUp() and wrapped
105    * with exception handling. Subclasses should override this method if they want to
106    * add set up steps that should occur in the standard set up process, wrapped by
107    * exception handling.
108    */
 
109  0 toggle protected void setUpInternal() throws Exception {
110  0 assertNotNull(getModuleName());
111  0 setModuleName(getModuleName());
112  0 setBaseDirSystemProperty(getModuleName());
113   
114  0 this.perTestLifeCycles = getPerTestLifecycles();
115  0 this.suiteLifeCycles = getSuiteLifecycles();
116   
117  0 if (SUITE_LIFE_CYCLES_FAILED) {
118  0 fail("Suite Lifecycles startup failed on test " + failedSuiteTestName + "!!! Please see logs for details.");
119    }
120  0 if (!SUITE_LIFE_CYCLES_RAN) {
121  0 try {
122  0 startLifecycles(this.suiteLifeCycles);
123  0 SUITE_LIFE_CYCLES_RAN = true;
124    } catch (Throwable e) {
125  0 e.printStackTrace();
126  0 SUITE_LIFE_CYCLES_RAN = false;
127  0 SUITE_LIFE_CYCLES_FAILED = true;
128  0 failedSuiteTestName = getFullTestName();
129  0 tearDown();
130  0 stopLifecycles(this.suiteLifeCycles);
131  0 throw new RuntimeException(e);
132    }
133    }
134   
135  0 startSuiteDataLoaderLifecycles();
136   
137  0 startLifecycles(this.perTestLifeCycles);
138   
139    }
140   
141    /**
142    * This block is walking up the class hierarchy of the current unit test looking for PerSuiteUnitTestData annotations. If it finds one,
143    * it will run it once, then add it to a set so that it does not get run again. This is needed so that multiple
144    * tests can extend from the same suite and so that there can be multiple suites throughout the test source branch.
145    *
146    * @throws Exception if a PerSuiteDataLoaderLifecycle is unable to be started
147    */
 
148  0 toggle protected void startSuiteDataLoaderLifecycles() throws Exception {
149  0 List<Class> classes = TestUtilities.getHierarchyClassesToHandle(getClass(), new Class[] { PerSuiteUnitTestData.class }, perSuiteDataLoaderLifecycleNamesRun);
150  0 for (Class c: classes) {
151  0 new PerSuiteDataLoaderLifecycle(c).start();
152  0 perSuiteDataLoaderLifecycleNamesRun.add(c.getName());
153    }
154    }
155   
156    /**
157    * maven will set this property and find resources from the config based on it. This makes eclipse testing work because
158    * we have to put the basedir in our config files in order to find things when testing from maven
159    */
 
160  0 toggle protected void setBaseDirSystemProperty(String moduleBaseDir) {
161  0 if (System.getProperty("basedir") == null) {
162  0 final String userDir = System.getProperty("user.dir");
163   
164  0 System.setProperty("basedir", userDir + ((userDir.endsWith(File.separator + "test" + File.separator + moduleBaseDir)) ? "" : File.separator + "test" + File.separator + moduleBaseDir));
165    }
166    }
167   
168    /**
169    * Returns the basedir for the module under which the tests are currently executing.
170    */
 
171  0 toggle protected String getBaseDir() {
172  0 return System.getProperty("basedir");
173    }
174   
 
175  0 toggle protected void setModuleName(String moduleName) {
176  0 if (System.getProperty("module.name") == null) {
177  0 System.setProperty("module.name", moduleName);
178    }
179    }
180   
 
181  0 toggle @Override
182    @After
183    public void tearDown() throws Exception {
184    // wait for outstanding threads to complete for 1 minute
185  0 ThreadMonitor.tearDown(60000);
186  0 stopLifecycles(this.perTestLifeCycles);
187  0 logAfterRun();
188    }
189   
 
190  0 toggle protected void logBeforeRun() {
191  0 LOG.info("##############################################################");
192  0 LOG.info("# Starting test " + getFullTestName() + "...");
193  0 LOG.info("# " + dumpMemory());
194  0 LOG.info("##############################################################");
195    }
196   
 
197  0 toggle protected void logAfterRun() {
198  0 LOG.info("##############################################################");
199  0 LOG.info("# ...finished test " + getFullTestName());
200  0 LOG.info("# " + dumpMemory());
201  0 for (final String report : this.reports) {
202  0 LOG.info("# " + report);
203    }
204  0 LOG.info("##############################################################\n\n\n");
205    }
206   
 
207  0 toggle protected String getFullTestName() {
208  0 return getClass().getSimpleName() + "." + getName();
209    }
210   
 
211  0 toggle protected void configureLogging() throws IOException {
212  0 ResourceLoader resourceLoader = new FileSystemResourceLoader();
213  0 String altLog4jConfigLocation = System.getProperty(ALT_LOG4J_CONFIG_LOCATION_PROP);
214  0 Resource log4jConfigResource = null;
215  0 if (!StringUtils.isEmpty(altLog4jConfigLocation)) {
216  0 log4jConfigResource = resourceLoader.getResource(altLog4jConfigLocation);
217    }
218  0 if (log4jConfigResource == null || !log4jConfigResource.exists()) {
219  0 System.out.println("Alternate Log4j config resource does not exist! " + altLog4jConfigLocation);
220  0 System.out.println("Using default log4j configuration: " + DEFAULT_LOG4J_CONFIG);
221  0 log4jConfigResource = resourceLoader.getResource(DEFAULT_LOG4J_CONFIG);
222    } else {
223  0 System.out.println("Using alternate log4j configuration at: " + altLog4jConfigLocation);
224    }
225  0 Properties p = new Properties();
226  0 p.load(log4jConfigResource.getInputStream());
227  0 PropertyConfigurator.configure(p);
228    }
229   
230    /**
231    * Executes the start() method of each of the lifecycles in the given list.
232    */
 
233  0 toggle protected void startLifecycles(List<Lifecycle> lifecycles) throws Exception {
234  0 for (Lifecycle lifecycle : lifecycles) {
235  0 lifecycle.start();
236    }
237    }
238   
239    /**
240    * Executes the stop() method of each of the lifecyles in the given list. The
241    * List of lifecycles is processed in reverse order.
242    */
 
243  0 toggle protected void stopLifecycles(List<Lifecycle> lifecycles) throws Exception {
244  0 int lifecyclesSize = lifecycles.size() - 1;
245  0 for (int i = lifecyclesSize; i >= 0; i--) {
246  0 try {
247  0 if (lifecycles.get(i) == null) {
248  0 LOG.warn("Attempted to stop a null lifecycle");
249    } else {
250  0 if (lifecycles.get(i).isStarted()) {
251  0 LOG.warn("Attempting to stop a lifecycle " + lifecycles.get(i).getClass());
252  0 lifecycles.get(i).stop();
253    }
254    }
255    } catch (Exception e) {
256  0 LOG.error("Failed to shutdown one of the lifecycles!", e);
257    }
258    }
259    }
260   
261    /**
262    * Returns the List of Lifecycles to start when the unit test suite is started
263    */
 
264  0 toggle protected List<Lifecycle> getSuiteLifecycles() {
265  0 List<Lifecycle> lifecycles = new LinkedList<Lifecycle>();
266   
267    /**
268    * Initializes Rice configuration from the test harness configuration file.
269    */
270  0 lifecycles.add(new BaseLifecycle() {
 
271  0 toggle @Override
272    public void start() throws Exception {
273  0 Config config = getTestHarnessConfig();
274  0 ConfigContext.init(config);
275  0 super.start();
276    }
277    });
278   
279    /**
280    * Loads the TestHarnessSpringBeans.xml file which obtains connections to the DB for us
281    */
282  0 lifecycles.add(getTestHarnessSpringResourceLoader());
283   
284    /**
285    * Establishes the TestHarnessServiceLocator so that it has a reference to the Spring context
286    * created from TestHarnessSpringBeans.xml
287    */
288  0 lifecycles.add(new BaseLifecycle() {
 
289  0 toggle @Override
290    public void start() throws Exception {
291  0 TestHarnessServiceLocator.setContext(getTestHarnessSpringResourceLoader().getContext());
292  0 super.start();
293    }
294    });
295   
296    /**
297    * Clears the tables in the database.
298    */
299  0 if (clearTables) {
300  0 lifecycles.add(new ClearDatabaseLifecycle());
301    }
302   
303    /**
304    * Loads Suite Test Data
305    */
306  0 lifecycles.add(new BaseLifecycle() {
 
307  0 toggle @Override
308    public void start() throws Exception {
309  0 loadSuiteTestData();
310  0 super.start();
311    }
312    });
313   
314  0 Lifecycle loadApplicationLifecycle = getLoadApplicationLifecycle();
315  0 if (loadApplicationLifecycle != null) {
316  0 lifecycles.add(loadApplicationLifecycle);
317    }
318  0 return lifecycles;
319    }
320   
321    /**
322    * This should return a Lifecycle that can be used to load the application
323    * being tested. For example, this could start a Jetty Server which loads
324    * the application, or load a Spring context to establish a set of services,
325    * or any other application startup activities that the test depends upon.
326    */
 
327  0 toggle protected Lifecycle getLoadApplicationLifecycle() {
328    // by default return null, do nothing
329  0 return null;
330    }
331   
332    /**
333    * @return Lifecycles run every test run
334    */
 
335  0 toggle protected List<Lifecycle> getPerTestLifecycles() {
336  0 List<Lifecycle> lifecycles = new LinkedList<Lifecycle>();
337  0 lifecycles.add(getPerTestDataLoaderLifecycle());
338  0 lifecycles.add(new BaseLifecycle() {
 
339  0 toggle @Override
340    public void start() throws Exception {
341  0 loadPerTestData();
342  0 super.start();
343    }
344    });
345  0 return lifecycles;
346    }
347   
348    /**
349    * A method that can be overridden to load test data for the unit test Suite.
350    */
 
351  0 toggle protected void loadSuiteTestData() throws Exception {
352    // do nothing by default, subclass can override
353    }
354   
355    /**
356    * A method that can be overridden to load test data on a test-by-test basis
357    */
 
358  0 toggle protected void loadPerTestData() throws Exception {
359    // do nothing by default, subclass can override
360    }
361   
 
362  0 toggle protected void report(final String report) {
363  0 this.reports.add(report);
364    }
365   
 
366  0 toggle protected String dumpMemory() {
367  0 final long total = Runtime.getRuntime().totalMemory();
368  0 final long free = Runtime.getRuntime().freeMemory();
369  0 final long max = Runtime.getRuntime().maxMemory();
370  0 return "[Memory] max: " + max + ", total: " + total + ", free: " + free;
371    }
372   
 
373  0 toggle public SpringResourceLoader getTestHarnessSpringResourceLoader() {
374  0 if (testHarnessSpringResourceLoader == null) {
375  0 testHarnessSpringResourceLoader = new SpringResourceLoader(new QName("TestHarnessSpringContext"), getTestHarnessSpringBeansLocation(), null);
376    }
377  0 return testHarnessSpringResourceLoader;
378    }
379   
380    /**
381    * Returns the location of the test harness spring beans context file.
382    * Subclasses may override to specify a different location.
383    * @return the location of the test harness spring beans context file.
384    */
 
385  0 toggle protected List<String> getTestHarnessSpringBeansLocation() {
386  0 return Collections.singletonList( DEFAULT_TEST_HARNESS_SPRING_BEANS );
387    }
388   
 
389  0 toggle protected Config getTestHarnessConfig() throws Exception {
390  0 Config config = new JAXBConfigImpl(getConfigLocations(), System.getProperties());
391  0 config.parseConfig();
392  0 return config;
393    }
394   
395    /**
396    * Subclasses may override this method to customize the location(s) of the Rice configuration.
397    * By default it is: classpath:META-INF/" + getModuleName().toLowerCase() + "-test-config.xml"
398    * @return List of config locations to add to this tests config location.
399    */
 
400  0 toggle protected List<String> getConfigLocations() {
401  0 List<String> configLocations = new ArrayList<String>();
402  0 configLocations.add(getRiceMasterDefaultConfigFile());
403  0 configLocations.add(getModuleTestConfigLocation());
404  0 return configLocations;
405    }
406   
 
407  0 toggle protected String getModuleTestConfigLocation() {
408  0 return "classpath:META-INF/" + getModuleName().toLowerCase() + "-test-config.xml";
409    }
410   
 
411  0 toggle protected String getRiceMasterDefaultConfigFile() {
412  0 return "classpath:META-INF/test-config-defaults.xml";
413    }
414   
415    /**
416    * same as the module directory in the project.
417    *
418    * @return name of module that the tests located
419    */
420    protected abstract String getModuleName();
421   
 
422  0 toggle protected void setClearTables(boolean clearTables) {
423  0 this.clearTables = clearTables;
424    }
425   
426    }
 
CloverReport generated by Clover Code Coverage v3.0.2
Wed Apr 13 2011 04:35:00 EDT.		   Clover: Open Source License registered to University of Arizona.