Streamline configuration of a sonar plugin (#17)

Author: petertrr

gradle-modules/build.gradle.kts

@@ -27,6 +27,7 @@ dependencies {
     implementation(libs.jfrog.buildinfo.gradle) {
         exclude("ch.qos.logback", "logback-core")
     }
+    implementation(libs.shadow)
 }
 
 gradlePlugin {

gradle-modules/src/main/kotlin/org.sonarsource.cloud-native.artifactory-configuration.gradle.kts

@@ -22,8 +22,11 @@ plugins {
     id("com.jfrog.artifactory")
 }
 
-if (project.path != ":") {
-    throw GradleException("This build script must be applied to the root project only")
+if (project.path != ":" && "-plugin" !in project.path) {
+    throw GradleException(
+        "This build script configures Artifactory connection for a build of a SonarQube plugin. " +
+            "This script must be applied either to the root project or in a \"-plugin\" project."
+    )
 }
 
 // this value is present on CI

gradle-modules/src/main/kotlin/org.sonarsource.cloud-native.sonar-plugin.gradle.kts

@@ -0,0 +1,42 @@
+/*
+ * SonarSource Cloud Native Gradle Modules
+ * Copyright (C) 2024-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+plugins {
+    id("org.sonarsource.cloud-native.java-conventions")
+    id("org.sonarsource.cloud-native.code-style-conventions")
+    id("org.sonarsource.cloud-native.publishing-configuration")
+    id("com.gradleup.shadow")
+}
+
+val cleanupTask = tasks.register<Delete>("cleanupOldVersion") {
+    group = "build"
+    description = "Clean up jars of old plugin version"
+
+    delete(
+        fileTree(project.layout.buildDirectory.dir("libs")).matching {
+            include("${project.name}-*.jar")
+            exclude("${project.name}-${project.version}-*.jar")
+        }
+    )
+}
+
+artifacts {
+    archives(tasks.shadowJar)
+}
+
+tasks.shadowJar {
+    dependsOn(cleanupTask)
+}

gradle-modules/src/main/kotlin/org/sonarsource/cloudnative/gradle/BuildUtils.kt

@@ -16,6 +16,10 @@
  */
 package org.sonarsource.cloudnative.gradle
 
+import java.io.File
+import java.util.HashSet
+import java.util.jar.JarInputStream
+import org.gradle.api.GradleException
 import org.gradle.api.Project
 import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.artifacts.repositories.MavenArtifactRepository
@@ -65,3 +69,38 @@ fun Exec.callMake(arg: String) {
         commandLine("./make.sh", arg)
     }
 }
+
+fun enforceJarSize(
+    file: File,
+    minSize: Long,
+    maxSize: Long,
+) {
+    val size = file.length()
+    if (size < minSize) {
+        throw GradleException("${file.path} size ($size) too small. Min is $minSize")
+    } else if (size > maxSize) {
+        throw GradleException("${file.path} size ($size) too large. Max is $maxSize")
+    }
+}
+
+fun checkJarEntriesPathUniqueness(file: File) {
+    val allNames = HashSet<String>()
+    val duplicatedNames = HashSet<String>()
+    file.inputStream().use { input ->
+        JarInputStream(input).use { jarInput ->
+            for (jarEntry in generateSequence { jarInput.nextJarEntry }) {
+                if (!allNames.add(jarEntry.name)) {
+                    duplicatedNames.add(jarEntry.name)
+                }
+            }
+        }
+    }
+    if (duplicatedNames.isNotEmpty()) {
+        throw GradleException("Duplicated entries in the jar: '${file.path}': ${duplicatedNames.joinToString(", ")}")
+    }
+}
+
+fun Project.commitHashProvider(ref: String = "HEAD") =
+    providers.exec {
+        commandLine("git", "rev-parse", ref)
+    }.standardOutput.asText

gradle-modules/src/main/kotlin/org/sonarsource/cloudnative/gradle/CommonSettingsPlugin.kt

@@ -81,10 +81,17 @@ open class CommonSettingsPlugin
 
         private fun Settings.configureDevelocity() {
             val develocity = extensions.getByType<DevelocityConfiguration>()
+            val isCI = System.getenv("CI") != null
 
             extensions.configure<DevelocityConfiguration> {
                 server = "https://develocity.sonar.build"
                 buildScan {
+                    publishing {
+                        onlyIf {
+                            isCI
+                        }
+                    }
+
                     tag(if (System.getenv("CI").isNullOrEmpty()) "local" else "CI")
                     tag(System.getProperty("os.name"))
                     if (System.getenv("CIRRUS_BRANCH") == "master") {
@@ -105,7 +112,6 @@ open class CommonSettingsPlugin
                 }
             }
 
-            val isCI = System.getenv("CI") != null
             buildCache {
                 local {
                     isEnabled = !isCI

gradle/libs.versions.toml

@@ -4,13 +4,15 @@ blowdryer-gradle = "1.7.1"
 develocity = "3.18.2"
 jfrog-gradle = "5.2.5"
 rule-api = "2.9.0.4061"
+gradle-plugin-shadow = "8.3.5"
 
 [libraries]
 diffplug-spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version.ref = "spotless-gradle" }
 diffplug-blowdryer-setup = { module = "com.diffplug.blowdryerSetup:com.diffplug.blowdryerSetup.gradle.plugin", version.ref = "blowdryer-gradle" }
 develocity = { module = "com.gradle.develocity:com.gradle.develocity.gradle.plugin", version.ref = "develocity" }
 jfrog-buildinfo-gradle = { module = "org.jfrog.buildinfo:build-info-extractor-gradle", version.ref = "jfrog-gradle" }
 sonar-rule-api = { module = "org.sonarsource.rule-api:rule-api", version.ref = "rule-api" }
+shadow = { module = "com.gradleup.shadow:com.gradleup.shadow.gradle.plugin", version.ref = "gradle-plugin-shadow" }
 
 [plugins]
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless-gradle" }