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

#{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 end with "Test".

   * <<<"**/*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 end with "IT".

   * <<<"**/*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.

+---+
<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>
  [...]
</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.