gov.nih.nci.firebird.test.AbstractHibernateTestCase.java Source code

Java tutorial

Introduction

Here is the source code for gov.nih.nci.firebird.test.AbstractHibernateTestCase.java

Source

/**
 * The software subject to this notice and license includes both human readable
 * source code form and machine readable, binary, object code form. The NCI OCR
 * Software was developed in conjunction with the National Cancer Institute
 * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent
 * government employees are authors, any rights in such works shall be subject
 * to Title 17 of the United States Code, section 105.
 *
 * This NCI OCR Software License (the License) is between NCI and You. You (or
 * Your) shall mean a person or an entity, and all other entities that control,
 * are controlled by, or are under common control with the entity. Control for
 * purposes of this definition means (i) the direct or indirect power to cause
 * the direction or management of such entity, whether by contract or otherwise,
 * or (ii) ownership of fifty percent (50%) or more of the outstanding shares,
 * or (iii) beneficial ownership of such entity.
 *
 * This License is granted provided that You agree to the conditions described
 * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
 * no-charge, irrevocable, transferable and royalty-free right and license in
 * its rights in the NCI OCR Software to (i) use, install, access, operate,
 * execute, copy, modify, translate, market, publicly display, publicly perform,
 * and prepare derivative works of the NCI OCR Software; (ii) distribute and
 * have distributed to and by third parties the NCI OCR Software and any
 * modifications and derivative works thereof; and (iii) sublicense the
 * foregoing rights set out in (i) and (ii) to third parties, including the
 * right to license such rights to further third parties. For sake of clarity,
 * and not by way of limitation, NCI shall have no right of accounting or right
 * of payment from You or Your sub-licensees for the rights granted under this
 * License. This License is granted at no charge to You.
 *
 * Your redistributions of the source code for the Software must retain the
 * above copyright notice, this list of conditions and the disclaimer and
 * limitation of liability of Article 6, below. Your redistributions in object
 * code form must reproduce the above copyright notice, this list of conditions
 * and the disclaimer of Article 6 in the documentation and/or other materials
 * provided with the distribution, if any.
 *
 * Your end-user documentation included with the redistribution, if any, must
 * include the following acknowledgment: This product includes software
 * developed by 5AM and the National Cancer Institute. If You do not include
 * such end-user documentation, You shall include this acknowledgment in the
 * Software itself, wherever such third-party acknowledgments normally appear.
 *
 * You may not use the names "The National Cancer Institute", "NCI", or "5AM"
 * to endorse or promote products derived from this Software. This License does
 * not authorize You to use any trademarks, service marks, trade names, logos or
 * product names of either NCI or 5AM, except as required to comply with the
 * terms of this License.
 *
 * For sake of clarity, and not by way of limitation, You may incorporate this
 * Software into Your proprietary programs and into any third party proprietary
 * programs. However, if You incorporate the Software into third party
 * proprietary programs, You agree that You are solely responsible for obtaining
 * any permission from such third parties required to incorporate the Software
 * into such third party proprietary programs and for informing Your
 * sub-licensees, including without limitation Your end-users, of their
 * obligation to secure any required permissions from such third parties before
 * incorporating the Software into such third party proprietary software
 * programs. In the event that You fail to obtain such permissions, You agree
 * to indemnify NCI for any claims against NCI by such third parties, except to
 * the extent prohibited by law, resulting from Your failure to obtain such
 * permissions.
 *
 * For sake of clarity, and not by way of limitation, You may add Your own
 * copyright statement to Your modifications and to the derivative works, and
 * You may provide additional or different license terms and conditions in Your
 * sublicenses of modifications of the Software, or any derivative works of the
 * Software as a whole, provided Your use, reproduction, and distribution of the
 * Work otherwise complies with the conditions stated in this License.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
 * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR
 * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package gov.nih.nci.firebird.test;

import gov.nih.nci.firebird.test.util.ComparisonUtil;

import java.sql.SQLException;
import java.sql.Statement;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;

import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.Transaction;
import org.hibernate.persister.collection.AbstractCollectionPersister;
import org.hibernate.persister.entity.EntityPersister;
import org.hibernate.tool.hbm2ddl.SchemaExport;
import org.junit.After;
import org.junit.Before;
import org.junit.runner.RunWith;

import com.fiveamsolutions.nci.commons.data.persistent.PersistentObject;
import com.fiveamsolutions.nci.commons.util.HibernateHelper;
import com.fiveamsolutions.nci.commons.util.ProxyUtils;
import com.google.inject.Inject;
import com.google.inject.Provider;

@RunWith(GuiceTestRunner.class)
public class AbstractHibernateTestCase {
    private static final ResourceBundle APPLICATION_RESOURCES = ResourceBundle.getBundle("ApplicationResources");
    private static final ResourceBundle RESOURCES = ResourceBundle.getBundle("resources");
    private static SchemaExport schemaExporter;

    private Transaction transaction;
    private Provider<Session> currentSessionProvider;
    private HibernateHelper helper;

    @Inject
    protected void setCurrentSessionProvider(Provider<Session> currentSessionProvider) {
        this.currentSessionProvider = currentSessionProvider;
    }

    protected Session getCurrentSession() {
        return currentSessionProvider.get();
    }

    @Inject
    void setHelper(HibernateHelper helper) {
        this.helper = helper;
    }

    /**
     * Method that runs before the test to clean up the db and start the transaction.
     */
    @SuppressWarnings("unchecked")
    @Before
    public void setUp() throws Exception {
        // clean up the hibernate second level cache between runs
        SessionFactory sf = getCurrentSession().getSessionFactory();
        Map<String, EntityPersister> classMetadata = sf.getAllClassMetadata();
        for (EntityPersister ep : classMetadata.values()) {
            if (ep.hasCache()) {
                sf.evictEntity(ep.getCacheAccessStrategy().getRegion().getName());
            }
        }

        Map<?, AbstractCollectionPersister> collMetadata = sf.getAllCollectionMetadata();
        for (AbstractCollectionPersister acp : collMetadata.values()) {
            if (acp.hasCache()) {
                sf.evictCollection(acp.getCacheAccessStrategy().getRegion().getName());
            }
        }
        transaction = helper.beginTransaction();
    }

    /**
     * method to clean up after test is done.
     */
    @After
    public final void tearDown() {
        transaction.rollback();
    }

    /**
     * method to init the db if needed.
     *
     * @throws SQLException on error
     */
    @Before
    @SuppressWarnings({ "unchecked", "deprecation" })
    public final void initDbIfNeeded() throws SQLException {
        // First drop the audit sequence (& associated table, see
        // http://opensource.atlassian.com/projects/hibernate/browse/HHH-2472)
        Transaction tx = helper.beginTransaction();
        Statement s = getCurrentSession().connection().createStatement();
        try {
            s.execute("drop sequence AUDIT_ID_SEQ");
            s.execute("drop table if exists dual_AUDIT_ID_SEQ");
        } catch (SQLException e) {
            // expected
        }
        tx.commit();

        tx = helper.beginTransaction();
        List<Long> counts = getCurrentSession().createQuery("select count(*) from " + Object.class.getName())
                .list();
        s = getCurrentSession().connection().createStatement();
        s.execute("create sequence AUDIT_ID_SEQ");
        s.execute("create table dual_AUDIT_ID_SEQ(test boolean)");
        for (Long count : counts) {
            if (count > 0) {
                if (schemaExporter == null) {
                    schemaExporter = new SchemaExport(helper.getConfiguration());
                }
                schemaExporter.drop(false, true);
                schemaExporter.create(false, true);
                break;
            }
        }
        tx.commit();
    }

    protected void save(Object... objects) {
        saveAll(Arrays.asList(objects));
    }

    protected void saveAll(Collection<? extends Object> objects) {
        for (Object object : objects) {
            getCurrentSession().saveOrUpdate(object);
        }
    }

    protected void saveAndFlushAll(Collection<?> objects) {
        saveAll(objects);
        flushAndClearSession();
    }

    protected void saveAndFlush(Object... objects) {
        save(objects);
        flushAndClearSession();
    }

    protected void flushAndClearSession() {
        getCurrentSession().flush();
        getCurrentSession().clear();
    }

    protected void delete(Object... objects) {
        deleteAll(Arrays.asList(objects));
    }

    protected void deleteAll(Collection<? extends Object> objects) {
        for (Object object : objects) {
            getCurrentSession().delete(object);
        }
    }

    @SuppressWarnings("unchecked")
    protected <T extends PersistentObject> T loadObject(Class<T> clazz, Long id) {
        return (T) getCurrentSession().load(clazz, id);
    }

    @SuppressWarnings("unchecked")
    protected <T extends PersistentObject> T getObject(Class<T> clazz, Long id) {
        return (T) getCurrentSession().get(clazz, id);
    }

    @SuppressWarnings("unchecked")
    protected <T extends PersistentObject> T reloadObject(T obj) {
        return (T) getCurrentSession().load(getPersistentClass(obj), obj.getId());
    }

    protected void assertSamePersistentObjects(PersistentObject object1, PersistentObject object2) {
        ComparisonUtil.assertSamePersistentObjects(object1, object2);
    }

    private Class<?> getPersistentClass(Object obj) {
        Class<?> clazz = ProxyUtils.unEnhanceCGLIBClass(obj.getClass());
        if (isJavassistProxy(clazz)) {
            clazz = clazz.getSuperclass();
        }
        return clazz;
    }

    private boolean isJavassistProxy(Class<?> clazz) {
        return clazz.getName().contains("$$_javassist");
    }

    protected String getPropertyText(String property, String... replacements) {
        //MessageFormat strips out ' characters, among others
        String message;
        if (APPLICATION_RESOURCES.containsKey(property)) {
            message = APPLICATION_RESOURCES.getString(property);
        } else {
            message = RESOURCES.getString(property);
        }
        return MessageFormat.format(message.replaceAll("'", "''"), (Object[]) replacements);
    }
}