ci: Validate Maven version on publish (#1949)

* ci: Validate Gradle version on publish

* use composite build plugin to validate version

buildSrc/build.gradle.kts

@@ -1,5 +1,5 @@
 repositories {
-    jcenter()
+    mavenCentral()
 }
 
 plugins {

buildSrc/src/main/kotlin/Plugins.kt

@@ -5,6 +5,7 @@ object Plugins {
     const val MAVEN_PUBLISH = "maven-publish"
     const val NEXUS_STAGING = "io.codearte.nexus-staging"
     const val BEN_MANES_PLUGIN = "com.github.ben-manes.versions"
+    const val MAVEN_VERSION_CHECK = "maven-version-check"
     object Kotlin {
         const val PLUGIN_JVM = "jvm"
         const val PLUGIN_SERIALIZATION = "plugin.serialization"

maven_version_check/build.gradle.kts

@@ -0,0 +1,20 @@
+repositories {
+    mavenCentral()
+}
+
+plugins {
+    `kotlin-dsl`
+    `java-gradle-plugin`
+}
+
+gradlePlugin {
+    plugins.register("maven-version-check") {
+        id = "maven-version-check"
+        implementationClass = "com.github.flank.gradle.MavenVersionCheck"
+    }
+}
+
+dependencies {
+    testImplementation("junit:junit:4.13.2") // unfortunately it does not work with buildSrc Dependencies
+}
+

maven_version_check/settings.gradle.kts

@@ -0,0 +1 @@
+rootProject.name = "mavenVersionCheck"

maven_version_check/src/main/kotlin/MavenVersionCheck.kt

@@ -0,0 +1,27 @@
+package com.github.flank.gradle
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.artifacts.PublishException
+import org.gradle.api.publish.maven.tasks.PublishToMavenRepository
+import org.gradle.internal.impldep.org.jetbrains.annotations.VisibleForTesting
+import org.gradle.kotlin.dsl.withType
+
+class MavenVersionCheck : Plugin<Project> {
+    override fun apply(project: Project) {
+        project.tasks.withType<PublishToMavenRepository>().configureEach {
+            doFirst {
+                assertValidVersion(publication.version)
+            }
+        }
+    }
+
+    @VisibleForTesting
+    internal fun assertValidVersion(version: String) {
+        val validSnapshots = arrayOf("master-SNAPSHOT", "local-SNAPSHOT")
+        val versionRegex = "2\\d\\.\\d{2}\\.\\d{1,2}".toRegex()
+        if (version !in validSnapshots && !versionRegex.matches(version)) {
+            throw PublishException("Maven version is not valid!")
+        }
+    }
+}

maven_version_check/src/test/kotlin/MavenVersionCheckTest.kt

@@ -0,0 +1,40 @@
+package com.github.flank.gradle
+
+import org.junit.Assert.assertTrue
+import org.junit.Test
+
+class MavenVersionCheckTest {
+
+    @Test
+    fun `Should properly validate maven version for snapshots`() {
+        with(MavenVersionCheck()) {
+            assertValidVersion("master-SNAPSHOT")
+            assertValidVersion("local-SNAPSHOT")
+        }
+    }
+
+    @Test
+    fun `Should properly validate maven version for not snapshots`() {
+        with(MavenVersionCheck()) {
+            assertValidVersion("21.02.0")
+            assertValidVersion("22.01.1")
+            assertValidVersion("23.11.11")
+        }
+    }
+
+    @Test
+    fun `Should throw exception for not proper maven version`() {
+        with(MavenVersionCheck()) {
+            assertTrue(runCatching { assertValidVersion("master_SNAPSHOT") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("local_version") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("version") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("test") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("snapshot") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("2113") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("2020.12.21") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("21.2.1") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("v21.02.01") }.isFailure)
+            assertTrue(runCatching { assertValidVersion("19.02.1") }.isFailure)
+        }
+    }
+}

settings.gradle.kts

@@ -3,6 +3,8 @@ import org.gradle.kotlin.dsl.support.serviceOf
 
 rootProject.name = "flank"
 
+includeBuild("maven_version_check")
+
 include(
     ":test_runner",
     ":firebase_apis:test_api",

test_runner/build.gradle.kts

@@ -2,10 +2,8 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import groovy.util.Node
 import groovy.util.NodeList
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
-import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import java.io.ByteArrayOutputStream
-import java.nio.file.Paths
 
 plugins {
     application
@@ -14,6 +12,7 @@ plugins {
     id(Plugins.MAVEN_PUBLISH)
     signing
     id(Plugins.PLUGIN_SHADOW_JAR) version Versions.SHADOW
+    id(Plugins.MAVEN_VERSION_CHECK)
 }
 
 val artifactID = "flank"