SONARPY-3808 Add telemetry key that checks if sonar.tests is set (#865)

GitOrigin-RevId: e3ef416f52432d4f59fbf45d83fde18ad6f09862

Author: marc-jasper-sonarsource

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

@@ -156,6 +156,7 @@ public void execute(SensorContext context) {
     scanner.execute(pythonFiles, context);
     Duration sensorTime = Duration.between(sensorStartTime, Instant.now());
 
+    updateSonarTestsTelemetry(context);
     updateDatabricksTelemetry(scanner);
     updateTypeInferenceTelemetry(scanner);
     updateTestFileTelemetry(scanner);
@@ -228,6 +229,14 @@ private void updateNamespacePackageTelemetry(PythonIndexer pythonIndexer) {
     }
   }
 
+  private void updateSonarTestsTelemetry(SensorContext context) {
+    if (context.runtime().getProduct() == SonarProduct.SONARLINT) {
+      return;
+    }
+    boolean sonarTestsSet = context.config().get("sonar.tests").isPresent();
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_SONAR_TESTS_SET, sonarTestsSet);
+  }
+
   private void updatePythonVersionTelemetry(SensorContext context, String[] pythonVersionParameter) {
     if (context.runtime().getProduct() == SonarProduct.SONARLINT) {
       return;

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

@@ -59,7 +59,8 @@ public enum TelemetryMetricKey {
   PYTHON_MAIN_FILES_MISCLASSIFIED_IMPORT_BASED_ONLY("python.files.main.misclassified_import_based_only"),
   PYTHON_MAIN_LINES_MISCLASSIFIED_IMPORT_BASED_ONLY("python.lines.main.misclassified_import_based_only"),
   PYTHON_MAIN_FILES_MISCLASSIFIED_PATH_BASED_ONLY("python.files.main.misclassified_path_based_only"),
-  PYTHON_MAIN_LINES_MISCLASSIFIED_PATH_BASED_ONLY("python.lines.main.misclassified_path_based_only");
+  PYTHON_MAIN_LINES_MISCLASSIFIED_PATH_BASED_ONLY("python.lines.main.misclassified_path_based_only"),
+  PYTHON_SONAR_TESTS_SET("python.sonar_tests.set");
 
   private final String key;
 

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

@@ -1531,6 +1531,35 @@ void send_telemetry_no_version() {
     verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_VERSION_SET_KEY.key(), "0");
   }
 
+  @Test
+  void send_telemetry_sonar_tests_set() {
+    activeRules = new ActiveRulesBuilder()
+      .addRule(new NewActiveRule.Builder()
+        .setRuleKey(RuleKey.of(PythonRuleRepository.REPOSITORY_KEY, "S930"))
+        .build())
+      .build();
+
+    context.setSettings(new MapSettings().setProperty("sonar.tests", "tests"));
+    var contextSpy = spy(context);
+    PythonSensor sensor = sensor();
+    sensor.execute(contextSpy);
+    verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_SONAR_TESTS_SET.key(), "1");
+  }
+
+  @Test
+  void send_telemetry_sonar_tests_not_set() {
+    activeRules = new ActiveRulesBuilder()
+      .addRule(new NewActiveRule.Builder()
+        .setRuleKey(RuleKey.of(PythonRuleRepository.REPOSITORY_KEY, "S930"))
+        .build())
+      .build();
+
+    PythonSensor sensor = sensor();
+    var contextSpy = spy(context);
+    sensor.execute(contextSpy);
+    verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_SONAR_TESTS_SET.key(), "0");
+  }
+
   @Test
   void detects_databricks() {
     activeRules = new ActiveRulesBuilder()