Address review comments

Author: ghislainpiot

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

@@ -97,21 +97,25 @@ private void processNotebooksFiles(List<PythonInputFile> pythonFiles, SensorCont
     PythonIndexer pythonIndexer = new SonarQubePythonIndexer(pythonFiles, cacheContext, context);
     PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser.createIPythonParser(), pythonIndexer);
     scanner.execute(pythonFiles, context);
-    sensorTelemetryStorage.data.put(SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY, String.valueOf(scanner.getRecognitionErrorCount()));
+    sensorTelemetryStorage.updateMetric(SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY, String.valueOf(scanner.getRecognitionErrorCount()));
   }
 
   private List<PythonInputFile> parseNotebooks(List<PythonInputFile> pythonFiles, SensorContext context) {
     List<PythonInputFile> generatedIPythonFiles = new ArrayList<>();
 
-    sensorTelemetryStorage.data.put(SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY, String.valueOf(pythonFiles.size()));
-    final int[] numberOfFailedParsing = {0};
+    sensorTelemetryStorage.updateMetric(SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY, String.valueOf(pythonFiles.size()));
+    var numberOfFailedParsing = 0;
     var numberOfExceptions = 0;
 
     for (PythonInputFile inputFile : pythonFiles) {
       try {
-        sensorTelemetryStorage.data.put(SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY, "1");
+        sensorTelemetryStorage.updateMetric(SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY, "1");
         var result = IpynbNotebookParser.parseNotebook(inputFile);
-        result.ifPresentOrElse(generatedIPythonFiles::add, () -> numberOfFailedParsing[0]++);
+        if (result.isPresent()) {
+          generatedIPythonFiles.add(result.get());
+        } else {
+          numberOfFailedParsing++;
+        }
       } catch (Exception e) {
         numberOfExceptions++;
         if (context.config().getBoolean(FAIL_FAST_PROPERTY_NAME).orElse(false) && !isErrorOnTestFile(inputFile)) {
@@ -120,8 +124,8 @@ private List<PythonInputFile> parseNotebooks(List<PythonInputFile> pythonFiles,
       }
     }
 
-    sensorTelemetryStorage.data.put(SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY, String.valueOf(numberOfFailedParsing[0]));
-    sensorTelemetryStorage.data.put(SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY, String.valueOf(numberOfExceptions));
+    sensorTelemetryStorage.updateMetric(SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY, String.valueOf(numberOfFailedParsing));
+    sensorTelemetryStorage.updateMetric(SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY, String.valueOf(numberOfExceptions));
 
     return generatedIPythonFiles;
   }

sonar-python-plugin/src/main/java/org/sonar/plugins/python/SensorTelemetryStorage.java

@@ -25,20 +25,36 @@
 public class SensorTelemetryStorage {
   private static final Logger LOG = LoggerFactory.getLogger(SensorTelemetryStorage.class);
 
-  public static final String NOTEBOOK_PRESENT_KEY = "python.notebook.present";
-  public static final String NOTEBOOK_TOTAL_KEY = "python.notebook.total";
-  public static final String NOTEBOOK_PARSE_ERROR_KEY = "python.notebook.parse_error";
-  public static final String NOTEBOOK_RECOGNITION_ERROR_KEY = "python.notebook.recognition_error";
-  public static final String NOTEBOOK_EXCEPTION_KEY = "python.notebook.exceptions";
+  public static final MetricKey NOTEBOOK_PRESENT_KEY = new MetricKey("python.notebook.present");
+  public static final MetricKey NOTEBOOK_TOTAL_KEY = new MetricKey("python.notebook.total");
+  public static final MetricKey NOTEBOOK_PARSE_ERROR_KEY = new MetricKey("python.notebook.parse_error");
+  public static final MetricKey NOTEBOOK_RECOGNITION_ERROR_KEY = new MetricKey("python.notebook.recognition_error");
+  public static final MetricKey NOTEBOOK_EXCEPTION_KEY = new MetricKey("python.notebook.exceptions");
   final Map<String, String> data;
 
   public SensorTelemetryStorage() {
     data = new HashMap<>();
-    data.put(NOTEBOOK_PRESENT_KEY, "false");
+    data.put(NOTEBOOK_PRESENT_KEY.key(), "false");
   }
 
   public void send(SensorContext sensorContext) {
     data.forEach(sensorContext::addTelemetryProperty);
     data.forEach((k, v) -> LOG.info("Metrics property: {}={}", k, v));
   }
+
+  public void updateMetric(MetricKey key, String value) {
+    data.put(key.key(), value);
+  }
+
+  static class MetricKey {
+    private final String key;
+
+    private MetricKey(String key) {
+      this.key = key;
+    }
+
+    public String key() {
+      return key;
+    }
+  }
 }

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

@@ -218,11 +218,11 @@ void test_notebook_sensor_is_executed_on_json_file() {
     assertDoesNotThrow(() -> sensor.execute(context));
     assertThat(sensor.getSensorTelemetryStorage().data)
       .containsExactlyInAnyOrderEntriesOf(Map.of(
-        SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY, "1",
-        SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY, "0",
-        SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY, "0",
-        SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY, "1",
-        SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY, "0"));
+        SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY.key(), "1",
+        SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY.key(), "0",
+        SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY.key(), "0",
+        SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY.key(), "1",
+        SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY.key(), "0"));
   }
 
   @Test
@@ -236,7 +236,7 @@ void test_notebook_sensor_does_not_execute_cpd_measures() {
   }
 
   @Test
-  void test_notebook_sensor_parse_error_on_valid_line(){
+  void test_notebook_sensor_parse_error_on_valid_line() {
     inputFile("notebook_parse_error.ipynb");
     activeRules = new ActiveRulesBuilder().build();
     var sensor = notebookSensor();
@@ -245,10 +245,10 @@ void test_notebook_sensor_parse_error_on_valid_line(){
     assertThat(logs).contains("Unable to parse file: notebook_parse_error.ipynbParse error at line 1");
     assertThat(sensor.getSensorTelemetryStorage().data)
       .containsExactlyInAnyOrderEntriesOf(Map.of(
-        SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY, "1",
-        SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY, "0",
-        SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY, "1",
-        SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY, "0",
-        SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY, "1"));
+        SensorTelemetryStorage.NOTEBOOK_PRESENT_KEY.key(), "1",
+        SensorTelemetryStorage.NOTEBOOK_PARSE_ERROR_KEY.key(), "0",
+        SensorTelemetryStorage.NOTEBOOK_TOTAL_KEY.key(), "1",
+        SensorTelemetryStorage.NOTEBOOK_EXCEPTION_KEY.key(), "0",
+        SensorTelemetryStorage.NOTEBOOK_RECOGNITION_ERROR_KEY.key(), "1"));
   }
 }