SONARPY-3195 Refactor PythonVisitorContext Constructors to Builder (#400)

GitOrigin-RevId: 92a379e79fa41e75964a2a5303d866edd2e39a92

Author: Seppli11

python-checks-testkit/src/main/java/org/sonar/python/checks/quickfix/PythonQuickFixVerifier.java

@@ -159,9 +159,11 @@ private static PythonVisitorContext createVisitorContext(PythonParser parser, Py
     var astNode = parser.parse(pythonFile.content());
     var fileInput = treeMaker.fileInput(astNode);
 
-    return new PythonVisitorContext(fileInput,
-      pythonFile, null, "",
-      ProjectLevelSymbolTable.empty(), CacheContextImpl.dummyCache(), SonarProduct.SONARLINT);
+    return new PythonVisitorContext.Builder(fileInput, pythonFile)
+      .projectLevelSymbolTable(ProjectLevelSymbolTable.empty())
+      .cacheContext(CacheContextImpl.dummyCache())
+      .sonarProduct(SonarProduct.SONARLINT)
+      .build();
   }
 
   private static String applyQuickFix(String codeWithIssue, PythonQuickFix quickFix) {

python-checks/src/test/java/org/sonar/python/checks/ParsingErrorCheckTest.java

@@ -23,6 +23,7 @@
 import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.sonar.plugins.python.api.PythonCheck.PreciseIssue;
+import org.sonar.api.SonarProduct;
 import org.sonar.plugins.python.api.PythonVisitorContext;
 import org.sonar.python.parser.PythonParser;
 
@@ -41,7 +42,7 @@ void test() throws Exception {
       parser.parse(fileContent);
       throw new IllegalStateException("Expected RecognitionException");
     } catch (RecognitionException e) {
-      context = new PythonVisitorContext(null, e);
+      context = new PythonVisitorContext(null, e, SonarProduct.SONARQUBE);
     }
 
     ParsingErrorCheck check = new ParsingErrorCheck();

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

@@ -150,13 +150,13 @@ private PythonVisitorContext createVisitorContext(PythonInputFile inputFile, Pyt
       AstNode astNode = parserSupplier.get().parse(inputFile.contents());
       PythonTreeMaker treeMaker = getTreeMaker(inputFile);
       FileInput parse = treeMaker.fileInput(astNode);
-      visitorContext = new PythonVisitorContext(parse,
-        pythonFile,
-        getWorkingDirectory(context),
-        indexer.packageName(inputFile),
-        indexer.projectLevelSymbolTable(),
-        indexer.cacheContext(),
-        context.runtime().getProduct());
+      visitorContext = new PythonVisitorContext.Builder(parse, pythonFile)
+        .workingDirectory(getWorkingDirectory(context))
+        .packageName(indexer.packageName(inputFile))
+        .projectLevelSymbolTable(indexer.projectLevelSymbolTable())
+        .cacheContext(indexer.cacheContext())
+        .sonarProduct(context.runtime().getProduct())
+        .build();
 
     } catch (RecognitionException e) {
       visitorContext = new PythonVisitorContext(pythonFile, e, context.runtime().getProduct());

python-commons/src/test/java/org/sonar/plugins/python/IpynbNotebookParserScannerTest.java

@@ -37,11 +37,10 @@ void trailing_whitespace() throws IOException {
     var inputFile = createInputFile(baseDir, "notebook_trailing_whitespace.ipynb", InputFile.Status.CHANGED, InputFile.Type.MAIN);
     var result = IpynbNotebookParser.parseNotebook(inputFile).get();
     var check = new TrailingWhitespaceCheck();
-    var context = new PythonVisitorContext(
+    var context = new PythonVisitorContext.Builder(
       TestPythonVisitorRunner.parseNotebookFile(result.locationMap(), result.contents()),
-      SonarQubePythonFile.create(result),
-      null,
-      "");
+      SonarQubePythonFile.create(result))
+      .build();
     check.scanFile(context);
 
     var issues = context.getIssues();
@@ -68,11 +67,10 @@ void trailing_whitespace_compressed() throws IOException {
     var inputFile = createInputFile(baseDir, "notebook_trailing_whitespace_compressed.ipynb", InputFile.Status.CHANGED, InputFile.Type.MAIN);
     var result = IpynbNotebookParser.parseNotebook(inputFile).get();
     var check = new TrailingWhitespaceCheck();
-    var context = new PythonVisitorContext(
+    var context = new PythonVisitorContext.Builder(
       TestPythonVisitorRunner.parseNotebookFile(result.locationMap(), result.contents()),
-      SonarQubePythonFile.create(result),
-      null,
-      "");
+      SonarQubePythonFile.create(result))
+      .build();
     check.scanFile(context);
 
     var issues = context.getIssues();

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

@@ -21,6 +21,7 @@
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import org.sonar.api.SonarProduct;
@@ -46,78 +47,32 @@ public class PythonVisitorContext extends PythonInputFileContext {
   private final List<PreciseIssue> issues;
   private final ProjectConfiguration projectConfiguration;
 
-  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName) {
-    this(rootTree, pythonFile, workingDirectory, packageName, new ProjectConfiguration());
-  }
-
-  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName, ProjectConfiguration projectConfiguration) {
-    super(pythonFile, workingDirectory, CacheContextImpl.dummyCache(), ProjectLevelSymbolTable.empty());
-    buildSymbols(rootTree, pythonFile, packageName);
-    var symbolTable = new SymbolTableBuilderV2(rootTree).build();
-    var projectLevelTypeTable = new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty());
-
-    this.rootTree = rootTree;
-    this.parsingException = null;
-    this.moduleType = new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable, packageName).inferModuleType(rootTree);
-    this.typeChecker = new TypeChecker(projectLevelTypeTable);
-    this.projectConfiguration = projectConfiguration;
-    this.issues = new ArrayList<>();
-  }
-
-  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
-    ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext) {
-    this(rootTree, pythonFile, workingDirectory, packageName, projectLevelSymbolTable, cacheContext, new ProjectConfiguration());
-  }
-
-  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
-    ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext, ProjectConfiguration projectConfiguration) {
-    super(pythonFile, workingDirectory, cacheContext, projectLevelSymbolTable);
-
-    buildSymbols(rootTree, pythonFile, packageName, projectLevelSymbolTable);
-    var symbolTable = new SymbolTableBuilderV2(rootTree).build();
-    var projectLevelTypeTable = new ProjectLevelTypeTable(projectLevelSymbolTable);
-
-    this.rootTree = rootTree;
-    this.parsingException = null;
-    this.moduleType = new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable, packageName).inferModuleType(rootTree);
-    this.typeChecker = new TypeChecker(projectLevelTypeTable);
-    this.projectConfiguration = projectConfiguration;
-    this.issues = new ArrayList<>();
-  }
+  private PythonVisitorContext(FileInput rootTree, 
+      PythonFile pythonFile, 
+      @Nullable File workingDirectory, 
+      String packageName, 
+      ProjectLevelSymbolTable projectLevelSymbolTable, 
+      CacheContext cacheContext,
+      SonarProduct sonarProduct,
+      ProjectConfiguration projectConfiguration) {
 
-  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
-    ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext, SonarProduct sonarProduct) {
     super(pythonFile, workingDirectory, cacheContext, sonarProduct, projectLevelSymbolTable);
     var symbolTableBuilderV2 = new SymbolTableBuilderV2(rootTree);
     var symbolTable = symbolTableBuilderV2.build();
     buildSymbols(rootTree, pythonFile, packageName, projectLevelSymbolTable);
     var projectLevelTypeTable = new ProjectLevelTypeTable(projectLevelSymbolTable);
     this.moduleType = new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable, packageName).inferModuleType(rootTree);
     this.typeChecker = new TypeChecker(projectLevelTypeTable);
