Merge pull request #65 from SpineEventEngine/apply-validation-gradle-plugin

Apply Validation Gradle Plugin

Author: alexander-yevsyukov

annotation/src/test/kotlin/io/spine/tools/core/jvm/annotation/ApiAnnotationsPluginIgTest.kt

@@ -69,40 +69,41 @@ import org.junit.jupiter.api.io.TempDir
  * [Internal] or [SPI].
  *
  * The subject of test is [io.spine.tools.core.annotation.ApiAnnotationsPlugin] which is
- * a plugin to ProtoData. We test the plugin as a part of the Gradle build performed by
+ * a plugin to Spine Compiler. We test the plugin as a part of the Gradle build performed by
  * the CoreJvm Compiler Gradle plugin.
  *
  * The test project is located in `resources/annotator-plugin-test` directory.
  *
- * ### Enabling remote debugging for ProtoData CLI
- * Since ProtoData launches the code generation in a separate JVM, it is not possible to debug
+ * ### Enabling remote debugging for the Compiler CLI
+ * Since the Compiler launches the code generation in a separate JVM, it is not possible to debug
  * it directly in an IDE. To debug the code generation, perform the following steps:
  *  1. Open the resource file `resources/annotator-plugin-test/build.gradle.kts`.
  *  2. Find the `debugOptions` block.
  *  3. Set the value of the `enabled` property to `true`. Pay attention to the fact that when
- *     enabled, the ProtoData CLI process will be suspended until a debugger is attached.
+ *     enabled, the Compiler CLI process will be suspended until a debugger is attached.
  *
  * ### Creating a remote debugging configuration in IDEA
- *  Check or create `LaunchProtoData Remote Debug` Run/Debug configuration is available in IDEA:
+ *  Check or create `LaunchSpineCompiler Remote Debug` Run/Debug configuration is available in IDEA:
  *  1. Open the Run/Debug configuration window.
- *  2. Under "Remote JVM Debug" on the left, check if the `LaunchProtoData Remote Debug` is
+ *  2. Under "Remote JVM Debug" on the left, check if the `LaunchSpineCompiler Remote Debug` is
  *     present, if not, create it via the "+" button at the top left of the dialog.
  *  3. Under "Debugger mode" select "Attach to remote JVM".
  *  4. Under "Host" enter `localhost`.
  *  5. Under "Port" enter `5566`.
  *  6. Under "Use module classpath" selection `io.spine.tools.mc-java-annotations.test`.
  *
  *  ### Starting debugging session
- *  1. Put a breakpoint on `project.executeTask(launchProtoData)` in the `AnnotatorPluginSpec`.
+ *  1. Put a breakpoint on `project.executeTask(launchSpineCompile)` in the `AnnotatorPluginSpec`.
  *  2. Run "Debug 'AnnotatorPluginSpec'" configuration.
- *  3. Once the breakpoint is reached, hit F8 or F9 to run the `launchProtoData` task.
+ *  3. Once the breakpoint is reached, hit F8 or F9 to run the `launchSpineCompile` task.
  *     It would take several seconds, depending on the performance of your workstation.
  *     The task will be suspended until the debugger is attached.
  *  4. Once the task is suspended, put a breakpoint in the place of interest of your
- *     [Plugin] or [Renderer] code, which is called by ProtoData.
- *  5. Run the "LaunchProtoData Remote Debug" configuration. You should see a console message
+ *     [io.spine.tools.compiler.plugin.Plugin] or [io.spine.tools.compiler.render.Renderer] code,
+ *     which is called by the Compiler.
+ *  5. Run the "LaunchSpineCompile Remote Debug" configuration. You should see a console message
  *     about attaching to a process. If attaching to a process fails, it could mean that
- *     ProtoData CLI has not been started yet. Repeat the attempt in a few seconds.
+ *     the Compiler CLI has not been started yet. Repeat the attempt in a few seconds.
  */
 @DisplayName("`ApiAnnotationsPlugin` should")
 internal class ApiAnnotationsPluginIgTest {

build.gradle.kts

@@ -80,7 +80,8 @@ buildscript {
                     "${compiler.module}:${compiler.dogfoodingVersion}",
                     compiler.api,
                     "${validation.runtimeModule}:${validation.version}",
-                    "${validation.runtimeModule}:${validation.version}"
+                    "${validation.runtimeModule}:${validation.version}",
+                    "io.spine.validation:spine-validation-java-runtime:2.0.0-SNAPSHOT.360"
                 )
             }
         }

buildSrc/src/main/kotlin/io/spine/dependency/local/Base.kt

