Package org.apache.maven.plugin.failsafe

Class IntegrationTestMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.surefire.AbstractSurefireMojo
org.apache.maven.plugin.failsafe.IntegrationTestMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.plugin.surefire.SurefireExecutionParameters
@Mojo(name="integration-test", requiresProject=true, requiresDependencyResolution=TEST, defaultPhase=INTEGRATION_TEST, threadSafe=true) public class IntegrationTestMojo extends org.apache.maven.plugin.surefire.AbstractSurefireMojo
Run integration tests using Surefire.

  • Field Details

    • FAILSAFE_IN_PROGRESS_CONTEXT_KEY

      private static final String FAILSAFE_IN_PROGRESS_CONTEXT_KEY
      See Also:

    • classesDirectory

      @Parameter private File classesDirectory
      The path representing project JAR file, if exists; Otherwise the directory containing generated classes of the project being tested. This will be included after the test classes in the test classpath. Defaults to built artifact JAR file or ${project.build.outputDirectory}.

    • defaultClassesDirectory

      @Parameter(readonly=true, defaultValue="${project.build.outputDirectory}") private File defaultClassesDirectory

    • skipITs

      @Parameter(property="skipITs") private boolean skipITs
      Set this to "true" to skip running integration tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
      Since:
      2.4.3-alpha-2

    • reportsDirectory

      @Parameter(defaultValue="${project.build.directory}/failsafe-reports") private File reportsDirectory
      Base directory where all reports are written to.

    • test

      @Parameter(property="it.test") private String test

    • summaryFile

      @Parameter(defaultValue="${project.build.directory}/failsafe-reports/failsafe-summary.xml", required=true) private File summaryFile
      The summary file to write integration test results to.

    • printSummary

      @Parameter(property="failsafe.printSummary", defaultValue="true") private boolean printSummary
      Option to print summary of test suites or just print the test cases that have errors.

    • reportFormat

      @Parameter(property="failsafe.reportFormat", defaultValue="brief") private String reportFormat
      Selects the formatting for the test report to be generated. Can be set as "brief" or "plain". Only applies to the output format of the output files (target/surefire-reports/testName.txt)

    • useFile

      @Parameter(property="failsafe.useFile", defaultValue="true") private boolean useFile
      Option to generate a file test report or just output the test report to the console.

    • failIfNoSpecifiedTests

      @Parameter(property="it.failIfNoSpecifiedTests") private Boolean failIfNoSpecifiedTests
      Set this to "true" to cause a failure if none of the tests specified in -Dtest=... are run. Defaults to "true".
      Since:
      2.12

    • debugForkedProcess

      @Parameter(property="maven.failsafe.debug") private String debugForkedProcess
      Attach a debugger to the forked JVM. If set to "true", the process will suspend and wait for a debugger to attach on port 5005. If set to some other string, that string will be appended to the argLine, allowing you to configure arbitrary debugging ability options (without overwriting the other options specified through the argLine parameter).
      Since:
      2.4

    • forkedProcessTimeoutInSeconds

      @Parameter(property="failsafe.timeout") private int forkedProcessTimeoutInSeconds
      Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
      Since:
      2.4

    • forkedProcessExitTimeoutInSeconds

      @Parameter(property="failsafe.exitTimeout", defaultValue="30") private int forkedProcessExitTimeoutInSeconds
      Forked process is normally terminated without any significant delay after given tests have completed. If the particular tests started non-daemon Thread(s), the process hangs instead of been properly terminated by System.exit(). Use this parameter in order to determine the timeout of terminating the process. see the documentation: http://maven.apache.org/surefire/maven-failsafe-plugin/examples/shutdown.html
      Since:
      2.20

    • parallelTestsTimeoutInSeconds

      @Parameter(property="failsafe.parallel.timeout") private double parallelTestsTimeoutInSeconds
      Stop executing queued parallel JUnit tests after a certain number of seconds.
      Example values: "3.5", "4"

      If set to 0, wait forever, never timing out. Makes sense with specified parallel different from "none".
      Since:
      2.16

    • parallelTestsTimeoutForcedInSeconds

      @Parameter(property="failsafe.parallel.forcedTimeout") private double parallelTestsTimeoutForcedInSeconds
      Stop executing queued parallel JUnit tests and interrupt currently running tests after a certain number of seconds.
      Example values: "3.5", "4"

      If set to 0, wait forever, never timing out. Makes sense with specified parallel different from "none".
      Since:
      2.16

    • includes

      @Parameter private List<String> includes

    • useSystemClassLoader

      @Parameter(property="failsafe.useSystemClassLoader", defaultValue="true") private boolean useSystemClassLoader
      Option to pass dependencies to the system's classloader instead of using an isolated class loader when forking. Prevents problems with JDKs which implement the service provider lookup mechanism by using the system's classloader.
      Since:
      2.3

    • useManifestOnlyJar

      @Parameter(property="failsafe.useManifestOnlyJar", defaultValue="true") private boolean useManifestOnlyJar
      By default, Surefire forks your tests using a manifest-only JAR; set this parameter to "false" to force it to launch your tests with a plain old Java classpath. (See the http://maven.apache.org/plugins/maven-failsafe-plugin/examples/class-loading.html for a more detailed explanation of manifest-only JARs and their benefits.)
      Beware, setting this to "false" may cause your tests to fail on Windows if your classpath is too long.
      Since:
      2.4.3

    • encoding

      @Parameter(property="encoding", defaultValue="${project.reporting.outputEncoding}") private String encoding
      The character encoding scheme to be applied while generating test report files (see target/surefire-reports/yourTestName.txt). The report output files (*-out.txt) are still encoded with JVM's encoding used in standard out/err pipes.
      Since:
      3.0.0-M1

    • rerunFailingTestsCount

      @Parameter(property="failsafe.rerunFailingTestsCount", defaultValue="0") private int rerunFailingTestsCount
      (JUnit 4+ providers) The number of times each failing test will be rerun. If set larger than 0, rerun failing tests immediately after they fail. If a failing test passes in any of those reruns, it will be marked as pass and reported as a "flake". However, all the failing attempts will be recorded.

    • suiteXmlFiles

      @Parameter(property="failsafe.suiteXmlFiles") private File[] suiteXmlFiles
      (TestNG) List of <suiteXmlFile> elements specifying TestNG suite xml file locations. Note that suiteXmlFiles is incompatible with several other parameters of this plugin, like includes and excludes.
      This parameter is ignored if the test parameter is specified (allowing you to run a single test instead of an entire suite).
      Since:
      2.2

    • runOrder

      @Parameter(property="failsafe.runOrder", defaultValue="filesystem") private String runOrder
      Defines the order the tests will be run in. Supported values are alphabetical, reversealphabetical, random, hourly (alphabetical on even hours, reverse alphabetical on odd hours), failedfirst, balanced and filesystem.

      Odd/Even for hourly is determined at the time the of scanning the classpath, meaning it could change during a multi-module build.

      Failed first will run tests that failed on previous run first, as well as new tests for this run.

      Balanced is only relevant with parallel=classes, and will try to optimize the run-order of the tests reducing the overall execution time. Initially a statistics file is created and every next test run will reorder classes.

      Note that the statistics are stored in a file named .surefire-XXXXXXXXX beside pom.xml and should not be checked into version control. The "XXXXX" is the SHA1 checksum of the entire surefire configuration, so different configurations will have different statistics files, meaning if you change any configuration settings you will re-run once before new statistics data can be established.
      Since:
      2.7

    • includesFile

      @Parameter(property="failsafe.includesFile") private File includesFile
      A file containing include patterns, each in a next line. Blank lines, or lines starting with # are ignored. If includes are also specified, these patterns are appended. Example with path, simple and regex includes: 
      
 */it/*
 **/NotIncludedByDefault.java
 %regex[.*IT.*|.*Not.*]

    • excludesFile

      @Parameter(property="failsafe.excludesFile") private File excludesFile
      A file containing exclude patterns, each in a next line. Blank lines, or lines starting with # are ignored. If excludes are also specified, these patterns are appended. Example with path, simple and regex excludes: 
      
 */it/*
 **/DontRunIT.*
 %regex[.*IT.*|.*Not.*]

    • skipAfterFailureCount

      @Parameter(property="failsafe.skipAfterFailureCount", defaultValue="0") private int skipAfterFailureCount
      Set to error/failure count in order to skip remaining tests. Due to race conditions in parallel/forked execution this may not be fully guaranteed.
      Enable with system property -Dfailsafe.skipAfterFailureCount=1 or any number greater than zero. Defaults to "0".
      See the prerequisites and limitations in documentation:
      http://maven.apache.org/plugins/maven-failsafe-plugin/examples/skip-after-failure.html
      Since:
      2.19

    • shutdown

      @Parameter(property="failsafe.shutdown", defaultValue="testset") private String shutdown
      After the plugin process is shutdown by sending SIGTERM signal (CTRL+C), SHUTDOWN command is received by every forked JVM.
      By default (shutdown=testset) forked JVM would not continue with new test which means that the current test may still continue to run.
      The parameter can be configured with other two values exit and kill.
      Using exit forked JVM executes System.exit(1) after the plugin process has received SIGTERM signal.
      Using kill the JVM executes Runtime.halt(1) and kills itself.
      Since:
      2.19

  • Constructor Details

    • IntegrationTestMojo

      public IntegrationTestMojo()

  • Method Details

    • getRerunFailingTestsCount

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

    • handleSummary

      protected void handleSummary(org.apache.maven.surefire.suite.RunResult summary, Exception firstForkException) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Specified by:
      handleSummary in class org.apache.maven.plugin.surefire.AbstractSurefireMojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • isJarArtifact

      private boolean isJarArtifact(File artifactFile)

    • toAbsoluteCanonical

      private static File toAbsoluteCanonical(File f)

    • isSkipExecution

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

    • getPluginName

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

    • getDefaultIncludes

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

    • getReportSchemaLocation

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

    • getMojoArtifact

      protected org.apache.maven.artifact.Artifact getMojoArtifact()
      Specified by:
      getMojoArtifact in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

    • isSkipTests

      public boolean isSkipTests()

    • setSkipTests

      public void setSkipTests(boolean skipTests)

    • isSkipITs

      public boolean isSkipITs()

    • setSkipITs

      public void setSkipITs(boolean skipITs)

    • isSkipExec

      @Deprecated public boolean isSkipExec()
      Deprecated.

    • setSkipExec

      @Deprecated public void setSkipExec(boolean skipExec)
      Deprecated.

    • isSkip

      public boolean isSkip()

    • setSkip

      public void setSkip(boolean skip)

    • getBasedir

      public File getBasedir()

    • setBasedir

      public void setBasedir(File basedir)

    • getTestClassesDirectory

      public File getTestClassesDirectory()

    • setTestClassesDirectory

      public void setTestClassesDirectory(File testClassesDirectory)

    • getClassesDirectory

      public File getClassesDirectory()
      Returns:
      Output directory, or artifact file if artifact type is "jar". If not forking the JVM, parameter useSystemClassLoader is ignored and the IsolatedClassLoader is used instead. See the resolution of ClassLoaderConfiguration.

    • setClassesDirectory

      public void setClassesDirectory(File classesDirectory)

    • setDefaultClassesDirectory

      public void setDefaultClassesDirectory(File defaultClassesDirectory)

    • getReportsDirectory

      public File getReportsDirectory()

    • setReportsDirectory

      public void setReportsDirectory(File reportsDirectory)

    • getTest

      public String getTest()

    • setTest

      public void setTest(String test)

    • getSummaryFile

      public File getSummaryFile()

    • setSummaryFile

      public void setSummaryFile(File summaryFile)

    • isPrintSummary

      public boolean isPrintSummary()

    • setPrintSummary

      public void setPrintSummary(boolean printSummary)

    • getReportFormat

      public String getReportFormat()

    • setReportFormat

      public void setReportFormat(String reportFormat)

    • isUseFile

      public boolean isUseFile()

    • setUseFile

      public void setUseFile(boolean useFile)

    • getDebugForkedProcess

      public String getDebugForkedProcess()

    • setDebugForkedProcess

      public void setDebugForkedProcess(String debugForkedProcess)

    • getForkedProcessTimeoutInSeconds

      public int getForkedProcessTimeoutInSeconds()

    • setForkedProcessTimeoutInSeconds

      public void setForkedProcessTimeoutInSeconds(int forkedProcessTimeoutInSeconds)

    • getForkedProcessExitTimeoutInSeconds

      public int getForkedProcessExitTimeoutInSeconds()

    • setForkedProcessExitTimeoutInSeconds

      public void setForkedProcessExitTimeoutInSeconds(int forkedProcessExitTimeoutInSeconds)

    • getParallelTestsTimeoutInSeconds

      public double getParallelTestsTimeoutInSeconds()

    • setParallelTestsTimeoutInSeconds

      public void setParallelTestsTimeoutInSeconds(double parallelTestsTimeoutInSeconds)

    • getParallelTestsTimeoutForcedInSeconds

      public double getParallelTestsTimeoutForcedInSeconds()

    • setParallelTestsTimeoutForcedInSeconds

      public void setParallelTestsTimeoutForcedInSeconds(double parallelTestsTimeoutForcedInSeconds)

    • isUseSystemClassLoader

      public boolean isUseSystemClassLoader()

    • setUseSystemClassLoader

      public void setUseSystemClassLoader(boolean useSystemClassLoader)

    • isUseManifestOnlyJar

      public boolean isUseManifestOnlyJar()

    • setUseManifestOnlyJar

      public void setUseManifestOnlyJar(boolean useManifestOnlyJar)

    • getEncoding

      public String getEncoding()

    • setEncoding

      public void setEncoding(String encoding)

    • isTestFailureIgnore

      public boolean isTestFailureIgnore()

    • setTestFailureIgnore

      public void setTestFailureIgnore(boolean testFailureIgnore)

    • addPluginSpecificChecksumItems

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

    • getFailIfNoSpecifiedTests

      public Boolean getFailIfNoSpecifiedTests()

    • setFailIfNoSpecifiedTests

      public void setFailIfNoSpecifiedTests(boolean failIfNoSpecifiedTests)

    • getSkipAfterFailureCount

      public int getSkipAfterFailureCount()

    • getShutdown

      public String getShutdown()

    • getIncludes

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

    • setIncludes

      public void setIncludes(List<String> includes)
      Specified by:
      setIncludes in interface org.apache.maven.plugin.surefire.SurefireExecutionParameters
      Specified by:
      setIncludes in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

    • getSuiteXmlFiles

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

    • setSuiteXmlFiles

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

    • getRunOrder

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

    • setRunOrder

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

    • getIncludesFile

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

    • getExcludesFile

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

    • suiteXmlFiles

      protected final List<File> suiteXmlFiles()
      Specified by:
      suiteXmlFiles in class org.apache.maven.plugin.surefire.AbstractSurefireMojo

    • hasSuiteXmlFiles

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

    • toCharset

      static Charset toCharset(String encoding)