SubActionComponentTest.java

/*
 * 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 2005 - 2009 Pentaho Corporation.  All rights reserved.
 *
*/
package org.pentaho.test.platform.plugin;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

//import org.pentaho.commons.connection.IPentahoConnection;
//import org.pentaho.commons.connection.IPentahoResultSet;
//import org.pentaho.platform.api.data.IPreparedComponent;
import org.pentaho.platform.api.engine.IActionParameter;
import org.pentaho.platform.api.engine.IRuntimeContext;
import org.pentaho.platform.engine.core.solution.SimpleParameterProvider;
import org.pentaho.platform.plugin.services.messages.Messages;
import org.pentaho.test.platform.engine.core.BaseTest;

@SuppressWarnings("nls")
public class SubActionComponentTest extends BaseTest {

  private static final String CO_TEST_NAME = "MultipleComponentTest_ContentOutput_"; //$NON-NLS-1$

  private static final String CO_TEST_EXTN = ".txt"; //$NON-NLS-1$

  private ByteArrayOutputStream lastStream;

  private static final String SOLUTION_NAME = "test"; //$NON-NLS-1$

  private static final String TEST_XACTION = "SubActionTest.xaction"; //$NON-NLS-1$

  private static final String SUBACTION = "SubActionTestTarget.xaction"; //$NON-NLS-1$

  private static final String SOLUTION_NAME_PARAM = "solution"; //$NON-NLS-1$

  private static final String SOLUTION_PATH_PARAM = "path"; //$NON-NLS-1$

  private static final String SUBACTION_PARAM = "subaction"; //$NON-NLS-1$

  private static final String TEST_STRING = "Hello World"; //$NON-NLS-1$

  private static final String TEST_OUTPUT_PARAM = "outputString"; //$NON-NLS-1$

  private static final String TEST_INPUT_PARAM = "inputString"; //$NON-NLS-1$

  private static final String SOLUTION_PATH = "test-src/solution";

  public String getSolutionPath() {
    return SOLUTION_PATH;
  }

  public void testSuccessPaths() {
    startTest();
    String testName = CO_TEST_NAME + "string_" + System.currentTimeMillis(); //$NON-NLS-1$
    SimpleParameterProvider parameterProvider = new SimpleParameterProvider();
    parameterProvider.setParameter(SOLUTION_NAME_PARAM, SOLUTION_NAME);
    parameterProvider.setParameter(SOLUTION_PATH_PARAM, "platform");
    parameterProvider.setParameter(SUBACTION_PARAM, SUBACTION);
    parameterProvider.setParameter(TEST_INPUT_PARAM, TEST_STRING);

    IRuntimeContext context = run(SOLUTION_NAME, "platform", TEST_XACTION, parameterProvider, testName, CO_TEST_EXTN);
    assertEquals(
        Messages.getInstance().getString("BaseTest.USER_RUNNING_ACTION_SEQUENCE"), IRuntimeContext.RUNTIME_STATUS_SUCCESS, context.getStatus()); //$NON-NLS-1$

    IActionParameter rtn = context.getOutputParameter(TEST_OUTPUT_PARAM);
    Object value = rtn.getValue();
    assertEquals(TEST_STRING, value);

    finishTest();
  }

  /**
   * parent action creates a connection, used by sub-action parent 
   * then re-uses connection
   */
  /*public void testParentConnectionSharing() {

    startTest();
    info("Expected: Successful execution with object available"); //$NON-NLS-1$
    IRuntimeContext context = run("test", "platform", "SubActionConnectionTest4.xaction"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    assertEquals(
        Messages.getInstance().getString("BaseTest.USER_RUNNING_ACTION_SEQUENCE"), IRuntimeContext.RUNTIME_STATUS_SUCCESS, context.getStatus()); //$NON-NLS-1$

    IActionParameter rtn = context.getOutputParameter("query-results");//$NON-NLS-1$
    assertNotNull(rtn);
    IPentahoResultSet resultSet = (IPentahoResultSet) rtn.getValue();
    assertNotNull(resultSet);

    try {
      assertEquals(5, resultSet.getRowCount());
    } catch (Exception e) {
      e.printStackTrace();
      fail();
    }

    finishTest();
  }*/

