IntegrationTest.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.model.integration;

import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;

import java.util.List;

import org.hibernate.SessionFactory;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.test.util.ReflectionTestUtils;

import com.qcadoo.model.api.Entity;
import com.qcadoo.model.api.EntityOpResult;
import com.qcadoo.model.internal.api.InternalDataDefinitionService;
import com.qcadoo.plugin.api.PluginAccessor;
import com.qcadoo.plugin.api.PluginManager;
import com.qcadoo.plugin.api.PluginStateResolver;
import com.qcadoo.plugin.internal.PluginUtilsService;
import com.qcadoo.plugin.internal.stateresolver.DefaultPluginStateResolver;
import com.qcadoo.plugin.internal.stateresolver.InternalPluginStateResolver;
import com.qcadoo.tenant.api.MultiTenantUtil;
import com.qcadoo.tenant.internal.DefaultMultiTenantService;

public abstract class IntegrationTest {

    protected static final String PLUGIN_PRODUCTS_NAME = "products";

    protected static final String PLUGIN_MACHINES_NAME = "machines";

    protected static final String ENTITY_NAME_PRODUCT = "product";

    protected static final String ENTITY_NAME_PART = "part";

    protected static final String ENTITY_NAME_MACHINE = "machine";

    protected static final String ENTITY_NAME_COMPONENT = "component";

    protected static final String ENTITY_NAME_FACTORY = "factory";

    protected static final String ENTITY_NAME_DIVISION = "division";

    protected static final String ENTITY_NAME_VERSIONABLE = "versionableEntity";

    protected static final String TABLE_NAME_VERSIONABLE = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_VERSIONABLE;

    protected static final String TABLE_NAME_PRODUCT = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_PRODUCT;

    protected static final String TABLE_NAME_MACHINE = PLUGIN_MACHINES_NAME + "_" + ENTITY_NAME_MACHINE;

    protected static final String TABLE_NAME_COMPONENT = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_COMPONENT;

    protected static final String TABLE_NAME_PART = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_PART;

    protected static final String TABLE_NAME_FACTORY = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_FACTORY;

    protected static final String TABLE_NAME_DIVISION = PLUGIN_PRODUCTS_NAME + "_" + ENTITY_NAME_DIVISION;

    protected static final String TABLE_NAME_JOIN_PRODUCT_PART = "JOINTABLE_" + ENTITY_NAME_PART.toUpperCase() + "_"
            + ENTITY_NAME_PRODUCT.toUpperCase();

    protected static final String TABLE_NAME_JOIN_PRODUCT_VERSIONABLE = "JOINTABLE_" + ENTITY_NAME_PRODUCT.toUpperCase() + "_"
            + ENTITY_NAME_VERSIONABLE.toUpperCase();

    protected static InternalDataDefinitionService dataDefinitionService;

    protected static SessionFactory sessionFactory;

    protected static JdbcTemplate jdbcTemplate;

    protected static ClassPathXmlApplicationContext applicationContext;

    protected static VerifyHooks verifyHooks;

    protected PluginManager pluginManager;

    @BeforeClass
    public static void classInit() throws Exception {
        MultiTenantUtil multiTenantUtil = new MultiTenantUtil();
        ReflectionTestUtils.setField(multiTenantUtil, "multiTenantService", new DefaultMultiTenantService());
        multiTenantUtil.init();

        applicationContext = new ClassPathXmlApplicationContext();
        applicationContext.setConfigLocation("spring.xml");
        applicationContext.refresh();
        dataDefinitionService = applicationContext.getBean(InternalDataDefinitionService.class);
        sessionFactory = applicationContext.getBean("sessionFactory", SessionFactory.class);
        jdbcTemplate = applicationContext.getBean(JdbcTemplate.class);
        verifyHooks = applicationContext.getBean(VerifyHooks.class);
    }

