Clover defines a Context as a part of source code that matches a specified structure or pattern. Contexts are either pre-defined or user-defined at instrumentation time. Each context must have a unique name. At report time, you can specify which contexts you would like to exclude in the coverage report.
Block Contexts are pre-defined by Clover. They represent 'block' syntactic constructs in the Java language. A full list of supported Block Contexts is shown below.
Clover's block context feature currently does not support Groovy.
Static initializer block
Instance initializer block
Switch statement body
While loop body
do-while loop body
For loop body
a deprecated block
A Method Context represents the set of methods whose signature matches a given pattern. Clover provides several pre-defined method contexts:
matches all private methods
matches all property getters/setters
A method signature includes all annotations, modifiers (public, static, final etc), the return type, the method name, parameter types and names, the throws clause and exceptions.
When matching method signatures against context regexps, whitespace is normalised and comments are ignored.
You can define your own method contexts via the
<methodContext> sub-element of
<clover-setup>, or via the configuration panel of your Clover IDE Plugin.
Contexts are matched against your source at instrumentation-time. This means you need to re-instrument your code after defining a new context.
Method Contexts with Groovy code
While Groovy syntax is flexible in nature, the regular expressions defined in the
regexp parameters of
<methodContext> elements must match a 'normalised' method signature.
Bear in mind that this is not necessarily how you would define the method in your Groovy source code.
For example, in Groovy code, a method defined via the 'def' keyword is always 'public'. This means that your
regexp must actually match "
public def". Hence, if you wanted to create a
regexp that matched the following Groovy method:
regexp must assume a match against:
Normalised method signature rules for defining
The following list illustrates the normalised form of the method signature (and hence, order) in which your
regexp must be defined to match specific methods in your Groovy source code:
- Modifiers– in the following order:
(Refer to Sun Java's documentation for more information.)
- Type Parameters (optional) – for example,
<E extends Object>
- Return Type – for example,
- Name – for example,
- Parameter List – for example,
(String arg1, int arg2)
- Throws – for example,
throws Exception1, Exception2
Examples of normalized signatures for Groovy
Clover's statement context feature currently does not support Groovy.
A Statement Context represents the set of statements that match a given pattern. For example, you might want to set up a statement context to allow you to filter out 'noisy' statements (such as logging calls) by defining a statement context regexp
A regular expression defined in a statement context will be matched against a normalized form of the statement:
- any white space characters before and after the statement are removed
- any newline characters are removed
- single space character is used to separate code tokens
When writing a regular expression you should take into account that in case of nested statements, the outer statement will contain inner statements as well. Consider the following example:
in this case, method body has three statements:
a) the while loop
b) the if condition
c) the logger.debug() method call
Assuming that you'd like to filter-out "logger.debug" calls, the regular expression should look like this:
Note that if the expression would be written as "^.*logger\.debug.*", then it would match also outer statements.
Using Context Filters
This section describes using context filters with Ant. For details of using filters with the IDE plugins, see the individual documentation for the plugin.
Filtering catch blocks
In some cases you may not be interested in the coverage of statements inside catch blocks. To filter them, you can use Clover's predefined
catch context to exclude statements inside catch blocks from a coverage report:
This generates a source-level HTML report that excludes coverage from statements inside catch blocks.
Filtering simple methods
In order to filter-out simple getters and setters you can use built-in "property" method context.
You can define also own filter, based on cyclomatic complexity and/or number of statements. For example:
Filtering logging statements
To remove logging statements for coverage reports, you will need to define one or more statement contexts that match logging statements in your source:
This defines two statement contexts and one method context. The first matches statements that start with '
LOG.' while the second matches statements that start with '
if (LOG.', which is designed to match conditional logging statements such as:
The third matches all 'main' methods that have a String Array named 'args' in the constructor:
After defining these contexts, you now need to re-compile with Clover and then re-run your tests. You can then generate a report that excludes logging statements:
This generates a source-level HTML report that excludes coverage from logging statements.