org.gradle.api.tasks.testing

Interface TestFilter

@Incubating
public interface TestFilter

Allows filtering tests for execution. Some examples:

   apply plugin: 'java'

   test {
       filter {
          //specific test method
          includeTestsMatching "org.gradle.SomeTest.someSpecificFeature"

          //specific test method, use wildcard for packages
          includeTestsMatching "*SomeTest.someSpecificFeature"

          //specific test class
          includeTestsMatching "org.gradle.SomeTest"

          //specific test class, wildcard for packages
          includeTestsMatching "*.SomeTest"

          //all classes in package, recursively
          includeTestsMatching "com.gradle.tooling.*"

          //all integration tests, by naming convention
          includeTestsMatching "*IntegTest"

          //only ui tests from integration tests, by some naming convention
          includeTestsMatching "*IntegTest*ui"
       }
   }

 

Since:

1.10

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getIncludePatterns() Returns the included test name patterns.
TestFilter	includeTestsMatching(String testNamePattern) Appends a test name pattern to the filter.
TestFilter	setIncludePatterns(String... testNamePatterns) Sets the test name patterns to be included in the filter.

Method Detail

includeTestsMatching

TestFilter includeTestsMatching(String testNamePattern)

Appends a test name pattern to the filter. Wildcard '*' is supported, either test method name or class name is supported. Examples of test names: "com.foo.FooTest.someMethod", "com.foo.FooTest", "*FooTest*", "com.foo*". See examples in the docs for TestFilter.

Parameters:

testNamePattern - test name pattern to include, can be class or method name, can contain wildcard '*'

Returns:

this filter object

getIncludePatterns

Set<String> getIncludePatterns()

Returns the included test name patterns. They can be class or method names and may contain wildcard '*'. Test name patterns can be appended via includeTestsMatching(String) or set via setIncludePatterns(String...).

Returns:

included test name patterns

setIncludePatterns

TestFilter setIncludePatterns(String... testNamePatterns)

Sets the test name patterns to be included in the filter. Wildcard '*' is supported. Replaces any existing test name patterns.

Parameters:

testNamePatterns - class or method name patterns to set, may contain wildcard '*'

Returns:

this filter object