org.apache.maven.plugin.surefire

Class SurefirePlugin

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.surefire.AbstractSurefireMojo

org.apache.maven.plugin.surefire.SurefirePlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, SurefireExecutionParameters, SurefireReportParameters

@Mojo(name="test",
      defaultPhase=TEST,
      threadSafe=true,
      requiresDependencyResolution=TEST)
public class SurefirePlugin
extends AbstractSurefireMojo
implements SurefireReportParameters

Run tests using Surefire.

Author:

Jason van Zyl

Field Summary

Fields inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo

basedir, skip, skipExec, skipTests, testClassesDirectory

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
SurefirePlugin()

Method Summary

Modifier and Type	Method and Description
protected void	addPluginSpecificChecksumItems(ChecksumCalculator checksum)
File	getBasedir()
String	getDebugForkedProcess()
protected String[]	getDefaultIncludes()
protected String	getEnableProcessChecker()
String	getEncoding()
protected String[]	getExcludedEnvironmentVariables()
String[]	getExcludeJUnit5Engines()
List<String>	getExcludes()
File	getExcludesFile()
boolean	getFailIfNoSpecifiedTests()
int	getFailOnFlakeCount()
int	getForkedProcessExitTimeoutInSeconds()
int	getForkedProcessTimeoutInSeconds()
protected ForkNodeFactory	getForkNode()
String[]	getIncludeJUnit5Engines()
List<String>	getIncludes()
File	getIncludesFile()
File	getMainBuildPath()
double	getParallelTestsTimeoutForcedInSeconds()
double	getParallelTestsTimeoutInSeconds()
protected String	getPluginName()
String	getReportFormat()
protected String	getReportSchemaLocation()
File	getReportsDirectory()
protected int	getRerunFailingTestsCount()
String	getRunOrder()
Long	getRunOrderRandomSeed()
String	getShutdown()
int	getSkipAfterFailureCount()
File[]	getSuiteXmlFiles()
File	getSystemPropertiesFile()
String	getTest()
File	getTestClassesDirectory()
protected void	handleSummary(RunResult summary, Exception firstForkException)
protected boolean	hasSuiteXmlFiles()
boolean	isPrintSummary()
boolean	isSkip()
boolean	isSkipExec() Deprecated.
protected boolean	isSkipExecution()
boolean	isSkipTests()
boolean	isTestFailureIgnore()
boolean	isUseFile()
boolean	isUseManifestOnlyJar()
boolean	isUseSystemClassLoader()
void	setBasedir(File basedir)
void	setDebugForkedProcess(String debugForkedProcess)
void	setEncoding(String encoding)
void	setExcludeJUnit5Engines(String[] excludeJUnit5Engines)
void	setExcludes(List<String> excludes)
void	setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)
void	setFailOnFlakeCount(int failOnFlakeCount)
void	setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)
void	setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)
void	setIncludeJUnit5Engines(String[] includeJUnit5Engines)
void	setIncludes(List<String> includes)
void	setMainBuildPath(File mainBuildPath)
void	setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)
void	setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)
void	setPrintSummary(boolean printSummary)
void	setReportFormat(String reportFormat)
void	setReportsDirectory(File reportsDirectory)
void	setRunOrder(String runOrder)
void	setRunOrderRandomSeed(Long runOrderRandomSeed)
void	setSkip(boolean skip)
void	setSkipExec(boolean skipExec) Deprecated.
void	setSkipTests(boolean skipTests)
void	setSuiteXmlFiles(File[] suiteXmlFiles)
void	setSystemPropertiesFile(File systemPropertiesFile)
void	setTest(String test)
void	setTestClassesDirectory(File testClassesDirectory)
void	setTestFailureIgnore(boolean testFailureIgnore)
void	setUseFile(boolean useFile)
void	setUseManifestOnlyJar(boolean useManifestOnlyJar)
protected void	setUseModulePath(boolean useModulePath)
void	setUseSystemClassLoader(boolean useSystemClassLoader)
protected List<File>	suiteXmlFiles()
protected boolean	useModulePath()
protected void	warnIfIllegalFailOnFlakeCount()

