Kotlin Gradle scripts. Part 2 of 2

.github/workflows/buildSrc.yml

@@ -0,0 +1,26 @@
+# Ensures that `buildSrc` directories are the same in all 3 projects:
+#  - the root project;
+#  - smoke tests;
+#  - the `base-validating-builders` project.
+
+name: Check buildSrc copies
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Check root and `smoke-tests` copies are the same.
+        shell: bash
+        run: ./script/same-dir.sh ./buildSrc ./tools/smoke-tests/buildSrc
+
+      - name: Check root and `base-validating-builders` copies are the same.
+        shell: bash
+        run: ./script/same-dir.sh ./buildSrc ./base-validating-builders/buildSrc

README.md

@@ -33,8 +33,18 @@ The repository also contains:
 
 ### Notes on Coverage
 
-Currently the coverage stats reflect the hits gathered from unit tests. However, Gradle plugins - 
+Currently, the coverage stats reflect the hits gathered from unit tests. However, Gradle plugins - 
 a significant part of this repository - are covered with integration tests. During each of those, a 
 standalone Gradle process is launched. The limitations of `jacoco` task API do not allow to include 
 the coverage of such tests into the repository coverage report easily. Therefore, current coverage 
 percentage shown is significantly lower than a real one.
+
+### `pull` scripts
+
+In most Spine repositories, we update the `config` submodule by running `./config/pull` (or its
+Batch equivalent). However, in `base` we also need to copy Gradle `buildSrc` directory into included
+builds: `smoke-tests` and `base-validating-builders`. Thus, here we have `./pull` and `.\pull.bat`
+scripts which do whatever their `config` counterparts do and also copy `buildSrc` into the two
+included build directories.
+
+It is always recommended to run `./pull` instead of `./config/pull`.

base-validating-builders/build.gradle.kts

@@ -0,0 +1,170 @@
+/*
+ * Copyright 2020, TeamDev. All rights reserved.
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import com.google.protobuf.gradle.ProtobufConfigurator.JavaGenerateProtoTaskCollection
+import com.google.protobuf.gradle.*
+import io.spine.gradle.internal.Deps
+import org.gradle.internal.os.OperatingSystem
+
+buildscript {
+    apply(from = "$projectDir/../version.gradle.kts")
+    val spineVersion: String by extra
+
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+
+    @Suppress("RemoveRedundantQualifierName") // Cannot use imports here.
+    val deps = io.spine.gradle.internal.Deps
+
+    dependencies {
+        deps.build.protobuf.forEach { classpath(it) }
+        classpath(deps.build.guava)
+        classpath(deps.build.flogger)
+        classpath(deps.build.checkerAnnotations)
+        deps.build.errorProneAnnotations.forEach { classpath(it) }
+        classpath(deps.build.jsr305Annotations)
+        classpath(deps.build.gradlePlugins.protobuf)
+
+        classpath(deps.gen.javaPoet)
+        classpath(deps.runtime.flogger.systemBackend)
+
+        // A library for parsing Java sources.
+        // Used for parsing Java sources generated from Protobuf files
+        // to make their annotation more convenient.
+        classpath(deps.build.roasterApi) {
+            exclude(group = "com.google.guava")
+        }
+        classpath (deps.build.roasterJdt) {
+            exclude(group = "com.google.guava")
+        }
+
+        classpath(files(
+                "$projectDir/../tools/protoc-api/build/libs/protoc-api-${spineVersion}.jar",
+                "$projectDir/../tools/model-compiler/build/libs/model-compiler-${spineVersion}.jar",
+                "$projectDir/../tools/plugin-base/build/libs/plugin-base-${spineVersion}.jar",
+                "$projectDir/../tools/tool-base/build/libs/tool-base-${spineVersion}.jar",
+                "$projectDir/../base/build/libs/base-${spineVersion}.jar"
+        ))
+    }
+}
+
+plugins {
+    java
+    idea
+    @Suppress("RemoveRedundantQualifierName") // Cannot use imports here.
+    id("com.google.protobuf").version(io.spine.gradle.internal.Deps.versions.protobufPlugin)
+}
+
+apply(plugin = "io.spine.tools.spine-model-compiler")
+
+extensions["modelCompiler"].withGroovyBuilder {
+    setProperty("generateValidation", true)
+}
+
+repositories {
+    // This defines the `libs` directory of upstream projects as a local repository.
+    // See `dependencies` section below for definition of the dependency on the JAR produced by
+    // the `base` module.
+    flatDir {
+        val baseRoot = "$projectDir/.."
+        dir("$baseRoot/base/build/libs/")
+    }
+    mavenLocal()
+    jcenter()
+}
+
+val spineVersion: String by extra
+
+dependencies {
+    Deps.build.protobuf.forEach { compileOnly(it) }
+    compileOnly(Deps.build.guava)
+    compileOnly(Deps.build.flogger)
+    compileOnly(Deps.build.checkerAnnotations)
+    Deps.build.errorProneAnnotations.forEach { compileOnly(it) }
+    compileOnly(Deps.build.jsr305Annotations)
+
+    // The below dependency refers to a local artifact.
+    // See `repositories.flatDir` definition above.
+    compileOnly(name = "base-${spineVersion}", group = "")
+}
+
+sourceSets {
+    main {
+        java.srcDirs("$projectDir/generated/main/spine")
+        proto.srcDirs("$projectDir/../base/src/main/proto")
+    }
+}
+
+protobuf {
+    generateProtoTasks {
+        all().forEach { task ->
+            task.plugins {
+                remove("grpc")
+            }
+        }
+    }
+}
+
+val compiledProtoDir = "$projectDir/compiled-proto"
+
+val copyCompiledClasses by tasks.registering(Copy::class) {
+    from(sourceSets.main.get().java.outputDir)
+    into(compiledProtoDir)
+
+    include {
+        it.isDirectory || it.name.endsWith(".class")
+    }
+
+    dependsOn(tasks.compileJava)
+}
+
+tasks.assemble {
+    dependsOn(copyCompiledClasses)
+}
+
+tasks.build {
+    doLast {
+        val directory = "$projectDir/../"
+        val os = OperatingSystem.current()
+        val script = when {
+            os.isWindows -> "gradlew.bat"
+            else -> "gradlew"
+        }
+        val process = ProcessBuilder()
+                .command("$directory/$script", ":base:cleanJar", ":base:jar", "--console=plain")
+                .directory(file(directory))
+                .start()
+        if (process.waitFor() != 0) {
+            throw GradleException("Unable to rebuild JAR for :base.")
+        }
+    }
+}
+
+val cleanGenerated by tasks.registering(Delete::class) {
+    delete(files("$projectDir/generated", "$projectDir/.spine", compiledProtoDir))
+}
+
+tasks.clean { dependsOn(cleanGenerated) }
+
+idea.module {
+    generatedSourceDirs.add(file(compiledProtoDir))
+}