SONARPY-3086 Send rule IDs that are suppressed with NOSONAR through telemetry (#382)

GitOrigin-RevId: 1ab10f987c10c9145f28a8d6efa52e3c87f7f6ca

Author: thomas-serre-sonarsource

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

@@ -108,6 +108,7 @@ public void execute(SensorContext context) {
     } else {
       processNotebooksFiles(pythonFiles, context);
     }
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOSONAR_RULE_ID_KEYS, noSonarLineInfoCollector.getSuppressedRuleIds());
     sensorTelemetryStorage.send(context);
   }
 

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

@@ -141,7 +141,7 @@ public void execute(SensorContext context) {
     scanner.execute(pythonFiles, context);
 
     updateDatabricksTelemetry(scanner);
-
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOSONAR_RULE_ID_KEYS, noSonarLineInfoCollector.getSuppressedRuleIds());
     sensorTelemetryStorage.send(context);
     durationReport.stop();
   }

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

@@ -26,7 +26,8 @@ public enum TelemetryMetricKey {
   PYTHON_DATABRICKS_FOUND("python.notebook.databricks.python"),
   IPYNB_DATABRICKS_FOUND("python.notebook.databricks.ipynb"),
   PYTHON_DEPENDENCIES("python.dependencies"),
-  PYTHON_DEPENDENCIES_FORMAT_VERSION("python.dependencies.format_version");
+  PYTHON_DEPENDENCIES_FORMAT_VERSION("python.dependencies.format_version"),
+  NOSONAR_RULE_ID_KEYS("python.nosonar.rule_ids");
 
   private final String key;
 

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

@@ -160,4 +160,12 @@ private Set<String> parseNoSonarRules(String noSonarCommentLine) {
     return rules;
   }
 
+  public String getSuppressedRuleIds(){
+    return componentKeyToNoSonarLineInfoMap.values().stream()
+      .flatMap(map -> map.values().stream())
+      .flatMap(noSonarLineInfo -> noSonarLineInfo.suppressedRuleKeys().stream())
+      .distinct()
+      .sorted()
+      .collect(Collectors.joining(","));
+  }
 }

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

@@ -30,7 +30,7 @@ class NoSonarLineInfoCollectorTest {
 
   @ParameterizedTest
   @MethodSource("provideCollectorParameters")
-  void collector_test(String code, Map<Integer, NoSonarLineInfo> expectedLineInfos, Set<Integer> expectedEmptyNoSonarLines) {
+  void collector_test(String code, Map<Integer, NoSonarLineInfo> expectedLineInfos, Set<Integer> expectedEmptyNoSonarLines, String expectedSuppressedRuleIds) {
     var astNode = PythonParser.create().parse(code);
 
     var fileInput = new PythonTreeMaker().fileInput(astNode);
@@ -48,45 +48,53 @@ private static Stream<Arguments> provideCollectorParameters() {
           a = 1 # NOSONAR(something)
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of("something"))),
-        Set.of()
+        Set.of(),
+        "something"
       ),
       Arguments.of("""
           a = 1 # NOSONAR(one, two) some text
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of("one", "two"))),
-        Set.of()
+        Set.of(),
+        "one,two"
       ),
       Arguments.of("""
           a = 1 # NOSONAR()
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of())),
-        Set.of(1)
+        Set.of(1),
+        ""
       ),
       Arguments.of("""
           a = 1 # NOSONAR(something,)
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of("something"))),
-        Set.of()
+        Set.of(),
+        "something"
       ),
       Arguments.of("""
           a = 1 # NOSONAR
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of())),
-        Set.of(1)
+        Set.of(1),
+        ""
       ),
       Arguments.of("""
           a = 1 # NOSONAR some text
           """,
         Map.of(1, new NoSonarLineInfo(1, Set.of())),
-        Set.of(1)
+        Set.of(1),
+        ""
       ),
       Arguments.of("a = 1 # NOSONAR some text",
         Map.of(1, new NoSonarLineInfo(1, Set.of())),
-        Set.of(1)
+        Set.of(1),
+        ""
       ),
       Arguments.of("# NOSONAR some text",
         Map.of(1, new NoSonarLineInfo(1, Set.of())),
-        Set.of(1)
+        Set.of(1),
+        ""
       ),
       Arguments.of("""
           ""\"
@@ -102,7 +110,8 @@ private static Stream<Arguments> provideCollectorParameters() {
           4, new NoSonarLineInfo(4, Set.of()),
           5, new NoSonarLineInfo(5, Set.of())
         ),
-        Set.of(1, 2, 3, 4, 5)
+        Set.of(1, 2, 3, 4, 5),
+        ""
       )
     );
   }