-
Notifications
You must be signed in to change notification settings - Fork 1
/
JacocoScanner.kt
422 lines (337 loc) · 13.8 KB
/
JacocoScanner.kt
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*
* RiceChecks
* Copyright (c) 2019, Dan S. Wallach, Rice University
* Available subject to the Apache 2.0 License
*/
package edu.rice.autograder
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonRootName
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty
import com.fasterxml.jackson.module.kotlin.readValue
// This is easily the most complicated XML we'll have to deal with. The original XML
// is one giant line, so check out the more human-readable version in:
// src/test/resources/comp215-build/reports/jacoco/test/jacocoTestReport-Reformatted.xml
// The XML structure:
// - the top-level report has a list of packages
// - each package has a list of classes
// - each class has a list of methods
// - each method has a list of counters
// - each class also has a list of counters
// - each counter has three attributes: type (string), missed (number), and covered (number)
// - each package also has a list of sourcefiles
// - each sourcefile has a list of "lines" (unclear what we're supposed to do with this)
// - each sourcefile also has a list of counters
// - each package also has a list of counters
// - the report also has a list of counters
@JsonRootName("report")
data class JacocoReport(
@set:JacksonXmlProperty(localName = "name", isAttribute = true)
var name: String? = null,
@set:JsonProperty("sessioninfo")
var session: JacocoSession? = null,
@set:JsonProperty("package")
var packages: List<JacocoPackage>? = null,
@set:JsonProperty("counter")
var counters: List<JacocoCounter>? = null
) {
val counterMap by lazy {
counters.associateNotNullBy { it.type }
}
val packageMap by lazy {
packages.associateNotNullBy { it.name }
}
val classesMap by lazy {
packageMap.values
.map { it.classMap }
.fold(emptyMap<String, JacocoClass>()) { a, b -> a + b }
}
}
@JsonRootName("sessioninfo")
data class JacocoSession(
@set:JacksonXmlProperty(localName = "id", isAttribute = true)
var id: String? = null,
@set:JacksonXmlProperty(localName = "start", isAttribute = true)
var start: Long = 0,
@set:JacksonXmlProperty(localName = "dump", isAttribute = true)
var dump: Long = 0
)
@JsonRootName("package")
data class JacocoPackage(
@set:JacksonXmlProperty(localName = "name", isAttribute = true)
var name: String? = null,
@set:JsonProperty("class")
var classes: List<JacocoClass>? = null,
@set:JsonProperty("counter")
var counters: List<JacocoCounter>? = null
) {
val counterMap by lazy {
counters.associateNotNullBy { it.type }
}
// Note: we're standardizing class names in classMap to use dots rather than slashes
// and dollar-signs, making them consistent with everything else in RiceChecks.
val classMap: Map<String, JacocoClass> by lazy {
classes.associateNotNullBy {
it.name.fixClassName()
}
}
}
@JsonRootName("class")
data class JacocoClass(
@set:JacksonXmlProperty(localName = "name", isAttribute = true)
var name: String? = null,
@set:JacksonXmlProperty(localName = "sourcefilename", isAttribute = true)
var sourceFileName: String? = null,
@set:JsonProperty("method")
var methods: List<JacocoMethod>? = null,
@set:JsonProperty("counter")
var counters: List<JacocoCounter>? = null
) {
val counterMap by lazy {
counters.associateNotNullBy { it.type }
}
val methodMap by lazy {
methods.associateNotNullBy { it.name }
}
}
@JsonRootName("method")
data class JacocoMethod(
@set:JacksonXmlProperty(localName = "name", isAttribute = true)
var name: String? = null,
@set:JacksonXmlProperty(localName = "desc", isAttribute = true)
var desc: String? = null,
@set:JacksonXmlProperty(localName = "line", isAttribute = true)
var line: Int = 0,
@set:JsonProperty("counter")
var counters: List<JacocoCounter>? = null
) {
val counterMap by lazy {
counters.associateNotNullBy { it.type }
}
}
@JsonRootName("sourcefile")
data class JacocoSourceFile(
@set:JsonProperty("line")
var lines: List<JacocoLine>? = null,
@set:JsonProperty("counter")
var counters: List<JacocoCounter>? = null
) {
val counterMap by lazy {
counters.associateNotNullBy { it.type }
}
val lineMap by lazy {
lines.associateNotNullBy { it.nr }
}
}
enum class JacocoCounterType {
INSTRUCTION, BRANCH, LINE, COMPLEXITY, METHOD, CLASS
}
@JsonRootName("counter")
data class JacocoCounter(
@set:JacksonXmlProperty(localName = "type", isAttribute = true)
var type: JacocoCounterType? = null,
@set:JacksonXmlProperty(localName = "missed", isAttribute = true)
var missed: Int = 0,
@set:JacksonXmlProperty(localName = "covered", isAttribute = true)
var covered: Int = 0
)
@JsonRootName("line")
data class JacocoLine(
@set:JacksonXmlProperty(localName = "nr", isAttribute = true)
var nr: Int = 0,
@set:JacksonXmlProperty(localName = "mi", isAttribute = true)
var mi: Int = 0,
@set:JacksonXmlProperty(localName = "ci", isAttribute = true)
var ci: Int = 0,
@set:JacksonXmlProperty(localName = "mb", isAttribute = true)
var mb: Int = 0,
@set:JacksonXmlProperty(localName = "cb", isAttribute = true)
var cb: Int = 0
)
/**
* Given a string -- the rest of reading a Jacoco XML results file --
* returns a [JacocoReport] data class, suitable for subsequent queries.
*/
fun jacocoParser(fileData: String): JacocoReport? {
Log.i(TAG, "jacocoParser: ${fileData.length} bytes")
return if (fileData.isEmpty()) null
else jacksonXmlMapper.readValue(fileData)
}
fun GCoverageStyle.toJacocoCounterType() = when (this) {
GCoverageStyle.INSTRUCTIONS -> JacocoCounterType.INSTRUCTION
GCoverageStyle.LINES -> JacocoCounterType.LINE
}
fun GGradeProject.jacocoResultsMissing() =
EvaluatorResult(
false, 0.0, coveragePoints,
"No test coverage results found", COVERAGE_CATEGORY, emptyList()
)
private const val TAG = "JacocoScanner"
private infix fun String.subClassOf(classOrPackageName: String): Boolean = when {
this == classOrPackageName -> true
this.startsWith("$classOrPackageName.") -> true
else -> false
}
fun JacocoReport.matchingClassSpecs(coverages: List<GGradeCoverage>): List<String> {
// In our GGradeProject structure, the names of classes are going to be in normal human
// form (e.g., edu.rice.autograder.test.Project3) while they'll be in slashy form in
// the JacocoReport, which we fixed in classesMap (see calls to String?.fixClassName).
Log.i(TAG, "looking for classes covered by: $coverages")
val packageSpecs = coverages
.filter { it.scope == GCoverageScope.PACKAGE }
.sortedBy { it.name }
val classSpecs = coverages
.filter { it.scope == GCoverageScope.CLASS }
.sortedBy { it.name }
Log.i(TAG, "possible packages: $packageSpecs")
Log.i(TAG, "possible classes: $classSpecs")
return classesMap.keys.filter { className ->
// We're working our way down from the most general to the most specific package annotation
// then the most general to the most specific class annotation (the sorting above is essential
// to make this happen). The logic here is that the last relevant annotation wins, so an inner
// "including" annotation overrides an external "excluding" annotation.
val matchingPackages = packageSpecs.filter { className subClassOf it.name }
val matchingClasses = classSpecs.filter { className subClassOf it.name }
val allSpecs = matchingPackages + matchingClasses
if (allSpecs.isNotEmpty()) {
Log.i(TAG, "for class ($className), found possible specs: $allSpecs")
allSpecs.fold(false) { _, next -> !next.excluded }
} else false
}
}
// literal dollar, one or more digits, end of string
private val anonymousInnerClassRegex = Regex("\\\$[0-9]+\$")
private val dollarsAndDigitsRegex = Regex("\\\$[$\\d]+")
/**
* Determines if a class name in JaCoCo's syntax (with /'s and $'s) is
* an anonymous inner class, based on ending with a dollar sign followed
* by a number.
*/
fun String.isAnonymousInnerClass() = contains(anonymousInnerClassRegex)
/**
* Determines if a class name in JaCoCo's syntax (with /'s and $'s) is
* an anonymous inner class of another (also in JaCoCo's syntax). This
* will also match *nested* anonymous inner classes.
*/
infix fun String?.isAnonymousInnerClassOf(name: String?) =
this != null && name != null &&
isAnonymousInnerClass() &&
startsWith(name) &&
drop(name.length).matches(dollarsAndDigitsRegex)
fun JacocoReport?.eval(project: GGradeProject): EvaluatorResult {
if (this == null) {
return project.jacocoResultsMissing()
}
if (project.coveragePoints == 0.0) {
return passingEvaluatorResult(0.0, "No test coverage requirement", COVERAGE_CATEGORY)
}
val counterType = project.coverageStyle.toJacocoCounterType()
val matchingClassNames = matchingClassSpecs(project.coverageAnnotations).sorted()
val matchingClasses = matchingClassNames.map {
val jacocoRecord = classesMap[it]
?: Log.ethrow(TAG, "internal failure: can't find $it")
val name = classesMap[it]?.name
?: Log.ethrow(TAG, "internal failure: class $it is missing a name from JaCoCo")
jacocoRecord to name.isAnonymousInnerClass()
}
if (matchingClasses.isEmpty()) {
Log.e(TAG, "No classes found to test for coverage!")
matchingClassNames.forEach {
Log.e(TAG, " -- matchingClassName: $it")
}
classesMap.keys.forEach {
Log.e(TAG, " -- classesMap[$it] = ${classesMap[it]}")
}
return EvaluatorResult(
false, 0.0, project.coveragePoints,
"Test coverage: no classes specified for coverage!", COVERAGE_CATEGORY, emptyList()
)
}
// Turns out, an interface with no default methods still appears in our data as a regular
// class, but JaCoCo doesn't assign any counters to it. Since they have no code, there's
// nothing to evaluate for coverage, and thus we filter them out here.
val regularClasses = matchingClasses
.filter { !it.second }
.map { it.first }
.filter { it.counters != null && it.counterMap[JacocoCounterType.LINE] != null }
// regularClasses.forEach { Log.i(TAG, "Regular class: ${it.name} (with counters)") }
val anonymousClasses = matchingClasses
.filter { it.second }
.map { it.first }
.filter { it.counters != null && it.counterMap[JacocoCounterType.LINE] != null }
// anonymousClasses.forEach { Log.i(TAG, "Anonymous class: ${it.name} (with counters)") }
Log.i(TAG, "Matching classes: ${matchingClasses.size}")
Log.i(TAG, "Regular classes with coverage counters: ${regularClasses.size}")
Log.i(TAG, "Anonymous inner classes with coverage counters: ${anonymousClasses.size}")
val coverageReport = regularClasses.flatMap { classRecord ->
val name = classRecord.name ?: Log.ethrow(TAG, "no name found for $classRecord")
val matchingAnonymousRecords = anonymousClasses.filter {
it.name isAnonymousInnerClassOf name
}
val numAnonInner = matchingAnonymousRecords.size
if (numAnonInner > 0) {
Log.i(TAG, "Found $numAnonInner anonymous inner classes for $name")
}
val allClassRecords = matchingAnonymousRecords + classRecord
val covered = allClassRecords.sumBy {
it.counterMap[counterType]?.covered
?: Log.ethrow(TAG, "no coverage numbers found for $it")
}
val missed = allClassRecords.sumBy {
it.counterMap[counterType]?.missed
?: Log.ethrow(TAG, "no missed numbers found for $it")
}
if (covered + missed == 0) {
emptyList()
} else {
val percentage = 100.0 * covered / (covered + missed).toDouble()
val classNameFixed = name.fixClassName()
val coverageStr = "Coverage of $classNameFixed: %.1f%% ($covered/${covered + missed})%s"
.format(
percentage,
when (numAnonInner) {
0 -> ""
1 -> "\n(including one anonymous inner class)"
else -> "\n(including $numAnonInner anonymous inner classes)"
}
)
Log.i(TAG, coverageStr)
listOf(CoverageDeduction(coverageStr, 0.0, classNameFixed, percentage))
}
}
val fails = coverageReport.filter {
it.coveragePercentage < project.coveragePercentage
}
val wins = coverageReport.filter {
it.coveragePercentage >= project.coveragePercentage
}
val passing = fails.isEmpty()
val counterTypeStr = "(by ${counterType.toString().toLowerCase()})"
return if (passing) {
EvaluatorResult(
true, project.coveragePoints, project.coveragePoints,
"Test coverage meets %.0f%% %s requirement"
.format(project.coveragePercentage, counterTypeStr),
COVERAGE_CATEGORY,
wins
)
} else {
EvaluatorResult(
false, 0.0, project.coveragePoints,
"Classes with coverage below %.0f%% %s requirement"
.format(project.coveragePercentage, counterTypeStr),
COVERAGE_CATEGORY,
fails +
listOf(
BasicDeduction(
"See the coverage report for details:\n" +
"${AutoGrader.buildDir}/reports/jacoco/index.html",
0.0
)
)
)
}
}
fun String?.fixClassName() =
this?.replace('/', '.')
?.replace('$', '.')
?: ""