1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*******************************************************************************
* Copyright (c) 2009, 2019 Mountainminds GmbH & Co. KG and Contributors
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Evgeny Mandrikov - initial API and implementation
* Kyle Lieber - implementation of CheckMojo
* Marc Hoffmann - redesign using report APIs
*
*******************************************************************************/
package org.jacoco.maven;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.jacoco.core.analysis.ICoverageNode;
import org.jacoco.report.IReportVisitor;
import org.jacoco.report.check.IViolationsOutput;
import org.jacoco.report.check.Limit;
import org.jacoco.report.check.Rule;
/**
* Checks that the code coverage metrics are being met.
*
* @since 0.6.1
*/
@Mojo(name = "check", defaultPhase = LifecyclePhase.VERIFY, threadSafe = true)
public class CheckMojo extends AbstractJacocoMojo implements IViolationsOutput {
private static final String MSG_SKIPPING = "Skipping JaCoCo execution due to missing execution data file:";
private static final String CHECK_SUCCESS = "All coverage checks have been met.";
private static final String CHECK_FAILED = "Coverage checks have not been met. See log for details.";
/**
* <p>
* Check configuration used to specify rules on element types (BUNDLE,
* PACKAGE, CLASS, SOURCEFILE or METHOD) with a list of limits. Each limit
* applies to a certain counter (INSTRUCTION, LINE, BRANCH, COMPLEXITY,
* METHOD, CLASS) and defines a minimum or maximum for the corresponding
* value (TOTALCOUNT, COVEREDCOUNT, MISSEDCOUNT, COVEREDRATIO, MISSEDRATIO).
* If a limit refers to a ratio it must be in the range from 0.0 to 1.0
* where the number of decimal places will also determine the precision in
* error messages. A limit ratio may optionally be declared as a percentage
* where 0.80 and 80% represent the same value.
* </p>
*
* <p>
* If not specified the following defaults are assumed:
* </p>
*
* <ul>
* <li>rule element: BUNDLE</li>
* <li>limit counter: INSTRUCTION</li>
* <li>limit value: COVEREDRATIO</li>
* </ul>
*
* <p>
* This example requires an overall instruction coverage of 80% and no class
* must be missed:
* </p>
*
* <pre>
* {@code
* <rules>
* <rule>
* <element>BUNDLE</element>
* <limits>
* <limit>
* <counter>INSTRUCTION</counter>
* <value>COVEREDRATIO</value>
* <minimum>0.80</minimum>
* </limit>
* <limit>
* <counter>CLASS</counter>
* <value>MISSEDCOUNT</value>
* <maximum>0</maximum>
* </limit>
* </limits>
* </rule>
* </rules>}
* </pre>
*
* <p>
* This example requires a line coverage minimum of 50% for every class
* except test classes:
* </p>
*
* <pre>
* {@code
* <rules>
* <rule>
* <element>CLASS</element>
* <excludes>
* <exclude>*Test</exclude>
* </excludes>
* <limits>
* <limit>
* <counter>LINE</counter>
* <value>COVEREDRATIO</value>
* <minimum>50%</minimum>
* </limit>
* </limits>
* </rule>
* </rules>}
* </pre>
*/
@Parameter(required = true)
private List<RuleConfiguration> rules;
/**
* Halt the build if any of the checks fail.
*/
@Parameter(property = "jacoco.haltOnFailure", defaultValue = "true", required = true)
private boolean haltOnFailure;
/**
* File with execution data.
*/
@Parameter(defaultValue = "${project.build.directory}/jacoco.exec")
private File dataFile;
/**
* A list of class files to include into analysis. May use wildcard
* characters (* and ?). When not specified everything will be included.
*/
@Parameter
private List<String> includes;
/**
* A list of class files to exclude from analysis. May use wildcard
* characters (* and ?). When not specified nothing will be excluded.
*/
@Parameter
private List<String> excludes;
private boolean violations;
private boolean canCheckCoverage() {
if (!dataFile.exists()) {
getLog().info(MSG_SKIPPING + dataFile);
return false;
}
final File classesDirectory = new File(
getProject().getBuild().getOutputDirectory());
if (!classesDirectory.exists()) {
getLog().info(
"Skipping JaCoCo execution due to missing classes directory:"
+ classesDirectory);
return false;
}
return true;
}
@Override
public void executeMojo() throws MojoExecutionException {
if (!canCheckCoverage()) {
return;
}
executeCheck();
}
private void executeCheck() throws MojoExecutionException {
violations = false;
final ReportSupport support = new ReportSupport(getLog());
final List<Rule> checkerrules = new ArrayList<Rule>();
for (final RuleConfiguration r : rules) {
checkerrules.add(r.rule);
}
support.addRulesChecker(checkerrules, this);
try {
final IReportVisitor visitor = support.initRootVisitor();
support.loadExecutionData(dataFile);
support.processProject(visitor, getProject(), includes, excludes);
visitor.visitEnd();
} catch (final IOException e) {
throw new MojoExecutionException(
"Error while checking code coverage: " + e.getMessage(), e);
}
if (violations) {
if (this.haltOnFailure) {
throw new MojoExecutionException(CHECK_FAILED);
} else {
this.getLog().warn(CHECK_FAILED);
}
} else {
this.getLog().info(CHECK_SUCCESS);
}
}
public void onViolation(final ICoverageNode node, final Rule rule,
final Limit limit, final String message) {
this.getLog().warn(message);
violations = true;
}
}
|
