[Gradle] Added error when provided kotlin.native.home is wrong.

^KT-67522 Fixed
^KT-67521 Fixed

(cherry picked from commit 2cb70c5)

Author: dkrasnoff

libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/KotlinToolingDiagnostics.kt

@@ -808,7 +808,8 @@ object KotlinToolingDiagnostics {
 
     object ResourceMayNotBeResolvedWithGradleVersion : ToolingDiagnosticFactory(ERROR) {
         operator fun invoke(
-            targetName: String, currentGradleVersion: String, minimumRequiredVersion: String) = build(
+            targetName: String, currentGradleVersion: String, minimumRequiredVersion: String,
+        ) = build(
             """
             Resources for target $targetName may not be resolved. Minimum required Gradle version is ${minimumRequiredVersion} but current is ${currentGradleVersion}.
             
@@ -895,6 +896,14 @@ object KotlinToolingDiagnostics {
             appendLine("They are already added from Kotlin Target Hierarchy template https://kotl.in/hierarchy-template")
         }
     }
+
+    object BrokenKotlinNativeBundleError : ToolingDiagnosticFactory(ERROR) {
+        operator fun invoke(kotlinNativeHomePropertyValue: String?, kotlinNativeHomeProperty: String): ToolingDiagnostic =
+            build(
+                "The Kotlin/Native distribution ($kotlinNativeHomePropertyValue) used in this build does not provide required subdirectories." +
+                        " Make sure that the '$kotlinNativeHomeProperty' property points to a valid Kotlin/Native distribution.",
+            )
+    }
 }
 
 private fun String.indentLines(nSpaces: Int = 4, skipFirstLine: Boolean = true): String {

libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/checkers/MissingNativeStdlibChecker.kt

@@ -12,13 +12,15 @@ import org.gradle.api.provider.ValueSourceParameters
 import org.jetbrains.kotlin.commonizer.stdlib
 import org.jetbrains.kotlin.compilerRunner.kotlinNativeToolchainEnabled
 import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
+import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.Companion.kotlinPropertiesProvider
 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.configurationTimePropertiesAccessor
 import org.jetbrains.kotlin.gradle.plugin.internal.usedAtConfigurationTime
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+import org.jetbrains.kotlin.gradle.utils.`is`
 import org.jetbrains.kotlin.gradle.utils.konanDistribution
 
 /**
@@ -43,6 +45,7 @@ internal object MissingNativeStdlibChecker : KotlinGradleProjectChecker {
             it.parameters.noStdlibEnabled.set(project.hasProperty("kotlin.native.nostdlib"))
             it.parameters.kotlinNativeToolchainEnabled.set(project.kotlinNativeToolchainEnabled)
             it.parameters.stdlib.setFrom(project.konanDistribution.stdlib)
+            it.parameters.overriddenKotlinNativeHome.set(project.kotlinPropertiesProvider.nativeHome)
         }.usedAtConfigurationTime(project.configurationTimePropertiesAccessor)
 
     internal abstract class StdlibExistenceCheckerValueSource :
@@ -52,11 +55,12 @@ internal object MissingNativeStdlibChecker : KotlinGradleProjectChecker {
             val noStdlibEnabled: Property<Boolean>
             val kotlinNativeToolchainEnabled: Property<Boolean>
             val stdlib: ConfigurableFileCollection
+            val overriddenKotlinNativeHome: Property<String>
         }
 
         override fun obtain(): Boolean {
             return parameters.noStdlibEnabled.get() || // suppressed
-                    parameters.kotlinNativeToolchainEnabled.get() || // with toolchain, we download konan after configuration phase, thus, we shouldn't check existence here
+                    (parameters.kotlinNativeToolchainEnabled.get() && !parameters.overriddenKotlinNativeHome.isPresent) || // with toolchain, we download konan after configuration phase, thus, we shouldn't check existence here
                     parameters.stdlib.singleFile.exists()
         }
     }

libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/diagnostics/checkers/OverriddenKotlinNativeHomeChecker.kt

@@ -0,0 +1,62 @@
+/*
+ * 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.provider.Property
+import org.gradle.api.provider.ValueSource
+import org.gradle.api.provider.ValueSourceParameters
+import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
+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.configurationTimePropertiesAccessor
+import org.jetbrains.kotlin.gradle.plugin.internal.usedAtConfigurationTime
+import java.io.File
+
+
+/**
+ * This class is required for checking that provided custom `kotlin.native.home` contains a Kotlin/Native bundle.
+ * For that, we are checking the existence of some main subdirectories inside the installed Kotlin/Native bundle.
+ */
+internal object OverriddenKotlinNativeHomeChecker : KotlinGradleProjectChecker {
+
+    override suspend fun KotlinGradleProjectCheckerContext.runChecks(collector: KotlinToolingDiagnosticsCollector) {
+        if (allKonanMainSubdirectoriesExist().get()) return
+
+        collector.report(
+            project, KotlinToolingDiagnostics.BrokenKotlinNativeBundleError(
+                kotlinPropertiesProvider.nativeHome, PropertiesProvider.KOTLIN_NATIVE_HOME
+            )
+        )
+    }
+
+    private fun KotlinGradleProjectCheckerContext.allKonanMainSubdirectoriesExist() =
+        // we need to wrap this check in ValueSource to prevent Gradle from monitoring the stdlib folder as a build configuration input
+        project.providers.of(StdlibExistenceCheckerValueSource::class.java) {
+            it.parameters.overriddenKotlinNativeHome.set(kotlinPropertiesProvider.nativeHome)
+        }.usedAtConfigurationTime(project.configurationTimePropertiesAccessor)
+
+    internal abstract class StdlibExistenceCheckerValueSource :
+        ValueSource<Boolean, StdlibExistenceCheckerValueSource.Params> {
+
+        interface Params : ValueSourceParameters {
+            val overriddenKotlinNativeHome: Property<String>
+        }
+
+        override fun obtain(): Boolean {
+            return !parameters.overriddenKotlinNativeHome.isPresent || // when `kotlin.native.home` was not provided, we don't need to make this diagnostic
+                    REQUIRED_SUBDIRECTORIES.all { subdir ->
+                        File(parameters.overriddenKotlinNativeHome.get()).resolve(subdir).exists()
+                    }
+
+        }
+
+        companion object {
+            private val REQUIRED_SUBDIRECTORIES = listOf("konan", "bin")
+        }
+    }
+}

libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/registerKotlinPluginExtensions.kt

@@ -147,6 +147,7 @@ internal fun Project.registerKotlinPluginExtensions() {
         register(project, CInteropInputChecker)
         register(project, IncorrectNativeDependenciesChecker)
         register(project, GradleDeprecatedPropertyChecker)
+        register(project, OverriddenKotlinNativeHomeChecker)
 
         if (isMultiplatform) {
             register(project, KotlinMultiplatformAndroidGradlePluginCompatibilityChecker)

libraries/tools/kotlin-gradle-plugin/src/functionalTest/kotlin/org/jetbrains/kotlin/gradle/unitTests/diagnosticsTests/OverriddenKotlinHomeCheckerTest.kt

@@ -0,0 +1,38 @@
+/*
+ * 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.unitTests.diagnosticsTests
+
+import org.jetbrains.kotlin.gradle.dsl.multiplatformExtension
+import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
+import org.jetbrains.kotlin.gradle.plugin.extraProperties
+import org.jetbrains.kotlin.gradle.util.assertNoDiagnostics
+import org.jetbrains.kotlin.gradle.util.buildProjectWithMPP
+import org.jetbrains.kotlin.gradle.util.checkDiagnostics
+import kotlin.test.Test
+
+class OverriddenKotlinHomeCheckerTest {
+
+    @Test
+    fun `overridden kotlin home with wrong path failes build`() {
+        val project = buildProjectWithMPP(
+            preApplyCode = {
+                project.extraProperties.set(PropertiesProvider.KOTLIN_NATIVE_HOME, "non_existed_path")
+            }) {
+            project.multiplatformExtension.applyDefaultHierarchyTemplate()
+            project.multiplatformExtension.linuxX64()
+        }
+        project.checkDiagnostics("BrokenKotlinNativeBundleError")
+    }
+
+    @Test
+    fun `without overridden kotlin home build is successfull`() {
+        val project = buildProjectWithMPP {
+            project.multiplatformExtension.applyDefaultHierarchyTemplate()
+            project.multiplatformExtension.linuxX64()
+        }
+        project.assertNoDiagnostics()
+    }
+}

libraries/tools/kotlin-gradle-plugin/src/functionalTest/resources/expectedDiagnostics/BrokenKotlinNativeBundleError.txt

@@ -0,0 +1 @@
+[BrokenKotlinNativeBundleError | ERROR] The Kotlin/Native distribution (non_existed_path) used in this build does not provide required subdirectories. Make sure that the 'kotlin.native.home' property points to a valid Kotlin/Native distribution.