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, org.apache.maven.plugin.surefire.SurefireExecutionParameters, org.apache.maven.plugin.surefire.SurefireReportParameters

@Mojo(name="test",
      defaultPhase=TEST,
      threadSafe=true,
      requiresDependencyResolution=TEST)
public class SurefirePlugin
extends org.apache.maven.plugin.surefire.AbstractSurefireMojo
implements org.apache.maven.plugin.surefire.SurefireReportParameters

Run tests using Surefire.

Author:: Jason van Zyl

Field Summary
- Fields inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  basedir, FORK_NUMBER_PLACEHOLDER, skip, skipExec, skipTests, testClassesDirectory, THREAD_NUMBER_PLACEHOLDER
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor Description

SurefirePlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File`	`getBasedir()`
`File`	`getClassesDirectory()`
`String`	`getDebugForkedProcess()`
`protected String[]`	`getDefaultIncludes()`
`String`	`getEncoding()`
`File`	`getExcludesFile()`
`Boolean`	`getFailIfNoSpecifiedTests()`
`int`	`getForkedProcessExitTimeoutInSeconds()`
`int`	`getForkedProcessTimeoutInSeconds()`
`List<String>`	`getIncludes()`
`File`	`getIncludesFile()`
`protected org.apache.maven.artifact.Artifact`	`getMojoArtifact()`
`double`	`getParallelTestsTimeoutForcedInSeconds()`
`double`	`getParallelTestsTimeoutInSeconds()`
`protected String`	`getPluginName()`
`String`	`getReportFormat()`
`protected String`	`getReportSchemaLocation()`
`File`	`getReportsDirectory()`
`protected int`	`getRerunFailingTestsCount()`
`String`	`getRunOrder()`
`String`	`getShutdown()`
`int`	`getSkipAfterFailureCount()`
`File[]`	`getSuiteXmlFiles()`
`String`	`getTest()`
`File`	`getTestClassesDirectory()`
`protected void`	`handleSummary(org.apache.maven.surefire.suite.RunResult summary, Exception firstForkException)`
`protected boolean`	`hasSuiteXmlFiles()`
`boolean`	`isPrintSummary()`
`boolean`	`isSkip()`
`boolean`	`isSkipExec()`
`protected boolean`	`isSkipExecution()`
`boolean`	`isSkipTests()`
`boolean`	`isTestFailureIgnore()`
`boolean`	`isUseFile()`
`boolean`	`isUseManifestOnlyJar()`
`boolean`	`isUseSystemClassLoader()`
`void`	`setBasedir(File basedir)`
`void`	`setClassesDirectory(File classesDirectory)`
`void`	`setDebugForkedProcess(String debugForkedProcess)`
`void`	`setEncoding(String encoding)`
`void`	`setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)`
`void`	`setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)`
`void`	`setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)`
`void`	`setIncludes(List<String> includes)`
`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`	`setSkip(boolean skip)`
`void`	`setSkipExec(boolean skipExec)`
`void`	`setSkipTests(boolean skipTests)`
`void`	`setSuiteXmlFiles(File[] suiteXmlFiles)`
`void`	`setTest(String test)`
`void`	`setTestClassesDirectory(File testClassesDirectory)`
`void`	`setTestFailureIgnore(boolean testFailureIgnore)`
`void`	`setUseFile(boolean useFile)`
`void`	`setUseManifestOnlyJar(boolean useManifestOnlyJar)`
`void`	`setUseSystemClassLoader(boolean useSystemClassLoader)`
`protected List<File>`	`suiteXmlFiles()`

Methods inherited from class org.apache.maven.plugin.surefire.AbstractSurefireMojo
addPluginSpecificChecksumItems, cleanupForkConfiguration, convertWithCoreCount, createCopyAndReplaceForkNumPlaceholder, createProviders, effectiveIsEnableAssertions, execute, getAdditionalClasspathElements, getArgLine, getArtifactFactory, getArtifactResolver, getClassLoaderConfiguration, getClasspathDependencyExcludes, getClasspathDependencyScopeExclude, getConsoleLogger, getDependenciesToScan, getEffectiveForkCount, getEnvironmentVariables, getExcludedGroups, getExcludes, getFailIfNoTests, getForkCount, getForkMode, getGroups, getJunitArtifactName, getJunitPlatformArtifactName, getJvm, getLocalRepository, getMetadataSource, getObjectFactory, getParallel, getPerCoreThreadCount, getPluginArtifactMap, getPluginDescriptor, getProject, getProjectArtifactMap, getProjectBuildDirectory, getRemoteRepositories, getReportNameSuffix, getSession, getSpecificTests, getStatisticsFile, getSystemProperties, getSystemPropertiesFile, getSystemPropertyVariables, getTempDir, getTestNGArtifactName, getTestSourceDirectory, getThreadCount, getThreadCountClasses, getThreadCountMethods, getThreadCountSuites, getToolchainManager, getUseUnlimitedThreads, getWorkingDirectory, hasExecutedBefore, isAnyConcurrencySelected, isAnyGroupsSelected, isChildDelegation, isDisableXmlReport, isEnableAssertions, isForking, isMavenParallel, isParallelOptimized, isRedirectTestOutputToFile, isReuseForks, isTrimStackTrace, logDebugOrCliShowErrors, logReportsDirectory, setAdditionalClasspathElements, setArgLine, setArtifactFactory, setArtifactResolver, setChildDelegation, setClasspathDependencyExcludes, setClasspathDependencyScopeExclude, setDependenciesToScan, setDisableXmlReport, setEnableAssertions, setEnvironmentVariables, setExcludedGroups, setExcludes, setFailIfNoTests, setForkMode, setGroups, setJunitArtifactName, setJunitPlatformArtifactName, setLocalRepository, setMetadataSource, setObjectFactory, setParallel, setParallelOptimized, setPerCoreThreadCount, setPluginArtifactMap, setProject, setProjectArtifactMap, setProjectBuildDirectory, setProperties, setRedirectTestOutputToFile, setRemoteRepositories, setReportNameSuffix, setSession, setSystemProperties, setSystemPropertiesFile, 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 org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - handleSummary
```
protected void handleSummary(org.apache.maven.surefire.suite.RunResult summary,
                             Exception firstForkException)
                      throws org.apache.maven.plugin.MojoExecutionException,
                             org.apache.maven.plugin.MojoFailureException
