-
Notifications
You must be signed in to change notification settings - Fork 47
/
KoverProjectApplier.kt
235 lines (202 loc) · 8.92 KB
/
KoverProjectApplier.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
/*
* Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.kover.appliers
import kotlinx.kover.api.*
import kotlinx.kover.api.KoverNames.CONFIGURATION_NAME
import kotlinx.kover.api.KoverNames.HTML_REPORT_TASK_NAME
import kotlinx.kover.api.KoverNames.VERIFY_TASK_NAME
import kotlinx.kover.api.KoverNames.XML_REPORT_TASK_NAME
import kotlinx.kover.engines.commons.*
import kotlinx.kover.lookup.*
import kotlinx.kover.tasks.*
import org.gradle.api.*
import org.gradle.api.artifacts.*
import org.gradle.api.file.ArchiveOperations
import org.gradle.api.provider.*
import org.gradle.api.tasks.testing.*
import org.gradle.configurationcache.extensions.*
import java.io.*
internal fun Project.applyToProject() {
val extension = createProjectExtension()
val config = createEngineConfig(extension.engine)
val engineProvider = engineProvider(config, extension.engine)
tasks.withType(Test::class.java).configureEach { t ->
t.applyToTestTask(extension, engineProvider)
}
val testsProvider = instrumentedTasksProvider(extension)
val xmlTask = createTask<KoverXmlTask>(
XML_REPORT_TASK_NAME,
extension.xmlReport.filters,
extension,
engineProvider,
testsProvider,
) {
it.reportFile.set(extension.xmlReport.reportFile)
it.description = "Generates code coverage XML report for all enabled test tasks in one project."
}
val htmlTask = createTask<KoverHtmlTask>(
HTML_REPORT_TASK_NAME,
extension.htmlReport.taskFilters,
extension,
engineProvider,
testsProvider,
) {
it.reportDir.set(extension.htmlReport.reportDir)
it.description = "Generates code coverage HTML report for all enabled test tasks in one project."
}
val verifyTask = createTask<KoverVerificationTask>(
VERIFY_TASK_NAME,
extension.filters,
extension,
engineProvider,
testsProvider,
) {
it.rules.set(extension.verify.rules)
it.resultFile.set(layout.buildDirectory.file(KoverPaths.PROJECT_VERIFICATION_REPORT_DEFAULT_PATH))
it.description = "Verifies code coverage metrics of one project based on specified rules."
}
// TODO `onlyIf` block moved out from config lambda because of bug in Kotlin compiler - it implicitly adds closure on `Project` inside onlyIf's lambda
verifyTask.onlyIf { extension.verify.hasActiveRules() }
// ordering of task calls, so that if a verification error occurs, reports are generated and the values can be viewed in them
verifyTask.shouldRunAfter(xmlTask, htmlTask)
tasks.create(KoverNames.REPORT_TASK_NAME) {
it.group = KoverNames.VERIFICATION_GROUP
it.dependsOn(xmlTask)
it.dependsOn(htmlTask)
it.description = "Generates code coverage HTML and XML reports for all enabled test tasks in one project."
}
tasks.configureEach {
if (it.name == KoverNames.CHECK_TASK_NAME) {
it.dependsOn(provider {
// don't add dependency if Kover is disabled
if (extension.isDisabled.get()) {
return@provider emptyList<Task>()
}
val tasks = mutableListOf<Task>()
if (extension.xmlReport.onCheck.get()) {
tasks += xmlTask
}
if (extension.htmlReport.onCheck.get()) {
tasks += htmlTask
}
if (extension.verify.onCheck.get() && extension.verify.hasActiveRules()) {
// don't add dependency if there is no active verification rules https://github.com/Kotlin/kotlinx-kover/issues/168
tasks += verifyTask
}
tasks
})
}
}
}
private inline fun <reified T : KoverReportTask> Project.createTask(
taskName: String,
filters: KoverProjectFilters,
extension: KoverProjectConfig,
engineProvider: Provider<EngineDetails>,
testsProvider: Provider<List<Test>>,
crossinline block: (T) -> Unit
): T {
val task = tasks.create(taskName, T::class.java) {
it.files.put(path, projectFilesProvider(extension, filters.sourceSets))
it.engine.set(engineProvider)
it.dependsOn(testsProvider)
it.classFilter.set(filters.classes)
it.group = KoverNames.VERIFICATION_GROUP
block(it)
}
// TODO `onlyIf` block moved out from config lambda because of bug in Kotlin compiler - it implicitly adds closure on `Project` inside onlyIf's lambda
// execute task only if Kover not disabled for project
task.onlyIf { !extension.isDisabled.get() }
// execute task only if there is at least one binary report
task.onlyIf { t -> (t as KoverReportTask).files.get().any { f -> !f.value.binaryReportFiles.isEmpty } }
return task
}
private fun Project.createProjectExtension(): KoverProjectConfig {
val extension = extensions.create(KoverNames.PROJECT_EXTENSION_NAME, KoverProjectConfig::class.java, objects)
// default values
extension.isDisabled.set(false)
extension.engine.set(DefaultIntellijEngine)
extension.filters.classes.set(KoverClassFilter())
extension.filters.sourceSets.set(KoverSourceSetFilter())
extension.xmlReport.reportFile.set(layout.buildDirectory.file(KoverPaths.PROJECT_XML_REPORT_DEFAULT_PATH))
extension.xmlReport.onCheck.set(false)
extension.xmlReport.filters.classes.set(extension.filters.classes)
extension.xmlReport.filters.sourceSets.set(extension.filters.sourceSets)
extension.htmlReport.reportDir.set(layout.buildDirectory.dir(KoverPaths.PROJECT_HTML_REPORT_DEFAULT_PATH))
extension.htmlReport.onCheck.set(false)
extension.htmlReport.taskFilters.classes.set(extension.filters.classes)
extension.htmlReport.taskFilters.sourceSets.set(extension.filters.sourceSets)
extension.verify.onCheck.set(true)
return extension
}
private fun Project.createEngineConfig(engineVariantProvider: Provider<CoverageEngineVariant>): Configuration {
val config = project.configurations.create(CONFIGURATION_NAME)
config.isVisible = false
config.isTransitive = true
config.description = "Kotlin Kover Plugin configuration for Coverage Engine"
config.defaultDependencies { default ->
val variant = engineVariantProvider.get()
EngineManager.dependencies(variant).forEach {
default.add(dependencies.create(it))
}
}
return config
}
private fun Project.engineProvider(
config: Configuration,
engineVariantProvider: Provider<CoverageEngineVariant>
): Provider<EngineDetails> {
val archiveOperations: ArchiveOperations = project.serviceOf()
return project.provider { engineByVariant(engineVariantProvider.get(), config, archiveOperations) }
}
internal fun engineByVariant(
variant: CoverageEngineVariant,
config: Configuration,
archiveOperations: ArchiveOperations
): EngineDetails {
val jarFile = EngineManager.findJarFile(variant, config, archiveOperations)
return EngineDetails(variant, jarFile, config)
}
internal fun Project.projectFilesProvider(
extension: KoverProjectConfig,
sourceSetFiltersProvider: Provider<KoverSourceSetFilter>
): Provider<ProjectFiles> {
return provider { projectFiles(sourceSetFiltersProvider.get(), extension) }
}
internal fun Project.projectFiles(
filters: KoverSourceSetFilter,
extension: KoverProjectConfig
): ProjectFiles {
val directories = DirsLookup.lookup(project, filters)
val reportFiles = files(binaryReports(extension))
return ProjectFiles(reportFiles, directories.sources, directories.outputs)
}
internal fun Project.instrumentedTasks(extension: KoverProjectConfig): List<Test> {
return tasks.withType(Test::class.java).asSequence()
// task can be disabled in the project extension
.filterNot { extension.instrumentation.excludeTasks.contains(it.name) }
.filterNot { t -> t.extensions.getByType(KoverTaskExtension::class.java).isDisabled.get() }
.toList()
}
private fun Project.instrumentedTasksProvider(extension: KoverProjectConfig): Provider<List<Test>> {
return provider { instrumentedTasks(extension) }
}
private fun Project.binaryReports(extension: KoverProjectConfig): List<File> {
if (extension.isDisabled.get()) {
return emptyList()
}
return tasks.withType(Test::class.java).asSequence()
// task can be disabled in the project extension
.filterNot { extension.instrumentation.excludeTasks.contains(it.name) }
.map { t -> t.extensions.getByType(KoverTaskExtension::class.java) }
// process binary report only from tasks with enabled cover
.filterNot { e -> e.isDisabled.get() }
.map { e -> e.reportFile.get().asFile }
// process binary report only from tasks with sources
.filter { f -> f.exists() }
.toList()
}
internal fun KoverVerifyConfig.hasActiveRules(): Boolean {
return rules.get().any { rule -> rule.isEnabled }
}