[TEST] LoadSaveTest for ExcelWriter

engine/src/org/pentaho/di/trans/steps/excelwriter/ExcelWriterStepField.java

@@ -59,12 +59,17 @@ public int compare( Object obj ) {
     return name.compareTo( field.getName() );
   }
 
-  public boolean equal( Object obj ) {
+  public boolean equals( Object obj ) {
     ExcelWriterStepField field = (ExcelWriterStepField) obj;
 
     return name.equals( field.getName() );
   }
 
+  @Deprecated
+  public boolean equal( Object obj ) {
+    return equals( obj );
+  }
+
   public Object clone() {
     try {
       Object retval = super.clone();

engine/test-src/org/pentaho/di/trans/steps/excelwriter/ExcelWriterStepMetaTest.java

@@ -0,0 +1,176 @@
+/*! ******************************************************************************
+ *
+ * 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.trans.steps.excelwriter;
+
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Random;
+import java.util.UUID;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.pentaho.di.core.KettleEnvironment;
+import org.pentaho.di.core.exception.KettleException;
+import org.pentaho.di.trans.steps.loadsave.LoadSaveTester;
+import org.pentaho.di.trans.steps.loadsave.validator.ArrayLoadSaveValidator;
+import org.pentaho.di.trans.steps.loadsave.validator.FieldLoadSaveValidator;
+
+public class ExcelWriterStepMetaTest {
+
+  @BeforeClass
+  public static void setUpBeforeClass() throws KettleException {
+    KettleEnvironment.init();
+  }
+
+  @Test
+  public void testRoundTrip() throws KettleException {
+    List<String> attributes = Arrays.asList(
+      "header", "footer", "makeSheetActive", "rowWritingMethod", "startingCell", "appendOmitHeader", "appendOffset",
+      "appendEmpty", "rowWritingMethod", "forceFormulaRecalculation", "leaveExistingStylesUnchanged",
+      "appendLines", "add_to_result_filenames", "name", "extention", "do_not_open_newfile_init", "split", "add_date",
+      "add_time", "SpecifyFormat", "date_time_format", "sheetname", "autosizecolums", "stream_data", "protect_sheet",
+      "password", "protected_by", "splitevery", "if_file_exists", "if_sheet_exists", "enabled", "sheet_enabled",
+      "filename", "sheetname", "outputfields" );
+
+    Map<String, String> getterMap = new HashMap<String, String>();
+    getterMap.put( "header", "isHeaderEnabled" );
+    getterMap.put( "footer", "isFooterEnabled" );
+    getterMap.put( "makeSheetActive", "isMakeSheetActive" );
+    getterMap.put( "rowWritingMethod", "getRowWritingMethod" );
+    getterMap.put( "startingCell", "getStartingCell" );
+    getterMap.put( "appendOmitHeader", "isAppendOmitHeader" );
+    getterMap.put( "appendOffset", "getAppendOffset" );
+    getterMap.put( "appendEmpty", "getAppendEmpty" );
+    getterMap.put( "rowWritingMethod", "getRowWritingMethod" );
+    getterMap.put( "forceFormulaRecalculation", "isForceFormulaRecalculation" );
+    getterMap.put( "leaveExistingStylesUnchanged", "isLeaveExistingStylesUnchanged" );
+    getterMap.put( "appendLines", "isAppendLines" );
+    getterMap.put( "add_to_result_filenames", "isAddToResultFiles" );
+    getterMap.put( "name", "getFileName" );
+    getterMap.put( "extention", "getExtension" );
+    getterMap.put( "do_not_open_newfile_init", "isDoNotOpenNewFileInit" );
+    getterMap.put( "split", "getSplitEvery" );
+    getterMap.put( "add_date", "isDateInFilename" );
+    getterMap.put( "add_time", "isTimeInFilename" );
+    getterMap.put( "SpecifyFormat", "isSpecifyFormat" );
+    getterMap.put( "date_time_format", "getDateTimeFormat" );
+    getterMap.put( "sheetname", "getSheetname" );
+    getterMap.put( "autosizecolums", "isAutoSizeColums" );
+    getterMap.put( "stream_data", "isStreamingData" );
+    getterMap.put( "protect_sheet", "isSheetProtected" );
+    getterMap.put( "password", "getPassword" );
+    getterMap.put( "protected_by", "getProtectedBy" );
+    getterMap.put( "splitevery", "getSplitEvery" );
+    getterMap.put( "if_file_exists", "getIfFileExists" );
+    getterMap.put( "if_sheet_exists", "getIfSheetExists" );
+    getterMap.put( "enabled", "isTemplateEnabled" );
+    getterMap.put( "sheet_enabled", "isTemplateSheetEnabled" );
+    getterMap.put( "filename", "getTemplateFileName" );
+    getterMap.put( "sheetname", "getTemplateSheetName" );
+    getterMap.put( "outputfields", "getOutputFields" );
+
+    Map<String, String> setterMap = new HashMap<String, String>();
+    setterMap.put( "header", "setHeaderEnabled" );
+    setterMap.put( "footer", "setFooterEnabled" );
+    setterMap.put( "makeSheetActive", "setMakeSheetActive" );
+    setterMap.put( "rowWritingMethod", "setRowWritingMethod" );
+    setterMap.put( "startingCell", "setStartingCell" );
+    setterMap.put( "appendOmitHeader", "setAppendOmitHeader" );
+    setterMap.put( "appendOffset", "setAppendOffset" );
+    setterMap.put( "appendEmpty", "setAppendEmpty" );
+    setterMap.put( "rowWritingMethod", "setRowWritingMethod" );
+    setterMap.put( "forceFormulaRecalculation", "setForceFormulaRecalculation" );
+    setterMap.put( "leaveExistingStylesUnchanged", "setLeaveExistingStylesUnchanged" );
+    setterMap.put( "appendLines", "setAppendLines" );
+    setterMap.put( "add_to_result_filenames", "setAddToResultFiles" );
+    setterMap.put( "name", "setFileName" );
+    setterMap.put( "extention", "setExtension" );
+    setterMap.put( "do_not_open_newfile_init", "setDoNotOpenNewFileInit" );
+    setterMap.put( "split", "setSplitEvery" );
+    setterMap.put( "add_date", "setDateInFilename" );
+    setterMap.put( "add_time", "setTimeInFilename" );
+    setterMap.put( "SpecifyFormat", "setSpecifyFormat" );
+    setterMap.put( "date_time_format", "setDateTimeFormat" );
+    setterMap.put( "sheetname", "setSheetname" );
+    setterMap.put( "autosizecolums", "setAutoSizeColums" );
+    setterMap.put( "stream_data", "setStreamingData" );
+    setterMap.put( "protect_sheet", "setProtectSheet" );
+    setterMap.put( "password", "setPassword" );
+    setterMap.put( "protected_by", "setProtectedBy" );
+    setterMap.put( "splitevery", "setSplitEvery" );
+    setterMap.put( "if_file_exists", "setIfFileExists" );
+    setterMap.put( "if_sheet_exists", "setIfSheetExists" );
+    setterMap.put( "enabled", "setTemplateEnabled" );
+    setterMap.put( "sheet_enabled", "setTemplateSheetEnabled" );
+    setterMap.put( "filename", "setTemplateFileName" );
+    setterMap.put( "sheetname", "setTemplateSheetName" );
+    setterMap.put( "outputfields", "setOutputFields" );
+
+    Map<String, FieldLoadSaveValidator<?>> fieldLoadSaveValidatorTypeMap =
+      new HashMap<String, FieldLoadSaveValidator<?>>();
+
+    fieldLoadSaveValidatorTypeMap.put( ExcelWriterStepField[].class.getCanonicalName(),
+      new ArrayLoadSaveValidator<ExcelWriterStepField>( new ExcelWriterStepFieldLoadSaveValidator() ) );
+
+    LoadSaveTester loadSaveTester = new LoadSaveTester( ExcelWriterStepMeta.class, attributes, getterMap, setterMap,
+      new HashMap<String, FieldLoadSaveValidator<?>>(), fieldLoadSaveValidatorTypeMap );
+    loadSaveTester.testRepoRoundTrip();
+    loadSaveTester.testXmlRoundTrip();
+  }
+
+  public class ExcelWriterStepFieldLoadSaveValidator implements FieldLoadSaveValidator<ExcelWriterStepField> {
+    @Override
+    public boolean validateTestObject( ExcelWriterStepField testObject, Object actual ) {
+      //Perform more-extensive test, as equals() method does check on "name" only
+      ExcelWriterStepField obj2 = (ExcelWriterStepField) actual;
+      return testObject.equals( ( obj2 ) )
+        && testObject.getType() == obj2.getType()
+        && testObject.getFormat().equals( obj2.getFormat() )
+        && testObject.getTitle().equals( obj2.getTitle() )
+        && testObject.getTitleStyleCell().equals( obj2.getTitleStyleCell() )
+        && testObject.getStyleCell().equals(  obj2.getStyleCell() )
+        && testObject.getCommentField().equals(  obj2.getCommentField() )
+        && testObject.getCommentAuthorField().equals( obj2.getCommentAuthorField() )
+        && testObject.isFormula() == obj2.isFormula()
+        && testObject.getHyperlinkField().equals(  obj2.getHyperlinkField() );
+    }
+
+    @Override
+    public ExcelWriterStepField getTestObject() {
+      ExcelWriterStepField obj = new ExcelWriterStepField();
+      obj.setName( UUID.randomUUID().toString() );
+      obj.setType( UUID.randomUUID().toString() );
+      obj.setFormat( UUID.randomUUID().toString() );
+      obj.setTitle( UUID.randomUUID().toString() );
+      obj.setTitleStyleCell( UUID.randomUUID().toString() );
+      obj.setStyleCell( UUID.randomUUID().toString() );
+      obj.setCommentField( UUID.randomUUID().toString() );
+      obj.setCommentAuthorField( UUID.randomUUID().toString() );
+      obj.setFormula( new Random().nextBoolean() );
+      obj.setHyperlinkField( UUID.randomUUID().toString() );
+      return obj;
+    }
+  }
+}