SONARPY-3083 Store line number and rules commented as NOSONAR(SXXXX, SYYYY) (#371)

GitOrigin-RevId: e92ba54f24ff5ef87dad37757137b7dc2e7b8678

Author: maksim-grebeniuk-sonarsource

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

@@ -38,6 +38,7 @@
 import org.sonar.plugins.python.editions.RepositoryInfoProvider.RepositoryInfo;
 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.caching.CacheContextImpl;
 import org.sonar.python.parser.PythonParser;
 
@@ -51,17 +52,23 @@ public final class IPynbSensor implements Sensor {
   private final PythonIndexer indexer;
   private static final String FAIL_FAST_PROPERTY_NAME = "sonar.internal.analysis.failFast";
   private final SensorTelemetryStorage sensorTelemetryStorage;
+  private final NoSonarLineInfoCollector noSonarLineInfoCollector;
 
-  public IPynbSensor(FileLinesContextFactory fileLinesContextFactory, CheckFactory checkFactory, NoSonarFilter noSonarFilter) {
-    this(fileLinesContextFactory, checkFactory, noSonarFilter, null, new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()});
+  public IPynbSensor(FileLinesContextFactory fileLinesContextFactory,
+    CheckFactory checkFactory,
+    NoSonarFilter noSonarFilter,
+    NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    this(fileLinesContextFactory, checkFactory, noSonarFilter, null, new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, noSonarLineInfoCollector);
   }
 
   public IPynbSensor(
     FileLinesContextFactory fileLinesContextFactory,
     CheckFactory checkFactory,
     NoSonarFilter noSonarFilter,
     @Nullable PythonIndexer indexer,
-    RepositoryInfoProvider[] editionMetadataProviders) {
+    RepositoryInfoProvider[] editionMetadataProviders,
+    NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    this.noSonarLineInfoCollector = noSonarLineInfoCollector;
 
     this.checks = createPythonChecks(checkFactory, editionMetadataProviders);
 
@@ -96,7 +103,7 @@ public void execute(SensorContext context) {
     }
     if (isInSonarLintRuntime(context)) {
       PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser::createIPythonParser,
-        indexer, new DummyArchitectureCallback());
+        indexer, new DummyArchitectureCallback(), noSonarLineInfoCollector);
       scanner.execute(pythonFiles, context);
     } else {
       processNotebooksFiles(pythonFiles, context);
@@ -110,7 +117,7 @@ private void processNotebooksFiles(List<PythonInputFile> pythonFiles, SensorCont
     CacheContext cacheContext = CacheContextImpl.dummyCache();
     PythonIndexer pythonIndexer = new SonarQubePythonIndexer(pythonFiles, cacheContext, context);
     PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser::createIPythonParser,
-      pythonIndexer, new DummyArchitectureCallback());
+      pythonIndexer, new DummyArchitectureCallback(), noSonarLineInfoCollector);
     scanner.execute(pythonFiles, context);
     sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOTEBOOK_RECOGNITION_ERROR_KEY, scanner.getRecognitionErrorCount());
     updateDatabricksTelemetry(scanner);

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

@@ -26,21 +26,29 @@
 import org.sonar.api.measures.FileLinesContextFactory;
 import org.sonar.api.measures.Metric;
 import org.sonar.plugins.python.api.PythonVisitorContext;
