Tycho Surefire Plugin

Arbitrary applications arguments to set on the command line.

Eclipse application to be run. If not specified, default application org.eclipse.ui.ide.workbench will be used. Application runnable will be invoked from test harness, not directly from Eclipse. Note that you need to ensure that the bundle which defines the configured application is included in the test runtime.

Arbitrary JVM options to set on the command line.

Bundle start level and auto start configuration used by the test runtime. Ignored if testRuntime is p2Installed. Example:

<bundleStartLevel>
  <bundle>
    <id>foo.bar.myplugin</id>
    <level>6</level>
    <autoStart>true</autoStart>
  </bundle>
</bundleStartLevel>

The test runtime is configured with a composite class loader. This defines the order in which the loaders are searched, and it may need to be configured depending on the resolved classpath of the project.

Available values are:

• booterFirst - the loader of the surefire booter (including bundled test platform) is searched first
• testProbeFirst - the loader of the test class's plugin is searched first

Defaults to booterFirst.

if set to a non-null value, the platform is put in debug mode. If the value is a non-empty string it is interpreted as the location of the .options file. This file indicates what debug points are available for a plug-in and whether or not they are enabled. for a list of available options see https://git.eclipse.org/c/equinox/rt.equinox.framework.git/plain/bundles/org.eclipse.osgi/.options

Set this parameter to suspend the test JVM waiting for a client to open a remote debug session on the specified port. If further customization of JVM debug parameters is required then argLine can be used instead.

The default bundle start level and auto start configuration used by the test runtime for bundles where the start level/auto start is not configured in bundleStartLevel. Ignored if testRuntime is p2Installed. Example:

  <defaultStartLevel>
    <level>6</level>
    <autoStart>true</autoStart>
  </defaultStartLevel>

Whether to recursively delete the directory osgiDataDirectory before running the tests.

If enabled, deletes the workarea after test execution

Additional dependencies to be added to the test runtime. Note: This parameter has only limited support for dependencies to artifacts within the reactor. Therefore it is recommended to specify extraRequirements on the target-platform-configuration plugin instead. Example:

<plugin>
   <groupId>org.eclipse.tycho</groupId>
   <artifactId>target-platform-configuration</artifactId>
   <version>${tycho-version}</version>
   <configuration>
      <dependency-resolution>
         <extraRequirements>
            <requirement>
               <type>eclipse-feature</type>
               <id>example.project.feature</id>
               <versionRange>0.0.0</versionRange>
            </requirement>
         </extraRequirements>
      </dependency-resolution>
   </configuration>
</plugin>

The dependencies specified as extraRequirements are – together with the dependencies specified in the MANIFEST.MF of the project – transitively resolved against the target platform. The resulting set of bundles is included in the test runtime.

By default, Tycho Surefire disables JVM assertions for the execution of your test cases. To enable the assertions, set this flag to "true".

Additional environments to set for the forked test JVM.

(junit47 provider with JUnit4.8+ only) Excluded groups/categories (comma-separated). Any methods/classes/etc with one of the groups/categories specified in this list will specifically not be run. For JUnit, this parameter forces the use of the junit47 provider

List of patterns (separated by commas) used to specify the tests that should be excluded in testing. When not specified and when the test parameter is not specified, the default excludes will be **/*$* (which excludes all inner classes).

List of bundles that must be expanded in order to execute the tests. Ignored if testRuntime is p2Installed.

If set to "false" the test execution will not fail in case there are no tests found.

Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.

List of framework extension bundles to add. Note: The goal does not automatically detect which bundles in the test runtime are framework extensions, but they have to be explicitly specified using this parameter. Ignored if testRuntime is p2Installed.

(junit47 provider with JUnit4.8+ only) Groups/categories for this test (comma-separated). Only classes/methods/etc decorated with one of the group/category specified here will be included in test run, if specified. For JUnit, this parameter forces the use of the junit47 provider

List of patterns (separated by commas) used to specify the tests that should be included in testing. When not specified and when the test parameter is not specified, the default includes will be **/Test*.java **/*Test.java **/*Tests.java **/*TestCase.java

Additional root IUs to install, only relevant if testRuntime is p2Installed.

<install>
   <iu>
      <id>...</id>
      <version>...optional version...</id>
      <feature>true/false</feature> <!-- optional if true .feature.group is automatically added to the id  -->
</install>

The directory where OSGi/PDE metadata files (e.g., MANIFEST.MF) are located. Useful in case said metadata is changed at build time, using filtering.

Defaults to the project's base directory.

OSGi data directory (osgi.instance.area, aka the workspace) of the Equinox runtime used to execute tests.

Configures the packaging type where this mojos applies

(JUnit 4.7 provider) Supports values "classes"/"methods"/"both" to run in separate threads, as controlled by threadCount.

(JUnit 4.7 provider) Indicates that threadCount is per cpu core.

No description.

prints all loaded bundles

prints all loaded bundles

Eclipse product to be run, i.e. -product parameter passed to test Eclipse runtime.

p2 profile name of the installation under test. Only relevant if testRuntime is p2Installed. If tests are installed on top of an already existing installation in work, this must match the name of the existing profile.

Normally, Tycho will automatically determine the test framework provider based on the test project's classpath. This options forces the use of a test framework provider implementation with the given role hint. Tycho comes with providers such as "junit3","junit4","junit47","junit5", or "junit59". Note that when specifying a providerHint, you have to make sure the provider is actually available in the dependencies of tycho-surefire-plugin.

Use this to specify surefire provider-specific properties.

Configures the overall concurrency level. Important Note: If there are multiple mojo configurations this will choose the lowest configured number! So for example if in the same reactor there is one configuration with a concurrency level of 5 and one with a concurrency level of 3 then then only three parallel runs will be possible!

Set this to "true" to redirect the unit test standard output to a file (found in reportsDirectory/testName-output.txt).

No description.

Additional repositories used to install units from, only relevant if testRuntime is p2Installed.

<repositories>
  <repository>
      <url>...another repository...</url>
  </repository>
</repositories>

Flaky tests will re-run until they pass or the number of reruns has been exhausted. See surefire documentation for details.

Note: This feature is supported only for JUnit 4.x

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) and "filesystem".

Enables -consolelog for the test OSGi runtime

Same as skipTests

Skips the remaining tests after the Nth failure or error. See surefire documentation for details.

No description.

Set this to "true" to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion. Default: false

Only supported by the TestNG test provider. The values specified are passed to TestNG as test suite files. The suite files will overwrite the includes and excludes patterns. The path to the suite file(s) could be relative (test bundle classpath) or an absolute path to xml files outside the test bundle.

<configuration>
  <suiteXmlFiles>
    <suiteXmlFile>myTestSuite.xml</suiteXmlFile>
  </suiteXmlFiles>
</configuration>

No description.

No description.

Additional system properties to set for the forked test JVM.

Specify this parameter if you want to use the test pattern matching notation, Ant pattern matching, to select tests to run. The Ant pattern will be used to create an include pattern formatted like **/${test}.java When used, the includes and excludes patterns parameters are ignored