-    this.projectConfiguration = new ProjectConfiguration();
+    this.projectConfiguration = projectConfiguration;
     this.rootTree = rootTree;
     this.parsingException = null;
     this.issues = new ArrayList<>();
   }
-
-  private static synchronized void buildSymbols(FileInput rootTree, PythonFile pythonFile, String packageName) {
-    buildSymbols(rootTree, pythonFile, packageName, ProjectLevelSymbolTable.empty());
-  }
-
   private static synchronized void buildSymbols(FileInput rootTree, PythonFile pythonFile, String packageName, ProjectLevelSymbolTable projectLevelSymbolTable) {
     var symbolTableBuilder = new SymbolTableBuilder(packageName, pythonFile, projectLevelSymbolTable);
     symbolTableBuilder.visitFileInput(rootTree);
   }
 
-  public PythonVisitorContext(PythonFile pythonFile, RecognitionException parsingException) {
-    super(pythonFile, null, CacheContextImpl.dummyCache(), ProjectLevelSymbolTable.empty());
-    this.rootTree = null;
-    this.parsingException = parsingException;
-    this.typeChecker = new TypeChecker(new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty()));
-    this.projectConfiguration = new ProjectConfiguration();
-    this.issues = new ArrayList<>();
-  }
-
   public PythonVisitorContext(PythonFile pythonFile, RecognitionException parsingException, SonarProduct sonarProduct) {
     super(pythonFile, null, CacheContextImpl.dummyCache(), sonarProduct, ProjectLevelSymbolTable.empty());
     this.rootTree = null;
@@ -156,4 +111,64 @@ public ModuleType moduleType() {
   public ProjectConfiguration projectConfiguration() {
     return projectConfiguration;
   }
+
+  public static class Builder {
+    private final PythonFile pythonFile;
+    private final FileInput rootTree;
+
+    private Optional<ProjectLevelSymbolTable> projectLevelSymbolTable = Optional.empty();
+    private Optional<CacheContext> cacheContext = Optional.empty();
+    private Optional<SonarProduct> sonarProduct = Optional.empty();
+    private Optional<File> workingDirectory = Optional.empty();
+    private Optional<ProjectConfiguration> projectConfiguration = Optional.empty();
+    private Optional<String> packageName = Optional.empty();
+
+    public Builder(FileInput rootTree, PythonFile pythonFile) {
+      this.rootTree = rootTree;
+      this.pythonFile = pythonFile;
+    }
+
+    public Builder workingDirectory(@Nullable File workingDirectory) {
+      this.workingDirectory = Optional.ofNullable(workingDirectory);
+      return this;
+    }
+    
+    public Builder packageName(String packageName) {
+      this.packageName = Optional.ofNullable(packageName);
+      return this;
+    }
+
+    public Builder projectLevelSymbolTable(ProjectLevelSymbolTable projectLevelSymbolTable) {
+      this.projectLevelSymbolTable = Optional.ofNullable(projectLevelSymbolTable);
+      return this;
+    }
+
+    public Builder cacheContext(CacheContext cacheContext) {
+      this.cacheContext = Optional.ofNullable(cacheContext);
+      return this;
+    }
+
+    public Builder sonarProduct(SonarProduct sonarProduct) {
+      this.sonarProduct = Optional.ofNullable(sonarProduct);
+      return this;
+    }
+
+    public Builder projectConfiguration(ProjectConfiguration projectConfiguration) {
+      this.projectConfiguration = Optional.ofNullable(projectConfiguration);
+      return this;
+    }
+
+    public PythonVisitorContext build() {
+      return new PythonVisitorContext(
+        rootTree,
+        pythonFile,
+        workingDirectory.orElse(null),
+        packageName.orElse(""),
+        projectLevelSymbolTable.orElseGet(ProjectLevelSymbolTable::empty),
+        cacheContext.orElseGet(CacheContextImpl::dummyCache),
+        sonarProduct.orElse(SonarProduct.SONARQUBE),
+        projectConfiguration.orElse(new ProjectConfiguration())
+      );
+    } 
+  }
 }

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

@@ -80,20 +80,35 @@ public static PythonVisitorContext createContext(File file, @Nullable File worki
     ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext, ProjectConfiguration projectConfiguration) {
     TestPythonFile pythonFile = new TestPythonFile(file);
     FileInput rootTree = parseFile(pythonFile);
-    return new PythonVisitorContext(rootTree, pythonFile, workingDirectory, packageName, projectLevelSymbolTable, cacheContext, projectConfiguration);
+    return new PythonVisitorContext.Builder(rootTree, pythonFile)
+      .workingDirectory(workingDirectory)
+      .packageName(packageName)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .projectConfiguration(projectConfiguration)
+      .build();
   }
 
   public static PythonVisitorContext createContext(MockPythonFile file, @Nullable File workingDirectory, String packageName,
                                                    ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext) {
     FileInput rootTree = parseFile(file);
-    return new PythonVisitorContext(rootTree, file, workingDirectory, packageName, projectLevelSymbolTable, cacheContext);
+    return new PythonVisitorContext.Builder(rootTree, file)
+      .workingDirectory(workingDirectory)
+      .packageName(packageName)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .build();
   }
 
   public static PythonVisitorContext createNotebookContext(File file, Map<Integer, IPythonLocation> locations, String content, String packageName,
     ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext) {
     TestPythonFile pythonFile = new TestPythonFile(file);
     FileInput rootTree = parseNotebookFile(locations, content);
-    return new PythonVisitorContext(rootTree, pythonFile, null, packageName, projectLevelSymbolTable, cacheContext);
+    return new PythonVisitorContext.Builder(rootTree, pythonFile)
+      .packageName(packageName)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .build();
   }
 
   public static ProjectLevelSymbolTable globalSymbols(List<File> files, File baseDir) {

python-frontend/src/test/java/org/sonar/plugins/python/api/PythonVisitorContextTest.java

@@ -17,7 +17,6 @@
 package org.sonar.plugins.python.api;
 
 import com.sonar.sslr.api.RecognitionException;
-import java.io.File;
 import java.util.Collections;
 import java.util.Map;
 import java.util.Set;
@@ -47,21 +46,21 @@ void fullyQualifiedModuleName() {
     FileInput fileInput = PythonTestUtils.parse("def foo(): pass");
 
     PythonFile pythonFile = pythonFile("my_module.py");
-    var ctx = new PythonVisitorContext(fileInput, pythonFile, null, "my_package");
+    var ctx = new PythonVisitorContext.Builder(fileInput, pythonFile).packageName("my_package").build();
     FunctionDef functionDef = (FunctionDef) PythonTestUtils.getAllDescendant(fileInput, t -> t.is(Tree.Kind.FUNCDEF)).get(0);
     assertThat(functionDef.name().symbol().fullyQualifiedName()).isEqualTo("my_package.my_module.foo");
     assertThat(ctx.moduleType()).isNotNull()
       .hasFieldOrPropertyWithValue("fullyQualifiedName", "my_package.my_module");
 
     // no package
-    ctx = new PythonVisitorContext(fileInput, pythonFile, null, "");
+    ctx = new PythonVisitorContext.Builder(fileInput, pythonFile).build();
     assertThat(functionDef.name().symbol().fullyQualifiedName()).isEqualTo("my_module.foo");
     assertThat(ctx.moduleType()).isNotNull()
       .hasFieldOrPropertyWithValue("fullyQualifiedName", "my_module");
 
     // file without extension
     Mockito.when(pythonFile.fileName()).thenReturn("my_module");
-    ctx = new PythonVisitorContext(fileInput, pythonFile, null, "my_package");
+    ctx = new PythonVisitorContext.Builder(fileInput, pythonFile).packageName("my_package").build();
     functionDef = (FunctionDef) PythonTestUtils.getAllDescendant(fileInput, t -> t.is(Tree.Kind.FUNCDEF)).get(0);
     assertThat(functionDef.name().symbol().fullyQualifiedName()).isEqualTo("my_package.my_module.foo");
     assertThat(ctx.moduleType()).isNotNull()
@@ -72,12 +71,12 @@ void fullyQualifiedModuleName() {
   void initModuleFullyQualifiedName() {
     FileInput fileInput = PythonTestUtils.parse("def fn(): pass");
     PythonFile pythonFile = pythonFile("__init__.py");
-    new PythonVisitorContext(fileInput, pythonFile, null, "foo.bar");
+    new PythonVisitorContext.Builder(fileInput, pythonFile).packageName("foo.bar").build();
     FunctionDef functionDef = (FunctionDef) PythonTestUtils.getAllDescendant(fileInput, t -> t.is(Tree.Kind.FUNCDEF)).get(0);
     assertThat(functionDef.name().symbol().fullyQualifiedName()).isEqualTo("foo.bar.fn");
 
     // no package
-    new PythonVisitorContext(fileInput, pythonFile, null, "");
+    new PythonVisitorContext.Builder(fileInput, pythonFile).build();
     assertThat(functionDef.name().symbol().fullyQualifiedName()).isEqualTo("fn");
   }
 
@@ -90,7 +89,11 @@ void globalSymbols() {
     Set<Descriptor> descriptors = Set.of(new VariableDescriptor("a", "mod.a", null), new VariableDescriptor("b", "mod.b", null));
     Map<String, Set<Descriptor>> globalDescriptors = Collections.singletonMap("mod", descriptors);
 
-    new PythonVisitorContext(fileInput, pythonFile, null, "my_package", ProjectLevelSymbolTable.from(globalDescriptors), CacheContextImpl.dummyCache());
+    new PythonVisitorContext.Builder(fileInput, pythonFile)
+      .packageName("my_package")
+      .projectLevelSymbolTable(ProjectLevelSymbolTable.from(globalDescriptors))
+      .cacheContext(CacheContextImpl.dummyCache())
+      .build();
     assertThat(fileInput.globalVariables()).extracting(Symbol::name).containsExactlyInAnyOrder("a", "b");
   }
 
@@ -99,21 +102,34 @@ void sonar_product() {
     CacheContextImpl cacheContext = CacheContextImpl.dummyCache();
     ProjectLevelSymbolTable projectLevelSymbolTable = ProjectLevelSymbolTable.empty();
     String myPackage = "my_package";
-    File workingDirectory = null;
     PythonFile pythonFile = pythonFile("my_module.py");
     FileInput fileInput = mock(FileInputImpl.class);
 
-    PythonVisitorContext pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext, SonarProduct.SONARLINT);
+    PythonVisitorContext pythonVisitorContext = new PythonVisitorContext.Builder(fileInput, pythonFile)
+      .packageName(myPackage)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .sonarProduct(SonarProduct.SONARLINT)
+      .build();
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARLINT);
 
-    pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext, SonarProduct.SONARQUBE);
+    pythonVisitorContext = new PythonVisitorContext.Builder(fileInput, pythonFile)
+      .packageName(myPackage)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .sonarProduct(SonarProduct.SONARQUBE)
+      .build();
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARQUBE);
 
-    pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext);
+    pythonVisitorContext = new PythonVisitorContext.Builder(fileInput, pythonFile)
+      .packageName(myPackage)
+      .projectLevelSymbolTable(projectLevelSymbolTable)
+      .cacheContext(cacheContext)
+      .build();
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARQUBE);
 
     RecognitionException parsingException = mock(RecognitionException.class);
-    pythonVisitorContext = new PythonVisitorContext(pythonFile, parsingException);
+    pythonVisitorContext = new PythonVisitorContext(pythonFile, parsingException, SonarProduct.SONARQUBE);
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARQUBE);
 
     pythonVisitorContext = new PythonVisitorContext(pythonFile, parsingException, SonarProduct.SONARLINT);