    @Before
    public void mainInit() throws Exception {
        verifyHooks.clear();

        pluginManager = applicationContext.getBean(PluginManager.class);
        pluginManager.enablePlugin(PLUGIN_MACHINES_NAME);
        pluginManager.enablePlugin(PLUGIN_PRODUCTS_NAME);

        // We have to get a rid of mocked replacements injected into PluginUtilService, and restore the original one.
        resetPluginUtils();
    }

    private void resetPluginUtils() {
        InternalPluginStateResolver pluginStateResolver = new DefaultPluginStateResolver();
        pluginStateResolver.setPluginAccessor(applicationContext.getBean(PluginAccessor.class));
        PluginUtilsService pluginUtil = new PluginUtilsService(pluginStateResolver);
        pluginUtil.init();
    }

    @After
    public void mainDestroy() {
        jdbcTemplate.execute("delete from " + TABLE_NAME_DIVISION);
        jdbcTemplate.execute("delete from " + TABLE_NAME_FACTORY);

        jdbcTemplate.execute("delete from " + TABLE_NAME_JOIN_PRODUCT_PART);
        jdbcTemplate.execute("delete from " + TABLE_NAME_PART);
        jdbcTemplate.execute("delete from " + TABLE_NAME_COMPONENT);
        jdbcTemplate.execute("delete from " + TABLE_NAME_MACHINE);
        jdbcTemplate.execute("delete from " + TABLE_NAME_JOIN_PRODUCT_VERSIONABLE);
        jdbcTemplate.execute("delete from " + TABLE_NAME_VERSIONABLE);
        jdbcTemplate.execute("delete from " + TABLE_NAME_PRODUCT);
    }

    @AfterClass
    public static void classDestroy() {
        sessionFactory.close();
        applicationContext.close();
    }

    protected Entity createComponent(final String name, final Object product, final Object machine) {
        Entity entity = dataDefinitionService.get(PLUGIN_PRODUCTS_NAME, ENTITY_NAME_COMPONENT).create();
        entity.setField("name", name);
        entity.setField("product", product);
        entity.setField("machine", machine);
        return entity;
    }

    protected Entity createPart(final String name, final Object product) {
        Entity entity = dataDefinitionService.get(PLUGIN_PRODUCTS_NAME, ENTITY_NAME_PART).create();
        entity.setField("name", name);
        entity.setField("product", product);
        return entity;
    }

    protected Entity createPart(final String name, final Object product, final List<Entity> productsManyToMany) {
        Entity entity = createPart(name, product);
        entity.setField("products", productsManyToMany);
        return entity;
    }

    protected Entity createMachine(final String name) {
        Entity entity = dataDefinitionService.get(PLUGIN_MACHINES_NAME, ENTITY_NAME_MACHINE).create();
        entity.setField("name", name);
        return entity;
    }

    protected Entity createProduct(final String name, final String number) {
        Entity entity = dataDefinitionService.get(PLUGIN_PRODUCTS_NAME, ENTITY_NAME_PRODUCT).create();
        entity.setField("name", name);
        entity.setField("number", number);
        return entity;
    }

    protected Entity createComponentPart(final String name, final Entity component) {
        Entity part = createPart(name, null);
        part.setField("component", component);
        return part.getDataDefinition().save(part);
    }

    protected Entity createFactory(final String name) {
        Entity factory = dataDefinitionService.get(PLUGIN_PRODUCTS_NAME, ENTITY_NAME_FACTORY).create();
        factory.setField("name", name);
        return factory;
    }

    protected Entity createDivision(final String name, final Entity factory) {
        Entity division = dataDefinitionService.get(PLUGIN_PRODUCTS_NAME, ENTITY_NAME_DIVISION).create();
        division.setField("name", name);
        division.setField("factory", factory);
        return division;
    }

    protected EntityOpResult delete(final Entity entity) {
        return entity.getDataDefinition().delete(entity.getId());
    }

    protected Entity save(final Entity entity) {
        return entity.getDataDefinition().save(entity);
    }

    protected Entity fromDb(final Entity entity) {
        return entity.getDataDefinition().get(entity.getId());
    }

}