Package org.apache.maven.plugin.surefire

Class AbstractSurefireMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.surefire.AbstractSurefireMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, SurefireExecutionParameters
Direct Known Subclasses:
IntegrationTestMojo, SurefirePlugin
public abstract class AbstractSurefireMojo extends org.apache.maven.plugin.AbstractMojo implements SurefireExecutionParameters
Abstract base class for running tests using Surefire.
Version:
$Id: SurefirePlugin.java 945065 2010-05-17 10:26:22Z stephenc $

  • Field Details

    • FORK_ONCE

      private static final String FORK_ONCE
      See Also:

    • FORK_ALWAYS

      private static final String FORK_ALWAYS
      See Also:

    • FORK_NEVER

      private static final String FORK_NEVER
      See Also:

    • FORK_PERTHREAD

      private static final String FORK_PERTHREAD
      See Also:

    • JAVA_9_MATCHER_OLD_NOTATION

      private static final Map<String,String> JAVA_9_MATCHER_OLD_NOTATION

    • JAVA_9_MATCHER

      private static final Map<String,String> JAVA_9_MATCHER

    • PLATFORM

      private static final Platform PLATFORM

    • providerDetector

      private final ProviderDetector providerDetector

    • classpathCache

      private final AbstractSurefireMojo.ClasspathCache classpathCache

    • statelessTestsetReporter

      @Parameter private SurefireStatelessReporter statelessTestsetReporter
      Note: use the legacy system property disableXmlReport set to true to disable the report.

    • consoleOutputReporter

      @Parameter private SurefireConsoleOutputReporter consoleOutputReporter

    • statelessTestsetInfoReporter

      @Parameter private SurefireStatelessTestsetInfoReporter statelessTestsetInfoReporter

    • pluginDescriptor

      @Parameter(defaultValue="${plugin}", readonly=true, required=true) private org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor
      Information about this plugin, mainly used to lookup this plugin's configuration from the currently executing project.
      Since:
      2.12

    • skipTests

      @Parameter(property="skipTests", defaultValue="false") protected boolean skipTests
      Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
      Failsafe plugin deprecated the parameter skipTests and the parameter will be removed in Failsafe 3.0.0 as it is a source of conflicts between Failsafe and Surefire plugin.
      Since:
      2.4

    • skipExec

      @Deprecated @Parameter(property="maven.test.skip.exec") protected boolean skipExec
      Deprecated.
      Use skipTests instead.
      This old parameter is just like skipTests, but bound to the old property "maven.test.skip.exec".
      Since:
      2.3

    • skip

      @Parameter(property="maven.test.skip", defaultValue="false") protected boolean skip
      Set this to "true" to bypass unit tests entirely. Its use is NOT RECOMMENDED, especially if you enable it using the "maven.test.skip" property, because maven.test.skip disables both running the tests and compiling the tests. Consider using the skipTests parameter instead.

    • project

      @Parameter(defaultValue="${project}", required=true, readonly=true) private org.apache.maven.project.MavenProject project
      The Maven Project Object.

    • basedir

      @Parameter(defaultValue="${basedir}", readonly=true, required=true) protected File basedir
      The base directory of the project being tested. This can be obtained in your integration test via System.getProperty("basedir").

    • testClassesDirectory

      @Parameter(defaultValue="${project.build.testOutputDirectory}") protected File testClassesDirectory
      The directory containing generated test classes of the project being tested. This will be included at the beginning of the test classpath. *

    • classpathDependencyExcludes

      @Parameter(property="maven.test.dependency.excludes") private String[] classpathDependencyExcludes
      List of dependencies to exclude from the test classpath. Each dependency string must follow the format groupId:artifactId. For example: org.acme:project-a
      Since:
      2.6

    • classpathDependencyScopeExclude

      @Parameter(defaultValue="") private String classpathDependencyScopeExclude
      A dependency scope to exclude from the test classpath. The scope should be one of the scopes defined by org.apache.maven.artifact.Artifact. This includes the following:
      • compile - system, provided, compile
      • runtime - compile, runtime
      • compile+runtime - system, provided, compile, runtime
      • runtime+system - system, compile, runtime
      • test - system, provided, compile, runtime, test
      Since:
      2.6

    • additionalClasspathElements

      @Parameter(property="maven.test.additionalClasspath") private String[] additionalClasspathElements
      Additional elements to be appended to the classpath.
      Since:
      2.4

    • testSourceDirectory

      @Parameter(defaultValue="${project.build.testSourceDirectory}", required=true) private File testSourceDirectory
      The test source directory containing test class sources.
      Since:
      2.2

    • excludes

      @Parameter private List<String> excludes
      A list of <exclude> elements specifying the tests (by pattern) that should be excluded in testing. When not specified and when the test parameter is not specified, the default excludes will be 
      
 <excludes>
     <exclude>**/*$*</exclude>
 </excludes>
      (which excludes all inner classes).
      This parameter is ignored if the TestNG suiteXmlFiles parameter is specified.
      Each exclude item may also contain a comma-separated sub-list of items, which will be treated as multiple  <exclude> entries.
      Since 2.19 a complex syntax is supported in one parameter (JUnit 4, JUnit 4.7+, TestNG): 
      
 <exclude>%regex[pkg.*Slow.*.class], Unstable*</exclude>

      Notice that these values are relative to the directory containing generated test classes of the project being tested. This directory is declared by the parameter testClassesDirectory which defaults to the POM property ${project.build.testOutputDirectory}, typically src/test/java unless overridden.

    • localRepository

      @Parameter(defaultValue="${localRepository}", required=true, readonly=true) private org.apache.maven.artifact.repository.ArtifactRepository localRepository
      ArtifactRepository of the localRepository. To obtain the directory of localRepository in unit tests use System.getProperty("localRepository").

    • systemProperties

      @Deprecated @Parameter private Properties systemProperties
      Deprecated.
      Use systemPropertyVariables instead.
      List of System properties to pass to the JUnit tests.

    • systemPropertyVariables

      @Parameter private Map<String,String> systemPropertyVariables
      List of System properties to pass to the JUnit tests.
      Since:
      2.5

    • systemPropertiesFile

      @Parameter private File systemPropertiesFile
      List of System properties, loaded from a file, to pass to the JUnit tests.
      Since:
      2.8.2

    • properties

      @Parameter private Properties properties
      List of properties for configuring all TestNG related configurations. This is the new preferred method of configuring TestNG.
      Since:
      2.4

    • pluginArtifactMap

      @Parameter(property="plugin.artifactMap", required=true, readonly=true) private Map<String,org.apache.maven.artifact.Artifact> pluginArtifactMap
      Map of plugin artifacts.

    • projectArtifactMap

      @Parameter(property="project.artifactMap", readonly=true, required=true) private Map<String,org.apache.maven.artifact.Artifact> projectArtifactMap
      Map of project artifacts.

    • reportNameSuffix

      @Parameter(property="surefire.reportNameSuffix", defaultValue="") private String reportNameSuffix
      Add custom text into report filename: TEST-testClassName-reportNameSuffix.xml, testClassName-reportNameSuffix.txt and testClassName-reportNameSuffix-output.txt. File TEST-testClassName-reportNameSuffix.xml has changed attributes 'testsuite'--'name' and 'testcase'--'classname' - reportNameSuffix is added to the attribute value.

    • redirectTestOutputToFile

      @Parameter(property="maven.test.redirectTestOutputToFile", defaultValue="false") private boolean redirectTestOutputToFile
      Set this to "true" to redirect the unit test standard output to a file (found in reportsDirectory/testName-output.txt).
      Since:
      2.3

    • failIfNoTests

      @Parameter(property="failIfNoTests") private Boolean failIfNoTests
      Set this to "true" to cause a failure if there are no tests to run. Defaults to "false".
      Since:
      2.4

    • forkMode

      @Parameter(property="forkMode", defaultValue="once") private String forkMode
      DEPRECATED since version 2.14. Use forkCount and reuseForks instead.

      Option to specify the forking mode. Can be never, once, always, perthread.
      The none and pertest are also accepted for backwards compatibility.
      The always forks for each test-class.
      The perthread creates the number of parallel forks specified by threadCount, where each forked JVM is executing one test-class. See also the parameter reuseForks for the lifetime of JVM.
      Since:
      2.1

    • tempDir

      @Parameter(property="tempDir", defaultValue="surefire") private String tempDir
      Relative path to temporary-surefire-boot directory containing internal Surefire temporary files.
      The temporary-surefire-boot directory is project.build.directory on most platforms or system default temporary-directory specified by the system property java.io.tmpdir on Windows (see SUREFIRE-1400).
      It is deleted after the test set has completed.
      Since:
      2.20

    • jvm

      @Parameter(property="jvm") private String jvm
      Option to specify the jvm (or path to the java executable) to use with the forking options. For the default, the jvm will be a new instance of the same VM as the one used to run Maven. JVM settings are not inherited from MAVEN_OPTS.
      Since:
      2.1

    • argLine

      @Parameter(property="argLine") private String argLine
      Arbitrary JVM options to set on the command line.

      Since the Version 2.17 using an alternate syntax for argLine, @{...} allows late replacement of properties when the plugin is executed, so properties that have been modified by other plugins will be picked up correctly. See the Frequently Asked Questions page with more details:
      http://maven.apache.org/surefire/maven-surefire-plugin/faq.html
      http://maven.apache.org/surefire/maven-failsafe-plugin/faq.html
      Since:
      2.1

    • environmentVariables

      @Parameter private Map<String,String> environmentVariables
      Additional environment variables to set on the command line.
      Since:
      2.1.3

    • workingDirectory

      @Parameter(property="basedir") private File workingDirectory
      Command line working directory.
      Since:
      2.1.3

    • childDelegation

      @Parameter(property="childDelegation", defaultValue="false") private boolean childDelegation
      When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not none).
      Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser.
      Since:
      2.1

    • groups

      @Parameter(property="groups") private String groups
      (TestNG/JUnit47 provider with JUnit4.8+ only) Groups for this test. Only classes/methods/etc decorated with one of the groups specified here will be included in test run, if specified.
      For JUnit, this parameter forces the use of the 4.7 provider
      This parameter is ignored if the suiteXmlFiles parameter is specified.
      Since version 2.18.1 and JUnit 4.12, the @Category annotation type is automatically inherited from superclasses, see @java.lang.annotation.Inherited. Make sure that test class inheritance still makes sense together with @Category annotation of the JUnit 4.12 or higher appeared in superclass.
      Since:
      2.2

    • excludedGroups

      @Parameter(property="excludedGroups") private String excludedGroups
      (TestNG/JUnit47 provider with JUnit4.8+ only) Excluded groups. Any methods/classes/etc with one of the groups specified in this list will specifically not be run.
      For JUnit, this parameter forces the use of the 4.7 provider.
      This parameter is ignored if the suiteXmlFiles parameter is specified.
      Since version 2.18.1 and JUnit 4.12, the @Category annotation type is automatically inherited from superclasses, see @java.lang.annotation.Inherited. Make sure that test class inheritance still makes sense together with @Category annotation of the JUnit 4.12 or higher appeared in superclass.
      Since:
      2.2

    • junitArtifactName

      @Parameter(property="junitArtifactName", defaultValue="junit:junit") private String junitArtifactName
      Allows you to specify the name of the JUnit artifact. If not set, junit:junit will be used.
      Since:
      2.3.1

    • testNGArtifactName

      @Parameter(property="testNGArtifactName", defaultValue="org.testng:testng") private String testNGArtifactName
      Allows you to specify the name of the TestNG artifact. If not set, org.testng:testng will be used.
      Since:
      2.3.1

    • threadCount

      @Parameter(property="threadCount") private int threadCount
      (TestNG/JUnit 4.7 provider) The attribute thread-count allows you to specify how many threads should be allocated for this execution. Only makes sense to use in conjunction with the parallel parameter.
      Since:
      2.2

    • forkCount

      @Parameter(property="forkCount", defaultValue="1") private String forkCount
      Option to specify the number of VMs to fork in parallel in order to execute the tests. When terminated with "C", the number part is multiplied with the number of CPU cores. Floating point value are only accepted together with "C". If set to "0", no VM is forked and all tests are executed within the main process.

      Example values: "1.5C", "4"

      The system properties and the argLine of the forked processes may contain the place holder string ${surefire.forkNumber}, which is replaced with a fixed number for each of the parallel forks, ranging from 1 to the effective value of forkCount times the maximum number of parallel Surefire executions in maven parallel builds, i.e. the effective value of the -T command line argument of maven core.
      Since:
      2.14

    • reuseForks

      @Parameter(property="reuseForks", defaultValue="true") private boolean reuseForks
      Indicates if forked VMs can be reused. If set to "false", a new VM is forked for each test class to be executed. If set to "true", up to forkCount VMs will be forked and then reused to execute all tests.
      Since:
      2.13

    • perCoreThreadCount

      @Parameter(property="perCoreThreadCount", defaultValue="true") private boolean perCoreThreadCount
      (JUnit 4.7 provider) Indicates that threadCount, threadCountSuites, threadCountClasses, threadCountMethods are per cpu core.
      Since:
      2.5

    • useUnlimitedThreads

      @Parameter(property="useUnlimitedThreads", defaultValue="false") private boolean useUnlimitedThreads
      (JUnit 4.7 provider) Indicates that the thread pool will be unlimited. The parallel parameter and the actual number of classes/methods will decide. Setting this to "true" effectively disables perCoreThreadCount and threadCount. Defaults to "false".
      Since:
      2.5

    • parallel

      @Parameter(property="parallel") private String parallel
      (TestNG provider) When you use the parameter parallel, TestNG will try to run all your test methods in separate threads, except for methods that depend on each other, which will be run in the same thread in order to respect their order of execution.
      (JUnit 4.7 provider) Supports values classes, methods, both to run in separate threads been controlled by threadCount.

      Since version 2.16 (JUnit 4.7 provider), the value both is DEPRECATED. Use classesAndMethods instead.

      Since version 2.16 (JUnit 4.7 provider), additional vales are available:
      suites, suitesAndClasses, suitesAndMethods, classesAndMethods, all.
      By default, Surefire does not execute tests in parallel. You can set the parameter parallel to none to explicitly disable parallel execution (e.g. when disabling parallel execution in special Maven profiles when executing coverage analysis).
      Since:
      2.2

    • parallelOptimized

      @Parameter(property="parallelOptimized", defaultValue="true") private boolean parallelOptimized
      (JUnit 4.7 / provider only) The thread counts do not exceed the number of parallel suite, class runners and average number of methods per class if set to true.
      True by default.
      Since:
      2.17

    • threadCountSuites

      @Parameter(property="threadCountSuites", defaultValue="0") private int threadCountSuites
      (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test suites, i.e.:
      • number of concurrent suites if threadCount is 0 or unspecified
      • limited suites concurrency if useUnlimitedThreads is set to true
      • if threadCount and certain thread-count parameters are > 0 for parallel, the concurrency is computed from ratio. For instance parallel=all and the ratio between threadCountSuites:threadCountClasses:threadCountMethods is 2:3:5, there is 20% of threadCount which appeared in concurrent suites.
      Only makes sense to use in conjunction with the parallel parameter. The default value 0 behaves same as unspecified one.
      Since:
      2.16

    • threadCountClasses

      @Parameter(property="threadCountClasses", defaultValue="0") private int threadCountClasses
      (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test classes, i.e.:
      • number of concurrent classes if threadCount is 0 or unspecified
      • limited classes concurrency if useUnlimitedThreads is set to true
      • if threadCount and certain thread-count parameters are > 0 for parallel, the concurrency is computed from ratio. For instance parallel=all and the ratio between threadCountSuites:threadCountClasses:threadCountMethods is 2:3:5, there is 30% of threadCount in concurrent classes.
      • as in the previous case but without this leaf thread-count. Example: parallel=suitesAndClasses, threadCount=16, threadCountSuites=5, threadCountClasses is unspecified leaf, the number of concurrent classes is varying from >= 11 to 14 or 15. The threadCountSuites become given number of threads.
      Only makes sense to use in conjunction with the parallel parameter. The default value 0 behaves same as unspecified one.
      Since:
      2.16

    • threadCountMethods

      @Parameter(property="threadCountMethods", defaultValue="0") private int threadCountMethods
      (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test methods, i.e.:
      • number of concurrent methods if threadCount is 0 or unspecified
      • limited concurrency of methods if useUnlimitedThreads is set to true
      • if threadCount and certain thread-count parameters are > 0 for parallel, the concurrency is computed from ratio. For instance parallel=all and the ratio between threadCountSuites:threadCountClasses:threadCountMethods is 2:3:5, there is 50% of threadCount which appears in concurrent methods.
      • as in the previous case but without this leaf thread-count. Example: parallel=all, threadCount=16, threadCountSuites=2, threadCountClasses=3, but threadCountMethods is unspecified leaf, the number of concurrent methods is varying from >= 11 to 14 or 15. The threadCountSuites and threadCountClasses become given number of threads.
      Only makes sense to use in conjunction with the parallel parameter. The default value 0 behaves same as unspecified one.
      Since:
      2.16

    • trimStackTrace

      @Parameter(property="trimStackTrace", defaultValue="true") private boolean trimStackTrace
      Whether to trim the stack trace in the reports to just the lines within the test, or show the full trace.
      Since:
      2.2

    • remoteRepositories

      @Parameter(defaultValue="${project.pluginArtifactRepositories}", readonly=true, required=true) private List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories
      The remote plugin repositories declared in the POM.
      Since:
      2.2

    • projectRemoteRepositories

      @Parameter(defaultValue="${project.remoteArtifactRepositories}", required=true, readonly=true) private List<org.apache.maven.artifact.repository.ArtifactRepository> projectRemoteRepositories

    • disableXmlReport

      @Deprecated @Parameter(property="disableXmlReport", defaultValue="false") private boolean disableXmlReport
      Deprecated.
      Flag to disable the generation of report files in xml format. Deprecated since 3.0.0-M4. Instead use disable within statelessTestsetReporter since of 3.0.0-M6.
      Since:
      2.2

    • enableAssertions

      @Parameter(property="enableAssertions", defaultValue="true") private boolean enableAssertions
      By default, Surefire enables JVM assertions for the execution of your test cases. To disable the assertions, set this flag to "false".
      Since:
      2.3.1

    • session

      @Parameter(defaultValue="${session}", required=true, readonly=true) private org.apache.maven.execution.MavenSession session
      The current build session instance.

    • logger

      @Component private org.codehaus.plexus.logging.Logger logger

    • objectFactory

      @Parameter(property="objectFactory") private String objectFactory
      (TestNG only) Define the factory class used to create all test instances.
      Since:
      2.5

    • parallelMavenExecution

      @Parameter(defaultValue="${session.parallel}", readonly=true) private Boolean parallelMavenExecution
      Parallel Maven Execution.

    • projectBuildDirectory

      @Parameter(defaultValue="${project.build.directory}", readonly=true, required=true) private File projectBuildDirectory
      Read-only parameter with value of Maven property project.build.directory.
      Since:
      2.20

    • dependenciesToScan

      @Parameter(property="dependenciesToScan") private String[] dependenciesToScan
      List of dependencies to scan for test classes to include in the test run. The child elements of this element must be <dependency> elements, and the contents of each of these elements must be a string which follows the general form:

      groupId[:artifactId[:type[:classifier][:version]]]

      The wildcard character * can be used within the sub parts of those composite identifiers to do glob-like pattern matching. The classifier may be omitted when matching dependencies without a classifier.

      Examples:

      • group or, equivalently, group:*
      • g*p:*rtifac*
      • group:*:jar
      • group:artifact:*:1.0.0 (no classifier)
      • group:*:test-jar:tests
      • *:artifact:*:*:1.0.0

      Since version 2.22.0 you can scan for test classes from a project dependency of your multi-module project.

      In versions before 3.0.0-M4, only groupId:artifactId is supported.

      Since:
      2.15

    • toolchainManager

      @Component private org.apache.maven.toolchain.ToolchainManager toolchainManager

    • locationManager

      @Component private org.codehaus.plexus.languages.java.jpms.LocationManager locationManager

    • repositorySystem

      @Component private org.apache.maven.repository.RepositorySystem repositorySystem

    • dependencyResolver

      @Component private org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver

    • surefireBooterArtifact

      private org.apache.maven.artifact.Artifact surefireBooterArtifact

    • toolchain

      private org.apache.maven.toolchain.Toolchain toolchain

    • effectiveForkCount

      private int effectiveForkCount

    • surefireDependencyResolver

      private SurefireDependencyResolver surefireDependencyResolver

    • specificTests

      private TestListResolver specificTests

    • includedExcludedTests

      private TestListResolver includedExcludedTests

    • cli

      private List<CommandLineOption> cli

    • consoleLogger

      private volatile PluginConsoleLogger consoleLogger

  • Constructor Details

    • AbstractSurefireMojo

      public AbstractSurefireMojo()

  • Method Details

    • getPluginName

      protected abstract String getPluginName()

    • getRerunFailingTestsCount

      protected abstract int getRerunFailingTestsCount()

    • getIncludes

      public abstract List<String> getIncludes()
      Specified by:
      getIncludes in interface SurefireExecutionParameters

    • getIncludesFile

      public abstract File getIncludesFile()

    • setIncludes

      public abstract void setIncludes(List<String> includes)
      Specified by:
      setIncludes in interface SurefireExecutionParameters

    • getExcludesFile

      public abstract File getExcludesFile()

    • suiteXmlFiles

      protected abstract List<File> suiteXmlFiles()
      Calls getSuiteXmlFiles() as list. Never returns null.
      Returns:
      list of TestNG suite XML files provided by MOJO

    • hasSuiteXmlFiles

      protected abstract boolean hasSuiteXmlFiles()
      Returns:
      true if suite-xml files array is not empty.

    • getExcludedEnvironmentVariables

      protected abstract String[] getExcludedEnvironmentVariables()

    • getSuiteXmlFiles

      public abstract File[] getSuiteXmlFiles()

    • setSuiteXmlFiles

      public abstract void setSuiteXmlFiles(File[] suiteXmlFiles)

    • getRunOrder

      public abstract String getRunOrder()

    • setRunOrder

      public abstract void setRunOrder(String runOrder)

    • handleSummary

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

    • isSkipExecution

      protected abstract boolean isSkipExecution()

    • getDefaultIncludes

      protected abstract String[] getDefaultIncludes()

    • getReportSchemaLocation

      protected abstract String getReportSchemaLocation()

    • useModulePath

      protected abstract boolean useModulePath()

    • setUseModulePath

      protected abstract void setUseModulePath(boolean useModulePath)

    • getEnableProcessChecker

      protected abstract String getEnableProcessChecker()

    • getMojoArtifact

      protected org.apache.maven.artifact.Artifact getMojoArtifact()
      This plugin MOJO artifact.
      Returns:
      non-null plugin artifact

    • getDefaultExcludes

      private String getDefaultExcludes()

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Specified by:
      execute in interface org.apache.maven.plugin.Mojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • setLogger

      void setLogger(org.codehaus.plexus.logging.Logger logger)

    • getConsoleLogger

      @Nonnull protected final PluginConsoleLogger getConsoleLogger()

    • setupStuff

      private void setupStuff()

    • scanForTestClasses

      @Nonnull private DefaultScanResult scanForTestClasses() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • scanDirectories

      private DefaultScanResult scanDirectories() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • getProjectTestArtifacts

      List<org.apache.maven.artifact.Artifact> getProjectTestArtifacts()

    • scanDependencies

      DefaultScanResult scanDependencies() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • verifyParameters

      boolean verifyParameters() throws org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoFailureException
      org.apache.maven.plugin.MojoExecutionException

    • executeAfterPreconditionsChecked

      private void executeAfterPreconditionsChecked(@Nonnull DefaultScanResult scanResult) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • createProviders

      protected List<ProviderInfo> createProviders(TestClassPath testClasspath) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • setupProperties

      private SurefireProperties setupProperties()

    • systemPropertiesMatchingArgLine

      private Set<Object> systemPropertiesMatchingArgLine(SurefireProperties result)

    • showToLog

      private void showToLog(SurefireProperties props, ConsoleLogger log)

    • executeProvider

      @Nonnull private RunResult executeProvider(@Nonnull ProviderInfo provider, @Nonnull DefaultScanResult scanResult, @Nonnull TestClassPath testClasspathWrapper) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException, SurefireExecutionException, SurefireBooterForkException, TestSetFailedException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException
      SurefireExecutionException
      SurefireBooterForkException
      TestSetFailedException

    • createCopyAndReplaceForkNumPlaceholder

      public static SurefireProperties createCopyAndReplaceForkNumPlaceholder(SurefireProperties effectiveSystemProperties, int threadNumber)

    • cleanupForkConfiguration

      protected void cleanupForkConfiguration(ForkConfiguration forkConfiguration)

    • logReportsDirectory

      protected void logReportsDirectory()

    • getRepositorySystem

      public org.apache.maven.repository.RepositorySystem getRepositorySystem()

    • setRepositorySystem

      public void setRepositorySystem(org.apache.maven.repository.RepositorySystem repositorySystem)

    • getDependencyResolver

      public org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver getDependencyResolver()

    • setDependencyResolver

      public void setDependencyResolver(org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver)

    • existsModuleDescriptor

      private boolean existsModuleDescriptor()

    • getModuleDescriptor

      private File getModuleDescriptor()

    • canExecuteProviderWithModularPath

      private boolean canExecuteProviderWithModularPath(Platform platform)

    • convertTestNGParameters

      private void convertTestNGParameters() throws org.apache.maven.plugin.MojoExecutionException
      Converts old TestNG configuration parameters over to new properties based configuration method. (if any are defined the old way)
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getConfiguratorName

      private static String getConfiguratorName(org.apache.maven.artifact.versioning.ArtifactVersion version, PluginConsoleLogger log) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • convertGroupParameters

      private void convertGroupParameters()

    • isAnyConcurrencySelected

      protected boolean isAnyConcurrencySelected()

    • isAnyGroupsSelected

      protected boolean isAnyGroupsSelected()

    • convertJunitCoreParameters

      private void convertJunitCoreParameters() throws org.apache.maven.plugin.MojoExecutionException
      Converts old JUnit configuration parameters over to new properties based configuration method. (if any are defined the old way)
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • checkNonForkedThreads

      private void checkNonForkedThreads(String parallel) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • onlyThreadCount

      private boolean onlyThreadCount()

    • checkThreadCountEntity

      private static void checkThreadCountEntity(int count, String entity) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • isJunit47Compatible

      private boolean isJunit47Compatible(org.apache.maven.artifact.Artifact artifact)

    • isAnyJunit4

      private boolean isAnyJunit4(org.apache.maven.artifact.Artifact artifact)

    • isForkModeNever

      private static boolean isForkModeNever(String forkMode)

    • isForking

      protected boolean isForking()

    • getEffectiveForkMode

      String getEffectiveForkMode()

    • getRunOrders

      private List<RunOrder> getRunOrders()

    • requiresRunHistory

      private boolean requiresRunHistory()

    • getEffectiveFailIfNoTests

      private boolean getEffectiveFailIfNoTests()

    • createProviderConfiguration

      private ProviderConfiguration createProviderConfiguration(RunOrderParameters runOrderParameters) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • toStringProperties

      private static Map<String,String> toStringProperties(Properties properties)

    • getStatisticsFile

      private File getStatisticsFile(String configurationHash)

    • createStartupConfiguration

      private StartupConfiguration createStartupConfiguration(@Nonnull ProviderInfo provider, boolean isInprocess, @Nonnull ClassLoaderConfiguration classLoaderConfiguration, @Nonnull DefaultScanResult scanResult, @Nonnull Platform platform, @Nonnull TestClassPath testClasspathWrapper) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • newStartupConfigWithClasspath

      private StartupConfiguration newStartupConfigWithClasspath(@Nonnull ClassLoaderConfiguration classLoaderConfiguration, @Nonnull Set<org.apache.maven.artifact.Artifact> providerArtifacts, @Nonnull String providerName, @Nonnull TestClassPath testClasspathWrapper)

    • retainInProcArtifactsUnique

      private static Set<org.apache.maven.artifact.Artifact> retainInProcArtifactsUnique(Set<org.apache.maven.artifact.Artifact> providerArtifacts, org.apache.maven.artifact.Artifact... inPluginArtifacts)

    • hasGroupArtifactId

      private static boolean hasGroupArtifactId(String groupId, String artifactId, org.apache.maven.artifact.Artifact artifact)

    • createInProcClasspath

      private static Classpath createInProcClasspath(Classpath providerClasspath, Set<org.apache.maven.artifact.Artifact> newArtifacts)

    • getLocationManager

      private org.codehaus.plexus.languages.java.jpms.LocationManager getLocationManager()
      For testing purposes - Mockito.
      Returns:
      plexus component

    • newStartupConfigWithModularPath

      private StartupConfiguration newStartupConfigWithModularPath(@Nonnull ClassLoaderConfiguration classLoaderConfiguration, @Nonnull Set<org.apache.maven.artifact.Artifact> providerArtifacts, @Nonnull String providerName, @Nonnull File moduleDescriptor, @Nonnull DefaultScanResult scanResult, @Nonnull String javaHome, @Nonnull TestClassPath testClasspathWrapper) throws IOException
      Throws:
      IOException

    • getCommonArtifact

      private org.apache.maven.artifact.Artifact getCommonArtifact()

    • getExtensionsArtifact

      private org.apache.maven.artifact.Artifact getExtensionsArtifact()

    • getApiArtifact

      private org.apache.maven.artifact.Artifact getApiArtifact()

    • getLoggerApiArtifact

      private org.apache.maven.artifact.Artifact getLoggerApiArtifact()

    • getBooterArtifact

      private org.apache.maven.artifact.Artifact getBooterArtifact()

    • getShadefireArtifact

      private org.apache.maven.artifact.Artifact getShadefireArtifact()

    • getStartupReportConfiguration

      private StartupReportConfiguration getStartupReportConfiguration(String configChecksum, boolean isForkMode)

    • isSpecificTestSpecified

      private boolean isSpecificTestSpecified()

    • readListFromFile

      @Nonnull private List<String> readListFromFile(@Nonnull File file)

    • maybeAppendList

      private void maybeAppendList(List<String> base, List<String> list)

    • getExcludeList

      @Nonnull private List<String> getExcludeList() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • getIncludeList

      private List<String> getIncludeList() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • checkMethodFilterInIncludesExcludes

      private void checkMethodFilterInIncludesExcludes(Iterable<String> patterns) throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • getIncludedAndExcludedTests

      private TestListResolver getIncludedAndExcludedTests() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • getSpecificTests

      public TestListResolver getSpecificTests()

    • filterNulls

      @Nonnull private List<String> filterNulls(@Nonnull List<String> toFilter)

    • getTestNgArtifact

      private org.apache.maven.artifact.Artifact getTestNgArtifact() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • createVersionRange

      private org.apache.maven.artifact.versioning.VersionRange createVersionRange()

    • getJunitArtifact

      private org.apache.maven.artifact.Artifact getJunitArtifact()

    • getJunitDepArtifact

      private org.apache.maven.artifact.Artifact getJunitDepArtifact()

    • getJunitPlatformArtifact

      private org.apache.maven.artifact.Artifact getJunitPlatformArtifact()

    • createForkStarter

      private ForkStarter createForkStarter(@Nonnull ProviderInfo provider, @Nonnull ForkConfiguration forkConfiguration, @Nonnull ClassLoaderConfiguration classLoaderConfiguration, @Nonnull RunOrderParameters runOrderParameters, @Nonnull ConsoleLogger log, @Nonnull DefaultScanResult scanResult, @Nonnull Platform platform, @Nonnull TestClassPath testClasspathWrapper) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • createInprocessStarter

      private InPluginVMSurefireStarter createInprocessStarter(@Nonnull ProviderInfo provider, @Nonnull ClassLoaderConfiguration classLoaderConfig, @Nonnull RunOrderParameters runOrderParameters, @Nonnull DefaultScanResult scanResult, @Nonnull Platform platform, @Nonnull TestClassPath testClasspathWrapper) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • createForkConfiguration

      @Nonnull private ForkConfiguration createForkConfiguration(Platform platform)

    • ensureEnableProcessChecker

      private void ensureEnableProcessChecker() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • convertDeprecatedForkMode

      private void convertDeprecatedForkMode()

    • getEffectiveForkCount

      protected int getEffectiveForkCount()

    • convertWithCoreCount

      protected int convertWithCoreCount(String count)

    • getEffectiveDebugForkedProcess

      private String getEffectiveDebugForkedProcess()

    • getEffectiveJvm

      private JdkAttributes getEffectiveJvm() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • getSurefireTempDir

      File getSurefireTempDir()
      Where surefire stores its own temp files
      Returns:
      A file pointing to the location of surefire's own temp files

    • getConfigChecksum

      private String getConfigChecksum()
      Operates on raw plugin parameters, not the "effective" values.
      Returns:
      The checksum

    • addPluginSpecificChecksumItems

      protected void addPluginSpecificChecksumItems(ChecksumCalculator checksum)

    • hasExecutedBefore

      protected boolean hasExecutedBefore()

    • getClassLoaderConfiguration

      @Nonnull protected ClassLoaderConfiguration getClassLoaderConfiguration()

    • generateTestClasspath

      private TestClassPath generateTestClasspath()
      Generates the test classpath.
      Returns:
      the classpath elements

    • filterArtifacts

      private static Set<org.apache.maven.artifact.Artifact> filterArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts, org.apache.maven.artifact.resolver.filter.ArtifactFilter filter)
      Return a new set containing only the artifacts accepted by the given filter.
      Parameters:
      artifacts - The unfiltered artifacts
      filter - The filter to apply
      Returns:
      The filtered result

    • showMap

      private void showMap(Map<?,?> map, String setting)

    • showArray

      private <T> void showArray(T[] array, String setting)

    • getArtifactClasspath

      private Classpath getArtifactClasspath(org.apache.maven.artifact.Artifact surefireArtifact)

    • getUserProperties

      private Properties getUserProperties()

    • ensureWorkingDirectoryExists

      private void ensureWorkingDirectoryExists() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • ensureParallelRunningCompatibility

      private void ensureParallelRunningCompatibility() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • ensureThreadCountWithPerThread

      private void ensureThreadCountWithPerThread() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • warnIfUselessUseSystemClassLoaderParameter

      private void warnIfUselessUseSystemClassLoaderParameter()

    • isNotForking

      private boolean isNotForking()

    • commandLineOptions

      private List<CommandLineOption> commandLineOptions()

    • warnIfDefunctGroupsCombinations

      private void warnIfDefunctGroupsCombinations() throws org.apache.maven.plugin.MojoFailureException, org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoFailureException
      org.apache.maven.plugin.MojoExecutionException

    • warnIfRerunClashes

      private void warnIfRerunClashes() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • warnIfWrongShutdownValue

      private void warnIfWrongShutdownValue() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • warnIfNotApplicableSkipAfterFailureCount

      private void warnIfNotApplicableSkipAfterFailureCount() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • warnIfIllegalTempDir

      private void warnIfIllegalTempDir() throws org.apache.maven.plugin.MojoFailureException
      Throws:
      org.apache.maven.plugin.MojoFailureException

    • createSurefireBootDirectoryInBuild

      File createSurefireBootDirectoryInBuild()

    • createSurefireBootDirectoryInTemp

      File createSurefireBootDirectoryInTemp()

    • getExcludes

      public List<String> getExcludes()
      Specified by:
      getExcludes in interface SurefireExecutionParameters

    • setExcludes

      public void setExcludes(List<String> excludes)
      Specified by:
      setExcludes in interface SurefireExecutionParameters

    • getLocalRepository

      public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
      Specified by:
      getLocalRepository in interface SurefireExecutionParameters

    • setLocalRepository

      public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
      Specified by:
      setLocalRepository in interface SurefireExecutionParameters

    • getSystemProperties

      public Properties getSystemProperties()

    • setSystemProperties

      public void setSystemProperties(Properties systemProperties)

    • getSystemPropertyVariables

      public Map<String,String> getSystemPropertyVariables()

    • setSystemPropertyVariables

      public void setSystemPropertyVariables(Map<String,String> systemPropertyVariables)

    • getSystemPropertiesFile

      public File getSystemPropertiesFile()

    • setSystemPropertiesFile

      public void setSystemPropertiesFile(File systemPropertiesFile)

    • getProperties

      private Properties getProperties()

    • setProperties

      public void setProperties(Properties properties)

    • getPluginArtifactMap

      public Map<String,org.apache.maven.artifact.Artifact> getPluginArtifactMap()

    • setPluginArtifactMap

      public void setPluginArtifactMap(Map<String,org.apache.maven.artifact.Artifact> pluginArtifactMap)

    • getProjectArtifactMap

      public Map<String,org.apache.maven.artifact.Artifact> getProjectArtifactMap()

    • setProjectArtifactMap

      public void setProjectArtifactMap(Map<String,org.apache.maven.artifact.Artifact> projectArtifactMap)

    • getReportNameSuffix

      public String getReportNameSuffix()

    • setReportNameSuffix

      public void setReportNameSuffix(String reportNameSuffix)

    • isRedirectTestOutputToFile

      public boolean isRedirectTestOutputToFile()

    • setRedirectTestOutputToFile

      public void setRedirectTestOutputToFile(boolean redirectTestOutputToFile)

    • getFailIfNoTests

      public Boolean getFailIfNoTests()

    • setFailIfNoTests

      public void setFailIfNoTests(boolean failIfNoTests)

    • getForkMode

      public String getForkMode()

    • setForkMode

      public void setForkMode(String forkMode)

    • getJvm

      public String getJvm()

    • getArgLine

      public String getArgLine()

    • setArgLine

      public void setArgLine(String argLine)

    • getEnvironmentVariables

      public Map<String,String> getEnvironmentVariables()

    • setEnvironmentVariables

      public void setEnvironmentVariables(Map<String,String> environmentVariables)

    • getWorkingDirectory

      public File getWorkingDirectory()

    • setWorkingDirectory

      public void setWorkingDirectory(File workingDirectory)

    • isChildDelegation

      public boolean isChildDelegation()

    • setChildDelegation

      public void setChildDelegation(boolean childDelegation)

    • getGroups

      public String getGroups()

    • setGroups

      public void setGroups(String groups)

    • getExcludedGroups

      public String getExcludedGroups()

    • setExcludedGroups

      public void setExcludedGroups(String excludedGroups)

    • getJunitArtifactName

      public String getJunitArtifactName()

    • setJunitArtifactName

      public void setJunitArtifactName(String junitArtifactName)

    • getTestNGArtifactName

      public String getTestNGArtifactName()

    • setTestNGArtifactName

      public void setTestNGArtifactName(String testNGArtifactName)

    • getThreadCount

      public int getThreadCount()

    • setThreadCount

      public void setThreadCount(int threadCount)

    • getPerCoreThreadCount

      public boolean getPerCoreThreadCount()

    • setPerCoreThreadCount

      public void setPerCoreThreadCount(boolean perCoreThreadCount)

    • getUseUnlimitedThreads

      public boolean getUseUnlimitedThreads()

    • setUseUnlimitedThreads

      public void setUseUnlimitedThreads(boolean useUnlimitedThreads)

    • getParallel

      public String getParallel()

    • setParallel

      public void setParallel(String parallel)

    • isParallelOptimized

      public boolean isParallelOptimized()

    • setParallelOptimized

      public void setParallelOptimized(boolean parallelOptimized)

    • getThreadCountSuites

      public int getThreadCountSuites()

    • setThreadCountSuites

      public void setThreadCountSuites(int threadCountSuites)

    • getThreadCountClasses

      public int getThreadCountClasses()

    • setThreadCountClasses

      public void setThreadCountClasses(int threadCountClasses)

    • getThreadCountMethods

      public int getThreadCountMethods()

    • setThreadCountMethods

      public void setThreadCountMethods(int threadCountMethods)

    • isTrimStackTrace

      public boolean isTrimStackTrace()

    • setTrimStackTrace

      public void setTrimStackTrace(boolean trimStackTrace)

    • getProjectRemoteRepositories

      public List<org.apache.maven.artifact.repository.ArtifactRepository> getProjectRemoteRepositories()

    • setProjectRemoteRepositories

      public void setProjectRemoteRepositories(List<org.apache.maven.artifact.repository.ArtifactRepository> projectRemoteRepositories)

    • getRemoteRepositories

      public List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()

    • setRemoteRepositories

      public void setRemoteRepositories(List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories)

    • isDisableXmlReport

      public boolean isDisableXmlReport()

    • setDisableXmlReport

      public void setDisableXmlReport(boolean disableXmlReport)

    • isEnableAssertions

      public boolean isEnableAssertions()

    • effectiveIsEnableAssertions

      public boolean effectiveIsEnableAssertions()

    • setEnableAssertions

      public void setEnableAssertions(boolean enableAssertions)

    • getSession

      public org.apache.maven.execution.MavenSession getSession()

    • setSession

      public void setSession(org.apache.maven.execution.MavenSession session)

    • getObjectFactory

      public String getObjectFactory()

    • setObjectFactory

      public void setObjectFactory(String objectFactory)

    • getToolchainManager

      public org.apache.maven.toolchain.ToolchainManager getToolchainManager()

    • setToolchainManager

      public void setToolchainManager(org.apache.maven.toolchain.ToolchainManager toolchainManager)

    • isMavenParallel

      public boolean isMavenParallel()

    • getDependenciesToScan

      public String[] getDependenciesToScan()

    • setDependenciesToScan

      public void setDependenciesToScan(String[] dependenciesToScan)

    • setPluginDescriptor

      void setPluginDescriptor(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)

    • getPluginDescriptor

      public org.apache.maven.plugin.descriptor.PluginDescriptor getPluginDescriptor()

    • getProject

      public org.apache.maven.project.MavenProject getProject()

    • setProject

      public void setProject(org.apache.maven.project.MavenProject project)

    • getTestSourceDirectory

      public File getTestSourceDirectory()
      Specified by:
      getTestSourceDirectory in interface SurefireExecutionParameters

    • setTestSourceDirectory

      public void setTestSourceDirectory(File testSourceDirectory)
      Specified by:
      setTestSourceDirectory in interface SurefireExecutionParameters

    • getForkCount

      public String getForkCount()

    • isReuseForks

      public boolean isReuseForks()

    • getAdditionalClasspathElements

      public String[] getAdditionalClasspathElements()

    • setAdditionalClasspathElements

      public void setAdditionalClasspathElements(String[] additionalClasspathElements)

    • getClasspathDependencyExcludes

      public String[] getClasspathDependencyExcludes()

    • setClasspathDependencyExcludes

      public void setClasspathDependencyExcludes(String[] classpathDependencyExcludes)

    • getClasspathDependencyScopeExclude

      public String getClasspathDependencyScopeExclude()

    • setClasspathDependencyScopeExclude

      public void setClasspathDependencyScopeExclude(String classpathDependencyScopeExclude)

    • getProjectBuildDirectory

      public File getProjectBuildDirectory()

    • setProjectBuildDirectory

      public void setProjectBuildDirectory(File projectBuildDirectory)

    • logDebugOrCliShowErrors

      protected void logDebugOrCliShowErrors(String s)

    • getTempDir

      public String getTempDir()

    • setTempDir

      public void setTempDir(String tempDir)

    • getEffectiveForkMode

      private static String getEffectiveForkMode(String forkMode)