SONARPY-1988: Create an interface to wrap InputFile (#1855)

Author: joke1196

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

@@ -62,7 +62,7 @@ public void describe(SensorDescriptor descriptor) {
 
   @Override
   public void execute(SensorContext context) {
-    List<InputFile> pythonFiles = getInputFiles(context);
+    List<PythonInputFile> pythonFiles = getInputFiles(context);
     var pythonVersions = context.config().getStringArray(PYTHON_VERSION_KEY);
     if (pythonVersions.length != 0) {
       ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.fromStringArray(pythonVersions));
@@ -71,11 +71,11 @@ public void execute(SensorContext context) {
     scanner.execute(pythonFiles, context);
   }
 
-  private static List<InputFile> getInputFiles(SensorContext context) {
+  private static List<PythonInputFile> getInputFiles(SensorContext context) {
     FilePredicates p = context.fileSystem().predicates();
     Iterable<InputFile> it = context.fileSystem().inputFiles(p.and(p.hasLanguage(IPynb.KEY)));
-    List<InputFile> list = new ArrayList<>();
-    it.forEach(list::add);
+    List<PythonInputFile> list = new ArrayList<>();
+    it.forEach(f -> list.add(new PythonInputFileImpl(f)));
     return Collections.unmodifiableList(list);
   }
 }

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

@@ -23,7 +23,6 @@
 import java.util.HashSet;
 import java.util.Set;
 import javax.annotation.Nullable;
-import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.batch.sensor.highlighting.NewHighlighting;
 import org.sonar.api.batch.sensor.highlighting.TypeOfText;
@@ -93,10 +92,10 @@ public class PythonHighlighter extends PythonSubscriptionCheck {
 
   private Set<Token> docStringTokens;
 
-  public PythonHighlighter(SensorContext context, InputFile inputFile) {
+  public PythonHighlighter(SensorContext context, PythonInputFile inputFile) {
     docStringTokens = new HashSet<>();
     newHighlighting = context.newHighlighting();
-    newHighlighting.onFile(inputFile);
+    newHighlighting.onFile(inputFile.wrappedFile());
   }
 
   @Override

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

@@ -0,0 +1,28 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 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;
+
+import org.sonar.api.batch.fs.InputFile;
+
+public interface PythonInputFile {
+
+  InputFile wrappedFile();
+
+}

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

@@ -0,0 +1,51 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 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;
+
+import org.sonar.api.batch.fs.InputFile;
+
+public class PythonInputFileImpl implements PythonInputFile {
+  InputFile wrappedFile;
+
+  public PythonInputFileImpl(InputFile wrappedFile) {
+    this.wrappedFile = wrappedFile;
+  }
+
+  public InputFile wrappedFile() {
+    return this.wrappedFile;
+  }
+
+  @Override
+  public String toString() {
+    return wrappedFile.toString();
+  }
+
+
+  @Override
+  public boolean equals(Object obj) {
+    return wrappedFile.equals(obj);
+  }
+
+
+  @Override
+  public int hashCode() {
+    return wrappedFile.hashCode();
+  }
+}

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

@@ -77,7 +77,7 @@ public class PythonScanner extends Scanner {
   private final NoSonarFilter noSonarFilter;
   private final PythonCpdAnalyzer cpdAnalyzer;
   private final PythonIndexer indexer;
-  private final Map<InputFile, Set<PythonCheck>> checksExecutedWithoutParsingByFiles = new HashMap<>();
+  private final Map<PythonInputFile, Set<PythonCheck>> checksExecutedWithoutParsingByFiles = new HashMap<>();
 
   public PythonScanner(
     SensorContext context, PythonChecks checks,
@@ -98,10 +98,10 @@ protected String name() {
   }
 
   @Override
-  protected void scanFile(InputFile inputFile) {
-    PythonFile pythonFile = SonarQubePythonFile.create(inputFile);
+  protected void scanFile(PythonInputFile inputFile) {
+    PythonFile pythonFile = SonarQubePythonFile.create(inputFile.wrappedFile());
     PythonVisitorContext visitorContext;
-    InputFile.Type fileType = inputFile.type();
+    InputFile.Type fileType = inputFile.wrappedFile().type();
     try {
       AstNode astNode = parser.parse(pythonFile.content());
       PythonTreeMaker treeMaker = getTreeMaker(inputFile);
@@ -122,8 +122,8 @@ protected void scanFile(InputFile inputFile) {
       LOG.error("Unable to parse file: " + inputFile);
       LOG.error(e.getMessage());
       context.newAnalysisError()
-        .onFile(inputFile)
-        .at(inputFile.newPointer(e.getLine(), 0))
+        .onFile(inputFile.wrappedFile())
+        .at(inputFile.wrappedFile().newPointer(e.getLine(), 0))
         .message(e.getMessage())
         .save();
     }
@@ -143,18 +143,18 @@ protected void scanFile(InputFile inputFile) {
     saveIssues(inputFile, visitorContext.getIssues());
 
     if (visitorContext.rootTree() != null && !isInSonarLint(context)) {
-      new SymbolVisitor(context.newSymbolTable().onFile(inputFile)).visitFileInput(visitorContext.rootTree());
+      new SymbolVisitor(context.newSymbolTable().onFile(inputFile.wrappedFile())).visitFileInput(visitorContext.rootTree());
       new PythonHighlighter(context, inputFile).scanFile(visitorContext);
     }
   }
 
-  private static PythonTreeMaker getTreeMaker(InputFile inputFile) {
-    return Python.KEY.equals(inputFile.language()) ? new PythonTreeMaker() : new IPythonTreeMaker();
+  private static PythonTreeMaker getTreeMaker(PythonInputFile inputFile) {
+    return Python.KEY.equals(inputFile.wrappedFile().language()) ? new PythonTreeMaker() : new IPythonTreeMaker();
   }
 
   @Override
-  public boolean scanFileWithoutParsing(InputFile inputFile) {
-    InputFile.Type fileType = inputFile.type();
+  public boolean scanFileWithoutParsing(PythonInputFile inputFile) {
+    InputFile.Type fileType = inputFile.wrappedFile().type();
     boolean result = true;
     for (PythonCheck check : checks.all()) {
       if (!isCheckApplicable(check, fileType)) {
@@ -166,7 +166,7 @@ public boolean scanFileWithoutParsing(InputFile inputFile) {
         result = false;
         continue;
       }
-      PythonFile pythonFile = SonarQubePythonFile.create(inputFile);
+      PythonFile pythonFile = SonarQubePythonFile.create(inputFile.wrappedFile());
       PythonInputFileContext inputFileContext = new PythonInputFileContext(pythonFile, context.fileSystem().workDir(), indexer.cacheContext(), context.runtime().getProduct());
       if (check.scanWithoutParsing(inputFileContext)) {
         Set<PythonCheck> executedChecks = checksExecutedWithoutParsingByFiles.getOrDefault(inputFile, new HashSet<>());
@@ -184,7 +184,7 @@ public boolean scanFileWithoutParsing(InputFile inputFile) {
     return restoreAndPushMeasuresIfApplicable(inputFile);
   }
 
-  private boolean checkRequiresParsingOfImpactedFile(InputFile inputFile, PythonCheck check) {
+  private boolean checkRequiresParsingOfImpactedFile(PythonInputFile inputFile, PythonCheck check) {
     return !indexer.canBeFullyScannedWithoutParsing(inputFile) && !check.getClass().getPackageName().startsWith("org.sonar.python.checks");
   }
 
@@ -214,12 +214,12 @@ private static boolean isInSonarLint(SensorContext context) {
   }
 
   @Override
-  protected void processException(Exception e, InputFile file) {
+  protected void processException(Exception e, PythonInputFile file) {
     LOG.warn("Unable to analyze file: " + file, e);
   }
 
   @Override
-  public boolean canBeScannedWithoutParsing(InputFile inputFile) {
+  public boolean canBeScannedWithoutParsing(PythonInputFile inputFile) {
     return this.indexer.canBePartiallyScannedWithoutParsing(inputFile);
   }
 
@@ -229,7 +229,7 @@ protected void reportStatistics(int numSkippedFiles, int numTotalFiles) {
       numSkippedFiles, numTotalFiles);
   }
 
-  private void saveIssues(InputFile inputFile, List<PreciseIssue> issues) {
+  private void saveIssues(PythonInputFile inputFile, List<PreciseIssue> issues) {
     for (PreciseIssue preciseIssue : issues) {
       RuleKey ruleKey = checks.ruleKey(preciseIssue.check());
       NewIssue newIssue = context
@@ -251,7 +251,7 @@ private void saveIssues(InputFile inputFile, List<PreciseIssue> issues) {
         if (fileId != null) {
           InputFile issueLocationFile = component(fileId, context);
           if (issueLocationFile != null) {
-            secondaryLocationsFlow.addFirst(newLocation(issueLocationFile, newIssue, secondaryLocation));
+            secondaryLocationsFlow.addFirst(newLocation(new PythonInputFileImpl(issueLocationFile), newIssue, secondaryLocation));
           }
         } else {
           newIssue.addLocation(newLocation(inputFile, newIssue, secondaryLocation));
@@ -264,7 +264,7 @@ private void saveIssues(InputFile inputFile, List<PreciseIssue> issues) {
         newIssue.addFlow(secondaryLocationsFlow);
       }
 
-      handleQuickFixes(inputFile, ruleKey, newIssue, preciseIssue);
+      handleQuickFixes(inputFile.wrappedFile(), ruleKey, newIssue, preciseIssue);
 
       newIssue.save();
     }
@@ -280,15 +280,15 @@ private InputFile component(String fileId, SensorContext sensorContext) {
     return inputFile;
   }
 
-  private static NewIssueLocation newLocation(InputFile inputFile, NewIssue issue, IssueLocation location) {
+  private static NewIssueLocation newLocation(PythonInputFile inputFile, NewIssue issue, IssueLocation location) {
     NewIssueLocation newLocation = issue.newLocation()
-      .on(inputFile);
+      .on(inputFile.wrappedFile());
     if (location.startLine() != IssueLocation.UNDEFINED_LINE) {
       TextRange range;
       if (location.startLineOffset() == IssueLocation.UNDEFINED_OFFSET) {
-        range = inputFile.selectLine(location.startLine());
+        range = inputFile.wrappedFile().selectLine(location.startLine());
       } else {
-        range = inputFile.newRange(location.startLine(), location.startLineOffset(), location.endLine(), location.endLineOffset());
+        range = inputFile.wrappedFile().newRange(location.startLine(), location.startLineOffset(), location.endLine(), location.endLineOffset());
       }
       newLocation.at(range);
     }
@@ -300,14 +300,14 @@ private static NewIssueLocation newLocation(InputFile inputFile, NewIssue issue,
     return newLocation;
   }
 
-  private void saveMeasures(InputFile inputFile, PythonVisitorContext visitorContext) {
+  private void saveMeasures(PythonInputFile inputFile, PythonVisitorContext visitorContext) {
     FileMetrics fileMetrics = new FileMetrics(visitorContext);
     FileLinesVisitor fileLinesVisitor = fileMetrics.fileLinesVisitor();
 
-    noSonarFilter.noSonarInFile(inputFile, fileLinesVisitor.getLinesWithNoSonar());
+    noSonarFilter.noSonarInFile(inputFile.wrappedFile(), fileLinesVisitor.getLinesWithNoSonar());
 
     if (!isInSonarLint(context)) {
-      cpdAnalyzer.pushCpdTokens(inputFile, visitorContext);
+      cpdAnalyzer.pushCpdTokens(inputFile.wrappedFile(), visitorContext);
 
       Set<Integer> linesOfCode = fileLinesVisitor.getLinesOfCode();
       saveMetricOnFile(inputFile, CoreMetrics.NCLOC, linesOfCode.size());
@@ -318,7 +318,7 @@ private void saveMeasures(InputFile inputFile, PythonVisitorContext visitorConte
       saveMetricOnFile(inputFile, CoreMetrics.COGNITIVE_COMPLEXITY, fileMetrics.cognitiveComplexity());
       saveMetricOnFile(inputFile, CoreMetrics.COMMENT_LINES, fileLinesVisitor.getCommentLineCount());
 
-      FileLinesContext fileLinesContext = fileLinesContextFactory.createFor(inputFile);
+      FileLinesContext fileLinesContext = fileLinesContextFactory.createFor(inputFile.wrappedFile());
       for (int line : linesOfCode) {
         fileLinesContext.setIntValue(CoreMetrics.NCLOC_DATA_KEY, line, 1);
       }
@@ -329,19 +329,19 @@ private void saveMeasures(InputFile inputFile, PythonVisitorContext visitorConte
     }
   }
 
-  private boolean restoreAndPushMeasuresIfApplicable(InputFile inputFile) {
-    if (inputFile.type() == InputFile.Type.TEST) {
+  private boolean restoreAndPushMeasuresIfApplicable(PythonInputFile inputFile) {
+    if (inputFile.wrappedFile().type() == InputFile.Type.TEST) {
       return true;
     }
 
-    return cpdAnalyzer.pushCachedCpdTokens(inputFile, indexer.cacheContext());
+    return cpdAnalyzer.pushCachedCpdTokens(inputFile.wrappedFile(), indexer.cacheContext());
   }
 
-  private void saveMetricOnFile(InputFile inputFile, Metric<Integer> metric, Integer value) {
+  private void saveMetricOnFile(PythonInputFile inputFile, Metric<Integer> metric, Integer value) {
     context.<Integer>newMeasure()
       .withValue(value)
       .forMetric(metric)
-      .on(inputFile)
+      .on(inputFile.wrappedFile())
       .save();
   }
 

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

@@ -115,7 +115,7 @@ public void describe(SensorDescriptor descriptor) {
   @Override
   public void execute(SensorContext context) {
     PerformanceMeasure.Duration durationReport = createPerformanceMeasureReport(context);
-    List<InputFile> pythonFiles = getInputFiles(context);
+    List<PythonInputFile> pythonFiles = getInputFiles(context);
     String[] pythonVersionParameter = context.config().getStringArray(PYTHON_VERSION_KEY);
     if (pythonVersionParameter.length == 0 && context.runtime().getProduct() != SonarProduct.SONARLINT) {
       LOG.warn(UNSET_VERSION_WARNING);
@@ -133,11 +133,11 @@ public void execute(SensorContext context) {
     durationReport.stop();
   }
 
-  private static List<InputFile> getInputFiles(SensorContext context) {
+  private static List<PythonInputFile> getInputFiles(SensorContext context) {
     FilePredicates p = context.fileSystem().predicates();
     Iterable<InputFile> it = context.fileSystem().inputFiles(p.and(p.hasLanguage(Python.KEY)));
-    List<InputFile> list = new ArrayList<>();
-    it.forEach(list::add);
+    List<PythonInputFile> list = new ArrayList<>();
+    it.forEach(f -> list.add(new  PythonInputFileImpl(f)));
     return Collections.unmodifiableList(list);
   }
 

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

@@ -38,15 +38,15 @@ protected Scanner(SensorContext context) {
     this.context = context;
   }
 
-  public void execute(List<InputFile> files, SensorContext context) {
+  public void execute(List<PythonInputFile> files, SensorContext context) {
     ProgressReport progressReport = new ProgressReport(this.name() + " progress", TimeUnit.SECONDS.toMillis(10));
     String name = this.name();
     LOG.info("Starting {}", name);
-    List<String> filenames = files.stream().map(InputFile::toString).toList();
+    List<String> filenames = files.stream().map(PythonInputFile::wrappedFile).map(InputFile::toString).toList();
 
     int numScannedWithoutParsing = 0;
     progressReport.start(filenames);
-    for (InputFile file : files) {
+    for (PythonInputFile file : files) {
       if (context.isCancelled()) {
         progressReport.cancel();
         return;
@@ -77,28 +77,28 @@ public void execute(List<InputFile> files, SensorContext context) {
 
   protected abstract String name();
 
-  protected abstract void scanFile(InputFile file) throws IOException;
+  protected abstract void scanFile(PythonInputFile file) throws IOException;
 
-  protected boolean scanFileWithoutParsing(InputFile file) throws IOException {
+  protected boolean scanFileWithoutParsing(PythonInputFile file) throws IOException {
     return false;
   }
 
   protected void endOfAnalysis() {
     // no op
   }
 
-  protected abstract void processException(Exception e, InputFile file);
+  protected abstract void processException(Exception e, PythonInputFile file);
 
   protected void reportStatistics(int numSkippedFiles, int numTotalFiles) {
     // Intentionally empty. Subclasses can override this method to output logs containing some logs after the execution of the scanner.
   }
 
-  public boolean canBeScannedWithoutParsing(InputFile inputFile) {
+  public boolean canBeScannedWithoutParsing(PythonInputFile inputFile) {
     return false;
   }
 
-  private static boolean isParseErrorOnTestFile(InputFile file, Exception e) {
+  private static boolean isParseErrorOnTestFile(PythonInputFile file, Exception e) {
     // As test files may contain invalid syntax on purpose, we avoid failing the analysis when encountering parse errors on them
-    return e instanceof RecognitionException && file.type() == InputFile.Type.TEST;
+    return e instanceof RecognitionException && file.wrappedFile().type() == InputFile.Type.TEST;
   }
 }