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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
/*
* Copyright 2017-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.atomicfu.plugin.gradle
import kotlinx.atomicfu.transformer.*
import org.gradle.api.*
import org.gradle.api.file.*
import org.gradle.api.internal.*
import org.gradle.api.plugins.*
import org.gradle.api.tasks.*
import org.gradle.api.tasks.compile.*
import org.gradle.api.tasks.testing.*
import org.gradle.jvm.tasks.*
import org.jetbrains.kotlin.gradle.dsl.*
import org.jetbrains.kotlin.gradle.plugin.*
import java.io.*
import java.util.*
import java.util.concurrent.*
private const val EXTENSION_NAME = "atomicfu"
private const val ORIGINAL_DIR_NAME = "originalClassesDir"
private const val COMPILE_ONLY_CONFIGURATION = "compileOnly"
private const val IMPLEMENTATION_CONFIGURATION = "implementation"
private const val TEST_IMPLEMENTATION_CONFIGURATION = "testImplementation"
open class AtomicFUGradlePlugin : Plugin<Project> {
override fun apply(project: Project) = project.run {
val pluginVersion = rootProject.buildscript.configurations.findByName("classpath")
?.allDependencies?.find { it.name == "atomicfu-gradle-plugin" }?.version
extensions.add(EXTENSION_NAME, AtomicFUPluginExtension(pluginVersion))
configureDependencies()
configureTasks()
}
}
private fun Project.configureDependencies() {
withPluginWhenEvaluatedDependencies("kotlin") { version ->
dependencies.add(
if (config.transformJvm) COMPILE_ONLY_CONFIGURATION else IMPLEMENTATION_CONFIGURATION,
getAtomicfuDependencyNotation(Platform.JVM, version)
)
dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION, getAtomicfuDependencyNotation(Platform.JVM, version))
}
withPluginWhenEvaluatedDependencies("kotlin2js") { version ->
dependencies.add(
if (config.transformJs) COMPILE_ONLY_CONFIGURATION else IMPLEMENTATION_CONFIGURATION,
getAtomicfuDependencyNotation(Platform.JS, version)
)
dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION, getAtomicfuDependencyNotation(Platform.JS, version))
}
withPluginWhenEvaluatedDependencies("kotlin-multiplatform") { version ->
configureMultiplatformPluginDependencies(version)
}
}
private fun Project.configureTasks() {
val config = config
withPluginWhenEvaluated("kotlin") {
if (config.transformJvm) {
configureTransformTasks("compileTestKotlin") { sourceSet, transformedDir, originalDir ->
createJvmTransformTask(sourceSet).configureJvmTask(
sourceSet.compileClasspath,
sourceSet.classesTaskName,
transformedDir,
originalDir,
config
)
}
}
}
withPluginWhenEvaluated("kotlin2js") {
if (config.transformJs) {
configureTransformTasks("compileTestKotlin2Js") { sourceSet, transformedDir, originalDir ->
createJsTransformTask(sourceSet).configureJsTask(
sourceSet.classesTaskName,
transformedDir,
originalDir,
config
)
}
}
}
withPluginWhenEvaluated("kotlin-multiplatform") {
configureMultiplatformPluginTasks()
}
}
private enum class Platform(val suffix: String) {
JVM("-jvm"),
JS("-js"),
NATIVE(""),
MULTIPLATFORM("")
}
private enum class CompilationType { MAIN, TEST }
private fun String.compilationNameToType(): CompilationType? = when (this) {
KotlinCompilation.MAIN_COMPILATION_NAME -> CompilationType.MAIN
KotlinCompilation.TEST_COMPILATION_NAME -> CompilationType.TEST
else -> null
}
private fun String.sourceSetNameToType(): CompilationType? = when (this) {
SourceSet.MAIN_SOURCE_SET_NAME -> CompilationType.MAIN
SourceSet.TEST_SOURCE_SET_NAME -> CompilationType.TEST
else -> null
}
private val Project.config: AtomicFUPluginExtension
get() = extensions.findByName(EXTENSION_NAME) as? AtomicFUPluginExtension ?: AtomicFUPluginExtension(null)
private fun getAtomicfuDependencyNotation(platform: Platform, version: String): String =
"org.jetbrains.kotlinx:atomicfu${platform.suffix}:$version"
// Note "afterEvaluate" does nothing when the project is already in executed state, so we need
// a special check for this case
fun <T> Project.whenEvaluated(fn: Project.() -> T) {
if (state.executed) {
fn()
} else {
afterEvaluate { fn() }
}
}
fun Project.withPluginWhenEvaluated(plugin: String, fn: Project.() -> Unit) {
pluginManager.withPlugin(plugin) { whenEvaluated(fn) }
}
fun Project.withPluginWhenEvaluatedDependencies(plugin: String, fn: Project.(version: String) -> Unit) {
withPluginWhenEvaluated(plugin) {
config.dependenciesVersion?.let { fn(it) }
}
}
fun Project.withKotlinTargets(fn: (KotlinTarget) -> Unit) {
extensions.findByType(KotlinProjectExtension::class.java)?.let { kotlinExtension ->
val targetsExtension = (kotlinExtension as? ExtensionAware)?.extensions?.findByName("targets")
@Suppress("UNCHECKED_CAST")
val targets = targetsExtension as NamedDomainObjectContainer<KotlinTarget>
// find all compilations given sourceSet belongs to
targets.all { target -> fn(target) }
}
}
private fun KotlinCommonOptions.addFriendPaths(friendPathsFileCollection: FileCollection) {
val argName = when (this) {
is KotlinJvmOptions -> "-Xfriend-paths"
is KotlinJsOptions -> "-Xfriend-modules"
else -> return
}
freeCompilerArgs = freeCompilerArgs + "$argName=${friendPathsFileCollection.joinToString(",")}"
}
fun Project.configureMultiplatformPluginTasks() {
val originalDirsByCompilation = hashMapOf<KotlinCompilation<*>, FileCollection>()
val config = config
withKotlinTargets { target ->
if (target.platformType == KotlinPlatformType.common || target.platformType == KotlinPlatformType.native) {
return@withKotlinTargets // skip the common & native targets -- no transformation for them
}
target.compilations.all compilations@{ compilation ->
val compilationType = compilation.name.compilationNameToType()
?: return@compilations // skip unknown compilations
val classesDirs = compilation.output.classesDirs
// make copy of original classes directory
val originalClassesDirs: FileCollection =
project.files(classesDirs.from.toTypedArray()).filter { it.exists() }
originalDirsByCompilation[compilation] = originalClassesDirs
val transformedClassesDir =
project.buildDir.resolve("classes/atomicfu/${target.name}/${compilation.name}")
val transformTask = when (target.platformType) {
KotlinPlatformType.jvm, KotlinPlatformType.androidJvm -> {
if (!config.transformJvm) return@compilations // skip when transformation is turned off
project.createJvmTransformTask(compilation).configureJvmTask(
compilation.compileDependencyFiles,
compilation.compileAllTaskName,
transformedClassesDir,
originalClassesDirs,
config
)
}
KotlinPlatformType.js -> {
if (!config.transformJs) return@compilations // skip when transformation is turned off
project.createJsTransformTask(compilation).configureJsTask(
compilation.compileAllTaskName,
transformedClassesDir,
originalClassesDirs,
config
)
}
else -> error("Unsupported transformation platform '${target.platformType}'")
}
//now transformTask is responsible for compiling this source set into the classes directory
classesDirs.setFrom(transformedClassesDir)
classesDirs.builtBy(transformTask)
(tasks.findByName(target.artifactsTaskName) as? Jar)?.apply {
setupJarManifest(multiRelease = config.variant.toVariant() == Variant.BOTH)
}
// test should compile and run against original production binaries
if (compilationType == CompilationType.TEST) {
val mainCompilation =
compilation.target.compilations.getByName(KotlinCompilation.MAIN_COMPILATION_NAME)
val originalMainClassesDirs = project.files(
// use Callable because there is no guarantee that main is configured before test
Callable { originalDirsByCompilation[mainCompilation]!! }
)
(tasks.findByName(compilation.compileKotlinTaskName) as? AbstractCompile)?.classpath =
originalMainClassesDirs + compilation.compileDependencyFiles - mainCompilation.output.classesDirs
(tasks.findByName("${target.name}${compilation.name.capitalize()}") as? Test)?.classpath =
originalMainClassesDirs + (compilation as KotlinCompilationToRunnableFiles).runtimeDependencyFiles - mainCompilation.output.classesDirs
compilation.compileKotlinTask.doFirst {
compilation.kotlinOptions.addFriendPaths(originalMainClassesDirs)
}
}
}
}
}
fun Project.sourceSetsByCompilation(): Map<KotlinSourceSet, List<KotlinCompilation<*>>> {
val sourceSetsByCompilation = hashMapOf<KotlinSourceSet, MutableList<KotlinCompilation<*>>>()
withKotlinTargets { target ->
target.compilations.forEach { compilation ->
compilation.allKotlinSourceSets.forEach { sourceSet ->
sourceSetsByCompilation.getOrPut(sourceSet) { mutableListOf() }.add(compilation)
}
}
}
return sourceSetsByCompilation
}
fun Project.configureMultiplatformPluginDependencies(version: String) {
if (rootProject.findProperty("kotlin.mpp.enableGranularSourceSetsMetadata").toString().toBoolean()) {
val mainConfigurationName = project.extensions.getByType(KotlinMultiplatformExtension::class.java).sourceSets
.getByName(KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME)
.compileOnlyConfigurationName
dependencies.add(mainConfigurationName, getAtomicfuDependencyNotation(Platform.MULTIPLATFORM, version))
val testConfigurationName = project.extensions.getByType(KotlinMultiplatformExtension::class.java).sourceSets
.getByName(KotlinSourceSet.COMMON_TEST_SOURCE_SET_NAME)
.implementationConfigurationName
dependencies.add(testConfigurationName, getAtomicfuDependencyNotation(Platform.MULTIPLATFORM, version))
// For each source set that is only used in Native compilations, add an implementation dependency so that it
// gets published and is properly consumed as a transitive dependency:
sourceSetsByCompilation().forEach { (sourceSet, compilations) ->
val isSharedNativeSourceSet = compilations.all {
it.platformType == KotlinPlatformType.common || it.platformType == KotlinPlatformType.native
}
if (isSharedNativeSourceSet) {
val configuration = sourceSet.implementationConfigurationName
dependencies.add(configuration, getAtomicfuDependencyNotation(Platform.MULTIPLATFORM, version))
}
}
} else {
sourceSetsByCompilation().forEach { (sourceSet, compilations) ->
val platformTypes = compilations.map { it.platformType }.toSet()
val compilationNames = compilations.map { it.compilationName }.toSet()
if (compilationNames.size != 1)
error("Source set '${sourceSet.name}' of project '$name' is part of several compilations $compilationNames")
val compilationType = compilationNames.single().compilationNameToType()
?: return@forEach // skip unknown compilations
val platform =
if (platformTypes.size > 1) Platform.MULTIPLATFORM else // mix of platform types -> "common"
when (platformTypes.single()) {
KotlinPlatformType.common -> Platform.MULTIPLATFORM
KotlinPlatformType.jvm, KotlinPlatformType.androidJvm -> Platform.JVM
KotlinPlatformType.js -> Platform.JS
KotlinPlatformType.native -> Platform.NATIVE
}
val configurationName = when {
// impl dependency for native (there is no transformation)
platform == Platform.NATIVE -> sourceSet.implementationConfigurationName
// compileOnly dependency for main compilation (commonMain, jvmMain, jsMain)
compilationType == CompilationType.MAIN -> sourceSet.compileOnlyConfigurationName
// impl dependency for tests
else -> sourceSet.implementationConfigurationName
}
dependencies.add(configurationName, getAtomicfuDependencyNotation(platform, version))
}
}
}
fun Project.configureTransformTasks(
testTaskName: String,
createTransformTask: (sourceSet: SourceSet, transformedDir: File, originalDir: FileCollection) -> Task
) {
val config = config
sourceSets.all { sourceSet ->
val compilationType = sourceSet.name.sourceSetNameToType()
?: return@all // skip unknown types
val classesDirs = (sourceSet.output.classesDirs as ConfigurableFileCollection).from as Collection<Any>
// make copy of original classes directory
val originalClassesDirs: FileCollection = project.files(classesDirs.toTypedArray()).filter { it.exists() }
(sourceSet as ExtensionAware).extensions.add(ORIGINAL_DIR_NAME, originalClassesDirs)
val transformedClassesDir =
project.buildDir.resolve("classes/atomicfu/${sourceSet.name}")
// make transformedClassesDir the source path for output.classesDirs
(sourceSet.output.classesDirs as ConfigurableFileCollection).setFrom(transformedClassesDir)
val transformTask = createTransformTask(sourceSet, transformedClassesDir, originalClassesDirs)
//now transformTask is responsible for compiling this source set into the classes directory
sourceSet.compiledBy(transformTask)
(tasks.findByName(sourceSet.jarTaskName) as? Jar)?.apply {
setupJarManifest(multiRelease = config.variant.toVariant() == Variant.BOTH)
}
// test should compile and run against original production binaries
if (compilationType == CompilationType.TEST) {
val mainSourceSet = sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME)
val originalMainClassesDirs = project.files(
// use Callable because there is no guarantee that main is configured before test
Callable { (mainSourceSet as ExtensionAware).extensions.getByName(ORIGINAL_DIR_NAME) as FileCollection }
)
(tasks.findByName(testTaskName) as? AbstractCompile)?.run {
classpath =
originalMainClassesDirs + sourceSet.compileClasspath - mainSourceSet.output.classesDirs
(this as? KotlinCompile<*>)?.doFirst {
kotlinOptions.addFriendPaths(originalMainClassesDirs)
}
}
// todo: fix test runtime classpath for JS?
(tasks.findByName(JavaPlugin.TEST_TASK_NAME) as? Test)?.classpath =
originalMainClassesDirs + sourceSet.runtimeClasspath - mainSourceSet.output.classesDirs
}
}
}
fun String.toVariant(): Variant = enumValueOf(toUpperCase(Locale.US))
fun Project.createJvmTransformTask(compilation: KotlinCompilation<*>): AtomicFUTransformTask =
tasks.create(
"transform${compilation.target.name.capitalize()}${compilation.name.capitalize()}Atomicfu",
AtomicFUTransformTask::class.java
)
fun Project.createJsTransformTask(compilation: KotlinCompilation<*>): AtomicFUTransformJsTask =
tasks.create(
"transform${compilation.target.name.capitalize()}${compilation.name.capitalize()}Atomicfu",
AtomicFUTransformJsTask::class.java
)
fun Project.createJvmTransformTask(sourceSet: SourceSet): AtomicFUTransformTask =
tasks.create(sourceSet.getTaskName("transform", "atomicfuClasses"), AtomicFUTransformTask::class.java)
fun Project.createJsTransformTask(sourceSet: SourceSet): AtomicFUTransformJsTask =
tasks.create(sourceSet.getTaskName("transform", "atomicfuJsFiles"), AtomicFUTransformJsTask::class.java)
fun AtomicFUTransformTask.configureJvmTask(
classpath: FileCollection,
classesTaskName: String,
transformedClassesDir: File,
originalClassesDir: FileCollection,
config: AtomicFUPluginExtension
): ConventionTask =
apply {
dependsOn(classesTaskName)
classPath = classpath
inputFiles = originalClassesDir
outputDir = transformedClassesDir
variant = config.variant
verbose = config.verbose
}
fun AtomicFUTransformJsTask.configureJsTask(
classesTaskName: String,
transformedClassesDir: File,
originalClassesDir: FileCollection,
config: AtomicFUPluginExtension
): ConventionTask =
apply {
dependsOn(classesTaskName)
inputFiles = originalClassesDir
outputDir = transformedClassesDir
verbose = config.verbose
}
fun Jar.setupJarManifest(multiRelease: Boolean) {
if (multiRelease) {
manifest.attributes.apply {
put("Multi-Release", "true")
}
}
}
val Project.sourceSets: SourceSetContainer
get() = convention.getPlugin(JavaPluginConvention::class.java).sourceSets
class AtomicFUPluginExtension(pluginVersion: String?) {
var dependenciesVersion = pluginVersion
var transformJvm = true
var transformJs = true
var variant: String = "FU"
var verbose: Boolean = false
}
@CacheableTask
open class AtomicFUTransformTask : ConventionTask() {
@PathSensitive(PathSensitivity.RELATIVE)
@InputFiles
lateinit var inputFiles: FileCollection
@OutputDirectory
lateinit var outputDir: File
@Classpath
@InputFiles
lateinit var classPath: FileCollection
@Input
var variant = "FU"
@Input
var verbose = false
@TaskAction
fun transform() {
val cp = classPath.files.map { it.absolutePath }
inputFiles.files.forEach { inputDir ->
AtomicFUTransformer(cp, inputDir, outputDir).let { t ->
t.variant = variant.toVariant()
t.verbose = verbose
t.transform()
}
}
}
}
@CacheableTask
open class AtomicFUTransformJsTask : ConventionTask() {
@PathSensitive(PathSensitivity.RELATIVE)
@InputFiles
lateinit var inputFiles: FileCollection
@OutputDirectory
lateinit var outputDir: File
@Input
var verbose = false
@TaskAction
fun transform() {
inputFiles.files.forEach { inputDir ->
AtomicFUTransformerJS(inputDir, outputDir).let { t ->
t.verbose = verbose
t.transform()
}
}
}
}
|