Avoid Persisting BaseDir file, but use its absolute path instead (#927)

Author: andrea-guarino-sonarsource

python-checks-testkit/src/main/java/org/sonar/python/checks/utils/PythonCheckVerifier.java

@@ -83,7 +83,7 @@ private static MultiFileVerifier createVerifier(List<File> files, PythonCheck ch
     MultiFileVerifier multiFileVerifier = MultiFileVerifier.create(files.get(0).toPath(), UTF_8);
     for (File file : files) {
       PythonVisitorContext context = baseDir != null
-        ? TestPythonVisitorRunner.createContext(file, null, pythonPackageName(file, baseDir), projectLevelSymbolTable)
+        ? TestPythonVisitorRunner.createContext(file, null, pythonPackageName(file, baseDir.getAbsolutePath()), projectLevelSymbolTable)
         : TestPythonVisitorRunner.createContext(file);
       addFileIssues(check, multiFileVerifier, file, context);
     }

python-frontend/src/main/java/org/sonar/python/TestPythonVisitorRunner.java

@@ -72,7 +72,7 @@ public static ProjectLevelSymbolTable globalSymbols(List<File> files, File baseD
       TestPythonFile pythonFile = new TestPythonFile(file);
       AstNode astNode = PythonParser.create().parse(pythonFile.content());
       FileInput astRoot = new PythonTreeMaker().fileInput(astNode);
-      String packageName = pythonPackageName(file, baseDir);
+      String packageName = pythonPackageName(file, baseDir.getAbsolutePath());
       projectLevelSymbolTable.addModule(astRoot, packageName, pythonFile);
     }
     return projectLevelSymbolTable;

python-frontend/src/main/java/org/sonar/python/semantic/SymbolUtils.java

@@ -191,10 +191,10 @@ static List<Name> boundNamesFromExpression(@CheckForNull Tree tree) {
     return names;
   }
 
-  public static String pythonPackageName(File file, File projectBaseDir) {
+  public static String pythonPackageName(File file, String projectBaseDirAbsolutePath) {
     File currentDirectory = file.getParentFile();
     Deque<String> packages = new ArrayDeque<>();
-    while (!currentDirectory.getAbsolutePath().equals(projectBaseDir.getAbsolutePath())) {
+    while (!currentDirectory.getAbsolutePath().equals(projectBaseDirAbsolutePath)) {
       File initFile = new File(currentDirectory, "__init__.py");
       if (!initFile.exists()) {
         break;

python-frontend/src/test/java/org/sonar/python/semantic/SymbolUtilsTest.java

@@ -49,7 +49,7 @@ public class SymbolUtilsTest {
 
   @Test
   public void package_name_by_file() {
-    File baseDir = new File("src/test/resources").getAbsoluteFile();
+    String baseDir = new File("src/test/resources").getAbsoluteFile().getAbsolutePath();
     assertThat(pythonPackageName(new File(baseDir, "packages/sound/__init__.py"), baseDir)).isEqualTo("sound");
     assertThat(pythonPackageName(new File(baseDir, "packages/sound/formats/__init__.py"), baseDir)).isEqualTo("sound.formats");
     assertThat(pythonPackageName(new File(baseDir, "packages/sound/formats/wavread.py"), baseDir)).isEqualTo("sound.formats");

sonar-python-plugin/src/main/java/org/sonar/plugins/python/indexer/PythonIndexer.java

@@ -20,7 +20,6 @@
 package org.sonar.plugins.python.indexer;
 
 import com.sonar.sslr.api.AstNode;
-import java.io.File;
 import java.io.IOException;
 import java.net.URI;
 import java.util.HashMap;
@@ -43,7 +42,7 @@ public abstract class PythonIndexer {
 
   private static final Logger LOG = Loggers.get(PythonIndexer.class);
 
-  protected File projectBaseDir;
+  protected String projectBaseDirAbsolutePath;
 
   private final Map<URI, String> packageNames = new HashMap<>();
   private final PythonParser parser = PythonParser.create();
@@ -54,7 +53,7 @@ public ProjectLevelSymbolTable projectLevelSymbolTable() {
   }
 
   public String packageName(InputFile inputFile) {
-    return packageNames.computeIfAbsent(inputFile.uri(), k -> pythonPackageName(inputFile.file(), projectBaseDir));
+    return packageNames.computeIfAbsent(inputFile.uri(), k -> pythonPackageName(inputFile.file(), projectBaseDirAbsolutePath));
   }
 
   void removeFile(InputFile inputFile) {
@@ -70,7 +69,7 @@ void removeFile(InputFile inputFile) {
   void addFile(InputFile inputFile) throws IOException {
     AstNode astNode = parser.parse(inputFile.contents());
     FileInput astRoot = new PythonTreeMaker().fileInput(astNode);
-    String packageName = pythonPackageName(inputFile.file(), projectBaseDir);
+    String packageName = pythonPackageName(inputFile.file(), projectBaseDirAbsolutePath);
     packageNames.put(inputFile.uri(), packageName);
     PythonFile pythonFile = SonarQubePythonFile.create(inputFile);
     projectLevelSymbolTable.addModule(astRoot, packageName, pythonFile);

sonar-python-plugin/src/main/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexer.java

@@ -49,7 +49,7 @@ public void buildOnce(SensorContext context) {
     if (!shouldBuildProjectSymbolTable) {
       return;
     }
-    this.projectBaseDir = context.fileSystem().baseDir();
+    this.projectBaseDirAbsolutePath = context.fileSystem().baseDir().getAbsolutePath();
     List<InputFile> files = getInputFiles(moduleFileSystem);
     LOG.debug("Input files for indexing: " + files);
     // computes "globalSymbolsByModuleName"

sonar-python-plugin/src/main/java/org/sonar/plugins/python/indexer/SonarQubePythonIndexer.java

@@ -36,7 +36,7 @@ public SonarQubePythonIndexer(List<InputFile> files) {
 
   @Override
   public void buildOnce(SensorContext context) {
-    this.projectBaseDir = context.fileSystem().baseDir();
+    this.projectBaseDirAbsolutePath = context.fileSystem().baseDir().getAbsolutePath();
     LOG.debug("Input files for indexing: " + files);
     // computes "globalSymbolsByModuleName"
     long startTime = System.currentTimeMillis();