DefaultDatabaseCollectorTest.java

/*******************************************************************************
 * Copyright (c) 2010 Red Hat, Inc.
 * Distributed under license by Red Hat, Inc. All rights reserved.
 * This program is made available under the terms of the
 * Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributor:
 *     Red Hat, Inc. - initial API and implementation
 ******************************************************************************/
package org.hibernate.tool.hbm2x;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.cfg.JDBCMetaDataConfiguration;
import org.hibernate.cfg.JDBCReaderFactory;
import org.hibernate.cfg.MetaDataDialectFactory;
import org.hibernate.cfg.reveng.DatabaseCollector;
import org.hibernate.cfg.reveng.DefaultDatabaseCollector;
import org.hibernate.cfg.reveng.DefaultReverseEngineeringStrategy;
import org.hibernate.cfg.reveng.JDBCReader;
import org.hibernate.cfg.reveng.OverrideRepository;
import org.hibernate.cfg.reveng.SchemaSelection;
import org.hibernate.cfg.reveng.TableIdentifier;
import org.hibernate.cfg.reveng.dialect.MetaDataDialect;
import org.hibernate.engine.jdbc.spi.JdbcServices;
import org.hibernate.mapping.Table;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.tool.JDBCMetaDataBinderTestCase;

/**
 * @author Dmitry Geraskov
 *
 */
public class DefaultDatabaseCollectorTest extends JDBCMetaDataBinderTestCase {
	
	private static final String SCHEMA = "cat.cat";
	private static final String QSCHEMA = quote(SCHEMA);
	
	private static final String TABLE1 = "cat.child";
	private static final String QTABLE1 = quote(TABLE1);
	
	private static final String TABLE2 = "cat.master";
	private static final String QTABLE2 = quote(TABLE2);
	
	public void testReadOnlySpecificSchema() {
		
		JDBCMetaDataConfiguration configuration = new JDBCMetaDataConfiguration();
		
		OverrideRepository or = new OverrideRepository();
		or.addSchemaSelection(new SchemaSelection(null, SCHEMA));
		configuration.setReverseEngineeringStrategy(or.getReverseEngineeringStrategy(new DefaultReverseEngineeringStrategy()));
		configuration.readFromJDBC();
		
		List<Table> tables = getTables(configuration);
		
		assertEquals(2,tables.size());
		
		Table catchild = (Table) tables.get(0);
		Table catmaster = (Table) tables.get(1);
		
		if(catchild.getName().equals(TABLE2)) {
			catchild = (Table) tables.get(1);
			catmaster = (Table) tables.get(0);
		} 
			
		TableIdentifier masterid = TableIdentifier.create(catmaster);
		TableIdentifier childid = TableIdentifier.create(catchild);
		
		assertEquals(new TableIdentifier(null, SCHEMA, TABLE1), childid);
		assertEquals(new TableIdentifier(null, SCHEMA, TABLE2), masterid);
	}
	
	public void testNeedQuote() {
		ServiceRegistry serviceRegistry = cfg.getServiceRegistry();
				
		MetaDataDialect realMetaData = MetaDataDialectFactory.createMetaDataDialect( serviceRegistry.getService(JdbcServices.class).getDialect(), cfg.getProperties() );
		assertTrue("The name must be quoted!", realMetaData.needQuote(SCHEMA));
		assertTrue("The name must be quoted!", realMetaData.needQuote(TABLE1));
		assertTrue("The name must be quoted!", realMetaData.needQuote(TABLE2));
	}
	
	/**
	 * There are 2 solutions:
	 * 1. DatabaseCollector#addTable()/getTable() should be called for not quoted parameters - I think it is preferable way.
	 * 2. DatabaseCollector#addTable()/getTable() should be called for quoted parameters - here users should
	 * use the same quotes as JDBCReader.
	 * Because of this there are 2 opposite methods(and they are both failed as addTable uses quoted names
	 * but getTable uses non-quoted names )
	 */
	public void testQuotedNamesAndDefaultDatabaseCollector() {
		StandardServiceRegistryBuilder builder = new StandardServiceRegistryBuilder();
		ServiceRegistry serviceRegistry = builder.build();
				
		MetaDataDialect realMetaData = MetaDataDialectFactory.createMetaDataDialect( serviceRegistry.getService(JdbcServices.class).getDialect(), cfg.getProperties() );
		
		JDBCReader reader = JDBCReaderFactory.newJDBCReader( cfg.getProperties(), new DefaultReverseEngineeringStrategy(), realMetaData, serviceRegistry );
		
		DatabaseCollector dc = new DefaultDatabaseCollector(reader.getMetaDataDialect());
		reader.readDatabaseSchema( dc, null, SCHEMA );
		
		assertNotNull("The table should be found", dc.getTable(SCHEMA, "PUBLIC", TABLE1));
		assertNotNull("The table should be found", dc.getTable(SCHEMA, "PUBLIC", TABLE2));
		assertNull("Quoted names should not return the table", dc.getTable(quote(SCHEMA), "PUBLIC", QTABLE1));
		assertNull("Quoted names should not return the table", dc.getTable(quote(SCHEMA), "PUBLIC", QTABLE2));
		
		assertEquals("Foreign key 'masterref' was filtered!", 1, dc.getOneToManyCandidates().size());
	}
	
	private static String quote(String name) {
		return "\"" + name + "\"";
	}
	
	private List<Table> getTables(JDBCMetaDataConfiguration metaDataConfiguration) {
		List<Table> list = new ArrayList<Table>();
		Iterator<Table> iter = metaDataConfiguration.getMetadata().collectTableMappings().iterator();
		while(iter.hasNext()) {
			Table element = iter.next();
			list.add(element);
		}
		return list;
	}
	
   protected void tearDown() throws Exception {
        executeDDL(getDropSQL(), false);
    }

	protected String[] getCreateSQL() {
		return new String[] {
				"create schema " + QSCHEMA + " AUTHORIZATION dba",
				"create table "  + QSCHEMA + "." + QTABLE2 + " (" +
						" id integer NOT NULL," + 
						"  tt integer," + 
						"  CONSTRAINT master_pk PRIMARY KEY (id)" +
				")",
				"create table " + QSCHEMA + "." + QTABLE1 + " (" +
				" childid integer NOT NULL,\r\n" + 
				" masterref integer,\r\n" + 
				" CONSTRAINT child_pk PRIMARY KEY (childid),\r\n" + 
				" CONSTRAINT masterref FOREIGN KEY (masterref) references "+ QSCHEMA + "." + QTABLE2 + "(id)" +
				")",
		};
	}

	protected String[] getDropSQL() {
		
		return new String[]  {
				"drop table " + QSCHEMA + "." + QTABLE1,
				"drop table " + QSCHEMA + "." + QTABLE2,
				"drop schema " + QSCHEMA
		};
	}

}