Merge branch 'master' into romain/317-libraries

Author: romainbrenguier

build.gradle.kts

@@ -81,6 +81,7 @@ dependencies {
     testImplementation(localGroovy())
     testImplementation("org.assertj:assertj-core:3.26.0")
     testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-params:5.10.2")
     testImplementation("org.hamcrest:hamcrest-all:1.3")
     testImplementation("org.mockito:mockito-core:5.12.0")
     testImplementation("org.spockframework:spock-core:2.3-groovy-3.0") {
@@ -108,6 +109,7 @@ license {
     mapping("java", "SLASHSTAR_STYLE")
     strictCheck = true
     exclude("**/*-version.txt")
+    exclude("**/projects/*")
 }
 
 jacoco {

gradle/verification-metadata.xml

@@ -2633,6 +2633,11 @@
             <sha256 value="abe72c8fbf9a9c8f9ee79bac29ba6479d32b0dffaab88080a502911d24d39463" origin="Verified"/>
          </artifact>
       </component>
+      <component group="org.junit.jupiter" name="junit-jupiter-params" version="5.10.2">
+         <artifact name="junit-jupiter-params-5.10.2.jar">
+            <sha256 value="edb1e43ff0b8067626ffb55e5e9eeca1d9ab2478141a7c7f253d115b29cc7cf2" origin="Verified"/>
+         </artifact>
+      </component>
       <component group="org.junit.platform" name="junit-platform-commons" version="1.10.2">
          <artifact name="junit-platform-commons-1.10.2.jar">
             <sha256 value="b56a5ec000a479df4973b18bba24c98fe0db8faa14c8907d3ef451d8c71fd8ae" origin="Verified"/>

integrationTests/src/test/java/org/sonarqube/gradle/AbstractGradleIT.java

@@ -345,7 +345,7 @@ static void assertThatPluginDoesNotCreateGradleDeprecationWarnings(String text)
   }
 
   static boolean isUnexpectedWarning(String line){
-    if(line.contains("SonarResolverTask.java:128") || line.contains("SonarResolverTask.java:131")){
+    if(line.contains("SonarResolverTask.java:143") || line.contains("SonarResolverTask.java:146")){
       // These warnings are expected until we properly support Gradle 9
       return false;
     }

src/main/java/org/sonarqube/gradle/ResolutionSerializer.java

@@ -21,13 +21,16 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import java.nio.file.Files;
+import java.util.Optional;
+import org.gradle.api.logging.Logger;
+import org.gradle.api.logging.Logging;
+
 import java.io.File;
 import java.io.FileReader;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
-import org.gradle.api.logging.Logger;
-import org.gradle.api.logging.Logging;
 
 public class ResolutionSerializer {
 
@@ -38,24 +41,36 @@ private ResolutionSerializer() {
     /* No instantiation expected */
   }
 
-  public static ProjectProperties read(File input) throws IOException {
+  public static Optional<ProjectProperties> read(File input) throws IOException {
+    if (!input.exists()) {
+      return Optional.empty();
+    }
+
     try (FileReader reader = new FileReader(input, StandardCharsets.UTF_8)) {
       ProjectProperties projectProperties = GSON.fromJson(reader, ProjectProperties.class);
       if (LOGGER.isDebugEnabled()) {
         LOGGER.debug("Read project properties from file: {}", input.getAbsolutePath());
       }
-      return projectProperties;
+      return Optional.of(projectProperties);
     }
   }
 
-  public static File write(File output, ProjectProperties properties) throws IOException {
+  public static void write(File output, ProjectProperties properties) throws IOException {
+    if (properties.compileClasspath.isEmpty()
+      && properties.testCompileClasspath.isEmpty()
+      && properties.mainLibraries.isEmpty()
+      && properties.testLibraries.isEmpty()) {
+      // make sure we do not reuse output from previous execution
+      Files.deleteIfExists(output.toPath());
+      return;
+    }
+
     try (FileWriter writer = new FileWriter(output, StandardCharsets.UTF_8)) {
       GSON.toJson(properties, writer);
       if (LOGGER.isDebugEnabled()) {
         LOGGER.debug("Wrote project properties to file: {}", output.getAbsolutePath());
       }
     }
-    return output;
   }
 
 }

src/main/java/org/sonarqube/gradle/SonarExtension.java

@@ -58,7 +58,7 @@ public class SonarExtension {
   public static final String SONAR_TASK_NAME = "sonar";
   public static final String SONAR_DEPRECATED_TASK_NAME = "sonarqube";
 
-  private boolean skipProject;
+  private boolean skipProject = false;
   private final ActionBroadcast<SonarProperties> propertiesActions;
   private String androidVariant;
 

src/main/java/org/sonarqube/gradle/SonarQubePlugin.java

@@ -109,7 +109,10 @@ private static List<File> registerAndConfigureResolverTasks(Project topLevelProj
     List<File> resolverFiles = new ArrayList<>();
     topLevelProject.getAllprojects().forEach(target ->
       target.getTasks().register(SonarResolverTask.TASK_NAME, getCompatibleTaskType(GradleVersion.current()), task -> {
+        Provider<Boolean> skipProject = target.provider(() -> isSkipped(target));
+
         task.setDescription(SonarResolverTask.TASK_DESCRIPTION);
+        task.setSkipProject(skipProject);
         task.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
         if (target == topLevelProject) {
           task.setTopLevelProject(true);

src/main/java/org/sonarqube/gradle/SonarResolverTask.java

@@ -28,6 +28,7 @@
 import java.util.stream.Collectors;
 import org.gradle.api.DefaultTask;
 import org.gradle.api.file.FileCollection;
+import org.gradle.api.provider.Provider;
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.Internal;
 import org.gradle.api.tasks.OutputFile;
@@ -48,6 +49,7 @@ public abstract class SonarResolverTask extends DefaultTask {
   private FileCollection mainLibraries;
   private FileCollection testLibraries;
   private File outputDirectory;
+  private Provider<Boolean> skipProject;
 
   @Input
   public String getProjectName() {
@@ -115,8 +117,21 @@ public File getOutputFile() {
     return new File(outputDirectory, "properties");
   }
 
+  @Input
+  public Provider<Boolean> getSkipProject() {
+    return skipProject;
+  }
+
+  public void setSkipProject(Provider<Boolean> skipProject) {
+    this.skipProject = skipProject;
+  }
+
   @TaskAction
   void run() throws IOException {
+    if(Boolean.TRUE.equals(this.skipProject.get())){
+      return;
+    }
+
     String displayName = getProjectName();
     if (LOGGER.isLoggable(Level.INFO)) {
       LOGGER.info("Resolving properties for " + displayName + ".");

src/main/java/org/sonarqube/gradle/SonarTask.java

@@ -41,6 +41,7 @@
 import org.gradle.api.tasks.Internal;
 import org.gradle.api.tasks.TaskAction;
 import org.gradle.util.GradleVersion;
+import org.jetbrains.annotations.VisibleForTesting;
 import org.sonarsource.scanner.lib.ScannerEngineBootstrapResult;
 import org.sonarsource.scanner.lib.ScannerEngineBootstrapper;
 import org.sonarsource.scanner.lib.ScannerEngineFacade;
@@ -242,10 +243,15 @@ Map<String, String> resolveJavaLibraries(Map<String, String> properties) {
    * Reads class path information produced as output of {@link SonarResolverTask}, regenerates related
    * sonar.java.libraries and sonar.java.test.libraries and stores them into the result map.
    */
-  private static void processResolverFile(File resolverFile, Map<String, String> result) {
+  @VisibleForTesting
+  static void processResolverFile(File resolverFile, Map<String, String> result) {
     LOGGER.info("Looking at file: {}", resolverFile);
     try {
-      ProjectProperties resolvedProperties = ResolutionSerializer.read(resolverFile);
+      var prop = ResolutionSerializer.read(resolverFile);
+      if(prop.isEmpty()){
+        return;
+      }
+      ProjectProperties resolvedProperties = prop.get();
       List<File> libraries = resolvedProperties.compileClasspath.stream().map(File::new).collect(Collectors.toList());
 
       // Add mainLibraries if present (for Android projects)

src/test/groovy/org/sonarqube/gradle/FunctionalTests.groovy

@@ -186,7 +186,7 @@ class FunctionalTests extends Specification {
             id 'java'
             id 'org.sonarqube'
         }
-        
+
         compileJava {
           options.compilerArgs.addAll(['--release', '10'])
         }
@@ -334,7 +334,7 @@ class FunctionalTests extends Specification {
             id 'java'
             id 'org.sonarqube'
         }
-        
+
         compileJava {
           options.release = 8
         }
@@ -369,7 +369,7 @@ class FunctionalTests extends Specification {
             id 'java'
             id 'org.sonarqube'
         }
-        
+
         compileJava {
           options.compilerArgs.addAll("--enable-preview")
         }
@@ -431,7 +431,7 @@ class FunctionalTests extends Specification {
             id 'java'
             id 'org.sonarqube'
         }
-        
+
         compileJava {
           options.compilerArgs = [
             file("/")
@@ -545,7 +545,7 @@ class FunctionalTests extends Specification {
             id 'java'
             id 'org.sonarqube'
         }
-        
+
         sonar {
             properties {
                 $sonarSourcesProperty
@@ -791,7 +791,35 @@ class FunctionalTests extends Specification {
         then:
         assert result.task(":clean").getOutcome() == SUCCESS
         assert result.task(":sonar").getOutcome() == SUCCESS
-        assert projectDir.resolve("build").resolve("sonar-resolver").resolve("properties").toFile().exists()
     }
+
+  def "multi module gradle project"() {
+    given:
+    def multiModuleProjectDir = projectDir("gradle-multimodule")
+    // skip jacoco execution due to lock conflict on "build/jacoco/test.exec" when executing on windows
+    if (!System.getProperty("os.name").toLowerCase().contains("windows")) {
+      configureJacocoGradleTestkitPlugin(multiModuleProjectDir);
+    }
+    
+
+    when:
+    def result = GradleRunner.create()
+      .withProjectDir(multiModuleProjectDir.toFile())
+      .withGradleVersion(gradleVersion)
+      .forwardOutput()
+      .withArguments('clean', 'build', 'sonar',  '-Dsonar.scanner.internal.dumpToFile=' + outFile.toAbsolutePath())
+      .withPluginClasspath()
+      .build()
+
+    then:
+    def sonarResolver = multiModuleProjectDir.resolve("module-1/build/sonar-resolver")
+    assert result.task(":sonar").getOutcome() == SUCCESS
+    assert Files.list(sonarResolver).count() == 0
+
+  }
+
+  private Path projectDir(String project) {
+    return Path.of(this.class.getResource("/projects/"+project).toURI());
+  }
 }
 

src/test/java/org/sonarqube/gradle/ResolutionSerializerTest.java

@@ -0,0 +1,85 @@
+/*
+ * SonarQube Scanner for Gradle
+ * Copyright (C) 2015-2025 SonarSource
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonarqube.gradle;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Stream;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ResolutionSerializerTest {
+
+  private static final String TEST_PROJECT_NAME = "testProject";
+
+  @TempDir
+  Path tempDir;
+
+  @ParameterizedTest
+  @MethodSource(value="provideProperties")
+  void testWriteReadWithProperties(List<String> compileClasspath, List<String> testCompileClasspath, List<String> mainLibraries, List<String> testLibraries) throws IOException {
+    File file = tempDir.resolve("test.json").toFile();
+    ProjectProperties properties = new ProjectProperties(TEST_PROJECT_NAME, true, compileClasspath, testCompileClasspath, mainLibraries, testLibraries);
+
+    ResolutionSerializer.write(file, properties);
+    Optional<ProjectProperties> readProperties = ResolutionSerializer.read(file);
+
+    assertThat(readProperties).isPresent();
+    assertThat(readProperties.get().projectName).isEqualTo(TEST_PROJECT_NAME);
+    assertThat(readProperties.get().isRootProject).isTrue();
+    assertThat(readProperties.get().compileClasspath).isEqualTo(compileClasspath);
+    assertThat(readProperties.get().testCompileClasspath).isEqualTo(testCompileClasspath);
+    assertThat(readProperties.get().mainLibraries).isEqualTo(mainLibraries);
+    assertThat(readProperties.get().testLibraries).isEqualTo(testLibraries);
+  }
+
+  static Stream<Arguments> provideProperties() {
+    List<String> nonEmpty = Arrays.asList("path1.jar", "path2.jar");
+    List<String> empty = Collections.emptyList();
+    return Stream.of(
+      Arguments.of(nonEmpty, empty, empty, empty),
+      Arguments.of(nonEmpty, nonEmpty, empty, empty),
+      Arguments.of(nonEmpty, nonEmpty, nonEmpty, empty),
+      Arguments.of(nonEmpty, nonEmpty, nonEmpty, nonEmpty)
+    );
+  }
+
+  @Test
+  void testWriteReadWithoutProperties() throws IOException {
+    File file = tempDir.resolve("test.json").toFile();
+    List<String> emptyList = Collections.emptyList();
+    ProjectProperties properties = new ProjectProperties(TEST_PROJECT_NAME, false, emptyList, emptyList, emptyList,emptyList);
+
+    ResolutionSerializer.write(file, properties);
+    Optional<ProjectProperties> readProperties = ResolutionSerializer.read(file);
+
+    assertThat(readProperties).isEmpty();
+  }
+}