surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSet.java

package org.apache.maven.surefire.junit;

/*
 * 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 java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import org.apache.maven.surefire.api.report.LegacyPojoStackTraceWriter;
import org.apache.maven.surefire.api.report.RunListener;
import org.apache.maven.surefire.api.report.SimpleReportEntry;
import org.apache.maven.surefire.api.report.StackTraceWriter;
import org.apache.maven.surefire.api.testset.TestSetFailedException;

import static org.apache.maven.surefire.api.report.SimpleReportEntry.withException;

/**
 * Executes a JUnit3 test class
 *
 */
public class PojoTestSet
    implements SurefireTestSet
{
    private static final String TEST_METHOD_PREFIX = "test";

    private static final String SETUP_METHOD_NAME = "setUp";

    private static final String TEARDOWN_METHOD_NAME = "tearDown";

    private static final Object[] EMPTY_OBJECT_ARRAY = {};

    private final Class<?> testClass;

    private final Collection<Method> testMethods = new ArrayList<>();

    private Method setUpMethod;

    private Method tearDownMethod;

    public PojoTestSet( final Class<?> testClass )
    {
        if ( testClass == null )
        {
            throw new IllegalArgumentException( "testClass is null" );
        }

        this.testClass = testClass;
    }

    @Override
    public void execute( RunListener reportManager, ClassLoader loader )
            throws TestSetFailedException
    {
        if ( reportManager == null )
        {
            throw new NullPointerException( "reportManager is null" );
        }

        executeTestMethods( reportManager );
    }

    private void executeTestMethods( RunListener reportManager )
            throws TestSetFailedException
    {
        if ( reportManager == null )
        {
            throw new NullPointerException( "reportManager is null" );
        }

        discoverTestMethods();

        for ( Method testMethod : testMethods )
        {
            boolean abort = executeTestMethod( testMethod, reportManager );
            if ( abort )
            {
                break;
            }
        }
    }

    private boolean executeTestMethod( Method method, RunListener reportManager )
            throws TestSetFailedException
    {
        if ( method == null || reportManager == null )
        {
            throw new NullPointerException();
        }

        final Object testObject;

        try
        {
            testObject = testClass.newInstance();
        }
        catch ( ReflectiveOperationException e )
        {
            throw new TestSetFailedException( "Unable to instantiate POJO '" + testClass + "'.", e );
        }

        final String testClassName = getTestClass().getName();
        final String methodName = method.getName();
        final String userFriendlyMethodName = methodName + "()";
        final String testName = getTestName( userFriendlyMethodName );

        reportManager.testStarting( new SimpleReportEntry( testClassName, null, testName, null ) );

        try
        {
            setUpFixture( testObject );
        }
        catch ( Throwable e )
        {
            StackTraceWriter stackTraceWriter = new LegacyPojoStackTraceWriter( testClassName, methodName, e );
            reportManager.testFailed( withException( testClassName, null, testName, null, stackTraceWriter ) );

            // A return value of true indicates to this class's executeTestMethods
            // method that it should abort and not attempt to execute
            // any other test methods. The other caller of this method,
            // TestRerunner.rerun, ignores this return value, because it is
            // only running one test.
            return true;
        }

        // Make sure that tearDownFixture
        try
        {
            method.invoke( testObject, EMPTY_OBJECT_ARRAY );
            reportManager.testSucceeded( new SimpleReportEntry( testClassName, null, testName, null ) );
        }
        catch ( InvocationTargetException e )
        {
            Throwable t = e.getTargetException();
            StackTraceWriter stackTraceWriter = new LegacyPojoStackTraceWriter( testClassName, methodName, t );
            reportManager.testFailed( withException( testClassName, null, testName, null, stackTraceWriter ) );
            // Don't return  here, because tearDownFixture should be called even
            // if the test method throws an exception.
        }
        catch ( Throwable t )
        {
            StackTraceWriter stackTraceWriter = new LegacyPojoStackTraceWriter( testClassName, methodName, t );
            reportManager.testFailed( withException( testClassName, null, testName, null, stackTraceWriter ) );
            // Don't return  here, because tearDownFixture should be called even
            // if the test method throws an exception.
        }

        try
        {
            tearDownFixture( testObject );
        }
        catch ( Throwable t )
        {
            StackTraceWriter stackTraceWriter = new LegacyPojoStackTraceWriter( testClassName, methodName, t );
            // Treat any exception from tearDownFixture as a failure of the test.
            reportManager.testFailed( withException( testClassName, null, testName, null, stackTraceWriter ) );

            // A return value of true indicates to this class's executeTestMethods
            // method that it should abort and not attempt to execute
            // any other test methods. The other caller of this method,
            // TestRerunner.rerun, ignores this return value, because it is
            // only running one test.
            return true;
        }

        // A return value of false indicates to this class's executeTestMethods
        // method that it should keep plowing ahead and invoke more test methods.
        // The other caller of this method,
        // TestRerunner.rerun, ignores this return value, because it is
        // only running one test.
        return false;
    }

    private String getTestName( String testMethodName )
    {
        if ( testMethodName == null )
        {
            throw new NullPointerException( "testMethodName is null" );
        }

        return getTestClass().getName() + "." + testMethodName;
    }

    private void setUpFixture( Object testObject )
        throws Throwable
    {
        if ( setUpMethod != null )
        {
            setUpMethod.invoke( testObject );
        }
    }

    private void tearDownFixture( Object testObject )
        throws Throwable
    {
        if ( tearDownMethod != null )
        {
            tearDownMethod.invoke( testObject );
        }
    }

    private void discoverTestMethods()
    {
        for ( Method m : getTestClass().getMethods() )
        {
            if ( isNoArgsInstanceMethod( m ) )
            {
                if ( isValidTestMethod( m ) )
                {
                    testMethods.add( m );
                }
                else if ( SETUP_METHOD_NAME.equals( m.getName() ) )
                {
                    setUpMethod = m;
                }
                else if ( TEARDOWN_METHOD_NAME.equals( m.getName() ) )
                {
                    tearDownMethod = m;
                }
            }
        }
    }

    private static boolean isNoArgsInstanceMethod( Method m )
    {
        boolean isInstanceMethod = !Modifier.isStatic( m.getModifiers() );
        boolean returnsVoid = m.getReturnType().equals( void.class );
        boolean hasNoParams = m.getParameterTypes().length == 0;
        return isInstanceMethod && returnsVoid && hasNoParams;
    }

    private static boolean isValidTestMethod( Method m )
    {
        return m.getName().startsWith( TEST_METHOD_PREFIX );
    }

    @Override
    public String getName()
    {
        return getTestClass().getName();
    }

    private Class<?> getTestClass()
    {
        return testClass;
    }
}