package org.apache.maven.surefire.its.fixture;
/*
* 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.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.maven.artifact.versioning.ArtifactVersion;
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;
/**
* Encapsulate all needed features to start a surefire run
* <p/>
* Also includes thread-safe access to the extracted resource
* files
*
* @author Kristian Rosenvold -
*/
public class SurefireLauncher
{
private final MavenLauncher mavenLauncher;
private final String testNgVersion = System.getProperty( "testng.version" );
private final String surefireVersion = System.getProperty( "surefire.version" );
public SurefireLauncher( MavenLauncher mavenLauncher )
{
this.mavenLauncher = mavenLauncher;
reset();
}
public MavenLauncher maven()
{
return mavenLauncher;
}
String getTestMethodName()
{
return mavenLauncher.getTestMethodName();
}
public void reset()
{
mavenLauncher.reset();
for ( String s : getInitialGoals( testNgVersion ) )
{
mavenLauncher.addGoal( s );
}
}
public SurefireLauncher getSubProjectLauncher( String subProject )
throws VerificationException
{
return new SurefireLauncher( mavenLauncher.getSubProjectLauncher( subProject ) );
}
public OutputValidator getSubProjectValidator( String subProject )
throws VerificationException
{
return mavenLauncher.getSubProjectValidator( subProject );
}
public SurefireLauncher addEnvVar( String key, String value )
{
mavenLauncher.addEnvVar( key, value );
return this;
}
public SurefireLauncher setMavenOpts(String opts){
addEnvVar( "MAVEN_OPTS", opts );
return this;
}
private List<String> getInitialGoals( String testNgVersion )
{
List<String> goals1 = new ArrayList<String>();
goals1.add( "-Dsurefire.version=" + surefireVersion );
if ( this.testNgVersion != null )
{
goals1.add( "-DtestNgVersion=" + testNgVersion );
ArtifactVersion v = new DefaultArtifactVersion( testNgVersion );
try
{
if ( VersionRange.createFromVersionSpec( "(,5.12.1)" ).containsVersion( v ) )
{
goals1.add( "-DtestNgClassifier=jdk15" );
}
}
catch ( InvalidVersionSpecificationException e )
{
throw new RuntimeException( e.getMessage(), e );
}
}
return goals1;
}
public SurefireLauncher resetInitialGoals( String testNgVersion )
{
mavenLauncher.resetGoals();
for ( String s : getInitialGoals( testNgVersion ) )
{
mavenLauncher.addGoal( s );
}
return this;
}
public SurefireLauncher showErrorStackTraces()
{
mavenLauncher.showErrorStackTraces();
return this;
}
public SurefireLauncher debugLogging()
{
mavenLauncher.debugLogging();
return this;
}
@SuppressWarnings( "UnusedDeclaration" )
public SurefireLauncher debugSurefireFork()
{
mavenLauncher.sysProp( "maven.surefire.debug", "true" );
return this;
}
public SurefireLauncher failNever()
{
mavenLauncher.failNever();
return this;
}
public SurefireLauncher groups( String groups )
{
mavenLauncher.sysProp( "groups", groups );
return this;
}
public SurefireLauncher addGoal( String goal )
{
mavenLauncher.addGoal( goal );
return this;
}
public OutputValidator executeTest()
{
return mavenLauncher.execute( "test" );
}
public OutputValidator executeInstall()
throws VerificationException
{
return mavenLauncher.execute( "install" );
}
public FailsafeOutputValidator executeVerify()
{
OutputValidator verify = execute( "verify" );
return new FailsafeOutputValidator( verify );
}
public OutputValidator execute( String goal )
{
return mavenLauncher.execute( goal );
}
public OutputValidator executeSurefireReport()
{
return mavenLauncher.execute( "surefire-report:report" );
}
public OutputValidator executeCurrentGoals()
{
return mavenLauncher.executeCurrentGoals();
}
public SurefireLauncher printSummary( boolean printsummary )
{
mavenLauncher.sysProp( "printSummary", printsummary );
return this;
}
public SurefireLauncher redirectToFile( boolean redirect )
{
mavenLauncher.sysProp( "maven.test.redirectTestOutputToFile", redirect );
return this;
}
public SurefireLauncher forkOnce()
{
return forkMode( "once" );
}
public SurefireLauncher forkNever()
{
return forkMode( "never" );
}
public SurefireLauncher forkAlways()
{
return forkMode( "always" );
}
public SurefireLauncher forkPerTest()
{
return forkMode( "pertest" );
}
public SurefireLauncher forkPerThread()
{
return forkMode( "perthread" ).reuseForks( false );
}
public SurefireLauncher forkOncePerThread()
{
return forkPerThread().reuseForks( true );
}
public SurefireLauncher threadCount( int threadCount )
{
mavenLauncher.sysProp( "threadCount", threadCount );
return this;
}
public SurefireLauncher forkCount( int forkCount )
{
mavenLauncher.sysProp( "forkCount", forkCount );
return this;
}
public SurefireLauncher reuseForks( boolean reuseForks )
{
mavenLauncher.sysProp( "reuseForks", reuseForks );
return this;
}
public SurefireLauncher forkMode( String forkMode )
{
mavenLauncher.sysProp( "forkMode", forkMode );
return this;
}
public SurefireLauncher runOrder( String runOrder )
{
mavenLauncher.sysProp( "runOrder", runOrder );
return this;
}
public SurefireLauncher failIfNoTests( boolean fail )
{
mavenLauncher.sysProp( "failIfNoTests", fail );
return this;
}
public SurefireLauncher mavenTestFailureIgnore( boolean fail )
{
mavenLauncher.sysProp( "maven.test.failure.ignore", fail );
return this;
}
public SurefireLauncher failIfNoSpecifiedTests( boolean fail )
{
mavenLauncher.sysProp( "surefire.failIfNoSpecifiedTests", fail );
return this;
}
public SurefireLauncher useSystemClassLoader( boolean useSystemClassLoader )
{
mavenLauncher.sysProp( "useSystemClassLoader", useSystemClassLoader );
return this;
}
public SurefireLauncher activateProfile( String profile )
{
mavenLauncher.activateProfile( profile );
return this;
}
protected String getSurefireVersion()
{
return surefireVersion;
}
public SurefireLauncher parallel( String parallel )
{
mavenLauncher.sysProp( "parallel", parallel );
return this;
}
public SurefireLauncher parallelClasses()
{
return parallel( "classes" );
}
public SurefireLauncher parallelMethods()
{
return parallel( "methods" );
}
public SurefireLauncher sysProp( String variable, String value )
{
mavenLauncher.sysProp( variable, value );
return this;
}
public SurefireLauncher setJUnitVersion( String version )
{
mavenLauncher.sysProp( "junit.version", version );
return this;
}
public SurefireLauncher setGroups( String groups )
{
mavenLauncher.sysProp( "groups", groups );
return this;
}
public SurefireLauncher setExcludedGroups( String excludedGroups )
{
mavenLauncher.sysProp( "excludedGroups", excludedGroups );
return this;
}
public File getUnpackedAt()
{
return mavenLauncher.getUnpackedAt();
}
public SurefireLauncher addFailsafeReportOnlyGoal()
{
mavenLauncher.addGoal( getReportPluginGoal( ":failsafe-report-only" ) );
return this;
}
public SurefireLauncher addSurefireReportGoal()
{
mavenLauncher.addGoal( getReportPluginGoal( "report" ) );
return this;
}
public SurefireLauncher addSurefireReportOnlyGoal()
{
mavenLauncher.addGoal( getReportPluginGoal( "report-only" ) );
return this;
}
private String getReportPluginGoal( String goal )
{
return "org.apache.maven.plugins:maven-surefire-report-plugin:" + getSurefireVersion() + ":" + goal;
}
public SurefireLauncher setTestToRun( String basicTest )
{
mavenLauncher.sysProp( "test", basicTest );
return this;
}
public SurefireLauncher setForkJvm()
{
mavenLauncher.setForkJvm( true );
return this;
}
}