Methods inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo

cleanupForkConfiguration, convertWithCoreCount, createCopyAndReplaceForkNumPlaceholder, createProviders, effectiveIsEnableAssertions, execute, getAdditionalClasspathElements, getArgLine, getClassLoaderConfiguration, getClasspathDependencyExcludes, getClasspathDependencyScopeExclude, getConsoleLogger, getDependenciesToScan, getEffectiveForkCount, getEnvironmentVariables, getExcludedGroups, getFailIfNoTests, getForkCount, getGroups, getJdkToolchain, getJunitArtifactName, getJvm, getLocalRepositoryPath, getMojoArtifact, getObjectFactory, getParallel, getPerCoreThreadCount, getPluginArtifactMap, getPluginDescriptor, getProject, getProjectArtifactMap, getProjectBuildDirectory, getReportNameSuffix, getSession, getSpecificTests, getSystemProperties, getSystemPropertyVariables, getTempDir, getTestNGArtifactName, getTestSourceDirectory, getThreadCount, getThreadCountClasses, getThreadCountMethods, getThreadCountSuites, getToolchainManager, getUseUnlimitedThreads, getWorkingDirectory, hasExecutedBefore, isAnyConcurrencySelected, isAnyGroupsSelected, isChildDelegation, isDisableXmlReport, isEnableAssertions, isEnableOutErrElements, isEnablePropertiesElement, isForking, isMavenParallel, isParallelOptimized, isRedirectTestOutputToFile, isReuseForks, isTrimStackTrace, logDebugOrCliShowErrors, logReportsDirectory, resolveDependencies, setAdditionalClasspathElements, setArgLine, setChildDelegation, setClasspathDependencyExcludes, setClasspathDependencyScopeExclude, setDependenciesToScan, setDisableXmlReport, setEnableAssertions, setEnableOutErrElements, setEnablePropertiesElement, setEnvironmentVariables, setExcludedGroups, setFailIfNoTests, setGroups, setJdkToolchain, setJunitArtifactName, setObjectFactory, setParallel, setParallelOptimized, setPerCoreThreadCount, setPluginArtifactMap, setProject, setProjectArtifactMap, setProjectBuildDirectory, setProperties, setRedirectTestOutputToFile, setReportNameSuffix, setSession, setSystemProperties, setSystemPropertyVariables, setTempDir, setTestNGArtifactName, setTestSourceDirectory, setThreadCount, setThreadCountClasses, setThreadCountMethods, setThreadCountSuites, setToolchainManager, setTrimStackTrace, setUseUnlimitedThreads, setWorkingDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.surefire.SurefireReportParameters

getFailIfNoTests, setFailIfNoTests

Constructor Detail

SurefirePlugin

public SurefirePlugin()

Method Detail

getRerunFailingTestsCount

protected int getRerunFailingTestsCount()

Specified by:

getRerunFailingTestsCount in class AbstractSurefireMojo

getFailOnFlakeCount

public int getFailOnFlakeCount()

Specified by:

getFailOnFlakeCount in interface SurefireReportParameters

setFailOnFlakeCount

public void setFailOnFlakeCount(int failOnFlakeCount)

Specified by:

setFailOnFlakeCount in interface SurefireReportParameters

handleSummary

protected void handleSummary(RunResult summary,
                             Exception firstForkException)
                      throws org.apache.maven.plugin.MojoExecutionException,
                             org.apache.maven.plugin.MojoFailureException

Specified by:

handleSummary in class AbstractSurefireMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isSkipExecution

protected boolean isSkipExecution()

Specified by:

isSkipExecution in class AbstractSurefireMojo

getPluginName

protected String getPluginName()

Specified by:

