Package org.apache.maven.plugin.surefire

Class SurefireMojo

  • 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 SurefireMojo
extends org.apache.maven.plugin.surefire.AbstractSurefireMojo
implements org.apache.maven.plugin.surefire.SurefireReportParameters
    Run tests using Surefire.
    Author:
    Jason van Zyl

    • Constructor Detail

      • SurefireMojo

        public SurefireMojo()

    • Method Detail

      • getRerunFailingTestsCount

        protected int getRerunFailingTestsCount()
        Specified by:
        getRerunFailingTestsCount in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getFailOnFlakeCount

        public int getFailOnFlakeCount()
        Specified by:
        getFailOnFlakeCount in interface org.apache.maven.plugin.surefire.SurefireReportParameters

      • setFailOnFlakeCount

        public void setFailOnFlakeCount​(int failOnFlakeCount)
        Specified by:
        setFailOnFlakeCount in interface org.apache.maven.plugin.surefire.SurefireReportParameters

      • handleSummary

        protected void handleSummary​(org.apache.maven.surefire.api.suite.RunResult summary,
                             java.lang.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 java.lang.String getPluginName()
        Specified by:
        getPluginName in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getDefaultIncludes

        protected java.lang.String[] getDefaultIncludes()
        Specified by:
        getDefaultIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getReportSchemaLocation

        protected java.lang.String getReportSchemaLocation()
        Specified by:
        getReportSchemaLocation in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getSystemPropertiesFile

        public java.io.File getSystemPropertiesFile()
        Specified by:
        getSystemPropertiesFile in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setSystemPropertiesFile

        public void setSystemPropertiesFile​(java.io.File systemPropertiesFile)
        Specified by:
        setSystemPropertiesFile 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

        @Deprecated
public boolean isSkipExec()
        Deprecated.
        Specified by:
        isSkipExec in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
        Specified by:
        isSkipExec in interface org.apache.maven.plugin.surefire.SurefireReportParameters

      • setSkipExec

        @Deprecated
public void setSkipExec​(boolean skipExec)
        Deprecated.
        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 java.io.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​(java.io.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 java.io.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​(java.io.File testClassesDirectory)
        Specified by:
        setTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
        Specified by:
        setTestClassesDirectory in interface org.apache.maven.plugin.surefire.SurefireReportParameters

      • getMainBuildPath

        public java.io.File getMainBuildPath()
        Specified by:
        getMainBuildPath in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setMainBuildPath

        public void setMainBuildPath​(java.io.File mainBuildPath)
        Specified by:
        setMainBuildPath in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • getReportsDirectory

        public java.io.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​(java.io.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 java.lang.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 java.lang.String getEncoding()
        Specified by:
        getEncoding in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setEncoding

        public void setEncoding​(java.lang.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 java.lang.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 java.lang.String getReportFormat()
        Specified by:
        getReportFormat in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setReportFormat

        public void setReportFormat​(java.lang.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 java.lang.String getDebugForkedProcess()
        Specified by:
        getDebugForkedProcess in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setDebugForkedProcess

        public void setDebugForkedProcess​(java.lang.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​(java.lang.String test)
        Specified by:
        setTest in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • getIncludes

        public java.util.List<java.lang.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​(java.util.List<java.lang.String> includes)
        Specified by:
        setIncludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
        Specified by:
        setIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getExcludes

        public java.util.List<java.lang.String> getExcludes()
        Specified by:
        getExcludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setExcludes

        public void setExcludes​(java.util.List<java.lang.String> excludes)
        Specified by:
        setExcludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • getSuiteXmlFiles

        public java.io.File[] getSuiteXmlFiles()
        Specified by:
        getSuiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setSuiteXmlFiles

        public void setSuiteXmlFiles​(java.io.File[] suiteXmlFiles)
        Specified by:
        setSuiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getRunOrder

        public java.lang.String getRunOrder()
        Specified by:
        getRunOrder in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setRunOrder

        public void setRunOrder​(java.lang.String runOrder)
        Specified by:
        setRunOrder in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getRunOrderRandomSeed

        public java.lang.Long getRunOrderRandomSeed()
        Specified by:
        getRunOrderRandomSeed in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setRunOrderRandomSeed

        public void setRunOrderRandomSeed​(java.lang.Long runOrderRandomSeed)
        Specified by:
        setRunOrderRandomSeed in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getRunOrderStatisticsFileChecksum

        public java.lang.String getRunOrderStatisticsFileChecksum()
        Specified by:
        getRunOrderStatisticsFileChecksum in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setRunOrderStatisticsFileChecksum

        public void setRunOrderStatisticsFileChecksum​(java.lang.String runOrderStatisticsFileChecksum)
        Specified by:
        setRunOrderStatisticsFileChecksum in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getIncludesFile

        public java.io.File getIncludesFile()
        Specified by:
        getIncludesFile in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getExcludesFile

        public java.io.File getExcludesFile()
        Specified by:
        getExcludesFile in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • useModulePath

        protected boolean useModulePath()
        Specified by:
        useModulePath in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • setUseModulePath

        protected void setUseModulePath​(boolean useModulePath)
        Specified by:
        setUseModulePath in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • suiteXmlFiles

        protected final java.util.List<java.io.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

      • getExcludedEnvironmentVariables

        protected final java.lang.String[] getExcludedEnvironmentVariables()
        Specified by:
        getExcludedEnvironmentVariables in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getEnableProcessChecker

        protected final java.lang.String getEnableProcessChecker()
        Specified by:
        getEnableProcessChecker in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getForkNode

        protected final org.apache.maven.surefire.extensions.ForkNodeFactory getForkNode()
        Specified by:
        getForkNode in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • warnIfIllegalFailOnFlakeCount

        protected void warnIfIllegalFailOnFlakeCount()
                                      throws org.apache.maven.plugin.MojoFailureException
        Overrides:
        warnIfIllegalFailOnFlakeCount in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
        Throws:
        org.apache.maven.plugin.MojoFailureException

      • addPluginSpecificChecksumItems

        protected void addPluginSpecificChecksumItems​(org.apache.maven.plugin.surefire.booterclient.ChecksumCalculator checksum)
        Overrides:
        addPluginSpecificChecksumItems in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

      • getIncludeJUnit5Engines

        public java.lang.String[] getIncludeJUnit5Engines()
        Specified by:
        getIncludeJUnit5Engines in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setIncludeJUnit5Engines

        public void setIncludeJUnit5Engines​(java.lang.String[] includeJUnit5Engines)
        Specified by:
        setIncludeJUnit5Engines in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • getExcludeJUnit5Engines

        public java.lang.String[] getExcludeJUnit5Engines()
        Specified by:
        getExcludeJUnit5Engines in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

      • setExcludeJUnit5Engines

        public void setExcludeJUnit5Engines​(java.lang.String[] excludeJUnit5Engines)
        Specified by:
        setExcludeJUnit5Engines in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters