npanday-it-runner/src/test/java/npanday/its/AbstractNPandayIntegrationTestCase.java

package npanday.its;

/*
 * Copyright 2009
 *
 * Licensed 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.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.List;

import junit.framework.TestCase;

import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.it.VerificationException;
import org.apache.maven.it.Verifier;

public abstract class AbstractNPandayIntegrationTestCase
    extends TestCase
{
    /**
     * Save System.out for progress reports etc.
     */
    private static PrintStream out = System.out;

    private boolean skip;

    private static final String NPANDAY_VERSION_SYSTEM_PROPERTY = "npanday.version";

    private static DefaultArtifactVersion version = checkVersion();

    private VersionRange versionRange;

    protected AbstractNPandayIntegrationTestCase()
    {
        this( "(0,)" );
    }

    protected AbstractNPandayIntegrationTestCase( String versionRangeStr )
    {
        versionRange = createVersionRange( versionRangeStr );

        if ( !versionRange.containsVersion( version ) )
        {
            skip = true;
        }
    }

    private static DefaultArtifactVersion checkVersion()
    {
        DefaultArtifactVersion version = null;
        String v = System.getProperty( NPANDAY_VERSION_SYSTEM_PROPERTY );
        if ( v != null )
        {
            version = new DefaultArtifactVersion( v );
            out.println( "Using NPanday version " + version );
        }
        else
        {
            out.println( "No NPanday version given" );
        }
        return version;
    }

    protected boolean matchesVersionRange( String versionRangeStr )
    {
        VersionRange versionRange = createVersionRange( versionRangeStr );

        return versionRange.containsVersion( version );
    }

    private static VersionRange createVersionRange( String versionRangeStr )
    {
        VersionRange versionRange;
        try
        {
            versionRange = VersionRange.createFromVersionSpec( versionRangeStr );
        }
        catch ( InvalidVersionSpecificationException e )
        {
            throw (RuntimeException) new IllegalArgumentException( "Invalid version range: " + versionRangeStr ).initCause( e );
        }
        return versionRange;
    }

    protected void runTest()
        throws Throwable
    {
        out.print( getITName() + "(" + getName() + ").." );

        if ( skip )
        {
            out.println( " Skipping (version " + version + " not in range " + versionRange + ")" );
            return;
        }

        try
        {
            super.runTest();
            out.println( " Ok" );
        }
        catch ( Throwable t )
        {
            out.println( " Failure" );
            throw t;
        }
    }

    private String getITName()
    {
        String simpleName = getClass().getName();
        int idx = simpleName.lastIndexOf( '.' );
        simpleName = idx >= 0 ? simpleName.substring( idx + 1 ) : simpleName;
        simpleName = simpleName.startsWith( "NPandayIT" ) ? simpleName.substring( "NPandayIT".length() ) : simpleName;
        simpleName = simpleName.endsWith( "Test" ) ? simpleName.substring( 0, simpleName.length() - 4 ) : simpleName;
        return simpleName;
    }

    protected Verifier getVerifier( File testDirectory )
        throws VerificationException
    {
        Verifier verifier = new Verifier( testDirectory.getAbsolutePath() );
        List<String> cliOptions = new ArrayList<String>( 2 );
        cliOptions.add( "-Dnpanday.version=" + version );
        verifier.setCliOptions( cliOptions );
        return verifier;
    }

    protected String getCommentsFile()
    {
        return "target/comments.xml";
    }

    protected String getBuildSourcesMain( String fileName )
    {
        return getBuildFile( "build-sources", fileName );
    }

    protected String getBuildSourcesGenerated( String fileName )
    {
        return getBuildSourcesMain( fileName );
    }

    protected String getTestSourcesMain( String fileName )
    {
        return getBuildFile( "build-test-sources", fileName );
    }

    protected String getTestSourcesGenerated( String fileName )
    {
        return getTestSourcesMain( fileName );
    }

    private String getBuildFile( String buildDirectory, String fileName )
    {
        return "target/" + buildDirectory + "/" + fileName;
    }

    protected String getAssemblyFile( String assemblyName, String version, String type )
    {
        return getAssemblyFile( assemblyName, version, type, null );
    }

    protected String getAssemblyFile( String assemblyName, String version, String type, String classifier )
    {
        StringBuilder sb = new StringBuilder();
        sb.append( "target/" );
        sb.append( assemblyName );
        sb.append( "." );
        sb.append( type );
        return sb.toString();
    }
}