  /**
   * sub-action creates connection, passes result set on to parent action
   *
   */
  /*public void testChildResultSetSharing() {

    startTest();
    info("Expected: Successful execution with object available"); //$NON-NLS-1$
    IRuntimeContext context = run("test", "platform", "SubActionConnectionTest3.xaction"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    assertEquals(
        Messages.getInstance().getString("BaseTest.USER_RUNNING_ACTION_SEQUENCE"), IRuntimeContext.RUNTIME_STATUS_SUCCESS, context.getStatus()); //$NON-NLS-1$

    IActionParameter rtn = context.getOutputParameter("query-results");//$NON-NLS-1$
    assertNotNull(rtn);
    IPentahoResultSet resultSet = (IPentahoResultSet) rtn.getValue();
    assertNotNull(resultSet);

    try {
      // if row count is zero, that means the native connection has been closed.
      assertEquals(5, resultSet.getRowCount());
    } catch (Exception e) {
      e.printStackTrace();
      fail();
    }

    finishTest();
  }*/

  /**
   * sub-action creates result set, uses, and passes nothing to parent action
   */
  public void testChildConnectionNotSharing() {
    startTest();
    info("Expected: Failed execution with object not available"); //$NON-NLS-1$
    IRuntimeContext context = run("test", "platform", "SubActionConnectionTest2.xaction"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$

    // xaction should fail, because connection isn't available
    assertEquals(
        Messages.getInstance().getString("BaseTest.USER_RUNNING_ACTION_SEQUENCE"), IRuntimeContext.RUNTIME_STATUS_FAILURE, context.getStatus()); //$NON-NLS-1$

    finishTest();
  }

  /**
   * sub-action creates connection, passes connection on to the parent action
   */
  /*public void testChildConnectionSharing() {
    startTest();
    info("Expected: Successful execution with object available"); //$NON-NLS-1$
    IRuntimeContext context = run("test", "platform", "SubActionConnectionTest1.xaction"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    assertEquals(
        Messages.getInstance().getString("BaseTest.USER_RUNNING_ACTION_SEQUENCE"), IRuntimeContext.RUNTIME_STATUS_SUCCESS, context.getStatus()); //$NON-NLS-1$

    IActionParameter rtn = context.getOutputParameter("prepared_component");//$NON-NLS-1$
    assertNotNull(rtn);
    IPreparedComponent preparedComponent = (IPreparedComponent) rtn.getValue();

    // connection in this case should be available
    IPentahoConnection conn = preparedComponent.shareConnection();
    assertNotNull(conn);
    try {
      IPentahoResultSet results = conn
          .executeQuery("SELECT BUDGET FROM QUADRANT_ACTUALS WHERE REGION='Western' AND DEPARTMENT='Sales'"); //$NON-NLS-1$
      assertEquals(5, results.getRowCount());
    } catch (Exception e) {
      e.printStackTrace();
      fail();
    }

    finishTest();
  }*/

  protected OutputStream getOutputStream(String testName, String extension) {
    if (testName.indexOf("BAD_OUTPUTSTREAM_") > 0) { //$NON-NLS-1$ 
      ByteArrayOutputStream exceptionStream = new ByteArrayOutputStream() {
        public static final String ERROR_MSG = "Cannot write to this stream."; //$NON-NLS-1$

        public synchronized void write(int b) {
          throw new RuntimeException(ERROR_MSG);
        }

        public synchronized void write(byte b[], int off, int len) {
          throw new RuntimeException(ERROR_MSG);
        }
      };
      return exceptionStream;

    } else {
      lastStream = new ByteArrayOutputStream();
      return lastStream;
    }
  }

  protected InputStream getInputStreamFromOutput(String testName, String extension) {
    return new ByteArrayInputStream(lastStream.toByteArray());
  }

  public static void main(String[] args) {
    SubActionComponentTest test = new SubActionComponentTest();
    try {
      test.setUp();
      test.testSuccessPaths();
    } finally {
      test.tearDown();
      BaseTest.shutdown();
    }
  }
}