Introduce PipelineSetup testing utility

api/src/main/kotlin/io/spine/protodata/settings/SettingsDirectory.kt

@@ -37,17 +37,22 @@ import kotlin.io.path.listDirectoryEntries
  * A directory containing settings files.
  *
  * Only the files with the [recognized extensions][Format] are considered settings files.
- * Only the files directly in the directory are considered, no subdirectories are traversed.
+ *
+ * Only the files belonging to the directory directly are considered,
+ * no subdirectories are traversed.
+ *
+ * @param path
+ *         the existing path to the settings directory.
  */
 public class SettingsDirectory(
-    private val directory: Path
+    public val path: Path
 ) {
     init {
-        require(directory.toFile().isDirectory) {
-            "The path `$directory` is not a directory."
+        require(path.toFile().isDirectory) {
+            "The path `$path` is not a directory."
         }
-        require(directory.exists()) {
-            "The directory `$directory` does not exist."
+        require(path.exists()) {
+            "The directory `$path` does not exist."
         }
     }
 
@@ -111,7 +116,7 @@ public class SettingsDirectory(
 
     private fun file(consumerId: String, format: Format): Path {
         val fileName = "${consumerId}.${format.extensions.first()}"
-        return directory.resolve(fileName)
+        return path.resolve(fileName)
     }
 
     /**
@@ -126,6 +131,6 @@ public class SettingsDirectory(
         }
 
     private fun files() =
-        directory.listDirectoryEntries()
+        path.listDirectoryEntries()
             .filter { it.isSettings() }
 }

api/src/main/proto/spine/protodata/settings.proto

@@ -70,21 +70,31 @@ extend google.protobuf.EnumValueOptions {
 
     // Possible file extensions associated with a file format.
     //
-    // Only applicable to the `ConfigurationFormat` enum.
+    // Only applicable to the `Format` enum.
     //
     repeated string extension = 73980 [(internal) = true];
 }
 
-// The format of a custom configuration for ProtoData.
+// The format of a protobuf message stored in a file.
+//
+// Configuration files for ProtoData and its plugins could be stored in one of these formats.
 //
 enum Format {
 
     RCF_UNKNOWN = 0;
 
     // A Protobuf message encoded in binary.
-    PROTO_BINARY = 1 [(extension) = "pb", (extension) = "bin"];
+    //
+    // See: https://protobuf.dev/programming-guides/techniques/#suffixes
+    // See: https://buf.build/docs/reference/inputs#binpb
+    //
+    PROTO_BINARY = 1 [(extension) = "binpb", (extension) = "pb", (extension) = "bin"];
 
     // A Protobuf message encoded in Protobuf JSON.
+    //
+    // Use this item instead of [JSON] for Protobuf messages stored in
+    // JSON format so that the correct parser is selected for the file.
+    //
     PROTO_JSON = 2 [(extension) = "pb.json"];
 
     // A plain JSON value.

api/src/test/kotlin/io/spine/protodata/settings/FormatSpec.kt

@@ -26,7 +26,8 @@
 
 package io.spine.protodata.settings
 
-import com.google.common.truth.Truth.assertThat
+import io.kotest.matchers.collections.shouldContainInOrder
+import io.kotest.matchers.shouldBe
 import io.spine.protodata.settings.Format.JSON
 import io.spine.protodata.settings.Format.PLAIN
 import io.spine.protodata.settings.Format.PROTO_BINARY
@@ -41,18 +42,22 @@ class FormatSpec {
 
     @Test
     fun `provide allowed extensions`() {
-        assertThat(RCF_UNKNOWN.extensions)
-            .isEmpty()
+        RCF_UNKNOWN.extensions shouldBe emptyList()
 
-        assertThat(JSON.extensions)
-            .containsExactly("json")
-        assertThat(PROTO_JSON.extensions)
-            .containsExactly("pb.json")
-        assertThat(PROTO_BINARY.extensions)
-            .containsExactly("pb", "bin")
-        assertThat(YAML.extensions)
-            .containsExactly("yml", "yaml")
-        assertThat(PLAIN.extensions)
-            .containsExactly("txt")
+        PROTO_BINARY.extensions.shouldContainInOrder(
+            "binpb", "pb", "bin"
+        )
+        PROTO_JSON.extensions.shouldContainInOrder(
+            "pb.json"
+        )
+        JSON.extensions.shouldContainInOrder(
+            "json"
+        )
+        YAML.extensions.shouldContainInOrder(
+            "yml", "yaml"
+        )
+        PLAIN.extensions.shouldContainInOrder(
+            "txt"
+        )
     }
 }

backend/src/main/kotlin/io/spine/protodata/backend/Pipeline.kt

@@ -80,7 +80,7 @@ public class Pipeline(
     private val request: CodeGeneratorRequest,
 
     /**
-     * The directory where setting files for this pipeline are stored.
+     * The directory to which setting files for the [plugins] should be stored.
      */
     private val settings: SettingsDirectory
 ) {

buildSrc/src/main/kotlin/BuildExtensions.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023, TeamDev. All rights reserved.
+ * Copyright 2024, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,6 +31,7 @@ import io.spine.internal.dependency.GradleDoctor
 import io.spine.internal.dependency.Kotest
 import io.spine.internal.dependency.Kover
 import io.spine.internal.dependency.ProtoData
+import io.spine.internal.dependency.ProtoTap
 import io.spine.internal.dependency.Protobuf
 import io.spine.internal.dependency.Spine
 import io.spine.internal.gradle.standardToSpineSdk
@@ -81,8 +82,9 @@ val PluginDependenciesSpec.mcJava: Spine.McJava
 /**
  * Shortcut to [ProtoData] dependency object.
  *
- * This plugin is in Gradle Portal. But when used in pair with [mcJava], it cannot be applied
- * directly to a project. It is so, because [mcJava] uses [protoData] as its dependency.
+ * This plugin is published at Gradle Portal. But when used in a pair with [mcJava],
+ * it cannot be applied directly to a project.
+ * It is so, because [mcJava] uses [protoData] as its dependency.
  * And buildscript's classpath ends up with both of them.
  */
 val PluginDependenciesSpec.protoData: ProtoData
@@ -95,8 +97,8 @@ val PluginDependenciesSpec.protoData: ProtoData
  * declared in auto-generated `org.gradle.kotlin.dsl.PluginAccessors.kt` file.
  * It conflicts with our own declarations.
  *
- * Declaring of top-level shortcuts eliminates need in applying plugins
- * using fully-qualified name of dependency objects.
+ * Declaring of top-level shortcuts eliminates the need in applying plugins
+ * using fully qualified name of dependency objects.
  *
  * It is still possible to apply a plugin with a custom version, if needed.
  * Just declare a version again on the returned [PluginDependencySpec].
@@ -117,6 +119,9 @@ val PluginDependenciesSpec.errorprone: PluginDependencySpec
 val PluginDependenciesSpec.protobuf: PluginDependencySpec
     get() = id(Protobuf.GradlePlugin.id)
 
+val PluginDependenciesSpec.prototap: PluginDependencySpec
+    get() = id(ProtoTap.gradlePluginId).version(ProtoTap.version)
+
 val PluginDependenciesSpec.`gradle-doctor`: PluginDependencySpec
     get() = id(GradleDoctor.pluginId).version(GradleDoctor.version)
 
@@ -132,9 +137,9 @@ val PluginDependenciesSpec.kover: PluginDependencySpec
  * Configures the dependencies between third-party Gradle tasks
  * and those defined via ProtoData and Spine Model Compiler.
  *
- * It is required in order to avoid warnings in build logs, detecting the undeclared
+ * It is required to avoid warnings in build logs, detecting the undeclared
  * usage of Spine-specific task output by other tasks,
- * e.g. the output of `launchProtoData` is used by `compileKotlin`.
+ * e.g., the output of `launchProtoData` is used by `compileKotlin`.
  */
 @Suppress("unused")
 fun Project.configureTaskDependencies() {

buildSrc/src/main/kotlin/DependencyResolution.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023, TeamDev. All rights reserved.
+ * Copyright 2024, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,7 +57,7 @@ import org.gradle.api.artifacts.ConfigurationContainer
 import org.gradle.api.artifacts.ResolutionStrategy
 
 /**
- * The function to be used in `buildscript` when a fully-qualified call must be made.
+ * The function to be used in `buildscript` when a fully qualified call must be made.
  */
 @Suppress("unused")
 fun doForceVersions(configurations: ConfigurationContainer) {
@@ -122,6 +122,10 @@ private fun ResolutionStrategy.forceTestDependencies() {
 private fun ResolutionStrategy.forceTransitiveDependencies() {
     force(
         Asm.lib,
+        Asm.tree,
+        Asm.analysis,
+        Asm.util,
+        Asm.commons,
         AutoValue.annotations,
         CommonsCli.lib,
         CommonsCodec.lib,

buildSrc/src/main/kotlin/io/spine/internal/dependency/Asm.kt

@@ -29,6 +29,14 @@ package io.spine.internal.dependency
 // https://asm.ow2.io/
 @Suppress("unused", "ConstPropertyName")
 object Asm {
-    private const val version = "9.2"
+    private const val version = "9.6"
     const val lib = "org.ow2.asm:asm:$version"
+
+    // We use the following artifacts only to force the versions
+    // of the dependencies which are transitive for us.
+    //
+    const val tree = "org.ow2.asm:asm-tree:$version"
+    const val analysis = "org.ow2.asm:asm-analysis:$version"
+    const val util = "org.ow2.asm:asm-util:$version"
+    const val commons = "org.ow2.asm:asm-commons:$version"
 }

buildSrc/src/main/kotlin/io/spine/internal/dependency/Caffeine.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2024, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+package io.spine.internal.dependency
+
+/**
+ * A [high performance](https://github.com/ben-manes/caffeine/wiki/Benchmarks),
+ * [near optimal](https://github.com/ben-manes/caffeine/wiki/Efficiency) caching library.
+ *
+ * This library is a transitive dependency for us via ErrorProne.
+ *
+ * @see <a href="https://github.com/ben-manes/caffeine">Caffeine at GitHub</a>
+ */
+@Suppress("unused")
+object Caffeine {
+    private const val version = "3.0.5"
+    const val lib = "com.github.ben-manes.caffeine:caffeine:$version"
+}

buildSrc/src/main/kotlin/io/spine/internal/dependency/Dokka.kt

@@ -35,7 +35,7 @@ object Dokka {
      * When changing the version, also change the version used in the
      * `buildSrc/build.gradle.kts`.
      */
-    const val version = "1.9.10"
+    const val version = "1.9.20"
 
     object GradlePlugin {
         const val id = "org.jetbrains.dokka"

buildSrc/src/main/kotlin/io/spine/internal/dependency/Jacoco.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+package io.spine.internal.dependency
+
+/**
+ * Code coverage library for Java.
+ *
+ * @see <a href="https://www.eclemma.org/jacoco/">Releases</a>
+ */
+@Suppress("ConstPropertyName")
+object Jacoco {
+    const val version = "0.8.12"
+}

buildSrc/src/main/kotlin/io/spine/internal/dependency/Kover.kt

@@ -29,7 +29,7 @@ package io.spine.internal.dependency
 // https://github.com/Kotlin/kotlinx-kover
 @Suppress("unused", "ConstPropertyName")
 object Kover {
-    const val version = "0.7.4"
+    const val version = "0.7.6"
     const val id = "org.jetbrains.kotlinx.kover"
     const val classpath = "org.jetbrains.kotlinx:kover-gradle-plugin:$version"
 }

buildSrc/src/main/kotlin/io/spine/internal/dependency/Log4j2.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2024, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+package io.spine.internal.dependency
+
+/**
+ * An open-source logging framework.
+ *
+ * Spine uses its own [logging library][Spine.Logging], but also
+ * provides a backend implementation for [Log4j2]. This is why
+ * this dependency is needed.
+ *
+ * @see <a href="https://github.com/apache/logging-log4j2">Log4j2 releases at GitHub</a>
+ */
+@Suppress("unused", "ConstPropertyName")
+object Log4j2 {
+    private const val version = "2.20.0"
+    const val core = "org.apache.logging.log4j:log4j-core:$version"
+}

buildSrc/src/main/kotlin/io/spine/internal/dependency/ProtoData.kt

@@ -65,7 +65,7 @@ object ProtoData {
      * The version of ProtoData dependencies.
      */
     val version: String
-    private const val fallbackVersion = "0.20.7"
+    private const val fallbackVersion = "0.21.5"
 
     /**
      * The distinct version of ProtoData used by other build tools.
@@ -74,7 +74,7 @@ object ProtoData {
      * transitional dependencies, this is the version used to build the project itself.
      */
     val dogfoodingVersion: String
-    private const val fallbackDfVersion = "0.20.7"
+    private const val fallbackDfVersion = "0.21.5"
 
     /**
      * The artifact for the ProtoData Gradle plugin.