@@ -33,12 +33,14 @@ package io.spine.dependency.local
  */
 @Suppress("ConstPropertyName", "unused")
 object Base {
-    const val version = "2.0.0-SNAPSHOT.382"
-    const val versionForBuildScript = "2.0.0-SNAPSHOT.382"
+    const val version = "2.0.0-SNAPSHOT.383"
+    const val versionForBuildScript = "2.0.0-SNAPSHOT.383"
     const val group = Spine.group
-    const val artifact = "spine-base"
-    const val lib = "$group:$artifact:$version"
-    const val format = "$group:spine-format:$version"
-    const val libForBuildScript = "$group:$artifact:$versionForBuildScript"
-    const val annotations = "$group:spine-annotations:$version"
+    private const val prefix = "spine"
+    const val libModule = "$prefix-base"
+    const val lib = "$group:$libModule:$version"
+    const val libForBuildScript = "$group:$libModule:$versionForBuildScript"
+    const val annotations = "$group:$prefix-annotations:$version"
+    const val environment = "$group:$prefix-environment:$version"
+    const val format = "$group:$prefix-format:$version"
 }

buildSrc/src/main/kotlin/io/spine/dependency/local/Compiler.kt

@@ -26,6 +26,8 @@
 
 package io.spine.dependency.local
 
+import io.spine.dependency.Dependency
+
 /**
  * Dependencies on the Spine Compiler modules.
  *
@@ -56,9 +58,9 @@ package io.spine.dependency.local
     "ConstPropertyName" /* We use custom convention for artifact properties. */,
     "MemberVisibilityCanBePrivate" /* The properties are used directly by other subprojects. */,
 )
