PrivateDatabasesTestTemplate.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2015 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.base;

import org.junit.matchers.JUnitMatchers;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.pentaho.di.core.database.DatabaseMeta;
import org.pentaho.di.shared.SharedObjectInterface;
import org.pentaho.di.shared.SharedObjects;

import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.junit.Assert.*;

/**
 * @author Andrey Khayrutdinov
 */
public abstract class PrivateDatabasesTestTemplate<T extends AbstractMeta> {

  protected void doTest_OnePrivate_TwoShared() throws Exception {
    T meta = createMeta();
    DatabaseMeta privateMeta = createDatabase( "privateMeta" );
    meta.addDatabase( privateMeta );

    String xml = toXml( meta );

    DatabaseMeta meta1 = createDatabase( "meta1" );
    meta1.setShared( true );
    DatabaseMeta meta2 = createDatabase( "meta2" );
    meta2.setShared( true );

    SharedObjects fakeSharedObjects = createFakeSharedObjects( meta1, meta2 );

    T loaded = fromXml( xml, fakeSharedObjects );

    List<String> loadedDbs = Arrays.asList( loaded.getDatabaseNames() );
    assertEquals( 3, loadedDbs.size() );
    assertThat( loadedDbs, JUnitMatchers.hasItems( "meta1", "meta2", "privateMeta" ) );

    Set<String> privateDatabases = loaded.getPrivateDatabases();
    assertNotNull( privateDatabases );
    assertEquals( 1, privateDatabases.size() );
    assertTrue( privateDatabases.contains( "privateMeta" ) );
  }

  protected void doTest_NoPrivate() throws Exception {
    T meta = createMeta();
    String xml = toXml( meta );

    SharedObjects fakeSharedObjects = createFakeSharedObjects();
    T loaded = fromXml( xml, fakeSharedObjects );

    Set<String> privateDatabases = loaded.getPrivateDatabases();
    assertNotNull( privateDatabases );
    assertTrue( privateDatabases.isEmpty() );
  }

  protected void doTest_OnePrivate_NoShared() throws Exception {
    T meta = createMeta();
    DatabaseMeta privateMeta = createDatabase( "privateMeta" );
    meta.addDatabase( privateMeta );

    String xml = toXml( meta );

    SharedObjects fakeSharedObjects = createFakeSharedObjects();
    T loaded = fromXml( xml, fakeSharedObjects );

    List<String> loadedDbs = Arrays.asList( loaded.getDatabaseNames() );
    assertTrue( loadedDbs.contains( "privateMeta" ) );

    Set<String> privateDatabases = loaded.getPrivateDatabases();
    assertNotNull( privateDatabases );
    assertEquals( 1, privateDatabases.size() );
    assertTrue( privateDatabases.contains( privateMeta.getName() ) );
  }


  protected DatabaseMeta createDatabase( String name ) {
    DatabaseMeta db = new DatabaseMeta();
    db.setName( name );
    db.getDatabaseInterface().setDatabaseName( name );
    return db;
  }

  @SuppressWarnings( "unchecked" )
  protected SharedObjects createFakeSharedObjects( DatabaseMeta... shared ) throws Exception {
    SharedObjects fake = new SharedObjects();
    Map map = fake.getObjectsMap();
    map.clear();

    if ( shared != null ) {
      // hacky solution
      for ( DatabaseMeta meta : shared ) {
        map.put( new Object(), meta );
      }
    }

    return fake;
  }

  protected Answer<SharedObjects> createInjectingAnswer( final T meta, final SharedObjects fakeSharedObjects )
    throws Exception {
    return new Answer<SharedObjects>() {
      @Override
      public SharedObjects answer( InvocationOnMock invocation ) throws Throwable {
        for ( SharedObjectInterface value : fakeSharedObjects.getObjectsMap().values() ) {
          DatabaseMeta db = (DatabaseMeta) value;
          meta.addOrReplaceDatabase( db );
        }

        return fakeSharedObjects;
      }
    };
  }


  protected abstract T createMeta();

  protected abstract T fromXml( String xml, SharedObjects fakeSharedObjects ) throws Exception;

  protected abstract String toXml( T meta ) throws Exception;
}