From a65953a7fb2dfa938b64b4a50be115aa5cd05604 Mon Sep 17 00:00:00 2001 From: Dmitry Savvinov Date: Fri, 28 Jul 2023 19:48:33 +0200 Subject: [PATCH] [Gradle] Minor, rename task EnsureNoKotlinGradlePluginErrors -> CheckKotlinGradlePluginConfigurationErrors --- .../expectedOutput.txt | 2 +- .../expectedOutput-assemble-cache-reused.txt | 2 +- .../expectedOutput-assemble.txt | 2 +- .../expectedOutput-brokenA.txt | 2 +- .../expectedOutput-brokenB.txt | 2 +- .../expectedOutput-healthy.txt | 2 +- .../expectedOutput-root-with-continue.txt | 6 +++--- .../expectedOutput-root.txt | 2 +- .../suppressGradlePluginErrors/expectedOutput.txt | 2 +- .../suppressGradlePluginWarnings/expectedOutput.txt | 2 +- .../kotlin/gradle/plugin/KotlinPluginWrapper.kt | 3 +-- ...=> CheckKotlinGradlePluginConfigurationErrors.kt} | 12 ++++++------ .../gradle/internals/ExposedForIntegrationTests.kt | 4 ++-- 13 files changed, 21 insertions(+), 22 deletions(-) rename libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/{EnsureNoKotlinGradlePluginErrors.kt => CheckKotlinGradlePluginConfigurationErrors.kt} (83%) diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/earlyTasksMaterializationDoesntBreakReports/expectedOutput.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/earlyTasksMaterializationDoesntBreakReports/expectedOutput.txt index 5b3bd8eae89..b54e9b5822c 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/earlyTasksMaterializationDoesntBreakReports/expectedOutput.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/earlyTasksMaterializationDoesntBreakReports/expectedOutput.txt @@ -3,6 +3,6 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de #diagnostic-end -> Task :ensureNoKotlinGradlePluginErrors FAILED +> Task :checkKotlinGradlePluginConfigurationErrors FAILED e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare dependsOn on other source sets #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble-cache-reused.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble-cache-reused.txt index 7e8be82a0b6..3d91a71b6aa 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble-cache-reused.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble-cache-reused.txt @@ -1,3 +1,3 @@ -> Task :ensureNoKotlinGradlePluginErrors FAILED +> Task :checkKotlinGradlePluginConfigurationErrors FAILED e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotlin/Native targets were used in the project: linuxMips32 #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble.txt index 7d8cf2c18e1..d938232dd2e 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorDiagnosticBuildFails/expectedOutput-assemble.txt @@ -3,6 +3,6 @@ e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotli #diagnostic-end -> Task :ensureNoKotlinGradlePluginErrors FAILED +> Task :checkKotlinGradlePluginConfigurationErrors FAILED e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotlin/Native targets were used in the project: linuxMips32 #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenA.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenA.txt index 7182f814691..5b6ad56548f 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenA.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenA.txt @@ -12,6 +12,6 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de > Configure project :healthyProject -> Task :brokenProjectA:ensureNoKotlinGradlePluginErrors FAILED +> Task :brokenProjectA:checkKotlinGradlePluginConfigurationErrors FAILED e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotlin/Native targets were used in the project: linuxMips32 #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenB.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenB.txt index 938474aa0bf..7ed2261a3ab 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenB.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-brokenB.txt @@ -12,6 +12,6 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de > Configure project :healthyProject -> Task :brokenProjectB:ensureNoKotlinGradlePluginErrors FAILED +> Task :brokenProjectB:checkKotlinGradlePluginConfigurationErrors FAILED e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare dependsOn on other source sets #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-healthy.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-healthy.txt index 2cd4fed135f..aa46f7d11dc 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-healthy.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-healthy.txt @@ -12,4 +12,4 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de > Configure project :healthyProject -> Task :healthyProject:ensureNoKotlinGradlePluginErrors +> Task :healthyProject:checkKotlinGradlePluginConfigurationErrors diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root-with-continue.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root-with-continue.txt index 602e1854cdc..28c12eac9bf 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root-with-continue.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root-with-continue.txt @@ -12,14 +12,14 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de > Configure project :healthyProject -> Task :brokenProjectA:ensureNoKotlinGradlePluginErrors FAILED +> Task :brokenProjectA:checkKotlinGradlePluginConfigurationErrors FAILED e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotlin/Native targets were used in the project: linuxMips32 #diagnostic-end -> Task :brokenProjectB:ensureNoKotlinGradlePluginErrors FAILED +> Task :brokenProjectB:checkKotlinGradlePluginConfigurationErrors FAILED e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare dependsOn on other source sets #diagnostic-end -> Task :healthyProject:ensureNoKotlinGradlePluginErrors +> Task :healthyProject:checkKotlinGradlePluginConfigurationErrors diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root.txt index 7182f814691..5b6ad56548f 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/errorsFailOnlyRelevantProjects/expectedOutput-root.txt @@ -12,6 +12,6 @@ e: [CommonMainOrTestWithDependsOnDiagnostic | ERROR] commonMain can't declare de > Configure project :healthyProject -> Task :brokenProjectA:ensureNoKotlinGradlePluginErrors FAILED +> Task :brokenProjectA:checkKotlinGradlePluginConfigurationErrors FAILED e: [DeprecatedKotlinNativeTargetsDiagnostic | ERROR] The following removed Kotlin/Native targets were used in the project: linuxMips32 #diagnostic-end diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginErrors/expectedOutput.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginErrors/expectedOutput.txt index d3ab1061d79..8f7e3089fc0 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginErrors/expectedOutput.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginErrors/expectedOutput.txt @@ -9,4 +9,4 @@ Stability and future compatibility of the build is not guaranteed. #diagnostic-end -> Task :ensureNoKotlinGradlePluginErrors +> Task :checkKotlinGradlePluginConfigurationErrors diff --git a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginWarnings/expectedOutput.txt b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginWarnings/expectedOutput.txt index 07aecc3766d..9879ac9928b 100644 --- a/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginWarnings/expectedOutput.txt +++ b/libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/suppressGradlePluginWarnings/expectedOutput.txt @@ -1,3 +1,3 @@ > Configure project : -> Task :ensureNoKotlinGradlePluginErrors +> Task :checkKotlinGradlePluginConfigurationErrors diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPluginWrapper.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPluginWrapper.kt index 80d32aed579..43c5ef44b09 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPluginWrapper.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinPluginWrapper.kt @@ -33,7 +33,6 @@ import org.jetbrains.kotlin.gradle.internal.KOTLIN_MODULE_GROUP import org.jetbrains.kotlin.gradle.logging.kotlinDebug import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformAndroidGradlePluginCompatibilityHealthCheck.runMultiplatformAndroidGradlePluginCompatibilityHealthCheckWhenAndroidIsApplied import org.jetbrains.kotlin.gradle.plugin.diagnostics.* -import org.jetbrains.kotlin.gradle.plugin.diagnostics.EnsureNoKotlinGradlePluginErrors import org.jetbrains.kotlin.gradle.plugin.diagnostics.ToolingDiagnosticRenderingOptions import org.jetbrains.kotlin.gradle.plugin.diagnostics.UsesKotlinToolingDiagnostics import org.jetbrains.kotlin.gradle.plugin.diagnostics.kotlinToolingDiagnosticsCollectorProvider @@ -287,7 +286,7 @@ private fun Project.setupDiagnosticsChecksAndReporting() { launchKotlinGradleProjectCheckers() // Setup a task that will abort the build if errors will be reported. This task should be the first in the taskgraph - project.locateOrRegisterEnsureNoKotlinGradlePluginErrors() + project.locateOrRegisterCheckKotlinGradlePluginErrorsTask() // Schedule diagnostics rendering launch { diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/EnsureNoKotlinGradlePluginErrors.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/CheckKotlinGradlePluginConfigurationErrors.kt similarity index 83% rename from libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/EnsureNoKotlinGradlePluginErrors.kt rename to libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/CheckKotlinGradlePluginConfigurationErrors.kt index 640b6ed78c5..b9307701769 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/EnsureNoKotlinGradlePluginErrors.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/CheckKotlinGradlePluginConfigurationErrors.kt @@ -19,7 +19,7 @@ import org.jetbrains.kotlin.gradle.tasks.withType @DisableCachingByDefault( because = "This task renders reported diagnostics; caching this task will hide diagnostics and obscure issues in the build" ) -internal abstract class EnsureNoKotlinGradlePluginErrors : DefaultTask() { +internal abstract class CheckKotlinGradlePluginConfigurationErrors : DefaultTask() { @get:Input abstract val errorDiagnostics: ListProperty @@ -35,7 +35,7 @@ internal abstract class EnsureNoKotlinGradlePluginErrors : DefaultTask() { } companion object { - internal const val TASK_NAME = "ensureNoKotlinGradlePluginErrors" + internal const val TASK_NAME = "checkKotlinGradlePluginConfigurationErrors" } } @@ -43,10 +43,10 @@ private const val DESCRIPTION = "Checks that Kotlin Gradle Plugin hasn't reported project configuration errors, failing otherwise. " + "This task always runs before compileKotlin* or similar tasks." -internal fun Project.locateOrRegisterEnsureNoKotlinGradlePluginErrors(): TaskProvider { +internal fun Project.locateOrRegisterCheckKotlinGradlePluginErrorsTask(): TaskProvider { val taskProvider = tasks.register( - EnsureNoKotlinGradlePluginErrors.TASK_NAME, - EnsureNoKotlinGradlePluginErrors::class.java + CheckKotlinGradlePluginConfigurationErrors.TASK_NAME, + CheckKotlinGradlePluginConfigurationErrors::class.java ) { task -> task.errorDiagnostics.set( provider { @@ -74,6 +74,6 @@ internal fun Project.locateOrRegisterEnsureNoKotlinGradlePluginErrors(): TaskPro * The intuition here is that if the build manages to do something useful for a user without compiling any .kt-sources, * then it's OK for KGP to let that build pass even if it reported ERROR-diagnostics. */ -private fun TaskProvider.addDependsOnFromTasksThatShouldFailWhenErrorsReported(tasks: TaskContainer) { +private fun TaskProvider.addDependsOnFromTasksThatShouldFailWhenErrorsReported(tasks: TaskContainer) { tasks.withType().configureEach { it.dependsOn(this) } } diff --git a/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/internals/ExposedForIntegrationTests.kt b/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/internals/ExposedForIntegrationTests.kt index b999a1fc038..dc7044046d8 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/internals/ExposedForIntegrationTests.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/test/kotlin/org/jetbrains/kotlin/gradle/internals/ExposedForIntegrationTests.kt @@ -8,7 +8,7 @@ package org.jetbrains.kotlin.gradle.internals import org.jetbrains.kotlin.compilerRunner.asFinishLogMessage import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.PropertyNames.KOTLIN_NATIVE_IGNORE_DISABLED_TARGETS import org.jetbrains.kotlin.gradle.plugin.diagnostics.DIAGNOSTIC_SEPARATOR -import org.jetbrains.kotlin.gradle.plugin.diagnostics.EnsureNoKotlinGradlePluginErrors +import org.jetbrains.kotlin.gradle.plugin.diagnostics.CheckKotlinGradlePluginConfigurationErrors import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinProjectStructureMetadata import org.jetbrains.kotlin.gradle.plugin.mpp.MULTIPLATFORM_PROJECT_METADATA_JSON_FILE_NAME import org.jetbrains.kotlin.gradle.plugin.mpp.parseKotlinSourceSetMetadataFromJson @@ -22,7 +22,7 @@ val KOTLIN_NATIVE_IGNORE_DISABLED_TARGETS_PROPERTY = KOTLIN_NATIVE_IGNORE_DISABL const val VERBOSE_DIAGNOSTIC_SEPARATOR = DIAGNOSTIC_SEPARATOR -const val ENSURE_NO_KOTLIN_GRADLE_PLUGIN_ERRORS_TASK_NAME = EnsureNoKotlinGradlePluginErrors.TASK_NAME +const val ENSURE_NO_KOTLIN_GRADLE_PLUGIN_ERRORS_TASK_NAME = CheckKotlinGradlePluginConfigurationErrors.TASK_NAME val KotlinCompilerExecutionStrategy.asFinishLogMessage: String get() = this.asFinishLogMessage