Better versions

.github/workflows/build-on-ubuntu.yml

@@ -22,8 +22,15 @@ jobs:
         shell: bash
         run: ./gradlew build --stacktrace
 
+      # See: https://github.com/marketplace/actions/junit-report-action
+      - name: Publish Test Report
+        uses: mikepenz/[email protected]
+        if: always() # always run even if the previous step fails
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'
+
       - name: Upload code coverage report
         uses: codecov/codecov-action@v2
         with:
-          fail_ci_if_error: true
+          fail_ci_if_error: false
           verbose: true

.github/workflows/build-on-windows.yml

@@ -22,3 +22,10 @@ jobs:
         shell: cmd
         # For the reason on `--no-daemon` see https://github.com/actions/cache/issues/454
         run: gradlew.bat build --stacktrace --no-daemon
+
+      # See: https://github.com/marketplace/actions/junit-report-action
+      - name: Publish Test Report
+        uses: mikepenz/[email protected]
+        if: always() # always run even if the previous step fails
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'

buildSrc/build.gradle.kts

@@ -28,17 +28,14 @@
  * This script uses two declarations of the constant [licenseReportVersion] because
  * currently there is no way to define a constant _before_ a build script of `buildSrc`.
  * We cannot use imports or do something else before the `buildscript` or `plugin` clauses.
- *
- * Therefore, when a version of [io.spine.internal.dependency.LicenseReport] changes, it should be
- * changed in the Kotlin object _and_ in this file below twice.
  */
 
 plugins {
     java
     groovy
     `kotlin-dsl`
     pmd
-    val licenseReportVersion = "2.0"
+    val licenseReportVersion = "2.1"
     id("com.github.jk1.dependency-license-report").version(licenseReportVersion)
 }
 
