-
Notifications
You must be signed in to change notification settings - Fork 47
/
IntellijReports.kt
234 lines (198 loc) · 6.74 KB
/
IntellijReports.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
/*
* Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.kover.engines.intellij
import kotlinx.kover.api.*
import kotlinx.kover.engines.commons.*
import kotlinx.kover.engines.commons.Report
import org.gradle.api.*
import org.gradle.api.file.*
import java.io.*
import java.util.*
internal fun Task.intellijReport(
report: Report,
xmlFile: File?,
htmlDir: File?,
includes: List<String>,
excludes: List<String>,
classpath: FileCollection
) {
xmlFile?.let {
xmlFile.parentFile.mkdirs()
}
htmlDir?.let {
htmlDir.mkdirs()
}
val argsFile = File(temporaryDir, "intellijreport.json")
argsFile.printWriter().use { pw ->
pw.writeReportsJson(report, xmlFile, htmlDir, includes, excludes)
}
project.javaexec { e ->
e.mainClass.set("com.intellij.rt.coverage.report.Main")
e.classpath = classpath
e.args = mutableListOf(argsFile.canonicalPath)
}
project.copyIntellijErrorLog(project.layout.buildDirectory.get().file("kover/errors/$name.log").asFile)
}
internal fun Project.copyIntellijErrorLog(toFile: File, customDirectory: File? = null) {
var errorLog = customDirectory?.let { File(it, "coverage-error.log") }
if (errorLog == null || !errorLog.exists()) {
errorLog = File(projectDir, "coverage-error.log")
}
if (errorLog.exists() && errorLog.isFile) {
errorLog.copyTo(toFile, true)
errorLog.delete()
}
}
/*
JSON format:
```
{
reports: [{ic: "path", smap: "path" [OPTIONAL]}, ...],
modules: [{output: ["path1", "path2"], sources: ["source1", …]}, {…}],
xml: "path" [OPTIONAL],
html: "directory" [OPTIONAL],
include: {
classes: ["regex1", "regex2"] [OPTIONAL]
} [OPTIONAL],
exclude: {
classes: ["regex1", "regex2"] [OPTIONAL]
} [OPTIONAL],
}
```
JSON example:
```
{
"reports": [
{"ic": "/path/to/binary/report/result.ic"}
],
"html": "/path/to/html",
"modules": [
{
"output": [
"/build/output"
],
"sources": [
"/sources/java",
"/sources/kotlin"
]
}
]
}
```
*/
private fun Writer.writeReportsJson(
report: Report,
xmlFile: File?,
htmlDir: File?,
includes: List<String>,
excludes: List<String>,
) {
appendLine("{")
appendLine(""" "reports": [ """)
appendLine(report.files.joinToString(",\n ", " ") { f ->
"""{"ic": ${f.jsonString}}"""
})
appendLine(""" ], """)
xmlFile?.also {
appendLine(""" "xml": ${it.jsonString},""")
}
htmlDir?.also {
appendLine(""" "html": ${it.jsonString},""")
}
if (includes.isNotEmpty()) {
appendLine(""" "include": {""")
appendLine(includes.joinToString(", ", """ "classes": [""", "]") { i -> i.wildcardsToRegex().jsonString })
appendLine(""" },""")
}
if (excludes.isNotEmpty()) {
appendLine(""" "exclude": {""")
appendLine(excludes.joinToString(", ", """ "classes": [""", "]") { e -> e.wildcardsToRegex().jsonString })
appendLine(""" },""")
}
appendLine(""" "modules": [""")
report.projects.forEachIndexed { index, aProject ->
writeProjectReportJson(aProject, index == (report.projects.size - 1))
}
appendLine(""" ]""")
appendLine("}")
}
private fun Writer.writeProjectReportJson(projectInfo: ProjectInfo, isLast: Boolean) {
appendLine(""" {""")
appendLine(""" "output": [""")
appendLine(
projectInfo.outputs.joinToString(",\n ", " ") { f -> f.jsonString })
appendLine(""" ],""")
appendLine(""" "sources": [""")
appendLine(
projectInfo.sources.joinToString(",\n ", " ") { f -> f.jsonString })
appendLine(""" ]""")
appendLine(""" }${if (isLast) "" else ","}""")
}
private val File.jsonString: String
get() {
return canonicalPath.jsonString
}
private val String.jsonString: String
get() {
return '"' + replace("\\", "\\\\").replace("\"", "\\\"") + '"'
}
internal fun Task.intellijVerification(
xmlFile: File,
rules: Iterable<VerificationRule>
) {
val counters = readCounterValuesFromXml(xmlFile)
val violations = rules.mapNotNull { checkRule(counters, it) }
if (violations.isNotEmpty()) {
throw GradleException(violations.joinToString("\n"))
}
}
private fun readCounterValuesFromXml(file: File): Map<VerificationValueType, Int> {
val scanner = Scanner(file)
var lineCounterLine: String? = null
while (scanner.hasNextLine()) {
val line = scanner.nextLine()
if (line.startsWith("<counter type=\"LINE\"")) {
lineCounterLine = line
}
}
scanner.close()
lineCounterLine ?: throw GradleException("No LINE counter in XML report")
val coveredCount = lineCounterLine.substringAfter("covered=\"").substringBefore("\"").toInt()
val missedCount = lineCounterLine.substringAfter("missed=\"").substringBefore("\"").toInt()
val percentage = if ((coveredCount + missedCount) > 0) 100 * coveredCount / (coveredCount + missedCount) else 0
return mapOf(
VerificationValueType.COVERED_LINES_COUNT to coveredCount,
VerificationValueType.MISSED_LINES_COUNT to missedCount,
VerificationValueType.COVERED_LINES_PERCENTAGE to percentage
)
}
private fun Task.checkRule(counters: Map<VerificationValueType, Int>, rule: VerificationRule): String? {
val boundsViolations = rule.bounds.mapNotNull { it.check(counters) }
val ruleName = if (rule.name != null) "'${rule.name}' " else ""
return if (boundsViolations.size > 1) {
"Rule ${ruleName}violated for '${project.name}':" + boundsViolations.joinToString("\n ", "\n ")
} else if (boundsViolations.size == 1) {
"Rule ${ruleName}violated for '${project.name}': ${boundsViolations[0]}"
} else {
null
}
}
private fun VerificationBound.check(counters: Map<VerificationValueType, Int>): String? {
val minValue = this.minValue
val maxValue = this.maxValue
val valueType = this.valueType
val value = counters[valueType] ?: throw GradleException("Not found value for counter '${valueType}'")
val valueTypeName = when (valueType) {
VerificationValueType.COVERED_LINES_COUNT -> "covered lines count"
VerificationValueType.MISSED_LINES_COUNT -> "missed lines count"
VerificationValueType.COVERED_LINES_PERCENTAGE -> "covered lines percentage"
}
return if (minValue != null && minValue > value) {
"$valueTypeName is $value, but expected minimum is $minValue"
} else if (maxValue != null && maxValue < value) {
"$valueTypeName is $value, but expected maximum is $maxValue"
} else {
null
}
}