getPluginName in class AbstractSurefireMojo

getDefaultIncludes

protected String[] getDefaultIncludes()

Specified by:

getDefaultIncludes in class AbstractSurefireMojo

getReportSchemaLocation

protected String getReportSchemaLocation()

Specified by:

getReportSchemaLocation in class AbstractSurefireMojo

getSystemPropertiesFile

public File getSystemPropertiesFile()

Specified by:

getSystemPropertiesFile in class AbstractSurefireMojo

setSystemPropertiesFile

public void setSystemPropertiesFile(File systemPropertiesFile)

Specified by:

setSystemPropertiesFile in class AbstractSurefireMojo

isSkipTests

public boolean isSkipTests()

Specified by:

isSkipTests in interface SurefireExecutionParameters

Specified by:

isSkipTests in interface SurefireReportParameters

setSkipTests

public void setSkipTests(boolean skipTests)

Specified by:

setSkipTests in interface SurefireExecutionParameters

Specified by:

setSkipTests in interface SurefireReportParameters

isSkipExec

@Deprecated
public boolean isSkipExec()

Deprecated.

Specified by:

isSkipExec in interface SurefireExecutionParameters

Specified by:

isSkipExec in interface SurefireReportParameters

setSkipExec

@Deprecated
public void setSkipExec(boolean skipExec)

Deprecated.

Specified by:

setSkipExec in interface SurefireExecutionParameters

Specified by:

setSkipExec in interface SurefireReportParameters

isSkip

public boolean isSkip()

Specified by:

isSkip in interface SurefireExecutionParameters

Specified by:

isSkip in interface SurefireReportParameters

setSkip

public void setSkip(boolean skip)

Specified by:

setSkip in interface SurefireExecutionParameters

Specified by:

setSkip in interface SurefireReportParameters

isTestFailureIgnore

public boolean isTestFailureIgnore()

Specified by:

isTestFailureIgnore in interface SurefireReportParameters

setTestFailureIgnore

public void setTestFailureIgnore(boolean testFailureIgnore)

Specified by:

setTestFailureIgnore in interface SurefireReportParameters

getBasedir

public File getBasedir()

Specified by:

getBasedir in interface SurefireExecutionParameters

Specified by:

getBasedir in interface SurefireReportParameters

setBasedir

public void setBasedir(File basedir)

Specified by:

setBasedir in interface SurefireExecutionParameters

Specified by:

setBasedir in interface SurefireReportParameters

getTestClassesDirectory

public File getTestClassesDirectory()

Specified by:

getTestClassesDirectory in interface SurefireExecutionParameters

Specified by:

getTestClassesDirectory in interface SurefireReportParameters

setTestClassesDirectory

public void setTestClassesDirectory(File testClassesDirectory)

Specified by:

setTestClassesDirectory in interface SurefireExecutionParameters

Specified by:

setTestClassesDirectory in interface SurefireReportParameters

getMainBuildPath

public File getMainBuildPath()

Specified by:

getMainBuildPath in interface SurefireExecutionParameters

setMainBuildPath

public void setMainBuildPath(File mainBuildPath)

Specified by:

setMainBuildPath in interface SurefireExecutionParameters

getReportsDirectory

public File getReportsDirectory()

Specified by:

getReportsDirectory in interface SurefireExecutionParameters

Specified by:

getReportsDirectory in interface SurefireReportParameters

setReportsDirectory

public void setReportsDirectory(File reportsDirectory)

Specified by:

setReportsDirectory in interface SurefireExecutionParameters

Specified by:

setReportsDirectory in interface SurefireReportParameters

getTest

public String getTest()

Specified by:

getTest in interface SurefireExecutionParameters

isUseSystemClassLoader

public boolean isUseSystemClassLoader()

Specified by:

isUseSystemClassLoader in interface SurefireExecutionParameters

setUseSystemClassLoader

public void setUseSystemClassLoader(boolean useSystemClassLoader)