+import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
 import org.sonar.python.metrics.FileLinesVisitor;
 import org.sonar.python.metrics.FileMetrics;
 
 public class MeasuresRepository {
   private final SensorContext context;
   private final NoSonarFilter noSonarFilter;
   private final FileLinesContextFactory fileLinesContextFactory;
+  private final NoSonarLineInfoCollector noSonarLineInfoCollector;
   private final boolean isInSonarLint;
   private final Lock lock;
 
-  public MeasuresRepository(SensorContext context, NoSonarFilter noSonarFilter, FileLinesContextFactory fileLinesContextFactory, boolean isInSonarLint, Lock lock) {
+  public MeasuresRepository(SensorContext context,
+    NoSonarFilter noSonarFilter,
+    FileLinesContextFactory fileLinesContextFactory,
+    boolean isInSonarLint,
+    NoSonarLineInfoCollector noSonarLineInfoCollector,
+    Lock lock) {
     this.context = context;
     this.noSonarFilter = noSonarFilter;
     this.fileLinesContextFactory = fileLinesContextFactory;
     this.isInSonarLint = isInSonarLint;
+    this.noSonarLineInfoCollector = noSonarLineInfoCollector;
     this.lock = lock;
   }
 
@@ -57,7 +65,7 @@ private void saveInternal(PythonInputFile inputFile, PythonVisitorContext visito
     FileMetrics fileMetrics = new FileMetrics(visitorContext, isNotebook(inputFile));
     FileLinesVisitor fileLinesVisitor = fileMetrics.fileLinesVisitor();
 
-    processNoSonarInFile(inputFile, fileLinesVisitor);
+    processNoSonarInFile(inputFile);
 
     if (!isInSonarLint) {
       Set<Integer> linesOfCode = fileLinesVisitor.getLinesOfCode();
@@ -82,10 +90,11 @@ private void saveInternal(PythonInputFile inputFile, PythonVisitorContext visito
     }
   }
 
-  private void processNoSonarInFile(PythonInputFile inputFile, FileLinesVisitor fileLinesVisitor) {
+  private void processNoSonarInFile(PythonInputFile inputFile) {
     try {
       lock.lock();
-      noSonarFilter.noSonarInFile(inputFile.wrappedFile(), fileLinesVisitor.getLinesWithNoSonar());
+      var linesWithEmptyNosonar = noSonarLineInfoCollector.getLinesWithEmptyNoSonar(inputFile.wrappedFile().key());
+      noSonarFilter.noSonarInFile(inputFile.wrappedFile(), linesWithEmptyNosonar);
     } finally {
       lock.unlock();
     }

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

@@ -39,6 +39,7 @@
 import org.sonar.plugins.python.indexer.SonarLintPythonIndexer;
 import org.sonar.plugins.python.mypy.MypyRulesDefinition;
 import org.sonar.plugins.python.mypy.MypySensor;
+import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
 import org.sonar.plugins.python.pylint.PylintRulesDefinition;
 import org.sonar.plugins.python.pylint.PylintSensor;
 import org.sonar.plugins.python.ruff.RuffRulesDefinition;
@@ -67,6 +68,7 @@ private PythonExtensions() {
 
   public static void addCommonExtensions(Plugin.Context context) {
     context.addExtensions(
+      NoSonarLineInfoCollector.class,
       buildPythonSuffix(),
       buildIpynbPythonSuffix(),
       buildPythonVersion(),

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

@@ -51,6 +51,7 @@
 import org.sonar.plugins.python.api.tree.FileInput;
 import org.sonar.plugins.python.cpd.PythonCpdAnalyzer;
 import org.sonar.plugins.python.indexer.PythonIndexer;
+import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
 import org.sonar.python.IPythonLocation;
 import org.sonar.python.SubscriptionVisitor;
 import org.sonar.python.parser.PythonParser;
@@ -77,15 +78,17 @@ public class PythonScanner extends Scanner {
   private final PythonHighlighter pythonHighlighter;
   private final IssuesRepository issuesRepository;
   private final MeasuresRepository measuresRepository;
+  private final NoSonarLineInfoCollector noSonarLineInfoCollector;
   private final Lock lock;
 
   public PythonScanner(
     SensorContext context, PythonChecks checks, FileLinesContextFactory fileLinesContextFactory, NoSonarFilter noSonarFilter,
-    Supplier<PythonParser> parserSupplier, PythonIndexer indexer, PythonFileConsumer architectureCallback) {
+    Supplier<PythonParser> parserSupplier, PythonIndexer indexer, PythonFileConsumer architectureCallback, NoSonarLineInfoCollector noSonarLineInfoCollector) {
     super(context);
     this.checks = checks;
     this.parserSupplier = parserSupplier;
     this.indexer = indexer;
+    this.noSonarLineInfoCollector = noSonarLineInfoCollector;
     this.indexer.buildOnce(context);
     this.architectureCallback = architectureCallback;
     this.checksExecutedWithoutParsingByFiles = new ConcurrentHashMap<>();
@@ -97,7 +100,7 @@ public PythonScanner(
     this.newSymbolsCollector = new NewSymbolsCollector(lock);
     this.pythonHighlighter = new PythonHighlighter(lock);
     this.issuesRepository = new IssuesRepository(context, checks, indexer, isInSonarLint(context), lock);
-    this.measuresRepository = new MeasuresRepository(context, noSonarFilter, fileLinesContextFactory, isInSonarLint(context), lock);
+    this.measuresRepository = new MeasuresRepository(context, noSonarFilter, fileLinesContextFactory, isInSonarLint(context), noSonarLineInfoCollector, lock);
   }
 
   @Override
@@ -122,7 +125,16 @@ protected void scanFile(PythonInputFile inputFile) throws IOException {
 
     runLockedByRepository(ARCHITECTURE_CALLBACK_LOCK_KEY, () -> architectureCallback.scanFile(visitorContext));
 
-    issuesRepository.save(inputFile, visitorContext.getIssues());
+
+    noSonarLineInfoCollector.collect(pythonFile.key(), visitorContext.rootTree());
+
+    if (fileType == InputFile.Type.MAIN && visitorContext.rootTree() != null) {
+      pushTokens(inputFile, visitorContext);
+      measuresRepository.save(inputFile, visitorContext);
+    }
+
+    var issues = visitorContext.getIssues();
+    issuesRepository.save(inputFile, issues);
 
     if (visitorContext.rootTree() != null && !isInSonarLint(context)) {
       newSymbolsCollector.collect(context.newSymbolTable().onFile(inputFile.wrappedFile()), visitorContext.rootTree());
@@ -145,10 +157,7 @@ private PythonVisitorContext createVisitorContext(PythonInputFile inputFile, Pyt
         indexer.projectLevelSymbolTable(),
         indexer.cacheContext(),
         context.runtime().getProduct());
-      if (fileType == InputFile.Type.MAIN) {
-        pushTokens(inputFile, visitorContext);
-        measuresRepository.save(inputFile, visitorContext);
-      }
+
     } catch (RecognitionException e) {
       visitorContext = new PythonVisitorContext(pythonFile, e, context.runtime().getProduct());
 

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

@@ -47,6 +47,7 @@
 import org.sonar.plugins.python.indexer.PythonIndexer;
 import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarQubePythonIndexer;
+import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
 import org.sonar.plugins.python.warnings.AnalysisWarningsWrapper;
 import org.sonar.python.caching.CacheContextImpl;
 import org.sonar.python.parser.PythonParser;
@@ -77,6 +78,7 @@ public final class PythonSensor implements Sensor {
     """;
 
   private final SensorTelemetryStorage sensorTelemetryStorage;
+  private final NoSonarLineInfoCollector noSonarLineInfoCollector;
 
   public PythonSensor(
     FileLinesContextFactory fileLinesContextFactory,
@@ -87,7 +89,8 @@ public PythonSensor(
     SonarLintCacheWrapper sonarLintCacheWrapper,
     AnalysisWarningsWrapper analysisWarnings,
     RepositoryInfoProviderWrapper editionMetadataProviderWrapper,
-    ArchitectureCallbackWrapper architectureUDGBuilderWrapper) {
+    ArchitectureCallbackWrapper architectureUDGBuilderWrapper, NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    this.noSonarLineInfoCollector = noSonarLineInfoCollector;
 
     this.checks = createPythonChecks(checkFactory, editionMetadataProviderWrapper.infoProviders())
         .addCustomChecks(customRuleRepositoriesWrapper.customRuleRepositories());
@@ -134,7 +137,7 @@ public void execute(SensorContext context) {
     pythonIndexer.setSonarLintCache(sonarLintCache);
     TypeShed.setProjectLevelSymbolTable(pythonIndexer.projectLevelSymbolTable());
     PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser::create,
-      pythonIndexer, architectureCallback);
+      pythonIndexer, architectureCallback, noSonarLineInfoCollector);
     scanner.execute(pythonFiles, context);
 
     updateDatabricksTelemetry(scanner);

python-commons/src/main/java/org/sonar/plugins/python/nosonar/NoSonarLineInfo.java

@@ -0,0 +1,26 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 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 Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.plugins.python.nosonar;
+
+import java.util.Set;
+
+public record NoSonarLineInfo(Integer line, Set<String> suppressedRuleKeys) {
+
+  public boolean isSuppressedRuleKeysEmpty() {
+    return suppressedRuleKeys.isEmpty();
+  }
+}