SONARPY-3084 Filter issues after the analysis if there are on a line with # NOSONAR(SXXXX) (#372)

GitOrigin-RevId: 7172c20adcbc6732f6c8f9aaeeec4e1bbab32954

Author: maksim-grebeniuk-sonarsource

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.NoSonarIssueFilter;
 import org.sonar.plugins.python.nosonar.NoSonarLineInfoCollector;
 import org.sonar.plugins.python.pylint.PylintRulesDefinition;
 import org.sonar.plugins.python.pylint.PylintSensor;
@@ -69,6 +70,7 @@ private PythonExtensions() {
   public static void addCommonExtensions(Plugin.Context context) {
     context.addExtensions(
       NoSonarLineInfoCollector.class,
+      NoSonarIssueFilter.class,
       buildPythonSuffix(),
       buildIpynbPythonSuffix(),
       buildPythonVersion(),

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

@@ -0,0 +1,58 @@
+/*
+ * 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 org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.scan.issue.filter.FilterableIssue;
+import org.sonar.api.scan.issue.filter.IssueFilter;
+import org.sonar.api.scan.issue.filter.IssueFilterChain;
+import org.sonar.api.scanner.ScannerSide;
+import org.sonarsource.api.sonarlint.SonarLintSide;
+
+@SonarLintSide
+@ScannerSide
+public class NoSonarIssueFilter implements IssueFilter {
+  private static final Logger LOG = LoggerFactory.getLogger(NoSonarIssueFilter.class);
+
+  private final NoSonarLineInfoCollector noSonarLineInfoCollector;
+
+  public NoSonarIssueFilter(NoSonarLineInfoCollector noSonarLineInfoCollector) {
+    this.noSonarLineInfoCollector = noSonarLineInfoCollector;
+  }
+
+  @Override
+  public boolean accept(FilterableIssue issue, IssueFilterChain chain) {
+    var issueLine = issue.line();
+    if (issueLine == null) {
+      return chain.accept(issue);
+    }
+    var issueComponentKey = issue.componentKey();
+
+    var noSonarLineInfos = noSonarLineInfoCollector.get(issueComponentKey);
+    var noSonarLineInfo = noSonarLineInfos.get(issueLine);
+    var isNotFilteredOutByNoSonar = noSonarLineInfo == null || !noSonarLineInfo.suppressedRuleKeys().contains(issue.ruleKey().rule());
+    if (!isNotFilteredOutByNoSonar) {
+      LOG.debug("Filtering out issue in the componen with key: {} for rule: {} on line: {} based on the file NoSonar infos {}",
+        issueComponentKey,
+        issue.ruleKey().rule(),
+        issueLine,
+        noSonarLineInfos.values());
+    }
+    return isNotFilteredOutByNoSonar && chain.accept(issue);
+  }
+}

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(41);
+    assertThat(extensions(runtime)).hasSize(42);
     assertThat(extensions(runtime)).contains(AnalysisWarningsWrapper.class);
     assertThat(extensions(SonarRuntimeImpl.forSonarLint(v79)))
-      .hasSize(21)
+      .hasSize(22)
       .contains(SonarLintCache.class);
   }
 

python-commons/src/test/java/org/sonar/plugins/python/nosonar/NoSonarIssueFilterTest.java

@@ -0,0 +1,65 @@
+/*
+ * 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.Map;
+import java.util.Set;
+import java.util.stream.Stream;
+import javax.annotation.Nullable;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.mockito.Mockito;
+import org.sonar.api.rule.RuleKey;
+import org.sonar.api.scan.issue.filter.FilterableIssue;
+import org.sonar.api.scan.issue.filter.IssueFilterChain;
+
+class NoSonarIssueFilterTest {
+  
+  @ParameterizedTest
+  @MethodSource("provideFilterParameters")
+  void test(
+    String componentKey, Map<Integer, NoSonarLineInfo> noSonarInfos, @Nullable Integer line, String ruleRepo, String ruleKey, boolean filterChainAcceptResult, boolean expectedResult) {
+
+    var collector = Mockito.mock(NoSonarLineInfoCollector.class);
+    Mockito.when(collector.get(componentKey))
+      .thenReturn(noSonarInfos);
+    var filter = new NoSonarIssueFilter(collector);
+
+    var issue = Mockito.mock(FilterableIssue.class);
+    Mockito.when(issue.componentKey()).thenReturn(componentKey);
+    Mockito.when(issue.line()).thenReturn(line);
+    Mockito.when(issue.ruleKey()).thenReturn(RuleKey.of(ruleRepo, ruleKey));
+
+    var filterChain = Mockito.mock(IssueFilterChain.class);
+    Mockito.when(filterChain.accept(issue)).thenReturn(filterChainAcceptResult);
+
+    var result = filter.accept(issue, filterChain);
+    Assertions.assertThat(result).isEqualTo(expectedResult);
+  }
+
+  private static Stream<Arguments> provideFilterParameters() {
+    return Stream.of(
+      Arguments.of("foo.py", Map.of(1, new NoSonarLineInfo(1, Set.of("my_rule"))), 1, "my_repo", "my_rule", true, false),
+      Arguments.of("foo.py", Map.of(1, new NoSonarLineInfo(1, Set.of("other_rule"))), 1, "my_repo", "my_rule", true, true),
+      Arguments.of("foo.py", Map.of(2, new NoSonarLineInfo(2, Set.of("my_rule"))), 1, "my_repo", "my_rule", true, true),
+      Arguments.of("foo.py", Map.of(1, new NoSonarLineInfo(1, Set.of("my_rule"))), null, "my_repo", "my_rule", true, true),
+      Arguments.of("foo.py", Map.of(1, new NoSonarLineInfo(1, Set.of("other_rule"))), 1, "my_repo", "my_rule", false, false)
+    );
+  }
+}