SONARPY-3189 Implement a collection of a project AWS lambda handlers based on function signatures (#401)

GitOrigin-RevId: 86b7ce2424c8d13adb8c2fb1a3592ae5443783f1

Author: maksim-grebeniuk-sonarsource

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

@@ -58,15 +58,15 @@ public static void verify(String path, PythonCheck check) {
 
   public static void verifyNoIssue(String path, PythonCheck check) {
     File file = new File(path);
-    createVerifier(Collections.singletonList(file), check, ProjectLevelSymbolTable.empty(), null, new ProjectConfiguration())
+    createVerifier(Collections.singletonList(file), check, ProjectLevelSymbolTable.empty(), null, null)
       .assertNoIssues();
   }
 
   public static void verify(List<String> paths, PythonCheck check) {
-    verify(paths, check, new ProjectConfiguration());
+    verify(paths, check, null);
   }
 
-  public static void verify(List<String> paths, PythonCheck check, ProjectConfiguration projectConfiguration) {
+  public static void verify(List<String> paths, PythonCheck check, @Nullable ProjectConfiguration projectConfiguration) {
     List<File> files = paths.stream().map(File::new).toList();
     File baseDirFile = new File(files.get(0).getParent());
     ProjectLevelSymbolTable projectLevelSymbolTable = TestPythonVisitorRunner.globalSymbols(files, baseDirFile);
@@ -77,20 +77,20 @@ public static void verifyNoIssue(List<String> paths, PythonCheck check) {
     List<File> files = paths.stream().map(File::new).toList();
     File baseDirFile = new File(files.get(0).getParent());
     ProjectLevelSymbolTable projectLevelSymbolTable = TestPythonVisitorRunner.globalSymbols(files, baseDirFile);
-    createVerifier(files, check, projectLevelSymbolTable, baseDirFile, new ProjectConfiguration()).assertNoIssues();
+    createVerifier(files, check, projectLevelSymbolTable, baseDirFile, null).assertNoIssues();
   }
 
   public static List<PreciseIssue> issues(String path, PythonCheck check) {
     File file = new File(path);
-    PythonVisitorContext context = createContext(file, ProjectLevelSymbolTable.empty(), new ProjectConfiguration(), null);
+    PythonVisitorContext context = createContext(file, ProjectLevelSymbolTable.empty(), null, null);
     return scanFileForIssues(check, context);
   }
 
   private static MultiFileVerifier createVerifier(List<File> files,
     PythonCheck check,
     ProjectLevelSymbolTable projectLevelSymbolTable,
     @Nullable File baseDir,
-    ProjectConfiguration projectConfiguration) {
+    @Nullable ProjectConfiguration projectConfiguration) {
     MultiFileVerifier multiFileVerifier = MultiFileVerifier.create(files.get(0).toPath(), UTF_8);
     for (File file : files) {
       PythonVisitorContext context = createContext(file, projectLevelSymbolTable, projectConfiguration, baseDir);
@@ -101,7 +101,7 @@ private static MultiFileVerifier createVerifier(List<File> files,
 
   private static PythonVisitorContext createContext(File file,
     ProjectLevelSymbolTable projectLevelSymbolTable,
-    ProjectConfiguration projectConfiguration,
+    @Nullable ProjectConfiguration projectConfiguration,
     @Nullable File baseDir) {
     return baseDir != null
       ? TestPythonVisitorRunner.createContext(file,
@@ -145,7 +145,8 @@ private static MultiFileVerifier.Issue addPreciseIssue(Path path, MultiFileVerif
     MultiFileVerifier.Issue issueBuilder = verifier.reportIssue(path, message)
       .onRange(location.startLine(), location.startLineOffset() + 1, location.endLine(), location.endLineOffset());
     for (IssueLocation secondary : preciseIssue.secondaryLocations()) {
-      issueBuilder.addSecondary(path, secondary.startLine(), secondary.startLineOffset() + 1, secondary.endLine(), secondary.endLineOffset(), secondary.message());
+      issueBuilder.addSecondary(path, secondary.startLine(), secondary.startLineOffset() + 1, secondary.endLine(),
+        secondary.endLineOffset(), secondary.message());
     }
     return issueBuilder;
   }

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

@@ -39,6 +39,7 @@
 import org.sonar.plugins.python.indexer.PythonIndexer;
 import org.sonar.plugins.python.indexer.SonarQubePythonIndexer;
 import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.python.caching.CacheContextImpl;
 import org.sonar.python.parser.PythonParser;
 
@@ -53,12 +54,20 @@ public final class IPynbSensor implements Sensor {
   private static final String FAIL_FAST_PROPERTY_NAME = "sonar.internal.analysis.failFast";
   private final SensorTelemetryStorage sensorTelemetryStorage;
   private final NoSonarLineInfoCollector noSonarLineInfoCollector;
+  private final ProjectConfigurationBuilder projectConfigurationBuilder;
 
   public IPynbSensor(FileLinesContextFactory fileLinesContextFactory,
     CheckFactory checkFactory,
     NoSonarFilter noSonarFilter,
-    NoSonarLineInfoCollector noSonarLineInfoCollector) {
-    this(fileLinesContextFactory, checkFactory, noSonarFilter, null, new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, noSonarLineInfoCollector);
+    NoSonarLineInfoCollector noSonarLineInfoCollector,
+    ProjectConfigurationBuilder projectConfigurationBuilder) {
+    this(fileLinesContextFactory,
+      checkFactory,
+      noSonarFilter,
+      null,
+      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()},
+      noSonarLineInfoCollector,
+      projectConfigurationBuilder);
   }
 
   public IPynbSensor(
@@ -67,8 +76,10 @@ public IPynbSensor(
     NoSonarFilter noSonarFilter,
     @Nullable PythonIndexer indexer,
     RepositoryInfoProvider[] editionMetadataProviders,
-    NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    NoSonarLineInfoCollector noSonarLineInfoCollector,
+    ProjectConfigurationBuilder projectConfigurationBuilder) {
     this.noSonarLineInfoCollector = noSonarLineInfoCollector;
+    this.projectConfigurationBuilder = projectConfigurationBuilder;
 
     this.checks = createPythonChecks(checkFactory, editionMetadataProviders);
 
@@ -119,7 +130,7 @@ private void processNotebooksFiles(List<PythonInputFile> pythonFiles, SensorCont
     pythonFiles = parseNotebooks(pythonFiles, context);
     // Disable caching for IPynb files for now see: SONARPY-2020
     CacheContext cacheContext = CacheContextImpl.dummyCache();
-    PythonIndexer pythonIndexer = new SonarQubePythonIndexer(pythonFiles, cacheContext, context);
+    PythonIndexer pythonIndexer = new SonarQubePythonIndexer(pythonFiles, cacheContext, context, projectConfigurationBuilder);
     PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser::createIPythonParser,
       pythonIndexer, new DummyArchitectureCallback(), noSonarLineInfoCollector);
     scanner.execute(pythonFiles, context);

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

@@ -41,6 +41,7 @@
 import org.sonar.plugins.python.mypy.MypySensor;
 import org.sonar.plugins.python.nosonar.NoSonarIssueFilter;
 import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.plugins.python.pylint.PylintRulesDefinition;
 import org.sonar.plugins.python.pylint.PylintSensor;
 import org.sonar.plugins.python.ruff.RuffRulesDefinition;
@@ -69,6 +70,7 @@ private PythonExtensions() {
 
   public static void addCommonExtensions(Plugin.Context context) {
     context.addExtensions(
+      ProjectConfigurationBuilder.class,
       NoSonarLineInfoCollector.class,
       NoSonarIssueFilter.class,
       buildPythonSuffix(),

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

@@ -151,6 +151,7 @@ private PythonVisitorContext createVisitorContext(PythonInputFile inputFile, Pyt
       PythonTreeMaker treeMaker = getTreeMaker(inputFile);
       FileInput parse = treeMaker.fileInput(astNode);
       visitorContext = new PythonVisitorContext.Builder(parse, pythonFile)
+        .projectConfiguration(indexer.projectConfig())
         .workingDirectory(getWorkingDirectory(context))
         .packageName(indexer.packageName(inputFile))
         .projectLevelSymbolTable(indexer.projectLevelSymbolTable())

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

@@ -48,6 +48,7 @@
 import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarQubePythonIndexer;
 import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.plugins.python.warnings.AnalysisWarningsWrapper;
 import org.sonar.python.caching.CacheContextImpl;
 import org.sonar.python.parser.PythonParser;
@@ -79,6 +80,7 @@ public final class PythonSensor implements Sensor {
 
   private final SensorTelemetryStorage sensorTelemetryStorage;
   private final NoSonarLineInfoCollector noSonarLineInfoCollector;
+  private final ProjectConfigurationBuilder projectConfigurationBuilder;
 
   public PythonSensor(
     FileLinesContextFactory fileLinesContextFactory,
@@ -89,8 +91,11 @@ public PythonSensor(
     SonarLintCacheWrapper sonarLintCacheWrapper,
     AnalysisWarningsWrapper analysisWarnings,
     RepositoryInfoProviderWrapper editionMetadataProviderWrapper,
-    ArchitectureCallbackWrapper architectureUDGBuilderWrapper, NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    ArchitectureCallbackWrapper architectureUDGBuilderWrapper,
+    NoSonarLineInfoCollector noSonarLineInfoCollector,
+    ProjectConfigurationBuilder projectConfigurationBuilder) {
     this.noSonarLineInfoCollector = noSonarLineInfoCollector;
+    this.projectConfigurationBuilder = projectConfigurationBuilder;
 
     this.checks = createPythonChecks(checkFactory, editionMetadataProviderWrapper.infoProviders())
         .addCustomChecks(customRuleRepositoriesWrapper.customRuleRepositories());
@@ -133,7 +138,7 @@ public void execute(SensorContext context) {
     }
     updatePythonVersionTelemetry(context, pythonVersionParameter);
     CacheContext cacheContext = CacheContextImpl.of(context);
-    PythonIndexer pythonIndexer = this.indexer != null ? this.indexer : new SonarQubePythonIndexer(pythonFiles, cacheContext, context);
+    PythonIndexer pythonIndexer = this.indexer != null ? this.indexer : new SonarQubePythonIndexer(pythonFiles, cacheContext, context, projectConfigurationBuilder);
     pythonIndexer.setSonarLintCache(sonarLintCache);
     TypeShed.setProjectLevelSymbolTable(pythonIndexer.projectLevelSymbolTable());
     PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser::create,

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

@@ -35,7 +35,10 @@
 import org.sonar.plugins.python.api.PythonFile;
 import org.sonar.plugins.python.api.SonarLintCache;
 import org.sonar.plugins.python.api.caching.CacheContext;
+import org.sonar.plugins.python.api.project.configuration.ProjectConfiguration;
 import org.sonar.plugins.python.api.tree.FileInput;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
+import org.sonar.python.project.config.SignatureBasedAwsLambdaHandlersCollector;
 import org.sonar.python.parser.PythonParser;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
 import org.sonar.python.tree.PythonTreeMaker;
@@ -51,11 +54,21 @@ public abstract class PythonIndexer {
   private final Map<URI, String> packageNames = new ConcurrentHashMap<>();
   private final Supplier<PythonParser> parserSupplier = PythonParser::create;
   private final ProjectLevelSymbolTable projectLevelSymbolTable = ProjectLevelSymbolTable.empty();
+  private final SignatureBasedAwsLambdaHandlersCollector signatureBasedAwsLambdaHandlersCollector = new SignatureBasedAwsLambdaHandlersCollector();
+  private final ProjectConfigurationBuilder projectConfigurationBuilder;
+
+  protected PythonIndexer(ProjectConfigurationBuilder projectConfigurationBuilder) {
+    this.projectConfigurationBuilder = projectConfigurationBuilder;
+  }
 
   public ProjectLevelSymbolTable projectLevelSymbolTable() {
     return projectLevelSymbolTable;
   }
 
+  public ProjectConfiguration projectConfig() {
+    return projectConfigurationBuilder.build();
+  }
+
   public String packageName(PythonInputFile inputFile) {
     if (!packageNames.containsKey(inputFile.wrappedFile().uri())) {
       String name = pythonPackageName(inputFile.wrappedFile().file(), projectBaseDirAbsolutePath);
@@ -81,6 +94,7 @@ void removeFile(PythonInputFile inputFile) {
     }
     packageNames.remove(inputFile.wrappedFile().uri());
     projectLevelSymbolTable.removeModule(packageName, filename);
+    projectConfigurationBuilder.removePackageAwsLambdaHandlers(packageName);
   }
 
   void addFile(PythonInputFile inputFile) throws IOException {
@@ -91,6 +105,7 @@ void addFile(PythonInputFile inputFile) throws IOException {
     projectLevelSymbolTable.addProjectPackage(packageName);
     PythonFile pythonFile = SonarQubePythonFile.create(inputFile.wrappedFile());
     projectLevelSymbolTable.addModule(astRoot, packageName, pythonFile);
+    signatureBasedAwsLambdaHandlersCollector.collect(projectConfigurationBuilder, astRoot, packageName);
   }
 
   public abstract void buildOnce(SensorContext context);

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

@@ -32,6 +32,7 @@
 import org.sonar.plugins.python.api.caching.CacheContext;
 import org.sonar.plugins.python.PythonInputFile;
 import org.sonar.plugins.python.PythonInputFileImpl;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.python.caching.CacheContextImpl;
 import org.sonar.python.caching.PythonReadCacheImpl;
 import org.sonar.python.caching.PythonWriteCacheImpl;
@@ -52,7 +53,8 @@ public class SonarLintPythonIndexer extends PythonIndexer implements ModuleFileL
   private static final long DEFAULT_MAX_LINES_FOR_INDEXING = 300_000;
   private static final String MAX_LINES_PROPERTY = "sonar.python.sonarlint.indexing.maxlines";
 
-  public SonarLintPythonIndexer(ModuleFileSystem moduleFileSystem) {
+  public SonarLintPythonIndexer(ModuleFileSystem moduleFileSystem, ProjectConfigurationBuilder projectConfigurationBuilder) {
+    super(projectConfigurationBuilder);
     this.moduleFileSystem = moduleFileSystem;
   }
 

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

@@ -33,6 +33,7 @@
 import org.sonar.plugins.python.PythonInputFile;
 import org.sonar.plugins.python.api.caching.CacheContext;
 import org.sonar.plugins.python.caching.Caching;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.python.index.Descriptor;
 import org.sonar.python.semantic.DependencyGraph;
 import org.sonar.python.semantic.SymbolUtils;
@@ -57,7 +58,8 @@ public class SonarQubePythonIndexer extends PythonIndexer {
   private final List<PythonInputFile> inputFiles = new ArrayList<>();
   private final Map<PythonInputFile, String> inputFileToFQN = new HashMap<>();
 
-  public SonarQubePythonIndexer(List<PythonInputFile> inputFiles, CacheContext cacheContext, SensorContext context) {
+  public SonarQubePythonIndexer(List<PythonInputFile> inputFiles, CacheContext cacheContext, SensorContext context, ProjectConfigurationBuilder projectConfigurationBuilder) {
+    super(projectConfigurationBuilder);
     this.projectBaseDirAbsolutePath = context.fileSystem().baseDir().getAbsolutePath();
     this.caching = new Caching(cacheContext, getCacheVersion(context));
     inputFiles.forEach(f -> {

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

@@ -53,6 +53,7 @@
 import org.sonar.plugins.python.indexer.SonarLintPythonIndexer;
 import org.sonar.plugins.python.indexer.TestModuleFileSystem;
 import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -133,7 +134,13 @@ private IPynbSensor sensor(PythonIndexer indexer) {
     FileLinesContext fileLinesContext = mock(FileLinesContext.class);
     when(fileLinesContextFactory.createFor(Mockito.any(InputFile.class))).thenReturn(fileLinesContext);
     CheckFactory checkFactory = new CheckFactory(activeRules);
-    return new IPynbSensor(fileLinesContextFactory, checkFactory, mock(NoSonarFilter.class), indexer, new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, new NoSonarLineInfoCollector());
+    return new IPynbSensor(fileLinesContextFactory,
+      checkFactory,
+      mock(NoSonarFilter.class),
+      indexer,
+      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()},
+      new NoSonarLineInfoCollector(),
+      new ProjectConfigurationBuilder());
   }
 
   private PythonInputFile inputFile(String name) {
@@ -154,7 +161,7 @@ private PythonInputFile createInputFile(String name) {
   }
 
   private SonarLintPythonIndexer pythonIndexer(List<PythonInputFile> files) {
-    return new SonarLintPythonIndexer(new TestModuleFileSystem(files));
+    return new SonarLintPythonIndexer(new TestModuleFileSystem(files), new ProjectConfigurationBuilder());
   }
 
   @Test
@@ -176,7 +183,11 @@ private IPynbSensor notebookSensor() {
     FileLinesContext fileLinesContext = mock(FileLinesContext.class);
     when(fileLinesContextFactory.createFor(Mockito.any(InputFile.class))).thenReturn(fileLinesContext);
     CheckFactory checkFactory = new CheckFactory(activeRules);
-    return new IPynbSensor(fileLinesContextFactory, checkFactory, mock(NoSonarFilter.class), new NoSonarLineInfoCollector());
+    return new IPynbSensor(fileLinesContextFactory,
+      checkFactory,
+      mock(NoSonarFilter.class),
+      new NoSonarLineInfoCollector(),
+      new ProjectConfigurationBuilder());
   }
 
   @Test

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

@@ -43,10 +43,10 @@ class PythonExtensionsTest {
   void testGetExtensions() {
     Version v79 = Version.create(7, 9);
     SonarRuntime runtime = SonarRuntimeImpl.forSonarQube(v79, SonarQubeSide.SERVER, SonarEdition.DEVELOPER);
-    assertThat(extensions(runtime)).hasSize(42);
+    assertThat(extensions(runtime)).hasSize(43);
     assertThat(extensions(runtime)).contains(AnalysisWarningsWrapper.class);
     assertThat(extensions(SonarRuntimeImpl.forSonarLint(v79)))
-      .hasSize(22)
+      .hasSize(23)
       .contains(SonarLintCache.class);
   }