-
Notifications
You must be signed in to change notification settings - Fork 47
/
KoverPlugin.kt
333 lines (280 loc) · 12.8 KB
/
KoverPlugin.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
/*
* Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.kover
import kotlinx.kover.adapters.*
import kotlinx.kover.api.*
import kotlinx.kover.api.KoverPaths.MERGED_HTML_REPORT_DEFAULT_PATH
import kotlinx.kover.api.KoverNames.CHECK_TASK_NAME
import kotlinx.kover.api.KoverNames.COLLECT_REPORTS_TASK_NAME
import kotlinx.kover.api.KoverNames.MERGED_HTML_REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.HTML_REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.VERIFY_TASK_NAME
import kotlinx.kover.api.KoverNames.MERGED_REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.XML_REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.ROOT_EXTENSION_NAME
import kotlinx.kover.api.KoverNames.TASK_EXTENSION_NAME
import kotlinx.kover.api.KoverNames.VERIFICATION_GROUP
import kotlinx.kover.api.KoverNames.MERGED_VERIFY_TASK_NAME
import kotlinx.kover.api.KoverNames.MERGED_XML_REPORT_TASK_NAME
import kotlinx.kover.api.KoverPaths.ALL_PROJECTS_REPORTS_DEFAULT_PATH
import kotlinx.kover.api.KoverPaths.PROJECT_HTML_REPORT_DEFAULT_PATH
import kotlinx.kover.api.KoverPaths.MERGED_XML_REPORT_DEFAULT_PATH
import kotlinx.kover.api.KoverPaths.PROJECT_XML_REPORT_DEFAULT_PATH
import kotlinx.kover.engines.commons.*
import kotlinx.kover.engines.commons.CoverageAgent
import kotlinx.kover.engines.intellij.*
import kotlinx.kover.tasks.*
import org.gradle.api.*
import org.gradle.api.provider.*
import org.gradle.api.tasks.*
import org.gradle.api.tasks.testing.*
import org.gradle.process.*
import kotlin.reflect.*
class KoverPlugin : Plugin<Project> {
private val defaultJacocoVersion = "0.8.7"
override fun apply(target: Project) {
target.checkAlreadyApplied()
val koverExtension = target.createKoverExtension()
val agents = AgentsFactory.createAgents(target, koverExtension)
val providers = target.createProviders(agents)
target.allprojects {
it.applyToProject(providers, agents)
}
target.createCollectingTask()
target.createMergedTasks(providers)
}
private fun Project.applyToProject(providers: AllProviders, agents: Map<CoverageEngine, CoverageAgent>) {
val projectProviders =
providers.projects[name] ?: throw GradleException("Kover: Providers for project '$name' was not found")
val xmlReportTask = createKoverProjectTask(
XML_REPORT_TASK_NAME,
KoverXmlReportTask::class,
providers,
projectProviders
) {
it.xmlReportFile.set(layout.buildDirectory.file(PROJECT_XML_REPORT_DEFAULT_PATH))
it.description = "Generates code coverage XML report for all enabled test tasks in one project."
}
val htmlReportTask = createKoverProjectTask(
HTML_REPORT_TASK_NAME,
KoverHtmlReportTask::class,
providers,
projectProviders
) {
it.htmlReportDir.set(it.project.layout.buildDirectory.dir(PROJECT_HTML_REPORT_DEFAULT_PATH))
it.description = "Generates code coverage HTML report for all enabled test tasks in one project."
}
val verifyTask = createKoverProjectTask(
VERIFY_TASK_NAME,
KoverVerificationTask::class,
providers,
projectProviders
) {
it.onlyIf { t -> (t as KoverVerificationTask).rules.isNotEmpty() }
it.description = "Verifies code coverage metrics of one project based on specified rules."
}
tasks.create(REPORT_TASK_NAME) {
it.group = VERIFICATION_GROUP
it.dependsOn(xmlReportTask)
it.dependsOn(htmlReportTask)
it.description = "Generates code coverage HTML and XML reports for all enabled test tasks in one project."
}
tasks.configureEach {
if (it.name == CHECK_TASK_NAME) {
it.dependsOn(verifyTask)
}
}
tasks.withType(Test::class.java).configureEach { t ->
t.configTest(providers, agents)
}
}
private fun Project.createMergedTasks(providers: AllProviders) {
val xmlReportTask = createKoverMergedTask(
MERGED_XML_REPORT_TASK_NAME,
KoverMergedXmlReportTask::class,
providers
) {
it.xmlReportFile.set(layout.buildDirectory.file(MERGED_XML_REPORT_DEFAULT_PATH))
it.description = "Generates code coverage XML report for all enabled test tasks in all projects."
}
val htmlReportTask = createKoverMergedTask(
MERGED_HTML_REPORT_TASK_NAME,
KoverMergedHtmlReportTask::class,
providers
) {
it.htmlReportDir.set(layout.buildDirectory.dir(MERGED_HTML_REPORT_DEFAULT_PATH))
it.description = "Generates code coverage HTML report for all enabled test tasks in all projects."
}
val reportTask = tasks.create(MERGED_REPORT_TASK_NAME) {
it.group = VERIFICATION_GROUP
it.dependsOn(xmlReportTask)
it.dependsOn(htmlReportTask)
it.description = "Generates code coverage HTML and XML reports for all enabled test tasks in all projects."
}
val verifyTask = createKoverMergedTask(
MERGED_VERIFY_TASK_NAME,
KoverMergedVerificationTask::class,
providers
) {
it.onlyIf { t -> (t as KoverMergedVerificationTask).rules.isNotEmpty() }
it.description = "Verifies code coverage metrics of all projects based on specified rules."
}
tasks.configureEach {
if (it.name == CHECK_TASK_NAME) {
it.dependsOn(provider {
val koverExtension = extensions.getByType(KoverExtension::class.java)
if (koverExtension.generateReportOnCheck) {
listOf(reportTask, verifyTask)
} else {
listOf(verifyTask)
}
})
}
}
}
private fun <T : KoverMergedTask> Project.createKoverMergedTask(
taskName: String,
type: KClass<T>,
providers: AllProviders,
block: (T) -> Unit
): T {
return tasks.create(taskName, type.java) { task ->
task.group = VERIFICATION_GROUP
providers.projects.forEach { (projectName, m) ->
task.binaryReportFiles.put(projectName, NestedFiles(task.project.objects, m.reports))
task.srcDirs.put(projectName, NestedFiles(task.project.objects, m.sources))
task.outputDirs.put(projectName, NestedFiles(task.project.objects, m.output))
}
task.coverageEngine.set(providers.engine)
task.classpath.set(providers.classpath)
task.dependsOn(providers.merged.tests)
block(task)
}
}
private fun Project.createCollectingTask() {
tasks.create(COLLECT_REPORTS_TASK_NAME, KoverCollectingTask::class.java) { task ->
task.group = VERIFICATION_GROUP
task.description = "Collects all projects reports into one directory."
task.outputDir.set(project.layout.buildDirectory.dir(ALL_PROJECTS_REPORTS_DEFAULT_PATH))
// disable UP-TO-DATE check for task: it will be executed every time
task.outputs.upToDateWhen { false }
allprojects { proj ->
val xmlReportTask =
proj.tasks.withType(KoverXmlReportTask::class.java).getByName(XML_REPORT_TASK_NAME)
val htmlReportTask =
proj.tasks.withType(KoverHtmlReportTask::class.java).getByName(HTML_REPORT_TASK_NAME)
task.mustRunAfter(xmlReportTask)
task.mustRunAfter(htmlReportTask)
task.xmlFiles[proj.name] = xmlReportTask.xmlReportFile
task.htmlDirs[proj.name] = htmlReportTask.htmlReportDir
}
}
}
private fun <T : KoverProjectTask> Project.createKoverProjectTask(
taskName: String,
type: KClass<T>,
providers: AllProviders,
projectProviders: ProjectProviders,
block: (T) -> Unit
): T {
return tasks.create(taskName, type.java) { task ->
task.group = VERIFICATION_GROUP
task.coverageEngine.set(providers.engine)
task.classpath.set(providers.classpath)
task.srcDirs.set(projectProviders.sources)
task.outputDirs.set(projectProviders.output)
// it is necessary to read all binary reports because project's classes can be invoked in another project
task.binaryReportFiles.set(projectProviders.reports)
task.dependsOn(projectProviders.tests)
task.onlyIf { !projectProviders.disabled.get() }
task.onlyIf { !task.binaryReportFiles.get().isEmpty }
block(task)
}
}
private fun Project.createKoverExtension(): KoverExtension {
val extension = extensions.create(ROOT_EXTENSION_NAME, KoverExtension::class.java, objects)
extension.isDisabled = false
extension.coverageEngine.set(CoverageEngine.INTELLIJ)
extension.intellijEngineVersion.set(defaultIntellijVersion.toString())
extension.jacocoEngineVersion.set(defaultJacocoVersion)
return extension
}
private fun Test.configTest(
providers: AllProviders,
agents: Map<CoverageEngine, CoverageAgent>
) {
val taskExtension = extensions.create(TASK_EXTENSION_NAME, KoverTaskExtension::class.java, project.objects)
taskExtension.isDisabled = false
taskExtension.binaryReportFile.set(this.project.provider {
val koverExtension = providers.koverExtension.get()
val suffix = if (koverExtension.coverageEngine.get() == CoverageEngine.INTELLIJ) ".ic" else ".exec"
project.layout.buildDirectory.get().file("kover/$name$suffix").asFile
})
val excludeAndroidPackages =
project.provider { project.androidPluginIsApplied && !providers.koverExtension.get().instrumentAndroidPackage }
jvmArgumentProviders.add(
CoverageArgumentProvider(
this,
agents,
providers.koverExtension,
excludeAndroidPackages
)
)
doLast(IntellijErrorLogChecker(taskExtension))
}
private fun Project.checkAlreadyApplied() {
var parent = parent
while (parent != null) {
if (parent.plugins.hasPlugin(KoverPlugin::class.java)) {
throw GradleException("Kover plugin is applied in both parent project '${parent.name}' and child project '${this.name}'. Kover plugin should be applied only in parent project.")
}
parent = this.parent
}
}
}
private class IntellijErrorLogChecker(private val taskExtension: KoverTaskExtension) : Action<Task> {
override fun execute(task: Task) {
task.project.copyIntellijErrorLog(
task.project.layout.buildDirectory.get().file("kover/errors/${task.name}.log").asFile,
taskExtension.binaryReportFile.get().parentFile
)
}
}
private class CoverageArgumentProvider(
private val task: Task,
private val agents: Map<CoverageEngine, CoverageAgent>,
@get:Nested val koverExtension: Provider<KoverExtension>,
@get:Input val excludeAndroidPackage: Provider<Boolean>
) : CommandLineArgumentProvider, Named {
@get:Nested
val taskExtension: Provider<KoverTaskExtension> = task.project.provider {
task.extensions.getByType(KoverTaskExtension::class.java)
}
@Internal
override fun getName(): String {
return "koverArgumentsProvider"
}
override fun asArguments(): MutableIterable<String> {
val koverExtensionValue = koverExtension.get()
val taskExtensionValue = taskExtension.get()
if (taskExtensionValue.isDisabled
|| koverExtensionValue.isDisabled
|| koverExtensionValue.disabledProjects.contains(task.project.name)
) {
return mutableListOf()
}
if (excludeAndroidPackage.get()) {
/*
The instrumentation of android classes often causes errors when using third-party
frameworks (see https://github.com/Kotlin/kotlinx-kover/issues/89).
Because android classes are not part of the project, in any case they do not get into the report,
and they can be excluded from instrumentation.
FIXME Remove this code if the IntelliJ Agent stops changing project classes during instrumentation
*/
taskExtensionValue.excludes = taskExtensionValue.excludes + "android.*" + "com.android.*"
}
return agents.getFor(koverExtensionValue.coverageEngine.get()).buildCommandLineArgs(task, taskExtensionValue)
}
}