Introduce end of analysis API (#1321)

Author: guillaume-dequenne

python-frontend/src/main/java/org/sonar/plugins/python/api/internal/EndOfAnalysis.java

@@ -0,0 +1,37 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2022 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 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  02110-1301, USA.
+ */
+package org.sonar.plugins.python.api.internal;
+
+import org.sonar.api.Beta;
+import org.sonar.plugins.python.api.caching.CacheContext;
+
+/**
+ * Common interface for providing callbacks that are triggered at the end of an analysis, after all files have been scanned.
+ * <b>Warning: keeping state between files can lead to memory leaks. Implement with care.</b>
+ */
+@Beta
+public interface EndOfAnalysis {
+
+  /**
+   * A method called when all files have been processed.
+   * @param cacheContext CacheContext that can be used to store or retrieve information in the server cache.
+   */
+  void endOfAnalysis(CacheContext cacheContext);
+}

python-frontend/src/main/java/org/sonar/plugins/python/api/internal/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2022 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 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  02110-1301, USA.
+ */
+@ParametersAreNonnullByDefault
+package org.sonar.plugins.python.api.internal;
+
+import javax.annotation.ParametersAreNonnullByDefault;
+

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonScanner.java

@@ -50,6 +50,7 @@
 import org.sonar.plugins.python.api.PythonInputFileContext;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
 import org.sonar.plugins.python.api.PythonVisitorContext;
+import org.sonar.plugins.python.api.internal.EndOfAnalysis;
 import org.sonar.plugins.python.api.tree.FileInput;
 import org.sonar.plugins.python.cpd.PythonCpdAnalyzer;
 import org.sonar.plugins.python.indexer.PythonIndexer;
@@ -154,6 +155,14 @@ public boolean scanFileWithoutParsing(InputFile inputFile) {
     return true;
   }
 
+  @Override
+  public void endOfAnalysis() {
+    checks.all().stream()
+      .filter(EndOfAnalysis.class::isInstance)
+      .map(EndOfAnalysis.class::cast)
+      .forEach(c -> c.endOfAnalysis(indexer.cacheContext()));
+  }
+
   boolean isCheckApplicable(PythonCheck pythonCheck, InputFile.Type fileType) {
     PythonCheck.CheckScope checkScope = pythonCheck.scope();
     if (checkScope == PythonCheck.CheckScope.ALL) {

sonar-python-plugin/src/main/java/org/sonar/plugins/python/Scanner.java

@@ -69,7 +69,7 @@ public void execute(List<InputFile> files, SensorContext context) {
         progressReport.nextFile();
       }
     }
-
+    endOfAnalysis();
     progressReport.stop();
     this.reportStatistics(numScannedWithoutParsing, files.size());
   }
@@ -82,6 +82,10 @@ protected boolean scanFileWithoutParsing(InputFile file) throws IOException {
     return false;
   }
 
+  protected void endOfAnalysis() {
+    // no op
+  }
+
   protected abstract void processException(Exception e, InputFile file);
 
   protected void reportStatistics(int numSkippedFiles, int numTotalFiles) {

sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonSensorTest.java

@@ -63,7 +63,9 @@
 import org.sonar.api.rule.RuleKey;
 import org.sonar.api.utils.Version;
 import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.LoggerLevel;
+import org.sonar.api.utils.log.Loggers;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
@@ -72,6 +74,8 @@
 import org.sonar.plugins.python.api.PythonInputFileContext;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.plugins.python.api.PythonVisitorContext;
+import org.sonar.plugins.python.api.caching.CacheContext;
+import org.sonar.plugins.python.api.internal.EndOfAnalysis;
 import org.sonar.plugins.python.caching.TestReadCache;
 import org.sonar.plugins.python.caching.TestWriteCache;
 import org.sonar.plugins.python.indexer.PythonIndexer;
@@ -138,7 +142,10 @@ public List<Class> checkClasses() {
     name = "name",
     description = "desc",
     tags = {"bug"})
-  public static class MyCustomRule implements PythonCheck {
+  public static class MyCustomRule implements PythonCheck, EndOfAnalysis {
+
+    private static final Logger LOG = Loggers.get(MyCustomRule.class);
+
     @RuleProperty(
       key = "customParam",
       description = "Custom parameter",
@@ -154,6 +161,11 @@ public void scanFile(PythonVisitorContext visitorContext) {
     public boolean scanWithoutParsing(PythonInputFileContext inputFile) {
       return false;
     }
+
+    @Override
+    public void endOfAnalysis(CacheContext cacheContext) {
+      LOG.trace("End of analysis called!");
+    }
   }
 
   private final File baseDir = new File("src/test/resources/org/sonar/plugins/python/sensor").getAbsoluteFile();
@@ -406,6 +418,19 @@ public void cross_files_issues_only_one_file_analyzed() {
     assertThat(flow.locations().get(1).inputComponent()).isEqualTo(modFile);
   }
 
+  @Test
+  public void end_of_analysis_called() {
+    inputFile(FILE_2);
+    activeRules = new ActiveRulesBuilder()
+      .addRule(new NewActiveRule.Builder()
+        .setRuleKey(RuleKey.of(CUSTOM_REPOSITORY_KEY, CUSTOM_RULE_KEY))
+        .build())
+      .build();
+    sensor().execute(context);
+
+    assertThat(logTester.logs(LoggerLevel.TRACE)).containsExactly("End of analysis called!");
+  }
+
   @Test
   public void no_indexer_when_project_too_large_sonarlint() {
     activeRules = new ActiveRulesBuilder()