Class SurefireMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.surefire.AbstractSurefireMojo
org.apache.maven.plugin.surefire.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 Details

    • SurefireMojo

      public SurefireMojo()

  • Method Details

    • 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, 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

    • getSystemPropertiesFile

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

    • setSystemPropertiesFile

      public void setSystemPropertiesFile(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 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

    • getMainBuildPath

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

    • setMainBuildPath

      public void setMainBuildPath(File mainBuildPath)
      Specified by:
      setMainBuildPath 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

    • getExcludes

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

    • setExcludes

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

    • 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

    • getRunOrderRandomSeed

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

    • setRunOrderRandomSeed

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

    • getRunOrderStatisticsFileChecksum

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

    • setRunOrderStatisticsFileChecksum

      public void setRunOrderStatisticsFileChecksum(String runOrderStatisticsFileChecksum)
      Specified by:
      setRunOrderStatisticsFileChecksum 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

    • 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 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

    • getExcludedEnvironmentVariables

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

    • getEnableProcessChecker

      protected final 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 String[] getIncludeJUnit5Engines()
      Specified by:
      getIncludeJUnit5Engines in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters

    • setIncludeJUnit5Engines

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

    • getExcludeJUnit5Engines

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

    • setExcludeJUnit5Engines

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