Author: dwoods
Date: Wed Oct 13 21:40:13 2010
New Revision: 1022301

URL: http://svn.apache.org/viewvc?rev=1022301&view=rev
Log:
update testcase comments to denote if EM/EMFs are automatically cleaned up and 
what parent class it extends.

Modified:
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/common/utils/AbstractTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/criteria/AbstractCriteriaTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractCachedEMFTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractPersistenceTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SQLListenerTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMFTestCase.java
    
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMTestCase.java

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/common/utils/AbstractTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/common/utils/AbstractTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/common/utils/AbstractTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/common/utils/AbstractTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -88,6 +88,12 @@ import org.apache.regexp.RE;
 import org.apache.regexp.RESyntaxException;
 import org.apache.regexp.REUtil;
 
+/**
+ * Extends AbstractCachedEMFTestCase, which extends 
AbstractPersistenceTestCase.
+ * Cleans up EMFs returned by getEmf() in tearDown().
+ *
+ * @version $Rev$ $Date$
+ */
 public abstract class AbstractTestCase extends AbstractCachedEMFTestCase {
 
     private String persistenceXmlResource;

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/criteria/AbstractCriteriaTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/criteria/AbstractCriteriaTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/criteria/AbstractCriteriaTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/criteria/AbstractCriteriaTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -47,6 +47,11 @@ import org.apache.openjpa.persistence.Op
 import org.apache.openjpa.persistence.test.AllowFailure;
 import org.apache.openjpa.persistence.test.FilteringJDBCListener;
 
+/**
+ * Extends junit.framework.TestCase
+ *
+ * @version $Rev$ $Date$
+ */
 public abstract class AbstractCriteriaTestCase extends TestCase {
 
     protected abstract SQLAuditor getAuditor();

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractCachedEMFTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractCachedEMFTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractCachedEMFTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractCachedEMFTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -25,7 +25,8 @@ import org.apache.openjpa.persistence.Op
 
 /**
  * Testcase which caches EntityManagerFactories based on the persistence unit 
name and the properties provided at
- * runtime.
+ * runtime.  Extends AbstractPersistenceTestCase and provides cleanup of EMFs 
created by createNamedEMF() through
+ * LinkHashMap.removeEldestEntry().
  * 
  */
 public abstract class AbstractCachedEMFTestCase extends 
AbstractPersistenceTestCase {

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractPersistenceTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractPersistenceTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractPersistenceTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/AbstractPersistenceTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -50,7 +50,8 @@ import org.apache.openjpa.persistence.Op
 
 /**
  * Base class for Persistence TestCases. This class contains utility methods 
but does not maintain an EntityManager or
- * EntityManagerFactory - these tasks are left for subclasses to handle.
+ * EntityManagerFactory - these tasks are left for subclasses to handle.  
Extends junit.framework.TestCase and
+ * performs NO automatic clean up of EMFs created by createEMF() or 
createNamedEMF().
  */
 public abstract class AbstractPersistenceTestCase extends TestCase {
     public static final String FRESH_EMF = "Creates new EntityManagerFactory";

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SQLListenerTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SQLListenerTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SQLListenerTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SQLListenerTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -31,6 +31,7 @@ import org.apache.openjpa.lib.jdbc.JDBCL
 
 /**
  * Base class for tests that need to check generated SQL.
+ * Extends SingleEMFTestCase, which will cleanup the EMF it provides.
  *
  * @author Patrick Linskey
  */

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMFTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMFTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMFTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMFTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -32,12 +32,14 @@ import org.apache.openjpa.persistence.Op
 /**
  * Base class for OpenJPA-specific Test Case.
  * Provides utilities for configuration setup and persistent entity 
- * registration during setUp() method.
+ * registration during setUp() method and EMF cleanup in tearDown().
  * Derived classes can access protected EntityManagerFactory to create 
  * EntityManager. The protected EntityManagerFactory is declared to be
  * OpenJPA-extended SPI interface <code>OpenJPAEntityManagerFactorySPI</code>
  * so that derived classes can access internal mapping/metadata/configuration
- * and other structures.  
+ * and other structures.
+ * Extends AbstractCachedEMFTestCase, which extends AbstractPersistenceTestCase
+ * and cleans up the EMF it provides in tearDown().
  *   
  */
 public abstract class SingleEMFTestCase

Modified: 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMTestCase.java
URL: 
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMTestCase.java?rev=1022301&r1=1022300&r2=1022301&view=diff
==============================================================================
--- 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMTestCase.java
 (original)
+++ 
openjpa/trunk/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/test/SingleEMTestCase.java
 Wed Oct 13 21:40:13 2010
@@ -28,6 +28,8 @@ import org.apache.openjpa.persistence.Op
 /**
  * A base test case that can be used to easily test scenarios where there
  * is only a single EntityManager at any given time.
+ * Extends SingleEMFTestCase and cleans up provided EM in tearDown() and 
relies on
+ * SingEMFTestCase.tearDown() to clean up the EMF it provides.
  *
  * @author Marc Prud'hommeaux
  */


Reply via email to