Identifies a single test (suite) class to run. This is useful if you have a single JUnit test suite class defining which tests should be executed. Will be ignored if test is specified. Example:

<testClass>foo.bar.FooTest</testClass>

The directory containing generated test classes of the project being tested.

How to create the OSGi test runtime. Allowed values are default and p2Installed. Mode p2Installed is EXPERIMENTAL - only works when installing products under test (see below).

• In default mode, all necessary files to define the test runtime like config.ini are generated by tycho. This installation mode has the advantage that the test runtime is minimal (defined by the transitive dependencies of the test bundle plus and the test harness) and existing bundle jars are referenced rather than copied for the installation
• In p2Installed mode, use p2 director to install test bundle, test harness bundles and respective dependencies. This installation mode can be used for integration tests that require a fully p2-provisioned installation. To install a product IU, add it as extra requirement to the test bundle (see example below). Note that this installation mode comes with a certain performance overhead for executing the provisioning operations otherwise not required. Also note, that in this mode, in case the primary installation target environment is macOS, work is post-processed to ensure a proper macOS layout. That is, Eclipse.app/Contents/Eclipse is automatically appended (or only Contents/Eclipse, if work already ends with .app).

Example configuration which will install product IU under test "example.product.id" using p2:

<plugin>
   <groupId>org.eclipse.tycho</groupId>
   <artifactId>tycho-surefire-plugin</artifactId>
   <version>${tycho-version}</version>
   <configuration>
      <testRuntime>p2Installed</testRuntime>
   </configuration>
</plugin>
<plugin>
   <groupId>org.eclipse.tycho</groupId>
   <artifactId>target-platform-configuration</artifactId>
   <version>${tycho-version}</version>
   <configuration>
      <dependency-resolution>
         <extraRequirements>
            <!-- product IU under test -->
            <requirement>
               <type>p2-installable-unit</type>
               <id>example.product.id</id>
               <versionRange>0.0.0</versionRange>
            </requirement>
         </extraRequirements>
      </dependency-resolution>
   </configuration>
</plugin>

(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.

When true, stack traces are trimmed to only show lines within the test.

Which JDK to use for executing tests. Possible values are: SYSTEM, BREE .

• SYSTEM: Use the currently running JVM (or from toolchain if configured in pom.xml)
• BREE: use MANIFEST header Bundle-RequiredExecutionEnvironment to lookup the JDK from toolchains.xml. The value of BREE will be matched against the id of the JDK toolchain elements in toolchains.xml. If the BREEs version is 9 or later and the ID did not match any element, the version of the BREE will be matched against the version of the JDK toolchain elements.

Example for BREE:
In META-INF/MANIFEST.MF:

Bundle-RequiredExecutionEnvironment: JavaSE-11

In toolchains.xml:

<toolchains>
  <toolchain>
     <type>jdk</type>
     <provides>
         <id>JavaSE-11</id>
         <version>11</version>
     </provides>
     <configuration>
        <jdkHome>/path/to/jdk/11</jdkHome>
     </configuration>
  </toolchain>
</toolchains>

Run tests using UI (true) or headless (false) test harness.

Run tests in UI (true) or background (false) thread. Only applies to UI test harness.

(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.

Root directory (osgi.install.area) of the Equinox runtime used to execute tests.