SCANGRADLE-263 Declare build/sonar/ as an output directory (#395)

mark SonarTask as never up-to-date, because input are not all declared; thus gradle cannot compute correctly if the SonarTask is up to date or not

Author: erwan-serandour

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:108") || line.contains("SonarResolverTask.java:111")){
+    if(line.contains("SonarResolverTask.java:152") || line.contains("SonarResolverTask.java:155")){
       // These warnings are expected until we properly support Gradle 9
       return false;
     }

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

@@ -88,13 +88,15 @@ public void apply(Project project) {
         task.setDescription("Analyzes " + project + " and its subprojects with Sonar. This task is deprecated. Use 'sonar' instead.");
         task.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
         task.setResolverFiles(resolverFiles);
+        task.setBuildSonar(project.getLayout().getBuildDirectory().dir("sonar"));
         configureTask(task, project, actionBroadcastMap);
       });
 
       tasks.register(SonarExtension.SONAR_TASK_NAME, SonarTask.class, task -> {
         task.setDescription("Analyzes " + project + " and its subprojects with Sonar.");
         task.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
         task.setResolverFiles(resolverFiles);
+        task.setBuildSonar(project.getLayout().getBuildDirectory().dir("sonar"));
         configureTask(task, project, actionBroadcastMap);
       });
     }

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

@@ -26,17 +26,16 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
+import javax.inject.Inject;
 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;
 import org.gradle.api.tasks.TaskAction;
-import org.gradle.api.tasks.UntrackedTask;
 
 
-@UntrackedTask(because = "task must always be recomputed, as we cannot declare input output properly")
 public abstract class SonarResolverTask extends DefaultTask {
   public static final String TASK_NAME = "sonarResolver";
   public static final String TASK_DESCRIPTION = "Resolves and serializes project information and classpath for SonarQube analysis.";
@@ -51,6 +50,14 @@ public abstract class SonarResolverTask extends DefaultTask {
   private File outputDirectory;
   private Provider<Boolean> skipProject;
 
+  @Inject
+  public SonarResolverTask() {
+    super();
+    // some input are annotated with internal, thus grade cannot correctly compute if the task is up to date or not
+    this.getOutputs().upToDateWhen(task -> false);
+  }
+
+
   @Input
   public String getProjectName() {
     return projectName;

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

@@ -31,6 +31,8 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
+import javax.inject.Inject;
+import org.gradle.api.file.Directory;
 import org.gradle.api.internal.ConventionTask;
 import org.gradle.api.logging.LogLevel;
 import org.gradle.api.logging.Logger;
@@ -39,6 +41,7 @@
 import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.InputFiles;
 import org.gradle.api.tasks.Internal;
+import org.gradle.api.tasks.OutputDirectory;
 import org.gradle.api.tasks.TaskAction;
 import org.gradle.util.GradleVersion;
 import org.jetbrains.annotations.VisibleForTesting;
@@ -63,6 +66,7 @@ public class SonarTask extends ConventionTask {
   private LogOutput logOutput = new DefaultLogOutput();
 
   private Provider<Map<String, String>> properties;
+  private Provider<Directory> buildSonar;
 
   private static class DefaultLogOutput implements LogOutput {
     @Override
@@ -89,6 +93,13 @@ public void log(String formattedMessage, Level level) {
     }
   }
 
+  @Inject
+  public SonarTask(){
+    super();
+    // some input are annotated with internal, thus grade cannot correctly compute if the task is up to date or not
+    this.getOutputs().upToDateWhen(task -> false);
+  }
+
   /**
    * Logs output from the given {@link Level} at the {@link LogLevel#LIFECYCLE} log level, which is the default log
    * level for Gradle tasks. This can be used to specify the level of Sonar Scanner which it output during standard
@@ -213,6 +224,19 @@ public void setResolverFiles(List<File> resolverFiles) {
     this.resolverFiles = resolverFiles;
   }
 
+  /**
+   * @return folder containing all files generated by the analysis
+   * {@code null} values are not permitted.
+   */
+  @OutputDirectory
+  public Provider<Directory> getBuildSonar() {
+    return this.buildSonar;
+  }
+
+  public void setBuildSonar(Provider<Directory> buildSonar) {
+    this.buildSonar = buildSonar;
+  }
+
   /**
    * Finish the configuration of `sonar.java.libraries` and `sonar.java.test.libraries` by resolving the class paths that
    * were attached to the task at configuration time.

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
@@ -800,7 +800,7 @@ class FunctionalTests extends Specification {
     if (!System.getProperty("os.name").toLowerCase().contains("windows")) {
       configureJacocoGradleTestkitPlugin(multiModuleProjectDir);
     }
-    
+
 
     when:
     def result = GradleRunner.create()
@@ -818,6 +818,33 @@ class FunctionalTests extends Specification {
 
   }
 
+   def "check sonar and sonarResolver are not up to date"() {
+     given:
+     settingsFile << "rootProject.name = 'java-task-toolchains'"
+     buildFile << """
+        plugins {
+            id 'org.sonarqube'
+            id 'java'
+        }
+        """
+
+     when:
+     def command = GradleRunner.create()
+       .withProjectDir(projectDir.toFile())
+       .forwardOutput()
+       .withArguments('sonar', '-Dsonar.scanner.internal.dumpToFile=' + outFile.toAbsolutePath(), '--info')
+       .withPluginClasspath()
+
+     def run1 = command.build()
+     def run2 = command.build()
+
+     then:
+     assert run1.task(":sonar").getOutcome() == SUCCESS
+     assert run2.task(":sonar").getOutcome() == SUCCESS
+     assert run2.getOutput().contains("':sonarResolver' is not up-to-date")
+     assert run2.getOutput().contains("':sonar' is not up-to-date")
+   }
+
   private Path projectDir(String project) {
     return Path.of(this.class.getResource("/projects/"+project).toURI());
   }