-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Gradle] Check when Android library is published from kotlin managed
components. This can lead into errors and mistakes. Android requires users to explicitly configure publication on AGP side. For example BuildTypeAttribute may leak into publication. So in this diagnostic we will warn users that doing publications incorrectly. ^KT-70380 Verification Pending
- Loading branch information
1 parent
9b7fefd
commit 8c02836
Showing
14 changed files
with
348 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
...c/test/kotlin/org/jetbrains/kotlin/gradle/testbase/testProjectsBuildScriptInjectionDsl.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Copyright 2010-2024 JetBrains s.r.o. and Kotlin Programming Language contributors. | ||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. | ||
*/ | ||
|
||
package org.jetbrains.kotlin.gradle.testbase | ||
|
||
import org.gradle.api.publish.PublishingExtension | ||
import org.gradle.jvm.toolchain.JavaLanguageVersion | ||
import org.gradle.util.GradleVersion | ||
|
||
fun KGPBaseTest.kotlinAndroidLibraryProject( | ||
gradleVersion: GradleVersion, | ||
agpVersion: String, | ||
jdkVersion: JdkVersions.ProvidedJdk, | ||
): TestProject { | ||
return project( | ||
"base-kotlin-android-library", | ||
gradleVersion, | ||
buildOptions = defaultBuildOptions.copy(androidVersion = agpVersion), | ||
buildJdk = jdkVersion.location, | ||
) { | ||
buildScriptInjection { applyDefaultAndroidLibraryConfiguration() } | ||
} | ||
} | ||
|
||
fun GradleBuildScriptInjectionContext.applyMavenPublishPlugin(): PublishingExtension { | ||
project.plugins.apply("maven-publish") | ||
publishing.repositories.apply { | ||
maven { maven -> | ||
maven.setUrl(project.layout.projectDirectory.dir("repo")) | ||
} | ||
} | ||
return publishing | ||
} | ||
|
||
fun GradleBuildScriptInjectionContext.applyDefaultAndroidLibraryConfiguration() { | ||
androidLibrary.apply { | ||
compileSdk = 31 | ||
defaultConfig { | ||
minSdk = 31 | ||
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" | ||
} | ||
namespace = "org.jetbrains.kotlin.sample" | ||
} | ||
|
||
java.apply { | ||
toolchain.languageVersion.set(JavaLanguageVersion.of(8)) | ||
} | ||
} |
6 changes: 6 additions & 0 deletions
6
...gration-tests/src/test/resources/testProject/base-kotlin-android-library/build.gradle.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
plugins { | ||
id("com.android.library") | ||
kotlin("android") | ||
} | ||
|
||
// To be filled by test code using buildScriptInjection API |
6 changes: 6 additions & 0 deletions
6
...s/src/test/resources/testProject/base-kotlin-android-library/src/main/AndroidManifest.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"> | ||
<application> | ||
<activity android:name=".KotlinActivity"/> | ||
</application> | ||
</manifest> |
8 changes: 8 additions & 0 deletions
8
...resources/testProject/base-kotlin-android-library/src/main/kotlin/com/example/AppDummy.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
/* | ||
* Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors. | ||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. | ||
*/ | ||
|
||
package com.example | ||
|
||
class AppDummy |
10 changes: 10 additions & 0 deletions
10
...ces/testProject/base-kotlin-android-library/src/main/kotlin/com/example/KotlinActivity.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
/* | ||
* Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors. | ||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. | ||
*/ | ||
|
||
package com.example | ||
|
||
import android.app.Activity | ||
|
||
open class KotlinActivity : Activity() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
51 changes: 51 additions & 0 deletions
51
...rains/kotlin/gradle/plugin/diagnostics/checkers/AndroidPublicationNotConfiguredChecker.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
/* | ||
* Copyright 2010-2024 JetBrains s.r.o. and Kotlin Programming Language contributors. | ||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. | ||
*/ | ||
|
||
package org.jetbrains.kotlin.gradle.plugin.diagnostics.checkers | ||
|
||
import org.gradle.api.publish.PublishingExtension | ||
import org.gradle.api.publish.maven.MavenPublication | ||
import org.jetbrains.kotlin.gradle.dsl.KotlinAndroidProjectExtension | ||
import org.jetbrains.kotlin.gradle.dsl.kotlinExtension | ||
import org.jetbrains.kotlin.gradle.plugin.KotlinPluginLifecycle.Stage | ||
import org.jetbrains.kotlin.gradle.plugin.await | ||
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinGradleProjectChecker | ||
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinGradleProjectCheckerContext | ||
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinToolingDiagnostics | ||
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinToolingDiagnosticsCollector | ||
import org.jetbrains.kotlin.gradle.plugin.internal.getComponentOrNull | ||
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinTargetSoftwareComponent | ||
import org.jetbrains.kotlin.gradle.utils.isPluginApplied | ||
|
||
internal object AndroidPublicationNotConfiguredChecker : KotlinGradleProjectChecker { | ||
override suspend fun KotlinGradleProjectCheckerContext.runChecks(collector: KotlinToolingDiagnosticsCollector) { | ||
// kotlin("android") is applied | ||
if (project.kotlinExtension !is KotlinAndroidProjectExtension) return | ||
project.isPluginApplied("com.android.library") || return | ||
project.isPluginApplied("maven-publish") || return | ||
|
||
// After this stage, all publications are created and configured | ||
Stage.AfterFinaliseDsl.await() | ||
|
||
val publishing = project.extensions.getByName("publishing") as PublishingExtension | ||
publishing.publications.withType(MavenPublication::class.java).configureEach { publication -> | ||
val component = publication.getComponentOrNull(project) ?: return@configureEach | ||
|
||
// This is heuristic, but still reliable check. | ||
// When all three plugins are applied AND user configured AGP's publications correctly, | ||
// then neither of the components should be `KotlinTargetComponent` | ||
if (component !is KotlinTargetSoftwareComponent) return@configureEach | ||
|
||
collector.report( | ||
project, | ||
KotlinToolingDiagnostics.AndroidPublicationNotConfigured( | ||
// cast is needed to avoid ambiguity on getName() | ||
componentName = component.name, | ||
publicationName = publication.name, | ||
) | ||
) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.