XActionUtilTest.java example

Explorer
pentaho-platform-master
/*!
 * 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-2016 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.platform.web.http.api.resources;

import static org.mockito.Mockito.*;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import java.util.Arrays;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.core.MediaType;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentMatcher;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.pentaho.platform.api.engine.IActionCompleteListener;
import org.pentaho.platform.api.engine.IMessageFormatter;
import org.pentaho.platform.api.engine.IMimeTypeListener;
import org.pentaho.platform.api.engine.IOutputHandler;
import org.pentaho.platform.api.engine.IPentahoObjectFactory;
import org.pentaho.platform.api.engine.IPentahoSession;
import org.pentaho.platform.api.engine.IPentahoUrlFactory;
import org.pentaho.platform.api.engine.IRuntimeContext;
import org.pentaho.platform.api.engine.ISolutionEngine;
import org.pentaho.platform.api.engine.ISystemSettings;
import org.pentaho.platform.api.engine.ObjectFactoryException;
import org.pentaho.platform.api.repository2.unified.IUnifiedRepository;
import org.pentaho.platform.api.repository2.unified.RepositoryFile;
import org.pentaho.platform.engine.core.output.SimpleContentItem;
import org.pentaho.platform.engine.core.system.PentahoSessionHolder;
import org.pentaho.platform.engine.core.system.PentahoSystem;
import org.pentaho.platform.repository2.unified.fileio.RepositoryFileContentItem;
import org.pentaho.platform.api.repository.IContentItem;

/**
 * check that executing delete file from repository
 *
 */
public class XActionUtilTest {

  @Mock  private RepositoryFile xactionFile;

  @Mock  private RepositoryFile generatedFile;

  @Mock  private HttpServletRequest httpServletRequest;

  @Mock  private HttpServletResponse httpServletResponse;

  @Mock  private IPentahoSession userSession;

  @Mock  private IMimeTypeListener mimeTypeListener;

  @Mock  private IUnifiedRepository repository;

  @Mock private ISolutionEngine engine;

  @Mock private IMessageFormatter formatter;

  private IPentahoObjectFactory pentahoObjectFactoryUnified;

  @Before
  @SuppressWarnings( "unchecked" )
  public void setUp() throws ObjectFactoryException {
    MockitoAnnotations.initMocks( this );
    Map<String, String[]> map = mock( Map.class );
    when( httpServletRequest.getParameterMap() ).thenReturn( map );
    when( httpServletRequest.getParameter( anyString() ) ).thenReturn( null );

    when( repository.getFile( anyString() ) ).thenReturn( generatedFile );

    List<IContentItem> items = Arrays.asList( mock( RepositoryFileContentItem.class ) );
    IRuntimeContext context = mock( IRuntimeContext.class );
    when( context.getOutputContentItems() ).thenReturn( items );

    when( engine.execute( anyString(), anyString(), anyBoolean(), anyBoolean(), anyString(), anyBoolean(), anyMap(),
        any( IOutputHandler.class ), any( IActionCompleteListener.class ), any( IPentahoUrlFactory.class ),
        anyList() ) ).thenReturn( context );
    pentahoObjectFactoryUnified = mock( IPentahoObjectFactory.class );
    when( pentahoObjectFactoryUnified.objectDefined( anyString() ) ).thenReturn( true );
    when( pentahoObjectFactoryUnified.get( this.anyClass(), anyString(), any( IPentahoSession.class ) ) ).thenAnswer( new Answer<Object>() {
        @Override
        public Object answer( InvocationOnMock invocation ) throws Throwable {
          if ( IUnifiedRepository.class.toString().equals( invocation.getArguments()[0].toString() ) ) {
            return repository;
          } else if (  ISolutionEngine.class.toString().equals( invocation.getArguments()[0].toString() ) ) {
            return engine;
          } else if ( IMessageFormatter.class.toString().equals( invocation.getArguments()[0].toString() ) ) {
            return formatter;
          } else {
            return null;
          }
        }
      } );
    PentahoSystem.registerObjectFactory( pentahoObjectFactoryUnified );

    ISystemSettings systemSettingsService = mock( ISystemSettings.class );
    when( systemSettingsService.getSystemSetting( anyString(), anyString() ) ).thenAnswer( new Answer<String>() {
      @Override
      public String answer( InvocationOnMock invocation ) throws Throwable {
        return invocation.getArguments()[0].toString();
      }
    } );
    PentahoSystem.setSystemSettingsService( systemSettingsService );

    PentahoSessionHolder.setStrategyName( PentahoSessionHolder.MODE_INHERITABLETHREADLOCAL );
    PentahoSessionHolder.setSession( userSession );
  }

  private File createTempFile() throws IOException {
    return File.createTempFile( "XActionUtilTest", "tmp" );
  }

  @Test
  public void executeXActionSequence() throws Exception {
    XactionUtil.execute( MediaType.TEXT_HTML, xactionFile, httpServletRequest, httpServletResponse, userSession, mimeTypeListener );
    verify( repository, times( 1 ) ).deleteFile( anyString(), anyBoolean(), anyString() );
  }

  @Test
  public void testDeleteContentItem_null() throws Exception {
    XactionUtil.deleteContentItem( null, null ); // No exception
    XactionUtil.deleteContentItem( null, mock( IUnifiedRepository.class ) ); // No exception
    verify( repository, times( 0 ) ).deleteFile( anyString(), anyBoolean(), anyString() );
  }

  @Test
  public void testDeleteContentItem_simple() throws Exception {
    final IContentItem contentItem = mock( SimpleContentItem.class );
    doReturn( mock( OutputStream.class ) ).when( contentItem ).getOutputStream( anyObject() );
    try {
      XactionUtil.deleteContentItem( contentItem, null );
    } finally {
      contentItem.getOutputStream( null ).close();
    }
    verify( repository, times( 0 ) ).deleteFile( anyString(), anyBoolean(), anyString() );
  }

  @Test
  public void testDeleteContentItem_repo() throws Exception {
    IContentItem item = mock( RepositoryFileContentItem.class );
    doReturn( mock( OutputStream.class ) ).when( item ).getOutputStream( anyObject() );
    XactionUtil.deleteContentItem( item, repository );
    verify( repository, times( 1 ) ).deleteFile( anyString(), anyBoolean(), anyString() );
  }

  @Test
  public void testDeleteContentItem_repoNoFile() throws Exception {
    doReturn( null ).when( repository ).getFile( anyString() );
    IContentItem item = mock( RepositoryFileContentItem.class );
    doReturn( mock( OutputStream.class ) ).when( item ).getOutputStream( anyObject() );
    XactionUtil.deleteContentItem( item, repository );
    verify( repository, times( 0 ) ).deleteFile( anyString(), anyBoolean(), anyString() );
  }

  @After
  public void tearDown() {
    PentahoSessionHolder.removeSession();
    PentahoSystem.deregisterObjectFactory( pentahoObjectFactoryUnified );
    PentahoSystem.shutdown();
  }

  private Class<?> anyClass() {
    return argThat( new AnyClassMatcher() );
  }

  private class AnyClassMatcher extends ArgumentMatcher<Class<?>> {
    @Override
    public boolean matches( final Object arg ) {
      return true;
    }
  }

}