Specified by:

setUseSystemClassLoader in interface SurefireExecutionParameters

isUseManifestOnlyJar

public boolean isUseManifestOnlyJar()

Specified by:

isUseManifestOnlyJar in interface SurefireExecutionParameters

setUseManifestOnlyJar

public void setUseManifestOnlyJar(boolean useManifestOnlyJar)

Specified by:

setUseManifestOnlyJar in interface SurefireExecutionParameters

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface SurefireExecutionParameters

setEncoding

public void setEncoding(String encoding)

Specified by:

setEncoding in interface SurefireExecutionParameters

getFailIfNoSpecifiedTests

public boolean getFailIfNoSpecifiedTests()

Specified by:

getFailIfNoSpecifiedTests in interface SurefireExecutionParameters

setFailIfNoSpecifiedTests

public void setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)

Specified by:

setFailIfNoSpecifiedTests in interface SurefireExecutionParameters

getSkipAfterFailureCount

public int getSkipAfterFailureCount()

Specified by:

getSkipAfterFailureCount in interface SurefireExecutionParameters

getShutdown

public String getShutdown()

Specified by:

getShutdown in interface SurefireExecutionParameters

isPrintSummary

public boolean isPrintSummary()

Specified by:

isPrintSummary in interface SurefireExecutionParameters

setPrintSummary

public void setPrintSummary(boolean printSummary)

Specified by:

setPrintSummary in interface SurefireExecutionParameters

getReportFormat

public String getReportFormat()

Specified by:

getReportFormat in interface SurefireExecutionParameters

setReportFormat

public void setReportFormat(String reportFormat)

Specified by:

setReportFormat in interface SurefireExecutionParameters

isUseFile

public boolean isUseFile()

Specified by:

isUseFile in interface SurefireExecutionParameters

setUseFile

public void setUseFile(boolean useFile)

Specified by:

setUseFile in interface SurefireExecutionParameters

getDebugForkedProcess

public String getDebugForkedProcess()

Specified by:

getDebugForkedProcess in interface SurefireExecutionParameters

setDebugForkedProcess

public void setDebugForkedProcess(String debugForkedProcess)

Specified by:

setDebugForkedProcess in interface SurefireExecutionParameters

getForkedProcessTimeoutInSeconds

public int getForkedProcessTimeoutInSeconds()

Specified by:

getForkedProcessTimeoutInSeconds in interface SurefireExecutionParameters

setForkedProcessTimeoutInSeconds

public void setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)

Specified by:

setForkedProcessTimeoutInSeconds in interface SurefireExecutionParameters

getForkedProcessExitTimeoutInSeconds

public int getForkedProcessExitTimeoutInSeconds()

Specified by:

getForkedProcessExitTimeoutInSeconds in interface SurefireExecutionParameters

setForkedProcessExitTimeoutInSeconds

public void setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)

Specified by:

setForkedProcessExitTimeoutInSeconds in interface SurefireExecutionParameters

getParallelTestsTimeoutInSeconds

public double getParallelTestsTimeoutInSeconds()

Specified by:

getParallelTestsTimeoutInSeconds in interface SurefireExecutionParameters

setParallelTestsTimeoutInSeconds

public void setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)

Specified by:

setParallelTestsTimeoutInSeconds in interface SurefireExecutionParameters

getParallelTestsTimeoutForcedInSeconds

public double getParallelTestsTimeoutForcedInSeconds()

Specified by:

getParallelTestsTimeoutForcedInSeconds in interface SurefireExecutionParameters

setParallelTestsTimeoutForcedInSeconds

public void setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)

Specified by:

setParallelTestsTimeoutForcedInSeconds in interface SurefireExecutionParameters

setTest

public void setTest(String test)

Specified by:

setTest in interface SurefireExecutionParameters

getIncludes

public List<String> getIncludes()

Specified by:

getIncludes in interface SurefireExecutionParameters

