org.unitils.orm.hibernate.util.HibernateAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unitils-orm Show documentation
The newest version!
/*
 * Copyright 2008, Unitils.org
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.unitils.orm.hibernate.util;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.hibernate.HibernateException;
import org.hibernate.Session;
import org.hibernate.boot.MetadataBuilder;
import org.hibernate.boot.MetadataSources;
import org.hibernate.boot.registry.StandardServiceRegistry;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.boot.spi.MetadataImplementor;
import org.hibernate.cfg.Configuration;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.config.spi.ConfigurationService;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.tool.schema.TargetType;
import org.hibernate.tool.schema.internal.ExceptionHandlerLoggedImpl;
import org.hibernate.tool.schema.spi.ExceptionHandler;
import org.hibernate.tool.schema.spi.ExecutionOptions;
import org.hibernate.tool.schema.spi.SchemaManagementTool;
import org.hibernate.tool.schema.spi.SchemaManagementToolCoordinator;
import org.hibernate.tool.schema.spi.ScriptTargetOutput;
import org.hibernate.tool.schema.spi.TargetDescriptor;
import org.unitils.core.UnitilsException;

import static org.junit.Assert.assertTrue;

/**
 * Assert class that offers assert methods for testing things that are specific to Hibernate.
 *
 * @author Timmy Maris
 * @author Filip Neven
 * @author Tim Ducheyne
 */
public class HibernateAssert {
    /**
     * Checks if the mapping of the Hibernate managed objects with the database is still correct.
     *
     * @param configuration
     *     The hibernate config, not null
     * @param session
     *     The hibernate session, not null
     * @param databaseDialect
     *     The database dialect, not null
     */
    public static void assertMappingWithDatabaseConsistent(Configuration configuration, Session session, Dialect databaseDialect) {
        List script = generateDatabaseUpdateScript(configuration, session, databaseDialect);

        List differences = new ArrayList<>();
        for (String line : script) {
            // ignore constraints
            if (line.indexOf("add constraint") == -1) {
                differences.add(line);
            }
        }
        assertTrue("Found mismatches between Java objects and database tables. Applying following DDL statements to the "
            + "database should resolve the problem: \n" + formatErrorMessage(differences), differences.isEmpty());
    }

    /**
     * Generates a String array with DML statements based on the Hibernate mapping files.
     *
     * @param configuration
     *     The hibernate config, not null
     * @param session
     *     The hibernate session, not null
     * @param databaseDialect
     *     The database dialect, not null
     * @return List array of DDL statements that were needed to keep the database in sync with the mapping file
     */
    private static List generateDatabaseUpdateScript(Configuration configuration, Session session, Dialect databaseDialect) {
        StandardServiceRegistryBuilder ssrBuilder = configuration.getStandardServiceRegistryBuilder();
        StandardServiceRegistry ssr = ssrBuilder.build();
        try {
            MetadataSources metadataSources = new MetadataSources(ssr);
            MetadataBuilder metadataBuilder = metadataSources.getMetadataBuilder();
            MetadataImplementor metadata = (MetadataImplementor) metadataBuilder.build();

            ServiceRegistry serviceRegistry = metadata.getMetadataBuildingOptions().getServiceRegistry();

            Map config = new HashMap();
            config.putAll(serviceRegistry.getService(ConfigurationService.class).getSettings());

            SchemaManagementTool tool = serviceRegistry.getService(SchemaManagementTool.class);

            ExceptionHandler exceptionHandler = ExceptionHandlerLoggedImpl.INSTANCE;
            ExecutionOptions executionOptions = SchemaManagementToolCoordinator.buildExecutionOptions(config, exceptionHandler);

            List script = new ArrayList<>();
            ScriptTargetOutput scriptTarget = new ScriptTargetOutput() {
                @Override
                public void prepare() {
                }

                @Override
                public void accept(String action) {
                    script.add(action);
                }

                @Override
                public void release() {
                }
            };
            TargetDescriptor targetDescriptor = new TargetDescriptor() {
                @Override
                public EnumSet getTargetTypes() {
                    return EnumSet.of(TargetType.SCRIPT);
                }

                @Override
                public ScriptTargetOutput getScriptTargetOutput() {
                    return scriptTarget;
                }
            };
            tool.getSchemaMigrator(config).doMigration(metadata, executionOptions, targetDescriptor);
            return script;
        } catch (HibernateException e) {
            throw new UnitilsException("Could not retrieve database metadata", e);
        } finally {
            StandardServiceRegistryBuilder.destroy(ssr);
        }
    }

    /**
     * Formats the given list of messages.
     *
     * @param messageParts
     *     The different parts of the message
     * @return A formatted message, containing the different message parts.
     */
    private static String formatErrorMessage(List messageParts) {
        StringBuffer message = new StringBuffer();
        for (String messagePart : messageParts) {
            message.append(messagePart);
            message.append(";\n");
        }
        return message.toString();
    }
}