/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 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 Lesser General Public License for more details.
*
* Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
*/

package org.pentaho.reporting.libraries.formula;

import junit.framework.TestCase;
import org.junit.Assert;
import org.pentaho.reporting.libraries.base.util.StringUtils;
import org.pentaho.reporting.libraries.formula.common.TestFormulaContext;
import org.pentaho.reporting.libraries.formula.function.FunctionDescription;

import java.util.Locale;

public abstract class FormulaTestBase extends TestCase {
  private FormulaContext context;

  protected FormulaTestBase() {
  }

  protected FormulaTestBase( final String s ) {
    super( s );
  }

  protected void setUp() throws Exception {
    context = new TestFormulaContext( TestFormulaContext.testCaseDataset );
    LibFormulaBoot.getInstance().start();
  }

  protected abstract Object[][] createDataTest();

  public FormulaContext getContext() {
    return context;
  }

  protected void runDefaultTest() throws Exception {
    final Object[][] dataTest = createDataTest();
    runTest( dataTest );
  }

  protected void runTest( final Object[][] dataTest ) throws Exception {
    for ( int i = 0; i < dataTest.length; i++ ) {
      final Object[] objects = dataTest[ i ];
      performTest( (String) objects[ 0 ], objects[ 1 ] );
    }
  }

  protected void performTest( final String formula, final Object result ) throws Exception {
    performTest( formula, result, getContext() );
  }

  @SuppressWarnings( "unchecked" )
  protected void performTest( final String formulaText,
                              final Object expected,
                              final FormulaContext context ) throws Exception {
    final Formula formula = new Formula( formulaText );
    formula.initialize( context );
    final Object formulaResult = formula.evaluateTyped().getValue();
    if ( expected instanceof Comparable && formulaResult instanceof Comparable ) {
      final Comparable<Object> resultComparable = (Comparable<Object>) formulaResult;
      final Comparable<Object> expectedComparable = (Comparable<Object>) expected;
      try {
        int compareResult = resultComparable.compareTo( expectedComparable );
        assertTrue( String.format( "For formula [%s]\n - Expected \"%s\"\n but found \"%s\"",
          formulaText, expected, formulaResult ), compareResult == 0 );
      } catch ( final ClassCastException cce ) {
        Assert.assertEquals( expectedComparable, resultComparable );
      }
    } else if ( expected instanceof Object[] && formulaResult instanceof Object[] ) {
      Object[] expectedArray = (Object[]) expected;
      Object[] resultArray = (Object[]) formulaResult;
      Assert.assertArrayEquals( expectedArray, resultArray );
    } else {
      assertEquals( "Failure on " + formula, expected, formulaResult );
    }
  }

  protected void performTranslationTest( String function ) {
    FunctionDescription functionDesc = context.getFunctionRegistry().getMetaData( function );
    assertFalse( StringUtils.isEmpty( functionDesc.getDisplayName( Locale.ENGLISH ) ) );
    assertFalse( StringUtils.isEmpty( functionDesc.getDescription( Locale.ENGLISH ) ) );
    int count = functionDesc.getParameterCount();
    for ( int x = 0; x < count; x++ ) {
      assertFalse( StringUtils.isEmpty( functionDesc.getParameterDescription( x, Locale.ENGLISH ) ) );
      assertFalse( StringUtils.isEmpty( functionDesc.getParameterDisplayName( x, Locale.ENGLISH ) ) );
    }
  }
}