Apply Validation Gradle Plugin

Author: alexander-yevsyukov

gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/CompilerConfigPlugin.kt

@@ -29,8 +29,8 @@
 package io.spine.tools.core.jvm.gradle.plugins
 
 import io.spine.tools.compiler.gradle.api.CompilerSettings
-import io.spine.tools.compiler.gradle.api.Names
 import io.spine.tools.compiler.gradle.api.Names.GRADLE_PLUGIN_ID
+import io.spine.tools.compiler.gradle.api.addUserClasspathDependency
 import io.spine.tools.compiler.gradle.api.compilerSettings
 import io.spine.tools.compiler.gradle.api.compilerWorkingDir
 import io.spine.tools.compiler.gradle.plugin.LaunchSpineCompiler
@@ -42,7 +42,6 @@ import io.spine.tools.core.jvm.entity.EntityPlugin
 import io.spine.tools.core.jvm.gradle.coreJvmOptions
 import io.spine.tools.core.jvm.gradle.generatedGrpcDirName
 import io.spine.tools.core.jvm.gradle.generatedJavaDirName
-import io.spine.tools.core.jvm.gradle.plugins.CompilerConfigPlugin.Companion.VALIDATION_PLUGIN_CLASS
 import io.spine.tools.core.jvm.gradle.plugins.CompilerConfigPlugin.Companion.WRITE_COMPILER_PLUGINS_SETTINGS
 import io.spine.tools.core.jvm.gradle.settings.CoreJvmCompilerSettings
 import io.spine.tools.core.jvm.marker.MarkerPlugin
@@ -53,10 +52,8 @@ import io.spine.tools.core.jvm.uuid.UuidPlugin
 import io.spine.tools.fs.DirectoryName
 import io.spine.tools.gradle.task.JavaTaskName.Companion.processResources
 import io.spine.tools.gradle.task.JavaTaskName.Companion.sourcesJar
-import io.spine.tools.meta.MavenArtifact
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-import org.gradle.api.artifacts.Dependency
 import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.register
 import org.gradle.kotlin.dsl.withType
@@ -144,7 +141,7 @@ private fun Project.configureCompilerPlugins() {
     val compiler = compilerSettings
     compiler.setSubdirectories()
 
-    configureValidation(compiler)
+//    configureValidation(compiler)
     configureSignals(compiler)
 
     compiler.run {
@@ -174,29 +171,6 @@ private fun CompilerSettings.setSubdirectories() {
     )
 }
 
-private fun Project.configureValidation(compiler: CompilerSettings) {
-    val validationConfig = messageOptions.validation
-    val version = validationConfig.version.get()
-    if (validationConfig.enabled.get()) {
-        addUserClasspathDependency(ValidationSdk.javaCodegenBundle(version))
-        compiler.plugins(
-            VALIDATION_PLUGIN_CLASS
-        )
-    } else {
-        addUserClasspathDependency(ValidationSdk.configuration(version))
-    }
-
-    // We add the dependency on runtime anyway for the following reasons:
-    //  1. We do not want users to change their Gradle build files when they turn on or off
-    //     code generation for the validation code.
-    //
-    //  2. We have run-time validation rules that are going to be used in parallel with
-    //     the generated code. This includes current and new implementation for validation
-    //     rules for the already existing generated Protobuf code.
-    //
-    addDependency("implementation", ValidationSdk.jvmRuntime(version))
-}
-
 private fun Project.configureSignals(compiler: CompilerSettings) {
     compiler.addPlugin<SignalPlugin>()
 
@@ -206,25 +180,6 @@ private fun Project.configureSignals(compiler: CompilerSettings) {
     }
 }
 
-private fun Project.addUserClasspathDependency(vararg artifacts: MavenArtifact) =
-    artifacts.forEach {
-        addDependency(Names.USER_CLASSPATH_CONFIGURATION, it)
-    }
-
-private fun Project.addDependency(configuration: String, artifact: MavenArtifact) {
-    val dependency = findDependency(artifact) ?: artifact.coordinates
-    dependencies.add(configuration, dependency)
-}
-
-private fun Project.findDependency(artifact: MavenArtifact): Dependency? {
-    val dependencies = configurations.flatMap { c -> c.dependencies }
-    val found = dependencies.firstOrNull { d ->
-        artifact.group == d.group // `d.group` could be `null`.
-                && artifact.name == d.name
-    }
-    return found
-}
-
 private inline fun <reified T : CompilerPlugin> CompilerSettings.addPlugin() {
     plugins(T::class.java.name)
 }

gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/CoreJvmPlugin.kt

@@ -37,8 +37,11 @@ import io.spine.tools.core.jvm.grpc.gradle.GrpcCoreJvmPlugin
 import io.spine.tools.core.jvm.routing.gradle.RoutingPlugin
 import io.spine.tools.gradle.DslSpec
 import io.spine.tools.gradle.lib.LibraryPlugin
+import io.spine.tools.meta.MavenArtifact
+import io.spine.tools.validation.gradle.ValidationGradlePlugin
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.api.artifacts.Dependency
 
 /**
  * Spine Model Compiler for Java Gradle plugin.
@@ -63,6 +66,9 @@ public class CoreJvmPlugin : LibraryPlugin<CoreJvmOptions>(
         super.apply(project)
         project.run {
             applyProtobufPlugin()
+            afterEvaluate {
+                configureValidation()
+            }
             pluginManager.withPlugin(ProtobufGradlePlugin.id) { _ ->
                 applyCoreJvmPlugins()
             }
@@ -81,6 +87,20 @@ private fun Project.applyProtobufPlugin() {
     }
 }
 
+private fun Project.configureValidation() {
+    pluginManager.apply(ValidationGradlePlugin::class.java)
+
+    // We add the dependency on runtime anyway for the following reasons:
+    //  1. We do not want users to change their Gradle build files when they turn on or off
+    //     code generation for the validation code.
+    //
+    //  2. We have run-time validation rules that are going to be used in parallel with
+    //     the generated code. This includes current and new implementation for validation
+    //     rules for the already existing generated Protobuf code.
+    //
+    addDependency("implementation", ValidationSdk.jvmRuntime())
+}
+
 private fun Project.applyCoreJvmPlugins() {
     logApplying()
     val extension = project.coreJvmOptions
@@ -113,3 +133,17 @@ private fun Project.apply(plugin: Plugin<Project>) {
     logger.debug { "Applying `${plugin.javaClass.name}` plugin." }
     plugin.apply(project)
 }
+
+internal fun Project.addDependency(configuration: String, artifact: MavenArtifact) {
+    val dependency = findDependency(artifact) ?: artifact.coordinates
+    dependencies.add(configuration, dependency)
+}
+
+private fun Project.findDependency(artifact: MavenArtifact): Dependency? {
+    val dependencies = configurations.flatMap { c -> c.dependencies }
+    val found = dependencies.firstOrNull { d ->
+        artifact.group == d.group // `d.group` could be `null`.
+                && artifact.name == d.name
+    }
+    return found
+}