You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kr...@apache.org on 2012/12/06 20:16:44 UTC
[3/6] o Reformatted entire code base to code style
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/inclusion-exclusion.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/inclusion-exclusion.apt.vm b/maven-surefire-plugin/src/site/apt/examples/inclusion-exclusion.apt.vm
index 4c7d978..172d648 100644
--- a/maven-surefire-plugin/src/site/apt/examples/inclusion-exclusion.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/inclusion-exclusion.apt.vm
@@ -1,164 +1,165 @@
- ------
- Inclusions and Exclusions of Tests
- ------
- Allan Ramirez
- ------
- 2010-01-09
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Inclusions and Exclusions of Tests
+------
+Allan Ramirez
+------
+2010-01-09
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Inclusions and Exclusions of Tests
* Inclusions
- By default, the ${thisPlugin} Plugin will automatically include all test classes
- with the following wildcard patterns:
+By default, the ${thisPlugin} Plugin will automatically include all test classes
+with the following wildcard patterns:
#{if}(${project.artifactId}=="maven-surefire-plugin")
- * <<<"**/Test*.java">>> - includes all of its subdirectories and all java
- filenames that start with "Test".
+* <<<"**/Test*.java">>> - includes all of its subdirectories and all java
+filenames that start with "Test".
- * <<<"**/*Test.java">>> - includes all of its subdirectories and all java
- filenames that end with "Test".
+* <<<"**/*Test.java">>> - includes all of its subdirectories and all java
+filenames that end with "Test".
- * <<<"**/*TestCase.java">>> - includes all of its subdirectories and all java
- filenames that end with "TestCase".
+* <<<"**/*TestCase.java">>> - includes all of its subdirectories and all java
+filenames that end with "TestCase".
#{else}
- * <<<"**/IT*.java">>> - includes all of its subdirectories and all java
- filenames that start with "IT".
+* <<<"**/IT*.java">>> - includes all of its subdirectories and all java
+filenames that start with "IT".
- * <<<"**/*IT.java">>> - includes all of its subdirectories and all java
- filenames that end with "IT".
+* <<<"**/*IT.java">>> - includes all of its subdirectories and all java
+filenames that end with "IT".
- * <<<"**/*ITCase.java">>> - includes all of its subdirectories and all java
- filenames that end with "ITCase".
+* <<<"**/*ITCase.java">>> - includes all of its subdirectories and all java
+filenames that end with "ITCase".
#{end}
- []
+[]
- If the test classes does not go with the naming convention, then configure
- ${thisPlugin} Plugin and specify the tests you want to include.
+If the test classes does not go with the naming convention, then configure
+${thisPlugin} Plugin and specify the tests you want to include.
+---+
<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <includes>
- <include>Sample.java</include>
- </includes>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <includes>
+ <include>Sample.java</include>
+ </includes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
</project>
+---+
* Exclusions
- There are certain times when some tests are causing the build to fail.
- Excluding them is one of the best workarounds to continue the build.
- Exclusions can be done by configuring the <<excludes>> property of the
- plugin.
-
-#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <excludes>
- <exclude>**/TestCircle.java</exclude>
- <exclude>**/TestSquare.java</exclude>
- </excludes>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-#{else}
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <excludes>
- <exclude>**/CircleIT.java</exclude>
- <exclude>**/SquareIT.java</exclude>
- </excludes>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-#{end}
-
-* Regular expression support
-
- An include/exclude pattern can be an ant-style path expression, but
- regular expressions are also supported through this syntax:
-
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <includes>
- <include>%regex[.*[Cat|Dog].*Test.*]</include>
- </includes>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
- Note the syntax %regex[expr], where expr is the actual expression and the rest is just wrapping. Also
- note that regex matches are done over .class files and not .java files.
\ No newline at end of file
+There are certain times when some tests are causing the build to fail.
+Excluding them is one of the best workarounds to continue the build.
+Exclusions can be done by configuring the <
+<excludes>> property of the
+ plugin.
+
+ #{if}(${project.artifactId}=="maven-surefire-plugin")
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <excludes>
+ <exclude>**/TestCircle.java</exclude>
+ <exclude>**/TestSquare.java</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+ #{else}
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <excludes>
+ <exclude>**/CircleIT.java</exclude>
+ <exclude>**/SquareIT.java</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+ #{end}
+
+ * Regular expression support
+
+ An include/exclude pattern can be an ant-style path expression, but
+ regular expressions are also supported through this syntax:
+
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <includes>
+ <include>%regex[.*[Cat|Dog].*Test.*]</include>
+ </includes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+
+ Note the syntax %regex[expr], where expr is the actual expression and the rest is just wrapping. Also
+ note that regex matches are done over .class files and not .java files.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/junit.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/junit.apt.vm b/maven-surefire-plugin/src/site/apt/examples/junit.apt.vm
index a421f93..b249606 100644
--- a/maven-surefire-plugin/src/site/apt/examples/junit.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/junit.apt.vm
@@ -1,271 +1,285 @@
- ------
- Using JUnit
- ------
- Kristian Rosenvold <kr...@apache.org>
- ------
- 2010-10-10
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Using JUnit
+------
+Kristian Rosenvold
+<kr...@apache.org>
+------
+2010-10-10
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Using JUnit
* Configuring JUnit
- To get started with JUnit, you need to add the required version of JUnit to your project:
+To get started with JUnit, you need to add the required version of JUnit to your project:
+---+
<dependencies>
- [...]
+ [...]
<dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>4.8.1</version>
- <scope>test</scope>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>4.8.1</version>
+ <scope>test</scope>
</dependency>
- [...]
+ [...]
</dependencies>
+---+
- This is the only step that is required to get started - you can now create tests in your test source directory
- (eg, <<<src/test/java>>>).
+This is the only step that is required to get started - you can now create tests in your test source directory
+(eg, <<
+<src/test/java>>>).
* Different Generations of JUnit support
- Surefire supports three different generations of JUnit: JUnit 3.8.x, JUnit 4.x (serial provider) and JUnit 4.7 (junit-core provider
- with parallel support). The provider is selected based on the JUnit version in your project and the configuration parameters (for parallel).
+Surefire supports three different generations of JUnit: JUnit 3.8.x, JUnit 4.x (serial provider) and JUnit 4.7 (junit-core provider
+with parallel support). The provider is selected based on the JUnit version in your project and the configuration parameters (for parallel).
* Upgrade check for JUnit 4.x
- As of Surefire version 2.7, the algorithm for choosing which tests to run
- has changed. From 2.7 and on, only valid JUnit tests are run for all versions of JUnit, where older versions
- of the plugin would also run invalid tests that satisfied the naming convention.
+As of Surefire version 2.7, the algorithm for choosing which tests to run
+has changed. From 2.7 and on, only valid JUnit tests are run for all versions of JUnit, where older versions
+of the plugin would also run invalid tests that satisfied the naming convention.
- When upgrading from a Surefire version prior to 2.7, the build can be run with
- the flag -Dsurefire.junit4.upgradecheck. This will perform a check and notify you of any invalid tests that
- will not be run with this version of Surefire (and the build fails). This is only meant to be used as a tool
- when upgrading to check that all expected tests will be run. It is a transitional
- feature that will be removed in a future version of surefire.
+When upgrading from a Surefire version prior to 2.7, the build can be run with
+the flag -Dsurefire.junit4.upgradecheck. This will perform a check and notify you of any invalid tests that
+will not be run with this version of Surefire (and the build fails). This is only meant to be used as a tool
+when upgrading to check that all expected tests will be run. It is a transitional
+feature that will be removed in a future version of surefire.
* How is the provider chosen ?
- If nothing is configured, surefire detects which junit version to use by the following algorithm:
+If nothing is configured, surefire detects which junit version to use by the following algorithm:
+---+
if the JUnit version in the project >= 4.7 and the parallel attribute has ANY value
- use junit47 provider
+use junit47 provider
if JUnit >= 4.0 is present
- use junit4 provider
+use junit4 provider
else
- use junit3.8.1
+use junit3.8.1
+---+
- Please note that the "else" part of this algorithm is also a FAQ response:
+Please note that the "else" part of this algorithm is also a FAQ response:
- You depend on the appropriate version of JUnit being present in the project dependencies, or surefire may choose the wrong
- provider. If, for instance, one of your dependencies pulls in JUnit 3.8.1 you risk that surefire chooses the
- 3.8.1 provider, which will not support annotations or any of the 4.x features.
+You depend on the appropriate version of JUnit being present in the project dependencies, or surefire may choose the wrong
+provider. If, for instance, one of your dependencies pulls in JUnit 3.8.1 you risk that surefire chooses the
+3.8.1 provider, which will not support annotations or any of the 4.x features.
- Use mvn dependency:tree, pom dependency ordering and/or and exclusion of transitive dependencies to fix this problem.
+Use mvn dependency:tree, pom dependency ordering and/or and exclusion of transitive dependencies to fix this problem.
** Manually specifying a provider
- You can also manually force a specific provider by adding it as a dependency to ${thisPlugin} itself:
-
-+---+
-<plugins>
-[...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven.surefire</groupId>
- <artifactId>surefire-junit47</artifactId>
- <version>${project.version}</version>
- </dependency>
- </dependencies>
- </plugin>
-[...]
-</plugins>
-+---+
-
- When using this technique there is no check that the proper test-frameworks are present on your project's
- classpath. Failing to add the proper test-frameworks will result in a build failure.
-
-* Running tests in parallel
-
- From JUnit 4.7 and onwards you can run your tests in parallel. To do this, you must set the
- <<<parallel>>> parameter, and may change the <<<threadCount>>> or <<<useUnlimitedThreads>>> attribute.
- For example:
+You can also manually force a specific provider by adding it as a dependency to ${thisPlugin} itself:
+---+
<plugins>
[...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <parallel>methods</parallel>
- <threadCount>10</threadCount>
- </configuration>
- </plugin>
- [...]
-</plugins>
-+---+
-
-
- If your tests specify any value for the "parallel" attribute and your project uses JUnit 4.7+, your request will be routed to
- the concurrent JUnit provider, which uses the JUnit JUnitCore testrunner.
-
- This is particularly useful for slow tests that can have high concurrency.
-
- As of surefire 2.7, no additional dependencies are needed to use the full set of options with parallel.
-
-* Using custom listeners and reporters
-
- JUnit4/4.7 provider provides support for attaching custom RunListeners to your tests.
-
- You can configure multiple custom listeners like this:
-
-+---+
-<plugins>
-[...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <properties>
- <property>
- <name>listener</name>
- <value>com.mycompany.MyResultListener,com.mycompany.MyResultListener2</value>
- </property>
- </configuration>
- </plugin>
-[...]
-</plugins>
-+---+
-
-* Using a security manager (JUnit3 only)
-
- As long as forkMode!=never and you use JUnit3, you can run your tests with a java security manager active.
- The classname of the security manager must be sent as a system property variable to the JUnit3 provider.
-
- JUnit4 uses mechanisms internally that are not compatible with the tested security managers and is not supported
- by surefire.
-
-+---+
-<plugins>
-[...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <systemPropertyVariables>
- <surefire.security.manager>java.lang.SecurityManager</surefire.security.manager>
- </systemPropertyVariables>
- </configuration>
- </plugin>
-[...]
-</plugins>
-+---+
-
-* Using a security manager (All providers)
-
- Alternatively you can define a policy file that allows all providers to run with surefire
- and send them using the argLine parameter and two system properties;
-
-+---+
-<plugins>
-[...]
- <plugin>
+ <plugin>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
- <configuration>
- <argLine>-Djava.security.manager -Djava.security.policy=${basedir}/src/test/resources/java.policy</argLine>
- </configuration>
- </plugin>
-[...]
-</plugins>
-+---+
-
- The disadvantage of this solution is that the policy changes will affect the tests too, which make the
- security environment less realistic.
-
-* Using JUnit Categories
-
- JUnit 4.8 introduced the notion of Categories. You can use JUnit categories by using the <<<groups>>> parameter. As long as
- the JUnit version in the project is 4.8 or higher, the presence of the "groups" parameter will automatically make surefire select
- the junit47 provider, which supports groups.
-
-+---+
-<plugins>
-[...]
- <plugin>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.11</version>
- <configuration>
- <groups>com.mycompany.SlowTests</groups>
- </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven.surefire</groupId>
+ <artifactId>surefire-junit47</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
</plugin>
-[...]
+ [...]
</plugins>
+---+
- This will execute only those tests annotated with the <<<@Category(com.mycompany.SlowTests.class)>>> annotation and those tests
- annotated with <<<@Category(com.mycompany.SlowerTests.class)>>> if class/interface <<<SlowerTests>>> is subclass of <<<SlowTests>>>:
-
-+---+
- public interface SlowTests{}
- public interface SlowerTests extends SlowTests{}
-+---+
+When using this technique there is no check that the proper test-frameworks are present on your project's
+classpath. Failing to add the proper test-frameworks will result in a build failure.
-+---+
- public class AppTest {
- @Test
- @Category(com.mycompany.SlowTests.class)
- public void testSlow() {
- System.out.println("slow");
- }
-
- @Test
- @Category(com.mycompany.SlowerTests.class)
- public void testSlower() {
- System.out.println("slower");
- }
-
- @Test
- @Category(com.cmycompany.FastTests.class)
- public void testSlow() {
- System.out.println("fast");
- }
- }
-+---+
+* Running tests in parallel
- The @Category annotation can also be applied at class-level.
-
- For more information on JUnit, see the {{{http://www.junit.org}JUnit web site}}.
+From JUnit 4.7 and onwards you can run your tests in parallel. To do this, you must set the
+<<
+<parallel>>> parameter, and may change the <<
+ <threadCount>>> or <<
+ <useUnlimitedThreads>>> attribute.
+ For example:
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <parallel>methods</parallel>
+ <threadCount>10</threadCount>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+
+ If your tests specify any value for the "parallel" attribute and your project uses JUnit 4.7+, your request
+ will be routed to
+ the concurrent JUnit provider, which uses the JUnit JUnitCore testrunner.
+
+ This is particularly useful for slow tests that can have high concurrency.
+
+ As of surefire 2.7, no additional dependencies are needed to use the full set of options with parallel.
+
+ * Using custom listeners and reporters
+
+ JUnit4/4.7 provider provides support for attaching custom RunListeners to your tests.
+
+ You can configure multiple custom listeners like this:
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <properties>
+ <property>
+ <name>listener</name>
+ <value>com.mycompany.MyResultListener,com.mycompany.MyResultListener2</value>
+ </property>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ * Using a security manager (JUnit3 only)
+
+ As long as forkMode!=never and you use JUnit3, you can run your tests with a java security manager active.
+ The classname of the security manager must be sent as a system property variable to the JUnit3 provider.
+
+ JUnit4 uses mechanisms internally that are not compatible with the tested security managers and is not
+ supported
+ by surefire.
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <systemPropertyVariables>
+ <surefire.security.manager>java.lang.SecurityManager</surefire.security.manager>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ * Using a security manager (All providers)
+
+ Alternatively you can define a policy file that allows all providers to run with surefire
+ and send them using the argLine parameter and two system properties;
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <argLine>-Djava.security.manager -Djava.security.policy=${basedir}
+ /src/test/resources/java.policy
+ </argLine>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ The disadvantage of this solution is that the policy changes will affect the tests too, which make the
+ security environment less realistic.
+
+ * Using JUnit Categories
+
+ JUnit 4.8 introduced the notion of Categories. You can use JUnit categories by using the <<
+ <groups>>> parameter. As long as
+ the JUnit version in the project is 4.8 or higher, the presence of the "groups" parameter will
+ automatically make surefire select
+ the junit47 provider, which supports groups.
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <version>2.11</version>
+ <configuration>
+ <groups>com.mycompany.SlowTests</groups>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ This will execute only those tests annotated with the <<<@Category(com.mycompany.SlowTests.class)>>>
+ annotation and those tests
+ annotated with <<<@Category(com.mycompany.SlowerTests.class)>>> if class/interface <<
+ <SlowerTests>>> is subclass of <<
+ <SlowTests>>>:
+
+ +---+
+ public interface SlowTests{}
+ public interface SlowerTests extends SlowTests{}
+ +---+
+
+ +---+
+ public class AppTest {
+ @Test
+ @Category(com.mycompany.SlowTests.class)
+ public void testSlow() {
+ System.out.println("slow");
+ }
+
+ @Test
+ @Category(com.mycompany.SlowerTests.class)
+ public void testSlower() {
+ System.out.println("slower");
+ }
+
+ @Test
+ @Category(com.cmycompany.FastTests.class)
+ public void testSlow() {
+ System.out.println("fast");
+ }
+ }
+ +---+
+
+ The @Category annotation can also be applied at class-level.
+
+ For more information on JUnit, see the {{{http://www.junit.org}JUnit web site}}.
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/pojo-test.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/pojo-test.apt.vm b/maven-surefire-plugin/src/site/apt/examples/pojo-test.apt.vm
index 1d2661e..4ebfe9e 100644
--- a/maven-surefire-plugin/src/site/apt/examples/pojo-test.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/pojo-test.apt.vm
@@ -1,50 +1,54 @@
- ------
- Using POJO tests
- ------
- Christian Gruber
- ------
- May 2008
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Using POJO tests
+------
+Christian Gruber
+------
+May 2008
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Defining a POJO Test
- POJO tests look very much like JUnit or TestNG tests, though they do not
- require dependencies on these artifacts. A test class should be named
- <<<**/*Test>>> and should contain <<<test*>>> methods which will each be
- executed by surefire.
-
- Validating assertions can be done using the JDK 1.4 <<<assert>>> keyword.
- Simultaneous test execution is not possible with POJO tests.
-
- Fixture can be setup before and after each <<<test*>>> method by implementing
- a set-up and a tear-down method. These methods must match these signatures
- to be recognized and executed before and after each test method.
-
-+---+
-public void setUp();
-public void tearDown();
-+---+
-
- These fixture methods can also throw any exception and will still be valid.
+POJO tests look very much like JUnit or TestNG tests, though they do not
+require dependencies on these artifacts. A test class should be named
+<<<**/*Test>>> and should contain <<
+<test*>>> methods which will each be
+executed by surefire.
+
+Validating assertions can be done using the JDK 1.4 <<
+<assert>>> keyword.
+ Simultaneous test execution is not possible with POJO tests.
+
+ Fixture can be setup before and after each <<
+ <test
+ *>>> method by implementing
+ a set-up and a tear-down method. These methods must match these signatures
+ to be recognized and executed before and after each test method.
+
+ +---+
+ public void setUp();
+ public void tearDown();
+ +---+
+
+ These fixture methods can also throw any exception and will still be valid.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/providers.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/providers.apt.vm b/maven-surefire-plugin/src/site/apt/examples/providers.apt.vm
index 39eff4d..dd595f4 100644
--- a/maven-surefire-plugin/src/site/apt/examples/providers.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/providers.apt.vm
@@ -1,64 +1,65 @@
- ------
- Selecting providers
- ------
- Kristian Rosenvold <kr...@apache.org>
- ------
- 2010-12-04
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
+------
+Selecting providers
+------
+Kristian Rosenvold
+<kr...@apache.org>
+------
+2010-12-04
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Selecting providers
* Selecting a provider
- Surefire normally automatically selects which test-framework provider to use based on the version of
- TestNG/JUnit present in your project's classpath. In some cases it may be desirable to manually
- override such a selection. This can be done by adding the required provider as a dependency to
- the surefire-plugin.
+Surefire normally automatically selects which test-framework provider to use based on the version of
+TestNG/JUnit present in your project's classpath. In some cases it may be desirable to manually
+override such a selection. This can be done by adding the required provider as a dependency to
+the surefire-plugin.
- The following example shows how to force the junit 4.7 provider:
+The following example shows how to force the junit 4.7 provider:
+---+
<plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <dependencies>
- <dependency>
- <groupId>org.apache.maven.surefire</groupId>
- <artifactId>surefire-junit47</artifactId>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
- </dependency>
- </dependencies>
- </plugin>
- [...]
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven.surefire</groupId>
+ <artifactId>surefire-junit47</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ [...]
</plugins>
+---+
- The providers supplied with surefire are surefire-junit3, surefire-junit4, surefire-junit47 and surefire-testng.
- Please note that forcing a provider still requires that the test framework is properly set up on your project classpath.
+The providers supplied with surefire are surefire-junit3, surefire-junit4, surefire-junit47 and surefire-testng.
+Please note that forcing a provider still requires that the test framework is properly set up on your project classpath.
- You can also specify multiple providers as dependencies, and they will all be run and produce a common report.
- This may be especially handy with external providers, since there are few use-cases for combining the included providers.
+You can also specify multiple providers as dependencies, and they will all be run and produce a common report.
+This may be especially handy with external providers, since there are few use-cases for combining the included providers.
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/single-test.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/single-test.apt.vm b/maven-surefire-plugin/src/site/apt/examples/single-test.apt.vm
index b67897f..d228673 100644
--- a/maven-surefire-plugin/src/site/apt/examples/single-test.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/single-test.apt.vm
@@ -1,116 +1,122 @@
- ------
- Running a Single Test
- ------
- Allan Ramirez
- Olivier Lamy
- ------
- 2012-02-28
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Running a Single Test
+------
+Allan Ramirez
+Olivier Lamy
+------
+2012-02-28
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Running a Single Test
#{if}(${project.artifactId}=="maven-surefire-plugin")
- During development, you may run a single test class repeatedly. To run this
- through Maven, set the <<<test>>> property to a specific test case.
+During development, you may run a single test class repeatedly. To run this
+through Maven, set the <<
+<test>>> property to a specific test case.
-+---+
-mvn -Dtest=TestCircle test
-+---+
+ +---+
+ mvn -Dtest=TestCircle test
+ +---+
- The value for the <<<test>>> parameter is the name of the test class (without the extension; we'll strip off the extension if you accidentally provide one).
+ The value for the <<
+<test>>> parameter is the name of the test class (without the extension; we'll strip off the extension if you
+ accidentally provide one).
#{else}
- During development, you may run a single test class repeatedly. To run this
- through Maven, set the <<<it.test>>> property to a specific test case.
+ During development, you may run a single test class repeatedly. To run this
+ through Maven, set the <<
+<it.test>>> property to a specific test case.
-+---+
-mvn -Dit.test=ITCircle verify
-+---+
+ +---+
+ mvn -Dit.test=ITCircle verify
+ +---+
- The value for the <<<it.test>>> parameter is the name of the test class (without the extension; we'll strip off the extension if you accidentally provide one).
+ The value for the <<
+<it.test>>> parameter is the name of the test class (without the extension; we'll strip off the extension if you
+ accidentally provide one).
#{end}
- You may also use patterns to run a number of tests:
+ You may also use patterns to run a number of tests:
#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-mvn -Dtest=TestCi*le test
-+---+
+ +---+
+ mvn -Dtest=TestCi*le test
+ +---+
#{else}
-+---+
-mvn -Dit.test=ITCi*le verify
-+---+
+ +---+
+ mvn -Dit.test=ITCi*le verify
+ +---+
#{end}
- And you may use multiple names/patterns, separated by commas:
+ And you may use multiple names/patterns, separated by commas:
#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-mvn -Dtest=TestSquare,TestCi*le test
-+---+
+ +---+
+ mvn -Dtest=TestSquare,TestCi*le test
+ +---+
#{else}
-+---+
-mvn -Dit.test=ITSquare,ITCi*le verify
-+---+
+ +---+
+ mvn -Dit.test=ITSquare,ITCi*le verify
+ +---+
#{end}
-Running a set of methods in a Single Test Class
+ Running a set of methods in a Single Test Class
+
+ With version 2.7.3, you can run only n tests in a single Test Class.
+
+ << NOTE : it's supported for junit 4.x and TestNG. >>
+
+ You must use the following syntax
- With version 2.7.3, you can run only n tests in a single Test Class.
-
- << NOTE : it's supported for junit 4.x and TestNG. >>
-
- You must use the following syntax
-
#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-mvn -Dtest=TestCircle#mytest test
-+---+
+ +---+
+ mvn -Dtest=TestCircle#mytest test
+ +---+
#{else}
-+---+
-mvn -Dit.test=ITCircle#mytest verify
-+---+
+ +---+
+ mvn -Dit.test=ITCircle#mytest verify
+ +---+
#{end}
- You can use patterns too
-
+ You can use patterns too
+
#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-mvn -Dtest=TestCircle#test* test
-+---+
+ +---+
+ mvn -Dtest=TestCircle#test* test
+ +---+
#{else}
-+---+
-mvn -Dit.test=ITCircle#test* verify
-+---+
+ +---+
+ mvn -Dit.test=ITCircle#test* verify
+ +---+
#{end}
- As of surefire 2.12.1, you can select multiple methods (JUnit4X only at this time, patches welcome)
+ As of surefire 2.12.1, you can select multiple methods (JUnit4X only at this time, patches welcome)
#{if}(${project.artifactId}=="maven-surefire-plugin")
-+---+
-mvn -Dtest=TestCircle#testOne+testTwo test
-+---+
+ +---+
+ mvn -Dtest=TestCircle#testOne+testTwo test
+ +---+
#{else}
-+---+
-mvn -Dit.test=ITCircle#test* verify
-+---+
+ +---+
+ mvn -Dit.test=ITCircle#test* verify
+ +---+
#{end}
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/skipping-test.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/skipping-test.apt.vm b/maven-surefire-plugin/src/site/apt/examples/skipping-test.apt.vm
index ff8584f..85a0d1f 100644
--- a/maven-surefire-plugin/src/site/apt/examples/skipping-test.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/skipping-test.apt.vm
@@ -1,112 +1,118 @@
- ------
- Skipping Test
- ------
- Johnny Ruiz
- Brett Porter
- Allan Ramirez
- ------
- July 2006
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Skipping Test
+------
+Johnny Ruiz
+Brett Porter
+Allan Ramirez
+------
+July 2006
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Skipping Tests
- To skip running the tests for a particular project, set the <<skipTests>>
- property to <<true>>.
-
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <skipTests>true</skipTests>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
- You can also skip the tests via command line by executing the following command:
-
-+---+
-mvn install -DskipTests
-+---+
-
-#{if}(${project.artifactId}=="maven-failsafe-plugin")
- Since <<<skipTests>>> is also followed by the ${thatPlugin} Plugin, this will have the effect
- of not running any tests. If, instead, you want to skip only the integration tests
- being run by the ${thisPlugin} Plugin, you would use the <<<skipITs>>> property
-
-+---+
-mvn install -DskipITs
-+---+
-
-#{end}
- If you absolutely must, you can also use the <<<maven.test.skip>>> property to skip compiling the tests.
- <<<maven.test.skip>>> is honored by Surefire, Failsafe and the Compiler Plugin.
-
-+---+
-mvn install -Dmaven.test.skip=true
-+---+
-
-Skipping by default
-
- If you want to skip tests by default but want the ability to re-enable tests from the
- command line, you need to go via a properties section in the pom:
-
-+---+
-<project>
- [...]
- <properties>
- <skipTests>true</skipTests>
- </properties>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <skipTests>${skipTests}</skipTests>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
- This will allow you to run with tests disabled by default and to run them with this command:
-
-+---+
-mvn install -DskipTests=false
-+---+
-
- The same can be done with the "skip" parameter and other booleans on the plugin.
+To skip running the tests for a particular project, set the <
+<skipTests>>
+ property to <
+ <true>>.
+
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <skipTests>true</skipTests>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+
+ You can also skip the tests via command line by executing the following command:
+
+ +---+
+ mvn install -DskipTests
+ +---+
+
+ #{if}(${project.artifactId}=="maven-failsafe-plugin")
+ Since <<
+ <skipTests>>> is also followed by the ${thatPlugin} Plugin, this will have the effect
+ of not running any tests. If, instead, you want to skip only the integration tests
+ being run by the ${thisPlugin} Plugin, you would use the <<
+ <skipITs>>> property
+
+ +---+
+ mvn install -DskipITs
+ +---+
+
+ #{end}
+ If you absolutely must, you can also use the <<
+ <maven.test.skip>>> property to skip compiling the tests.
+ <<
+ <maven.test.skip>>> is honored by Surefire, Failsafe and the Compiler Plugin.
+
+ +---+
+ mvn install -Dmaven.test.skip=true
+ +---+
+
+ Skipping by default
+
+ If you want to skip tests by default but want the ability to re-enable tests from the
+ command line, you need to go via a properties section in the pom:
+
+ +---+
+ <project>
+ [...]
+ <properties>
+ <skipTests>true</skipTests>
+ </properties>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <skipTests>${skipTests}</skipTests>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+
+ This will allow you to run with tests disabled by default and to run them with this command:
+
+ +---+
+ mvn install -DskipTests=false
+ +---+
+
+ The same can be done with the "skip" parameter and other booleans on the plugin.
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/system-properties.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/system-properties.apt.vm b/maven-surefire-plugin/src/site/apt/examples/system-properties.apt.vm
index 76d8abf..ecc30ae 100644
--- a/maven-surefire-plugin/src/site/apt/examples/system-properties.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/system-properties.apt.vm
@@ -1,140 +1,150 @@
- ------
- Using System Properties
- ------
- Allan Ramirez
- Dan Tran
- ------
- 2010-01-09
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Using System Properties
+------
+Allan Ramirez
+Dan Tran
+------
+2010-01-09
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Using System Properties
- There are two ways to add a list of system properties to ${thisPlugin}:
+There are two ways to add a list of system properties to ${thisPlugin}:
* systemPropertyVariables
- This configuration is the replacement of the deprecated <<<systemProperties>>>. It can accept any value
- from Maven's properties that can be converted <<to String value>>.
-
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <systemPropertyVariables>
- <propertyName>propertyValue</propertyName>
- <buildDirectory>\${project.build.directory}</buildDirectory>
+This configuration is the replacement of the deprecated <<
+<systemProperties>>>. It can accept any value
+ from Maven's properties that can be converted <
+ <to String value>>.
+
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <systemPropertyVariables>
+ <propertyName>propertyValue</propertyName>
+ <buildDirectory>\${project.build.directory}</buildDirectory>
+ [...]
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+
+
+ * systemProperties ( deprecated )
+
+ +---+
+ <project>
[...]
- </systemPropertyVariables>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
-
-* systemProperties ( deprecated )
-
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <systemProperties>
- <property>
- <name>propertyName</name>
- <value>propertyValue</value>
- </property>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <systemProperties>
+ <property>
+ <name>propertyName</name>
+ <value>propertyValue</value>
+ </property>
+ [...]
+ </systemProperties>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
[...]
- </systemProperties>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
- Take note that only <<String valued>> properties can be passed as system
- properties. Any attempt to pass any other Maven variable type (i.e. <<<List>>>
- or a <<<URL>>> variable) will cause the variable expression to be passed
- literally (unevaluated). So having the example below:
-
-+---+
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <systemProperties>
- <property>
- <name>buildDir</name>
- <value>\${project.build.outputDirectory}</value>
- </property>
- </systemProperties>
- </configuration>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+---+
-
- will literally pass <<$\{project.build.outputDirectory\}>> because the value
- of that expression is a <<<File>>>, not a <<<String>>>.
-
- To inherit the "systemProperties" collection from the parent configuration,
- you will need to specify combine.children="append" on the systemProperties node in the child pom:
-
-+---+
- <systemProperties combine.children="append">
- <property>
- [...]
- </property>
- </systemProperties>
-+---+
-
-Special VM properties
-
- Some system properties must be set on the command line of the forked VM, and cannot be set after the
- VM has been started. These properties must be added to the argLine parameter of the surefire plugin.
-
-+---+
- <argLine>-Djava.endorsed.dirs=...</argLine>
-+---+
+ </project>
+ +---+
+
+ Take note that only <
+ <String valued>> properties can be passed as system
+ properties. Any attempt to pass any other Maven variable type (i.e. <<
+ <List>>>
+ or a <<
+ <URL>>> variable) will cause the variable expression to be passed
+ literally (unevaluated). So having the example below:
+
+ +---+
+ <project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <systemProperties>
+ <property>
+ <name>buildDir</name>
+ <value>\${project.build.outputDirectory}</value>
+ </property>
+ </systemProperties>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+ </project>
+ +---+
+
+ will literally pass <<$\{project.build.outputDirectory\}>> because the value
+ of that expression is a <<
+ <File>>>, not a <<
+ <String>>>.
+
+ To inherit the "systemProperties" collection from the parent configuration,
+ you will need to specify combine.children="append" on the systemProperties node in the child
+ pom:
+
+ +---+
+ <systemProperties combine.children="append">
+ <property>
+ [...]
+ </property>
+ </systemProperties>
+ +---+
+
+ Special VM properties
+
+ Some system properties must be set on the command line of the forked VM, and cannot be set
+ after the
+ VM has been started. These properties must be added to the argLine parameter of the surefire
+ plugin.
+
+ +---+
+ <argLine>-Djava.endorsed.dirs=...</argLine>
+ +---+
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/examples/testng.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/testng.apt.vm b/maven-surefire-plugin/src/site/apt/examples/testng.apt.vm
index 3b6e37e..beda88a 100644
--- a/maven-surefire-plugin/src/site/apt/examples/testng.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/testng.apt.vm
@@ -1,209 +1,235 @@
- ------
- Using TestNG
- ------
- Brett Porter <br...@apache.org>
- ------
- 2010-01-09
- ------
-
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements. See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership. The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License. You may obtain a copy of the License at
- ~~
- ~~ http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied. See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- ~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+------
+Using TestNG
+------
+Brett Porter
+<br...@apache.org>
+------
+2010-01-09
+------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Using TestNG
* Configuring TestNG
- To get started with TestNG, include the following dependency in your project (replacing the version with the one you wish to use):
+To get started with TestNG, include the following dependency in your project (replacing the version with the one you wish to use):
+---+
<dependencies>
- [...]
+ [...]
<dependency>
- <groupId>org.testng</groupId>
- <artifactId>testng</artifactId>
- <version>6.3.1</version>
- <scope>test</scope>
+ <groupId>org.testng</groupId>
+ <artifactId>testng</artifactId>
+ <version>6.3.1</version>
+ <scope>test</scope>
</dependency>
- [...]
+ [...]
</dependencies>
+---+
- If you are using an older version of TestNG (\<= 5.11), the dependency would instead look like this:
+If you are using an older version of TestNG (\<= 5.11), the dependency would instead look like this:
+---+
<dependencies>
- [...]
+ [...]
<dependency>
- <groupId>org.testng</groupId>
- <artifactId>testng</artifactId>
- <version>6.3.1</version>
- <scope>test</scope>
- <classifier>jdk15</classifier>
+ <groupId>org.testng</groupId>
+ <artifactId>testng</artifactId>
+ <version>6.3.1</version>
+ <scope>test</scope>
+ <classifier>jdk15</classifier>
</dependency>
- [...]
-</dependencies>
-+---+
-
- <<Note:>> if you are using JDK 1.4 Javadoc annotations for your TestNG tests, replace the classifier <<<jdk15>>> with <<<jdk14>>> above.
-
-#{if}(${project.artifactId}=="maven-surefire-plugin")
- This is the only step that is required to get started - you can now create tests in your test source directory
- (eg, <<<src/test/java>>>. As long as they are named using the defaults such as <<<*Test.java>>> they will be run
- by ${thisPlugin} as TestNG tests.
-#{else}
- This is the only step that is required to get started - you can now create tests in your test source directory
- (eg, <<<src/test/java>>>. As long as they are named using the defaults such as <<<*IT.java>>> they will be run
- by ${thisPlugin} as TestNG tests.
-#{end}
-
- If you'd like to use a different naming scheme, you can change the <<<includes>>> parameter, as discussed in the
- {{{./inclusion-exclusion.html}Inclusions and Exclusions of Tests}} example.
-
-* Using Suite XML Files
-
- Another alternative is to use TestNG suite XML files. This allows flexible configuration of the tests to be run.
- These files are created in the normal way, and then added to the ${thisPlugin} Plugin configuration:
-
-+---+
-<plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <suiteXmlFiles>
- <suiteXmlFile>testng.xml</suiteXmlFile>
- </suiteXmlFiles>
- </configuration>
- </plugin>
- [...]
-</plugins>
-+---+
-
- This configuration will override the includes and excludes patterns and run all tests in the suite files.
-
-* Specifying Test Parameters
-
- Your TestNG test can accept parameters with the @Parameters annotation. You can also pass parameters from Maven
- into your TestNG test, by specifying them as system properties, like this:
-
-+---+
-<plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <systemPropertyVariables>
- <propertyName>firefox</propertyName>
- </systemPropertyVariables>
- </configuration>
- </plugin>
- [...]
-</plugins>
-+---+
-
- For more information about setting system properties in ${thisPlugin} tests, see {{{./system-properties.html}System Properties}}.
-
-* Using Groups
-
- TestNG allows you to group your tests. You can then execute one or more specific groups. To do this with ${thisPlugin},
- use the <<<groups>>> parameter, for example:
-
-+---+
-<plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <groups>functest,perftest</groups>
- </configuration>
- </plugin>
- [...]
-</plugins>
-+---+
-
- Likewise, the <<<excludedGroups>>> parameter can be used to run all but a certain set of groups.
-
-* Running tests in parallel
-
- TestNG allows you to run your tests in parallel, including JUnit tests. To do this, you must set the
- <<<parallel>>> parameter, and may change the <<<threadCount>>> parameter if the default of 5 is not sufficient.
- For example:
-
-+---+
-</plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <parallel>methods</parallel>
- <threadCount>10</threadCount>
- </configuration>
- </plugin>
- [...]
-</plugins>
-+---+
-
- This is particularly useful for slow tests that can have high concurrency, or to quickly and roughly assess the independance
- and thread safety of your tests and code.
-
-* Using custom listeners and reporters
-
- TestNG provides support for attaching custom listeners, reporters, annotation transformers and method interceptors to your tests.
- By default, TestNG attaches a few basic listeners to generate HTML and XML reports.
-
- You can configure multiple custom listeners like this:
-
-+---+
-</plugins>
- [...]
- <plugin>
- <groupId>${project.groupId}</groupId>
- <artifactId>${project.artifactId}</artifactId>
- <version>${project.version}</version>
- <configuration>
- <properties>
- <property>
- <name>usedefaultlisteners</name>
- <value>false</value> <!-- disabling default listeners is optional -->
- </property>
- <property>
- <name>listener</name>
- <value>com.mycompany.MyResultListener,com.mycompany.MyAnnotationTransformer,com.mycompany.MyMethodInterceptor</value>
- </property>
- <property>
- <name>reporter</name>
- <value>listenReport.Reporter</value>
- </property>
- </properties>
- </configuration>
- </plugin>
[...]
-</plugins>
+</dependencies>
+---+
- For more information on TestNG, see the {{{http://www.testng.org}TestNG web site}}.
+<
+<Note:>> if you are using JDK 1.4 Javadoc annotations for your TestNG tests, replace the classifier <<
+ <jdk15>>> with <<
+ <jdk14>>> above.
+
+ #{if}(${project.artifactId}=="maven-surefire-plugin")
+ This is the only step that is required to get started - you can now create tests in your test source
+ directory
+ (eg, <<
+ <src
+ /test/java>>>. As long as they are named using the defaults such as <<<*Test.java>>> they will be run
+ by ${thisPlugin} as TestNG tests.
+ #{else}
+ This is the only step that is required to get started - you can now create tests in your test source
+ directory
+ (eg, <<
+ <src
+ /test/java>>>. As long as they are named using the defaults such as <<<*IT.java>>> they will be run
+ by ${thisPlugin} as TestNG tests.
+ #{end}
+
+ If you'd like to use a different naming scheme, you can change the <<
+ <includes>>> parameter, as discussed in the
+ {{{./inclusion-exclusion.html}Inclusions and Exclusions of Tests}} example.
+
+ * Using Suite XML Files
+
+ Another alternative is to use TestNG suite XML files. This allows flexible configuration of the tests to
+ be run.
+ These files are created in the normal way, and then added to the ${thisPlugin} Plugin configuration:
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <suiteXmlFiles>
+ <suiteXmlFile>testng.xml</suiteXmlFile>
+ </suiteXmlFiles>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ This configuration will override the includes and excludes patterns and run all tests in the suite
+ files.
+
+ * Specifying Test Parameters
+
+ Your TestNG test can accept parameters with the @Parameters annotation. You can also pass parameters
+ from Maven
+ into your TestNG test, by specifying them as system properties, like this:
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <systemPropertyVariables>
+ <propertyName>firefox</propertyName>
+ </systemPropertyVariables>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ For more information about setting system properties in ${thisPlugin} tests, see
+ {{{./system-properties.html}System Properties}}.
+
+ * Using Groups
+
+ TestNG allows you to group your tests. You can then execute one or more specific groups. To do this
+ with ${thisPlugin},
+ use the <<
+ <groups>>> parameter, for example:
+
+ +---+
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <groups>functest,perftest</groups>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ Likewise, the <<
+ <excludedGroups>>> parameter can be used to run all but a certain set of groups.
+
+ * Running tests in parallel
+
+ TestNG allows you to run your tests in parallel, including JUnit tests. To do this, you must set
+ the
+ <<
+ <parallel>>> parameter, and may change the <<
+ <threadCount>>> parameter if the default of 5 is not sufficient.
+ For example:
+
+ +---+
+ </plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <parallel>methods</parallel>
+ <threadCount>10</threadCount>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ This is particularly useful for slow tests that can have high concurrency, or to quickly
+ and roughly assess the independance
+ and thread safety of your tests and code.
+
+ * Using custom listeners and reporters
+
+ TestNG provides support for attaching custom listeners, reporters, annotation
+ transformers and method interceptors to your tests.
+ By default, TestNG attaches a few basic listeners to generate HTML and XML reports.
+
+ You can configure multiple custom listeners like this:
+
+ +---+
+ </plugins>
+ [...]
+ <plugin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <properties>
+ <property>
+ <name>usedefaultlisteners</name>
+ <value>false</value>
+ <!-- disabling default listeners is optional -->
+ </property>
+ <property>
+ <name>listener</name>
+ <value>
+ com.mycompany.MyResultListener,com.mycompany.MyAnnotationTransformer,com.mycompany.MyMethodInterceptor
+ </value>
+ </property>
+ <property>
+ <name>reporter</name>
+ <value>listenReport.Reporter</value>
+ </property>
+ </properties>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ +---+
+
+ For more information on TestNG, see the {{{http://www.testng.org}TestNG web site}}.
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/a303827d/maven-surefire-plugin/src/site/apt/featurematrix.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/featurematrix.apt.vm b/maven-surefire-plugin/src/site/apt/featurematrix.apt.vm
index 13a06a9..63e06b0 100644
--- a/maven-surefire-plugin/src/site/apt/featurematrix.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/featurematrix.apt.vm
@@ -20,27 +20,34 @@
Feature matrix
- Not all features are supported for all test frameworks, and the following table gives a brief overview
- of support status:
+Not all features are supported for all test frameworks, and the following table gives a brief overview
+of support status:
*---------------------------------------------+-----------+-----------+------------+-----------+----------+
-|| <<Feature>> ||<<JUnit3>>||<<JUnit4>>||<<Junit47>>||<<TestNG>>||<<Pojo>> |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-| groups/category support | N | N | Y | Y | N |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-| security manager support | Y | N | N | N | N |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-| runOrder support | Y | Y | Y | ? | Y |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-| run >1 individual test method in a class | N | Y | Y | N | N |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-| parallel support | N | N | Y | Y | N |
-*---------------------------------------------+------------+----------+------------+-----------+----------+
-
-
- Legend: Y means supported, N means not supported. ? means not tested.
-
- If you would like to implement support for
- a given provider with an N or a ? (or create tests for it), you should create a patch and mark the issue is an
- improvement. If there is something wrong with an implementation marked with "Y" it's a bug.
+|| <
+<Feature>> ||<
+ <JUnit3>>||<
+ <JUnit4>>||<
+ <Junit47>>||<
+ <TestNG>>||<
+ <Pojo>> |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+ | groups/category support | N | N | Y | Y | N |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+ | security manager support | Y | N | N | N | N |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+ | runOrder support | Y | Y | Y | ? | Y |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+ | run >1 individual test method in a class | N | Y | Y | N | N |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+ | parallel support | N | N | Y | Y | N |
+ *---------------------------------------------+------------+----------+------------+-----------+----------+
+
+
+ Legend: Y means supported, N means not supported. ? means not tested.
+
+ If you would like to implement support for
+ a given provider with an N or a ? (or create tests for it), you should create a patch and mark
+ the issue is an
+ improvement. If there is something wrong with an implementation marked with "Y" it's a bug.