@@ -57,7 +54,7 @@ repositories {
 val jacksonVersion = "2.13.0"
 
 val googleAuthToolVersion = "2.1.2"
-val licenseReportVersion = "2.0"
+val licenseReportVersion = "2.1"
 val grGitVersion = "3.1.1"
 
 /**
@@ -96,6 +93,16 @@ val errorProneVersion = "2.0.2"
  */
 val protobufPluginVersion = "0.8.18"
 
+/**
+ * The version of Dokka Gradle Plugins.
+ *
+ * Please keep in sync with [io.spine.internal.dependency.Dokka.version].
+ *
+ * @see <a href="https://github.com/Kotlin/dokka/releases">
+ *     Dokka Releases</a>
+ */
+val dokkaVersion = "1.6.10"
+
 dependencies {
     implementation("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
     implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-xml:$jacksonVersion")
@@ -108,4 +115,6 @@ dependencies {
     implementation("net.ltgt.gradle:gradle-errorprone-plugin:${errorProneVersion}")
     implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")
     implementation("gradle.plugin.com.google.protobuf:protobuf-gradle-plugin:$protobufPluginVersion")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:${dokkaVersion}")
+    implementation("org.jetbrains.dokka:dokka-base:${dokkaVersion}")
 }

buildSrc/src/main/kotlin/dokka-for-java.gradle.kts

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2022, 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.
+ */
+
+import io.spine.internal.dependency.Dokka
+import java.time.LocalDate
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.DokkaBaseConfiguration
+import org.jetbrains.dokka.gradle.DokkaTask
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+dependencies {
+    /**
+     * To generate the documentation as seen from Java perspective, the kotlin-as-java plugin was
+     * added to the Dokka's classpath.
+     *
+     * @see <a href="https://github.com/Kotlin/dokka#output-formats">
+     *     Dokka output formats</a>
+     */
+    dokkaPlugin(Dokka.KotlinAsJavaPlugin.lib)
+
+    /**
+     * To exclude pieces of code annotated with `@Internal` from the documentation a custom plugin
+     * is added to the Dokka's classpath.
+     *
+     * @see <a href="https://github.com/SpineEventEngine/dokka-tools/tree/master/dokka-extensions">
+     *     Custom Dokka Plugins</a>
+     */
+    dokkaPlugin(Dokka.SpineExtensions.lib)
+}
+
+tasks.withType<DokkaTask>().configureEach {
+    dokkaSourceSets.configureEach {
+        skipEmptyPackages.set(true)
+    }
+
+    outputDirectory.set(buildDir.resolve("docs/dokka"))
+
+    val dokkaConfDir = rootDir.resolve("buildSrc/src/main/resources/dokka")
+
+    /**
+     * Dokka Base plugin allows to set a few properties to customize the output:
+     *
+     * - `customStyleSheets` property to which we can pass our css files overriding styles generated
+     * by Dokka;
+     * - `customAssets` property to provide resources. We need to provide an image with the name
+     * "logo-icon.svg" to overwrite the default one used by Dokka;
+     * - `separateInheritedMembers` when set to `true`, creates a separate tab in type-documentation
+     * for inherited members.
+     *
+     * @see <a href="https://kotlin.github.io/dokka/1.6.10/user_guide/base-specific/frontend/#prerequisites">
+     * Dokka modifying frontend assets</a>
+     */
+    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
+        customStyleSheets = listOf(file("${dokkaConfDir.resolve("styles/custom-styles.css")}"))
+        customAssets = listOf(file("${dokkaConfDir.resolve("assets/logo-icon.svg")}"))
+        separateInheritedMembers = true
+        footerMessage = "Copyright ${LocalDate.now().year}, TeamDev"
+    }
+}

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

@@ -28,6 +28,6 @@ package io.spine.internal.dependency
 
 // https://www.mojohaus.org/animal-sniffer/animal-sniffer-maven-plugin/
 object AnimalSniffer {
-    private const val version = "1.19"
+    private const val version = "1.21"
     const val lib = "org.codehaus.mojo:animal-sniffer-annotations:${version}"
 }

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

@@ -31,7 +31,8 @@ package io.spine.internal.dependency
  *
  * [AssertK](https://github.com/willowtreeapps/assertk)
  */
+@Suppress("unused")
 object AssertK {
-    private const val version = "0.23.1"
+    private const val version = "0.25"
     const val libJvm = "com.willowtreeapps.assertk:assertk-jvm:${version}"
 }

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

@@ -27,6 +27,7 @@
 package io.spine.internal.dependency
 
 // https://www.bouncycastle.org/java.html
+@Suppress("unused")
 object BouncyCastle {
     const val libPkcsJdk15 = "org.bouncycastle:bcpkix-jdk15on:1.68"
 }

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

@@ -30,5 +30,5 @@ package io.spine.internal.dependency
 // See `io.spine.internal.gradle.checkstyle.CheckStyleConfig`.
 @Suppress("unused")
 object CheckStyle {
-    const val version = "9.2"
+    const val version = "10.1"
 }

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

@@ -28,7 +28,7 @@ package io.spine.internal.dependency
 
 // https://checkerframework.org/
 object CheckerFramework {
-    private const val version = "3.21.0"
+    private const val version = "3.21.3"
     const val annotations = "org.checkerframework:checker-qual:${version}"
     @Suppress("unused")
     val dataflow = listOf(

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

@@ -33,6 +33,6 @@ package io.spine.internal.dependency
  * [Commons CLI](https://commons.apache.org/proper/commons-cli/)
  */
 object CommonsCli {
-    private const val version = "1.4"
+    private const val version = "1.5.0"
     const val lib = "commons-cli:commons-cli:${version}"
 }

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

@@ -29,6 +29,48 @@ package io.spine.internal.dependency
 // https://github.com/Kotlin/dokka
 @Suppress("unused")
 object Dokka {
-    const val version = "1.5.0"
-    const val pluginId = "org.jetbrains.dokka"
+    private const val group = "org.jetbrains.dokka"
+
+    /**
+    When changing the version, also change the version used in the `buildSrc/build.gradle.kts`.
+     */
+    const val version = "1.6.10"
+
+    object GradlePlugin {
+        const val id = "org.jetbrains.dokka"
+
+        /**
+         * The version of this plugin is already specified in `buildSrc/build.gradle.kts` file.
+         * Thus, when applying the plugin in project's build files, only the [id] should be used.
+         */
+        const val lib = "${group}:dokka-gradle-plugin:${version}"
+    }
+
+    object BasePlugin {
+        const val lib = "${group}:dokka-base:${version}"
+    }
+
+    /**
+     * To generate the documentation as seen from Java perspective use this plugin.
+     *
+     * @see <a href="https://github.com/Kotlin/dokka#output-formats">
+     *     Dokka output formats</a>
+     */
+    object KotlinAsJavaPlugin {
+        const val lib = "${group}:kotlin-as-java-plugin:${version}"
+    }
+
+    /**
+     * Custom Dokka plugins developed for Spine-specific needs like excluding by `@Internal`
+     * annotation.
+     *
+     * @see <a href="https://github.com/SpineEventEngine/dokka-tools/tree/master/dokka-extensions">
+     *     Custom Dokka Plugins</a>
+     */
+    object SpineExtensions {
+        private const val group = "io.spine.tools"
+
+        const val version = "2.0.0-SNAPSHOT.2"
+        const val lib = "${group}:spine-dokka-extensions:${version}"
+    }
 }

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

@@ -30,7 +30,7 @@ package io.spine.internal.dependency
 @Suppress("unused")
 object ErrorProne {
     // https://github.com/google/error-prone
-    private const val version = "2.10.0"
+    private const val version = "2.11.0"
     // https://github.com/tbroyer/gradle-errorprone-plugin/blob/v0.8/build.gradle.kts
     private const val javacPluginVersion = "9+181-r4173-1"
 

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

@@ -30,7 +30,7 @@ package io.spine.internal.dependency
 @Suppress("unused")
 object Grpc {
     @Suppress("MemberVisibilityCanBePrivate")
-    const val version        = "1.43.1"
+    const val version        = "1.45.0"
     const val api            = "io.grpc:grpc-api:${version}"
     const val auth           = "io.grpc:grpc-auth:${version}"
     const val core           = "io.grpc:grpc-core:${version}"

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

@@ -33,6 +33,6 @@ package io.spine.internal.dependency
  * [Gson](https://github.com/google/gson)
  */
 object Gson {
-    private const val version = "2.8.9"
+    private const val version = "2.9.0"
     const val lib = "com.google.code.gson:gson:${version}"
 }

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

@@ -35,7 +35,7 @@ package io.spine.internal.dependency
  */
 // https://github.com/google/guava
 object Guava {
-    private const val version = "31.0.1-jre"
+    private const val version = "31.1-jre"
     const val lib     = "com.google.guava:guava:${version}"
     const val testLib = "com.google.guava:guava-testlib:${version}"
 }

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

@@ -32,7 +32,7 @@ package io.spine.internal.dependency
 @Suppress("unused")
 object HttpClient {
     // https://github.com/googleapis/google-http-java-client
-    const val version  = "1.40.1"
+    const val version  = "1.41.5"
     const val google   = "com.google.http-client:google-http-client:${version}"
     const val jackson2 = "com.google.http-client:google-http-client-jackson2:${version}"
     const val gson     = "com.google.http-client:google-http-client-gson:${version}"

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

@@ -28,11 +28,12 @@ package io.spine.internal.dependency
 
 @Suppress("unused")
 object Jackson {
-    private const val version = "2.13.1"
+    private const val version = "2.13.2"
+    private const val databindVersion = "2.13.2.2"
     // https://github.com/FasterXML/jackson-core
     const val core = "com.fasterxml.jackson.core:jackson-core:${version}"
     // https://github.com/FasterXML/jackson-databind
-    const val databind = "com.fasterxml.jackson.core:jackson-databind:${version}"
+    const val databind = "com.fasterxml.jackson.core:jackson-databind:${databindVersion}"
     // https://github.com/FasterXML/jackson-dataformat-xml/releases
     const val dataformatXml = "com.fasterxml.jackson.dataformat:jackson-dataformat-xml:${version}"
     // https://github.com/FasterXML/jackson-dataformats-text/releases

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

@@ -31,7 +31,8 @@ package io.spine.internal.dependency
  *
  * [Java JWT](https://github.com/auth0/java-jwt)
  */
+@Suppress("unused")
 object JavaJwt {
-    private const val version = "3.18.1"
+    private const val version = "3.19.1"
     const val lib = "com.auth0:java-jwt:${version}"
 }