```
    Specified by:
    
    handleSummary in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
    
    org.apache.maven.plugin.MojoFailureException
  - isSkipExecution
```
protected boolean isSkipExecution()
```
    Specified by:
    
    isSkipExecution in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getPluginName
```
protected String getPluginName()
```
    Specified by:
    
    getPluginName in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getDefaultIncludes
```
protected String[] getDefaultIncludes()
```
    Specified by:
    
    getDefaultIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getReportSchemaLocation
```
protected String getReportSchemaLocation()
```
    Specified by:
    
    getReportSchemaLocation in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getMojoArtifact
```
protected org.apache.maven.artifact.Artifact getMojoArtifact()
```
    Specified by:
    
    getMojoArtifact in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - isSkipTests
```
public boolean isSkipTests()
```
    Specified by:
    
    isSkipTests in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    isSkipTests in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setSkipTests
```
public void setSkipTests(boolean skipTests)
```
    Specified by:
    
    setSkipTests in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setSkipTests in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - isSkipExec
```
public boolean isSkipExec()
```
    Specified by:
    
    isSkipExec in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    isSkipExec in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setSkipExec
```
public void setSkipExec(boolean skipExec)
```
    Specified by:
    
    setSkipExec in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setSkipExec in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - isSkip
```
public boolean isSkip()
```
    Specified by:
    
    isSkip in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    isSkip in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setSkip
```
public void setSkip(boolean skip)
```
    Specified by:
    
    setSkip in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setSkip in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - isTestFailureIgnore
```
public boolean isTestFailureIgnore()
```
    Specified by:
    
    isTestFailureIgnore in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setTestFailureIgnore
```
public void setTestFailureIgnore(boolean testFailureIgnore)
```
    Specified by:
    
    setTestFailureIgnore in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - getBasedir
```
public File getBasedir()
```
    Specified by:
    
    getBasedir in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    getBasedir in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setBasedir
```
public void setBasedir(File basedir)
```
    Specified by:
    
    setBasedir in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setBasedir in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - getTestClassesDirectory
```
public File getTestClassesDirectory()
```
    Specified by:
    
    getTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    getTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setTestClassesDirectory
```
public void setTestClassesDirectory(File testClassesDirectory)
```
    Specified by:
    
    setTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - getClassesDirectory
```
public File getClassesDirectory()
```
    Specified by:
    
    getClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setClassesDirectory
```
public void setClassesDirectory(File classesDirectory)
```
    Specified by:
    
    setClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getReportsDirectory
```
public File getReportsDirectory()
```
    Specified by:
    
    getReportsDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    getReportsDirectory in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - setReportsDirectory
```
public void setReportsDirectory(File reportsDirectory)
```
    Specified by:
    
    setReportsDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setReportsDirectory in interface org.apache.maven.plugin.surefire.SurefireReportParameters
  - getTest
```
public String getTest()
```
    Specified by:
    
    getTest in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - isUseSystemClassLoader
```
public boolean isUseSystemClassLoader()
```
    Specified by:
    
    isUseSystemClassLoader in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setUseSystemClassLoader
```
public void setUseSystemClassLoader(boolean useSystemClassLoader)
```
    Specified by:
    
    setUseSystemClassLoader in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - isUseManifestOnlyJar
```
public boolean isUseManifestOnlyJar()
```
    Specified by:
    
    isUseManifestOnlyJar in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setUseManifestOnlyJar
```
public void setUseManifestOnlyJar(boolean useManifestOnlyJar)
```
    Specified by:
    
    setUseManifestOnlyJar in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getEncoding
```
public String getEncoding()
```
    Specified by:
    
    getEncoding in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setEncoding
```
public void setEncoding(String encoding)
```
    Specified by:
    
    setEncoding in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getFailIfNoSpecifiedTests
```
public Boolean getFailIfNoSpecifiedTests()
```
    Specified by:
    
    getFailIfNoSpecifiedTests in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setFailIfNoSpecifiedTests
```
public void setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)
```
    Specified by:
    
    setFailIfNoSpecifiedTests in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getSkipAfterFailureCount
```
public int getSkipAfterFailureCount()
```
    Specified by:
    
    getSkipAfterFailureCount in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getShutdown
```
public String getShutdown()
```
    Specified by:
    
    getShutdown in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - isPrintSummary
```
public boolean isPrintSummary()
```
    Specified by:
    
    isPrintSummary in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setPrintSummary
```
public void setPrintSummary(boolean printSummary)
```
    Specified by:
    
    setPrintSummary in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getReportFormat
```
public String getReportFormat()
```
    Specified by:
    
    getReportFormat in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setReportFormat
```
public void setReportFormat(String reportFormat)
```
    Specified by:
    
    setReportFormat in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - isUseFile
```
public boolean isUseFile()
```
    Specified by:
    
    isUseFile in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setUseFile
```
public void setUseFile(boolean useFile)
```
    Specified by:
    
    setUseFile in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getDebugForkedProcess
```
public String getDebugForkedProcess()
```
    Specified by:
    
    getDebugForkedProcess in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setDebugForkedProcess
```
public void setDebugForkedProcess(String debugForkedProcess)
```
    Specified by:
    
    setDebugForkedProcess in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getForkedProcessTimeoutInSeconds
```
public int getForkedProcessTimeoutInSeconds()
```
    Specified by:
    
    getForkedProcessTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setForkedProcessTimeoutInSeconds
```
public void setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)
```
    Specified by:
    
    setForkedProcessTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getForkedProcessExitTimeoutInSeconds
```
public int getForkedProcessExitTimeoutInSeconds()
```
    Specified by:
    
    getForkedProcessExitTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setForkedProcessExitTimeoutInSeconds
```
public void setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)
```
    Specified by:
    
    setForkedProcessExitTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getParallelTestsTimeoutInSeconds
```
public double getParallelTestsTimeoutInSeconds()
```
    Specified by:
    
    getParallelTestsTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setParallelTestsTimeoutInSeconds
```
public void setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)
```
    Specified by:
    
    setParallelTestsTimeoutInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getParallelTestsTimeoutForcedInSeconds
```
public double getParallelTestsTimeoutForcedInSeconds()
```
    Specified by:
    
    getParallelTestsTimeoutForcedInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setParallelTestsTimeoutForcedInSeconds
```
public void setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)
```
    Specified by:
    
    setParallelTestsTimeoutForcedInSeconds in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - setTest
```
public void setTest(String test)
```
    Specified by:
    
    setTest in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
  - getIncludes
```
public List<String> getIncludes()
```
    Specified by:
    
    getIncludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    getIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - setIncludes
```
public void setIncludes(List<String> includes)
```
    Specified by:
    
    setIncludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
    
    Specified by:
    
    setIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getSuiteXmlFiles
```
public File[] getSuiteXmlFiles()
```
    Specified by:
    
    getSuiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - setSuiteXmlFiles
```
public void setSuiteXmlFiles(File[] suiteXmlFiles)
```
    Specified by:
    
    setSuiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getRunOrder
```
public String getRunOrder()
```
    Specified by:
    
    getRunOrder in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - setRunOrder
```
public void setRunOrder(String runOrder)
```
    Specified by:
    
    setRunOrder in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getIncludesFile
```
public File getIncludesFile()
```
    Specified by:
    
    getIncludesFile in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - getExcludesFile
```
public File getExcludesFile()
```
    Specified by:
    
    getExcludesFile in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - suiteXmlFiles
```
protected final List<File> suiteXmlFiles()
```
    Specified by:
    
    suiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
  - hasSuiteXmlFiles
```
protected final boolean hasSuiteXmlFiles()
```
    Specified by:
    
    hasSuiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

Class SurefirePlugin

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SurefirePlugin

Method Detail

getRerunFailingTestsCount

handleSummary

isSkipExecution

getPluginName

getDefaultIncludes

getReportSchemaLocation

getMojoArtifact

isSkipTests

setSkipTests

isSkipExec

setSkipExec

isSkip

setSkip

isTestFailureIgnore

setTestFailureIgnore

getBasedir

setBasedir

getTestClassesDirectory

setTestClassesDirectory

getClassesDirectory

setClassesDirectory

getReportsDirectory

setReportsDirectory

getTest

isUseSystemClassLoader

setUseSystemClassLoader

isUseManifestOnlyJar

setUseManifestOnlyJar

getEncoding

setEncoding

getFailIfNoSpecifiedTests

setFailIfNoSpecifiedTests

getSkipAfterFailureCount

getShutdown

isPrintSummary

setPrintSummary

getReportFormat

setReportFormat

isUseFile

setUseFile

getDebugForkedProcess

setDebugForkedProcess

getForkedProcessTimeoutInSeconds

setForkedProcessTimeoutInSeconds

getForkedProcessExitTimeoutInSeconds

setForkedProcessExitTimeoutInSeconds

getParallelTestsTimeoutInSeconds

setParallelTestsTimeoutInSeconds

getParallelTestsTimeoutForcedInSeconds

setParallelTestsTimeoutForcedInSeconds

setTest

getIncludes

setIncludes

getSuiteXmlFiles

setSuiteXmlFiles

getRunOrder

setRunOrder

getIncludesFile

getExcludesFile

suiteXmlFiles

hasSuiteXmlFiles