Specified by:

getIncludes in class AbstractSurefireMojo

setIncludes

public void setIncludes(List<String> includes)

Specified by:

setIncludes in interface SurefireExecutionParameters

Specified by:

setIncludes in class AbstractSurefireMojo

getExcludes

public List<String> getExcludes()

Specified by:

getExcludes in interface SurefireExecutionParameters

setExcludes

public void setExcludes(List<String> excludes)

Specified by:

setExcludes in interface SurefireExecutionParameters

getSuiteXmlFiles

public File[] getSuiteXmlFiles()

Specified by:

getSuiteXmlFiles in class AbstractSurefireMojo

setSuiteXmlFiles

public void setSuiteXmlFiles(File[] suiteXmlFiles)

Specified by:

setSuiteXmlFiles in class AbstractSurefireMojo

getRunOrder

public String getRunOrder()

Specified by:

getRunOrder in class AbstractSurefireMojo

setRunOrder

public void setRunOrder(String runOrder)

Specified by:

setRunOrder in class AbstractSurefireMojo

getRunOrderRandomSeed

public Long getRunOrderRandomSeed()

Specified by:

getRunOrderRandomSeed in class AbstractSurefireMojo

setRunOrderRandomSeed

public void setRunOrderRandomSeed(Long runOrderRandomSeed)

Specified by:

setRunOrderRandomSeed in class AbstractSurefireMojo

getIncludesFile

public File getIncludesFile()

Specified by:

getIncludesFile in class AbstractSurefireMojo

getExcludesFile

public File getExcludesFile()

Specified by:

getExcludesFile in class AbstractSurefireMojo

useModulePath

protected boolean useModulePath()

Specified by:

useModulePath in class AbstractSurefireMojo

setUseModulePath

protected void setUseModulePath(boolean useModulePath)

Specified by:

setUseModulePath in class AbstractSurefireMojo

suiteXmlFiles

protected final List<File> suiteXmlFiles()

Specified by:

suiteXmlFiles in class AbstractSurefireMojo

hasSuiteXmlFiles

protected final boolean hasSuiteXmlFiles()

Specified by:

hasSuiteXmlFiles in class AbstractSurefireMojo

getExcludedEnvironmentVariables

protected final String[] getExcludedEnvironmentVariables()

Specified by:

getExcludedEnvironmentVariables in class AbstractSurefireMojo

getEnableProcessChecker

protected final String getEnableProcessChecker()

Specified by:

getEnableProcessChecker in class AbstractSurefireMojo

getForkNode

protected final ForkNodeFactory getForkNode()

Specified by:

getForkNode in class AbstractSurefireMojo

warnIfIllegalFailOnFlakeCount

protected void warnIfIllegalFailOnFlakeCount()
                                      throws org.apache.maven.plugin.MojoFailureException

Overrides:

warnIfIllegalFailOnFlakeCount in class AbstractSurefireMojo

Throws:

org.apache.maven.plugin.MojoFailureException

addPluginSpecificChecksumItems

protected void addPluginSpecificChecksumItems(ChecksumCalculator checksum)

Overrides:

addPluginSpecificChecksumItems in class AbstractSurefireMojo

getIncludeJUnit5Engines

public String[] getIncludeJUnit5Engines()

Specified by:

getIncludeJUnit5Engines in interface SurefireExecutionParameters

setIncludeJUnit5Engines

public void setIncludeJUnit5Engines(String[] includeJUnit5Engines)

Specified by:

setIncludeJUnit5Engines in interface SurefireExecutionParameters

getExcludeJUnit5Engines

public String[] getExcludeJUnit5Engines()

Specified by:

getExcludeJUnit5Engines in interface SurefireExecutionParameters

setExcludeJUnit5Engines

public void setExcludeJUnit5Engines(String[] excludeJUnit5Engines)

Specified by:

setExcludeJUnit5Engines in interface SurefireExecutionParameters