[CLEANUP] - creating test for RepositoriesMeta

pentaho · Nov 12, 2015 · 39b7bc2 · 39b7bc2
1 parent ac19c4f
commit 39b7bc2
Show file tree

Hide file tree

Showing 4 changed files with 292 additions and 5 deletions.
diff --git a/engine/src/org/pentaho/di/repository/RepositoriesMeta.java b/engine/src/org/pentaho/di/repository/RepositoriesMeta.java
@@ -69,7 +69,11 @@ public void clear() {
     errorMessage = null;
     databases = new ArrayList<DatabaseMeta>();
     repositories = new ArrayList<RepositoryMeta>();
-    log = new LogChannel( "RepositoriesMeta" );
+    setLog( newLogChannel() );
+  }
+
+  LogChannel newLogChannel() {
+    return new LogChannel( "RepositoriesMeta" );
   }
 
   public void addDatabase( DatabaseMeta ci ) {
@@ -80,6 +84,10 @@ public void addRepository( RepositoryMeta ri ) {
     repositories.add( ri );
   }
 
+  void setLog( LogChannel log ) {
+    this.log = log;
+  }
+
   public void addDatabase( int p, DatabaseMeta ci ) {
     databases.add( p, ci );
   }
@@ -172,11 +180,11 @@ public boolean readData() throws KettleException {
     //
     clear();
 
-    File file = new File( Const.getKettleLocalRepositoriesFile() );
+    File file = new File( getKettleLocalRepositoriesFile() );
     if ( !file.exists() || !file.isFile() ) {
       log.logDetailed( BaseMessages.getString( PKG, "RepositoryMeta.Log.NoRepositoryFileInLocalDirectory", file
         .getAbsolutePath() ) );
-      file = new File( Const.getKettleUserRepositoriesFile() );
+      file = new File( getKettleUserRepositoriesFile() );
       if ( !file.exists() || !file.isFile() ) {
         return true; // nothing to read!
       }
@@ -212,6 +220,14 @@ public boolean readData() throws KettleException {
     return true;
   }
 
+  String getKettleUserRepositoriesFile() {
+    return Const.getKettleUserRepositoriesFile();
+  }
+
+  String getKettleLocalRepositoriesFile() {
+    return Const.getKettleLocalRepositoriesFile();
+  }
+
   public void readDataFromInputStream( InputStream is ) throws KettleException {
     // Clear the information
     //
@@ -308,7 +324,7 @@ protected void parseRepositoriesDoc( Document doc ) throws Exception {
     if ( unableToReadIds != null && unableToReadIds.length() > 0 ) {
       errorMessage =
         BaseMessages.getString( PKG, "RepositoryMeta.Error.ReadRepositoryIdNotAvailable", unableToReadIds
-          .substring( 0, unableToReadIds.lastIndexOf( "," ) - 1 ) );
+          .substring( 0, unableToReadIds.lastIndexOf( "," ) ) );
     }
     if ( kettleException != null ) {
       throw kettleException;
@@ -337,7 +353,7 @@ public String getXML() {
 
   public void writeData() throws KettleException {
     try {
-      FileOutputStream fos = new FileOutputStream( new File( Const.getKettleUserRepositoriesFile() ) );
+      FileOutputStream fos = new FileOutputStream( new File( getKettleUserRepositoriesFile() ) );
       fos.write( getXML().getBytes() );
       fos.close();
     } catch ( Exception e ) {

diff --git a/engine/test-src/org/pentaho/di/repository/RepositoriesMetaTest.java b/engine/test-src/org/pentaho/di/repository/RepositoriesMetaTest.java
@@ -0,0 +1,230 @@
+/*! ******************************************************************************
+ *
+ * Pentaho Data Integration
+ *
+ * Copyright (C) 2002-2013 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.repository;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.pentaho.di.core.KettleEnvironment;
+import org.pentaho.di.core.database.DatabaseMeta;
+import org.pentaho.di.core.exception.KettleException;
+import org.pentaho.di.core.logging.LogChannel;
+
+import java.io.File;
+import java.io.InputStream;
+
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class RepositoriesMetaTest {
+  @BeforeClass
+  public static void setUpClass() throws Exception {
+    if ( !KettleEnvironment.isInitialized() ) {
+      KettleEnvironment.init();
+    }
+  }
+
+  @Test
+  public void testToString() throws Exception {
+    RepositoriesMeta repositoriesMeta = new RepositoriesMeta();
+    assertEquals( "RepositoriesMeta", repositoriesMeta.toString() );
+  }
+
+  @Test
+  public void testReadData() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.getKettleUserRepositoriesFile() ).thenReturn( getClass().getResource( "repositories.xml" ).getPath() );
+    when( spy.newLogChannel() ).thenReturn( log );
+    spy.readData();
+
+    String repositoriesXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      + "<repositories>\n"
+      + "  <connection>\n"
+      + "    <name>local postgres</name>\n"
+      + "    <server>localhost</server>\n"
+      + "    <type>POSTGRESQL</type>\n"
+      + "    <access>Native</access>\n"
+      + "    <database>hibernate</database>\n"
+      + "    <port>5432</port>\n"
+      + "    <username>auser</username>\n"
+      + "    <password>Encrypted 2be98afc86aa7f285bb18bd63c99dbdde</password>\n"
+      + "    <servername/>\n"
+      + "    <data_tablespace/>\n"
+      + "    <index_tablespace/>\n"
+      + "    <attributes>\n"
+      + "      <attribute><code>FORCE_IDENTIFIERS_TO_LOWERCASE</code><attribute>N</attribute></attribute>\n"
+      + "      <attribute><code>FORCE_IDENTIFIERS_TO_UPPERCASE</code><attribute>N</attribute></attribute>\n"
+      + "      <attribute><code>IS_CLUSTERED</code><attribute>N</attribute></attribute>\n"
+      + "      <attribute><code>PORT_NUMBER</code><attribute>5432</attribute></attribute>\n"
+      + "      <attribute><code>PRESERVE_RESERVED_WORD_CASE</code><attribute>N</attribute></attribute>\n"
+      + "      <attribute><code>QUOTE_ALL_FIELDS</code><attribute>N</attribute></attribute>\n"
+      + "      <attribute><code>SUPPORTS_BOOLEAN_DATA_TYPE</code><attribute>Y</attribute></attribute>\n"
+      + "      <attribute><code>SUPPORTS_TIMESTAMP_DATA_TYPE</code><attribute>Y</attribute></attribute>\n"
+      + "      <attribute><code>USE_POOLING</code><attribute>N</attribute></attribute>\n"
+      + "    </attributes>\n"
+      + "  </connection>\n"
+      + "  <repository>    <id>KettleFileRepository</id>\n"
+      + "    <name>Test Repository</name>\n"
+      + "    <description>Test Repository Description</description>\n"
+      + "    <base_directory>test-repository</base_directory>\n"
+      + "    <read_only>N</read_only>\n"
+      + "    <hides_hidden_files>N</hides_hidden_files>\n"
+      + "  </repository>  </repositories>\n";
+    assertEquals( repositoriesXml, spy.getXML() );
+    RepositoriesMeta clone = spy.clone();
+    assertEquals( repositoriesXml, spy.getXML() );
+    assertNotSame( clone, spy );
+
+    assertEquals( 1, spy.nrRepositories() );
+    RepositoryMeta repository = spy.getRepository( 0 );
+    assertEquals( "Test Repository", repository.getName() );
+    assertEquals( "Test Repository Description", repository.getDescription() );
+    assertEquals( "  <repository>    <id>KettleFileRepository</id>\n"
+      + "    <name>Test Repository</name>\n"
+      + "    <description>Test Repository Description</description>\n"
+      + "    <base_directory>test-repository</base_directory>\n"
+      + "    <read_only>N</read_only>\n"
+      + "    <hides_hidden_files>N</hides_hidden_files>\n"
+      + "  </repository>", repository.getXML() );
+    assertSame( repository, spy.searchRepository( "Test Repository" ) );
+    assertSame( repository, spy.findRepositoryById( "KettleFileRepository" ) );
+    assertSame( repository, spy.findRepository( "Test Repository" ) );
+    assertNull( spy.findRepository( "not found" ) );
+    assertNull( spy.findRepositoryById( "not found" ) );
+    assertEquals( 0, spy.indexOfRepository( repository ) );
+    spy.removeRepository( 0 );
+    assertEquals( 0, spy.nrRepositories() );
+    assertNull( spy.searchRepository( "Test Repository" ) );
+    spy.addRepository( 0, repository );
+    assertEquals( 1, spy.nrRepositories() );
+    spy.removeRepository( 1 );
+    assertEquals( 1, spy.nrRepositories() );
+
+
+    assertEquals( 1, spy.nrDatabases() );
+    assertEquals( "local postgres", spy.getDatabase( 0 ).getName() );
+    DatabaseMeta searchDatabase = spy.searchDatabase( "local postgres" );
+    assertSame( searchDatabase, spy.getDatabase( 0 ) );
+    assertEquals( 0, spy.indexOfDatabase( searchDatabase ) );
+    spy.removeDatabase( 0 );
+    assertEquals( 0, spy.nrDatabases() );
+    assertNull( spy.searchDatabase( "local postgres" ) );
+    spy.addDatabase( 0, searchDatabase );
+    assertEquals( 1, spy.nrDatabases() );
+    spy.removeDatabase( 1 );
+    assertEquals( 1, spy.nrDatabases() );
+
+    assertEquals( "Unable to read repository with id [junk]. RepositoryMeta is not available.", spy.getErrorMessage() );
+  }
+
+  @Test
+  public void testNothingToRead() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.getKettleUserRepositoriesFile() ).thenReturn( "filedoesnotexist.xml" );
+    when( spy.newLogChannel() ).thenReturn( log );
+    assertTrue( spy.readData() );
+    assertEquals( 0, spy.nrDatabases() );
+    assertEquals( 0, spy.nrRepositories() );
+  }
+
+  @Test
+  public void testReadDataFromInputStream() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.newLogChannel() ).thenReturn( log );
+    InputStream inputStream = getClass().getResourceAsStream( "repositories.xml" );
+    spy.readDataFromInputStream( inputStream );
+    assertEquals( 1, spy.nrDatabases() );
+    assertEquals( 1, spy.nrRepositories() );
+  }
+
+  @Test
+  public void testErrorReadingInputStream() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.newLogChannel() ).thenReturn( log );
+    try {
+      spy.readDataFromInputStream(  getClass().getResourceAsStream( "filedoesnotexist.xml" ) );
+    } catch ( KettleException e ) {
+      assertEquals( "\n"
+        + "Error reading information from file:\n"
+        + "InputStream cannot be null\n", e.getMessage() );
+    }
+  }
+
+  @Test
+  public void testErrorReadingFile() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.newLogChannel() ).thenReturn( log );
+    when( spy.getKettleUserRepositoriesFile() ).thenReturn( getClass().getResource( "bad-repositories.xml" ).getPath() );
+    try {
+      spy.readData();
+    } catch ( KettleException e ) {
+      assertEquals( "\n"
+        + "Error reading information from file:\n"
+        + "The element type \"repositories\" must be terminated by the matching end-tag \"</repositories>\".\n",
+        e.getMessage() );
+    }
+  }
+
+  @Test
+  public void testWriteFile() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.newLogChannel() ).thenReturn( log );
+    String path = getClass().getResource( "repositories.xml" ).getPath().replace( "repositories.xml", "new-repositories.xml" );
+    when( spy.getKettleUserRepositoriesFile() ).thenReturn( path );
+    spy.writeData();
+    InputStream resourceAsStream = getClass().getResourceAsStream( "new-repositories.xml" );
+    assertEquals(
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+        + "<repositories>\n"
+        + "  </repositories>\n", IOUtils.toString( resourceAsStream ) );
+    new File( path ).delete();
+  }
+
+  @Test
+  public void testErrorWritingFile() throws Exception {
+    RepositoriesMeta meta = new RepositoriesMeta();
+    RepositoriesMeta spy = Mockito.spy( meta );
+    LogChannel log = mock( LogChannel.class );
+    when( spy.newLogChannel() ).thenReturn( log );
+    when( spy.getKettleUserRepositoriesFile() ).thenReturn( null );
+    try {
+      spy.writeData();
+    } catch ( KettleException e ) {
+      assertTrue( e.getMessage().startsWith( "\nError writing repositories metadata" ) );
+    }
+  }
+}
diff --git a/engine/test-src/org/pentaho/di/repository/bad-repositories.xml b/engine/test-src/org/pentaho/di/repository/bad-repositories.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<repositories>
+</badrepositories>
diff --git a/engine/test-src/org/pentaho/di/repository/repositories.xml b/engine/test-src/org/pentaho/di/repository/repositories.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<repositories>
+  <connection>
+    <name>local postgres</name>
+    <server>localhost</server>
+    <type>POSTGRESQL</type>
+    <access>Native</access>
+    <database>hibernate</database>
+    <port>5432</port>
+    <username>auser</username>
+    <password>apassword</password>
+    <servername/>
+    <data_tablespace/>
+    <index_tablespace/>
+    <attributes>
+      <attribute><code>FORCE_IDENTIFIERS_TO_LOWERCASE</code><attribute>N</attribute></attribute>
+      <attribute><code>FORCE_IDENTIFIERS_TO_UPPERCASE</code><attribute>N</attribute></attribute>
+      <attribute><code>IS_CLUSTERED</code><attribute>N</attribute></attribute>
+      <attribute><code>PORT_NUMBER</code><attribute>5432</attribute></attribute>
+      <attribute><code>PRESERVE_RESERVED_WORD_CASE</code><attribute>N</attribute></attribute>
+      <attribute><code>QUOTE_ALL_FIELDS</code><attribute>N</attribute></attribute>
+      <attribute><code>SUPPORTS_BOOLEAN_DATA_TYPE</code><attribute>Y</attribute></attribute>
+      <attribute><code>SUPPORTS_TIMESTAMP_DATA_TYPE</code><attribute>Y</attribute></attribute>
+      <attribute><code>USE_POOLING</code><attribute>N</attribute></attribute>
+    </attributes>
+  </connection>
+  <repository>
+    <id>KettleFileRepository</id>
+    <name>Test Repository</name>
+    <description>Test Repository Description</description>
+    <base_directory>test-repository</base_directory>
+    <read_only>N</read_only>
+    <hides_hidden_files>N</hides_hidden_files>
+  </repository>
+  <repository>
+    <id>junk</id>
+  </repository>
+</repositories>