maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/RunPrepareGoalsPhaseTest.java

package org.apache.maven.shared.release.phase;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.isA;
import static org.mockito.Matchers.isNull;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import java.io.File;
import java.util.List;

import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.release.PlexusJUnit4TestCase;
import org.apache.maven.shared.release.ReleaseExecutionException;
import org.apache.maven.shared.release.ReleaseFailureException;
import org.apache.maven.shared.release.ReleaseResult;
import org.apache.maven.shared.release.config.ReleaseDescriptor;
import org.apache.maven.shared.release.env.DefaultReleaseEnvironment;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
import org.apache.maven.shared.release.exec.MavenExecutor;
import org.apache.maven.shared.release.exec.MavenExecutorException;
import org.apache.maven.shared.release.stubs.MavenExecutorWrapper;
import org.junit.Test;

/**
 * Test the simple test running phase.
 *
 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 */
public class RunPrepareGoalsPhaseTest
    extends PlexusJUnit4TestCase
{
    private RunPrepareGoalsPhase phase;

    private MavenExecutorWrapper mavenExecutorWrapper;
    
    private ReleaseEnvironment releaseEnvironment;

    public void setUp()
        throws Exception
    {
        super.setUp();

        phase = (RunPrepareGoalsPhase) lookup( ReleasePhase.ROLE, "run-preparation-goals" );
        
        mavenExecutorWrapper = (MavenExecutorWrapper) lookup( "org.apache.maven.shared.release.exec.MavenExecutor", "wrapper" );
        
        releaseEnvironment = new DefaultReleaseEnvironment();
        releaseEnvironment.setMavenExecutorId( "wrapper" );
    }

    @Test
    public void testExecute()
        throws ReleaseExecutionException, ReleaseFailureException, MavenExecutorException
    {
        // prepare
        File testFile = getTestFile( "target/working-directory" );

        ReleaseDescriptor config = new ReleaseDescriptor();
        config.setPreparationGoals( "clean integration-test" );
        config.setWorkingDirectory( testFile.getAbsolutePath() );

        MavenExecutor mock = mock( MavenExecutor.class );

        mavenExecutorWrapper.setMavenExecutor( mock );

        // execute
        phase.execute( config, releaseEnvironment, (List<MavenProject>) null );

        // verify
        verify( mock ).executeGoals( eq( testFile ), eq( "clean integration-test" ), isA( ReleaseEnvironment.class ),
                                     eq( true ), isNull( String.class ), isNull( String.class ),
                                     isA( ReleaseResult.class ) );
        verifyNoMoreInteractions( mock );
    }

    @Test
    public void testSimulate()
        throws ReleaseExecutionException, MavenExecutorException
    {
        // prepare
        File testFile = getTestFile( "target/working-directory" );

        ReleaseDescriptor config = new ReleaseDescriptor();
        config.setPreparationGoals( "clean integration-test" );
        config.setWorkingDirectory( testFile.getAbsolutePath() );

        MavenExecutor mock = mock( MavenExecutor.class );

        mavenExecutorWrapper.setMavenExecutor( mock );

        // execute
        phase.simulate( config, releaseEnvironment, null );

        // verify
        verify( mock ).executeGoals( eq( testFile ), eq( "clean integration-test" ), isA( ReleaseEnvironment.class ),
                                     eq( true ), isNull( String.class ), isNull( String.class ),
                                     isA( ReleaseResult.class ) );
        verifyNoMoreInteractions( mock );
    }

    @Test
    public void testExecuteException()
        throws ReleaseFailureException, MavenExecutorException
    {
        // prepare
        File testFile = getTestFile( "target/working-directory" );

        ReleaseDescriptor config = new ReleaseDescriptor();
        config.setPreparationGoals( "clean integration-test" );
        config.setWorkingDirectory( testFile.getAbsolutePath() );

        MavenExecutor mock = mock( MavenExecutor.class );
        doThrow( new MavenExecutorException( "...",
                                             new Exception() ) ).when( mock ).executeGoals( eq( testFile ),
                                                                                            eq( "clean integration-test" ),
                                                                                            isA( ReleaseEnvironment.class ),
                                                                                            eq( true ),
                                                                                            isNull( String.class ),
                                                                                            isNull( String.class ),
                                                                                            isA( ReleaseResult.class ) );

        mavenExecutorWrapper.setMavenExecutor( mock );

        // execute
        try
        {
            phase.execute( config, releaseEnvironment, (List<MavenProject>) null );

            fail( "Should have thrown an exception" );
        }
        catch ( ReleaseExecutionException e )
        {
            assertEquals( "Check cause", MavenExecutorException.class, e.getCause().getClass() );
        }

        // verify
        verify( mock ).executeGoals( eq( testFile ), eq( "clean integration-test" ), isA( ReleaseEnvironment.class ),
                                     eq( true ), isNull( String.class ), isNull( String.class ),
                                     isA( ReleaseResult.class ) );
        verifyNoMoreInteractions( mock );
    }

    @Test
    public void testSimulateException()
        throws MavenExecutorException
    {
        // prepare
        File testFile = getTestFile( "target/working-directory" );

        ReleaseDescriptor config = new ReleaseDescriptor();
        config.setPreparationGoals( "clean integration-test" );
        config.setWorkingDirectory( testFile.getAbsolutePath() );

        MavenExecutor mock = mock( MavenExecutor.class );
        doThrow( new MavenExecutorException( "...",
                                             new Exception() ) ).when( mock ).executeGoals( eq( testFile ),
                                                                                            eq( "clean integration-test" ),
                                                                                            isA( ReleaseEnvironment.class ),
                                                                                            eq( true ),
                                                                                            isNull( String.class ),
                                                                                            isNull( String.class ),
                                                                                            isA( ReleaseResult.class ) );

        mavenExecutorWrapper.setMavenExecutor( mock );

        // execute
        try
        {
            phase.simulate( config, releaseEnvironment, null );

            fail( "Should have thrown an exception" );
        }
        catch ( ReleaseExecutionException e )
        {
            assertEquals( "Check cause", MavenExecutorException.class, e.getCause().getClass() );
        }

        // verify
        verify( mock ).executeGoals( eq( testFile ), eq( "clean integration-test" ), isA( ReleaseEnvironment.class ),
                                     eq( true ), isNull( String.class ), isNull( String.class ),
                                     isA( ReleaseResult.class ) );
        verifyNoMoreInteractions( mock );

    }

    @Test
    public void testEmptyGoals()
        throws Exception
    {
        // prepare
        File testFile = getTestFile( "target/working-directory" );

        ReleaseDescriptor config = new ReleaseDescriptor();
        config.setPreparationGoals( "" );
        config.setWorkingDirectory( testFile.getAbsolutePath() );

        MavenExecutor mock = mock( MavenExecutor.class );

        mavenExecutorWrapper.setMavenExecutor( mock );

        // execute
        phase.execute( config, releaseEnvironment, (List<MavenProject>) null );

        // verify
        // no invocations of mock
        verifyNoMoreInteractions( mock );
    }
}