-object Compiler {
+object Compiler : Dependency() {
     const val pluginGroup = Spine.group
-    const val group = "io.spine.tools"
+    override val group = "io.spine.tools"
     const val pluginId = "io.spine.compiler"
 
     /**
@@ -69,8 +71,8 @@ object Compiler {
     /**
      * The version of the Compiler dependencies.
      */
-    val version: String
-    private const val fallbackVersion = "2.0.0-SNAPSHOT.034"
+    override val version: String
+    private const val fallbackVersion = "2.0.0-SNAPSHOT.035"
 
     /**
      * The distinct version of the Compiler used by other build tools.
@@ -79,7 +81,7 @@ object Compiler {
      * transitive dependencies, this is the version used to build the project itself.
      */
     val dogfoodingVersion: String
-    private const val fallbackDfVersion = "2.0.0-SNAPSHOT.030"
+    private const val fallbackDfVersion = "2.0.0-SNAPSHOT.035"
 
     /**
      * The artifact for the Compiler Gradle plugin.
@@ -129,6 +131,9 @@ object Compiler {
     val testlib
         get() = "$group:compiler-testlib:$version"
 
+    override val modules: List<String>
+        get() = listOf(api, backend, params, protocPlugin, gradleApi, cliApi, jvm, fatCli, testlib)
+
     /**
      * An env variable storing a custom [version].
      */

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvm.kt

@@ -38,7 +38,7 @@ typealias CoreJava = CoreJvm
 @Suppress("ConstPropertyName", "unused")
 object CoreJvm {
     const val group = Spine.group
-    const val version = "2.0.0-SNAPSHOT.356"
+    const val version = "2.0.0-SNAPSHOT.358"
 
     const val coreArtifact = "spine-core"
     const val clientArtifact = "spine-client"

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt

@@ -46,12 +46,12 @@ object CoreJvmCompiler {
     /**
      * The version used to in the build classpath.
      */
-    const val dogfoodingVersion = "2.0.0-SNAPSHOT.035"
+    const val dogfoodingVersion = "2.0.0-SNAPSHOT.040"
 
     /**
      * The version to be used for integration tests.
      */
-    const val version = "2.0.0-SNAPSHOT.035"
+    const val version = "2.0.0-SNAPSHOT.040"
 
     /**
      * The ID of the Gradle plugin.

buildSrc/src/main/kotlin/io/spine/dependency/local/Spine.kt

@@ -27,7 +27,7 @@
 package io.spine.dependency.local
 
 /**
- * Dependencies on smaller Spine modules.
+ * Defines Maven groups for the Spine SDK artifacts.
  */
 @Suppress("unused", "ConstPropertyName")
 object Spine {

buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt

@@ -36,21 +36,22 @@ object Validation {
     /**
      * The version of the Validation library artifacts.
      */
-    const val version = "2.0.0-SNAPSHOT.360"
+    const val version = "2.0.0-SNAPSHOT.375"
 
     /**
      * The last version of Validation compatible with ProtoData.
      */
     const val pdCompatibleVersion = "2.0.0-SNAPSHOT.342"
 
-    const val group = "io.spine.validation"
-    private const val prefix = "spine-validation"
+    const val group = Spine.toolsGroup
+    private const val prefix = "validation"
 
-    const val runtimeModule = "$group:$prefix-java-runtime"
+    const val gradlePluginLib = "$group:$prefix-gradle-plugin:$version"
+
+    const val runtimeModule = "${Spine.group}:spine-$prefix-jvm-runtime"
     const val runtime = "$runtimeModule:$version"
     const val javaModule = "$group:$prefix-java"
     const val java = "$javaModule:$version"
-
     const val javaBundleModule = "$group:$prefix-java-bundle"
 
     /** Obtains the artifact for the `java-bundle` artifact of the given version. */

buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt

@@ -30,7 +30,7 @@ import com.google.common.util.concurrent.Uninterruptibles.sleepUninterruptibly
 import io.spine.gradle.Cli
 import io.spine.gradle.fs.LazyTempPath
 import java.util.concurrent.TimeUnit.MILLISECONDS
-import org.gradle.api.logging.Logger
+import org.gradle.api.Project
 
 /**
  * Interacts with a real Git repository.
@@ -47,16 +47,17 @@ import org.gradle.api.logging.Logger
  * release of resources please use the provided functionality inside a `use` block or
  * call the `close` method manually.
  *
+ * @property project The Gradle project in which context the repo operations are held.
  * @property sshUrl The GitHub SSH URL to the underlying repository.
  * @property user Current user configuration.
  *   This configuration determines what ends up in the `author` and `committer` fields of a commit.
  * @property currentBranch The currently checked-out branch.
  */
 class Repository private constructor(
+    private val project: Project,
     private val sshUrl: String,
     private var user: UserInfo,
     private var currentBranch: String,
-    private val logger: Logger
 ) : AutoCloseable {
 
     /**
@@ -75,10 +76,9 @@ class Repository private constructor(
      * Executes a command in the [location].
      */
     private fun repoExecute(vararg command: String): String {
-        if (logger.isErrorEnabled) {
-            val msg = "[Repository] Executing command: `${command.toList().joinToString(" ")}`."
-            logger.error(msg)
-        }
+        val cmd = command.toList().joinToString(" ")
+        val msg = "[Repo (${project.path})] Executing command: `$cmd`."
+        System.err.println(msg)
         return Cli(location.toFile()).execute(*command)
     }
 
@@ -159,14 +159,14 @@ class Repository private constructor(
          * @throws IllegalArgumentException if SSH URL is an empty string.
          */
         fun clone(
+            project: Project,
             sshUrl: String,
             user: UserInfo,
             branch: String = Branch.master,
-            logger: Logger
         ): Repository {
             require(sshUrl.isNotBlank()) { "SSH URL cannot be an empty string." }
 
-            val repo = Repository(sshUrl, user, branch, logger)
+            val repo = Repository(project, sshUrl, user, branch)
             repo.clone()
             repo.configureUser(user)
 
@@ -199,9 +199,9 @@ class Repository private constructor(
  */
 @Suppress("TooGenericExceptionCaught", "LongParameterList")
 private fun <T> withRetries(
-    times: Int = 3,
-    initialDelay: Long = 100,      // ms
-    maxDelay: Long = 2000,         // ms
+    times: Int = 5,
+    initialDelay: Long = 2000,      // ms
+    maxDelay: Long = 20000,         // ms
     factor: Double = 2.0,
     description: String = "",
     block: () -> T

buildSrc/src/main/kotlin/io/spine/gradle/github/pages/RepositoryExtensions.kt

@@ -30,7 +30,7 @@ import io.spine.gradle.git.Branch
 import io.spine.gradle.git.Repository
 import io.spine.gradle.git.UserInfo
 import io.spine.gradle.repo.RepoSlug
-import org.gradle.api.logging.Logger
+import org.gradle.api.Project
 
 /**
  * Clones the current project repository with the branch dedicated to publishing
@@ -47,7 +47,7 @@ import org.gradle.api.logging.Logger
  * @throws org.gradle.api.GradleException if any of the environment variables described above
  *         is not set.
  */
-internal fun Repository.Factory.forPublishingDocumentation(logger: Logger): Repository {
+internal fun Repository.Factory.forPublishingDocumentation(project: Project): Repository {
     val host = RepoSlug.fromVar().gitHost()
 
     val username = "UpdateGitHubPages Plugin"
@@ -56,5 +56,5 @@ internal fun Repository.Factory.forPublishingDocumentation(logger: Logger): Repo
 
     val branch = Branch.documentation
 
-    return clone(host, user, branch, logger)
+    return clone(project, host, user, branch)
 }