SONARPY-3241: Add import telemetry metrics (#862)

Co-authored-by: joke1196 <david.kunzmann@sonarsource.com>
GitOrigin-RevId: f42b590fc398082eea83889e3c887a6ceaa3b594

Author: 2 people

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

@@ -47,6 +47,7 @@
 import org.sonar.plugins.python.editions.RepositoryInfoProvider.RepositoryInfo;
 import org.sonar.plugins.python.editions.RepositoryInfoProviderWrapper;
 import org.sonar.plugins.python.indexer.NamespacePackageTelemetry;
+import org.sonar.plugins.python.indexer.PackageResolutionResult;
 import org.sonar.plugins.python.indexer.PythonIndexer;
 import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarQubePythonIndexer;
@@ -226,7 +227,53 @@ private void updateNamespacePackageTelemetry(PythonIndexer pythonIndexer) {
       sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGES_WITHOUT_INIT, telemetry.packagesWithoutInit());
       sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_DUPLICATE_PACKAGES_WITHOUT_INIT, telemetry.duplicatePackagesWithoutInit());
       sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_NAMESPACE_PACKAGES_IN_REGULAR_PACKAGE, telemetry.namespacePackagesInRegularPackage());
+
+      updateResolutionMethodTelemetry(telemetry);
+      updateBuildSystemTelemetry(telemetry);
+    }
+  }
+
+  private void updateResolutionMethodTelemetry(NamespacePackageTelemetry telemetry) {
+    PackageResolutionResult.ResolutionMethod method = telemetry.resolutionMethod();
+    if (method == null) {
+      return;
+    }
+
+    // Report boolean flags for each resolution method
+    boolean usedPyproject = method == PackageResolutionResult.ResolutionMethod.PYPROJECT_TOML
+      || method == PackageResolutionResult.ResolutionMethod.PYPROJECT_AND_SETUP_PY;
+    boolean usedSetupPy = method == PackageResolutionResult.ResolutionMethod.SETUP_PY
+      || method == PackageResolutionResult.ResolutionMethod.PYPROJECT_AND_SETUP_PY;
+    boolean usedSonarSources = method == PackageResolutionResult.ResolutionMethod.SONAR_SOURCES;
+    boolean usedConventionalFolders = method == PackageResolutionResult.ResolutionMethod.CONVENTIONAL_FOLDERS;
+    boolean usedBaseDir = method == PackageResolutionResult.ResolutionMethod.BASE_DIR;
+
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_RESOLVED_VIA_PYPROJECT_TOML, usedPyproject ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_RESOLVED_VIA_SETUP_PY, usedSetupPy ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_RESOLVED_VIA_SONAR_SOURCES, usedSonarSources ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_RESOLVED_VIA_CONVENTIONAL_FOLDERS, usedConventionalFolders ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_RESOLVED_VIA_BASE_DIR, usedBaseDir ? 1 : 0);
+  }
+
+  private void updateBuildSystemTelemetry(NamespacePackageTelemetry telemetry) {
+    PackageResolutionResult.BuildSystem buildSystem = telemetry.buildSystem();
+    if (buildSystem == null) {
+      return;
     }
+
+    // Report boolean flags for each build system
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_SETUPTOOLS,
+      buildSystem == PackageResolutionResult.BuildSystem.SETUPTOOLS ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_POETRY,
+      buildSystem == PackageResolutionResult.BuildSystem.POETRY ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_HATCHLING,
+      buildSystem == PackageResolutionResult.BuildSystem.HATCHLING ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_UV_BUILD,
+      buildSystem == PackageResolutionResult.BuildSystem.UV_BUILD ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_PDM,
+      buildSystem == PackageResolutionResult.BuildSystem.PDM ? 1 : 0);
+    sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_PACKAGE_BUILD_SYSTEM_FLIT,
+      buildSystem == PackageResolutionResult.BuildSystem.FLIT ? 1 : 0);
   }
 
   private void updateSonarTestsTelemetry(SensorContext context) {

python-commons/src/main/java/org/sonar/plugins/python/indexer/NamespacePackageAnalyzer.java

@@ -57,7 +57,9 @@ public NamespacePackageTelemetry analyze(ProjectTree projectTree) {
       packagesWithInit,
       packagesWithoutInit,
       duplicatePackagesWithoutInit,
-      namespacePackagesInRegularPackage);
+      namespacePackagesInRegularPackage,
+      null,
+      null);
   }
 
   private static boolean hasAnyParentWithInit(ProjectTree.ProjectTreeFolder folder) {

python-commons/src/main/java/org/sonar/plugins/python/indexer/NamespacePackageTelemetry.java

@@ -16,22 +16,43 @@
  */
 package org.sonar.plugins.python.indexer;
 
+import javax.annotation.Nullable;
+
 /**
  * Telemetry data for namespace packages.
  * 
  * @param packagesWithInit The number of packages with an __init__.py file.
  * @param packagesWithoutInit The number of packages without an __init__.py file.
  * @param duplicatePackagesWithoutInit The number of packages without an __init__.py file that appear multiple times. Each occurrence increments this count.
  * @param namespacePackagesInRegularPackage The number of packages without an __init__.py file that have at least one parent with an __init__.py file.
+ * @param resolutionMethod How the package roots were resolved (e.g., pyproject.toml, setup.py, sonar.sources, fallback).
+ * @param buildSystem The build system identified when resolution method is PYPROJECT_TOML (e.g., setuptools, poetry).
  */
 public record NamespacePackageTelemetry(
   int packagesWithInit,
   int packagesWithoutInit,
   int duplicatePackagesWithoutInit,
-  int namespacePackagesInRegularPackage) {
+  int namespacePackagesInRegularPackage,
+  @Nullable PackageResolutionResult.ResolutionMethod resolutionMethod,
+  @Nullable PackageResolutionResult.BuildSystem buildSystem) {
 
   public static NamespacePackageTelemetry empty() {
-    return new NamespacePackageTelemetry(0, 0, 0, 0);
+    return new NamespacePackageTelemetry(0, 0, 0, 0, null, null);
+  }
+
+  /**
+   * Creates a new telemetry instance with resolution information added.
+   */
+  public NamespacePackageTelemetry withResolutionInfo(
+      PackageResolutionResult.ResolutionMethod method,
+      PackageResolutionResult.BuildSystem system) {
+    return new NamespacePackageTelemetry(
+      packagesWithInit,
+      packagesWithoutInit,
+      duplicatePackagesWithoutInit,
+      namespacePackagesInRegularPackage,
+      method,
+      system);
   }
 }
 

python-commons/src/main/java/org/sonar/plugins/python/indexer/PackageResolutionResult.java

@@ -0,0 +1,92 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource Sàrl
+ * 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.indexer;
+
+import java.util.List;
+
+/**
+ * Result of package root resolution containing both the resolved roots and
+ * information about how they were resolved.
+ *
+ * @param roots The resolved package root absolute paths
+ * @param method The method used to resolve the package roots
+ * @param buildSystem The build system identified (only applicable for PYPROJECT_TOML method)
+ */
+public record PackageResolutionResult(
+  List<String> roots,
+  ResolutionMethod method,
+  BuildSystem buildSystem) {
+
+  /**
+   * How the package roots were resolved.
+   */
+  public enum ResolutionMethod {
+    /** Resolved from pyproject.toml build configuration */
+    PYPROJECT_TOML,
+    /** Resolved from setup.py configuration */
+    SETUP_PY,
+    /** Resolved from both pyproject.toml and setup.py */
+    PYPROJECT_AND_SETUP_PY,
+    /** Resolved from sonar.sources property */
+    SONAR_SOURCES,
+    /** Resolved from conventional folders (src/, lib/) */
+    CONVENTIONAL_FOLDERS,
+    /** Fallback to project base directory */
+    BASE_DIR
+  }
+
+  /**
+   * Build systems supported in pyproject.toml.
+   */
+  public enum BuildSystem {
+    SETUPTOOLS,
+    POETRY,
+    HATCHLING,
+    UV_BUILD,
+    UV_BUILD_DEFAULT_MODULE,
+    PDM,
+    FLIT,
+    /** Multiple build systems detected */
+    MULTIPLE,
+    /** Used when resolution method is not PYPROJECT_TOML */
+    NONE
+  }
+
+  public static PackageResolutionResult fromPyProjectToml(List<String> roots, BuildSystem buildSystem) {
+    return new PackageResolutionResult(roots, ResolutionMethod.PYPROJECT_TOML, buildSystem);
+  }
+
+  public static PackageResolutionResult fromSetupPy(List<String> roots) {
+    return new PackageResolutionResult(roots, ResolutionMethod.SETUP_PY, BuildSystem.NONE);
+  }
+
+  public static PackageResolutionResult fromBothPyProjectAndSetupPy(List<String> roots, BuildSystem buildSystem) {
+    return new PackageResolutionResult(roots, ResolutionMethod.PYPROJECT_AND_SETUP_PY, buildSystem);
+  }
+
+  public static PackageResolutionResult fromSonarSources(List<String> roots) {
+    return new PackageResolutionResult(roots, ResolutionMethod.SONAR_SOURCES, BuildSystem.NONE);
+  }
+
+  public static PackageResolutionResult fromConventionalFolders(List<String> roots) {
+    return new PackageResolutionResult(roots, ResolutionMethod.CONVENTIONAL_FOLDERS, BuildSystem.NONE);
+  }
+
+  public static PackageResolutionResult fromBaseDir(List<String> roots) {
+    return new PackageResolutionResult(roots, ResolutionMethod.BASE_DIR, BuildSystem.NONE);
+  }
+}

python-commons/src/main/java/org/sonar/plugins/python/indexer/PyProjectExtractionResult.java

@@ -0,0 +1,41 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource Sàrl
+ * 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.indexer;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Result of extracting source roots from pyproject.toml, including the build system detected.
+ *
+ * @param configRoots The extracted source roots
+ * @param buildSystem The build system that provided the source roots
+ */
+public record PyProjectExtractionResult(ConfigSourceRoots configRoots, PackageResolutionResult.BuildSystem buildSystem){
+
+  public static PyProjectExtractionResult empty(File file) {
+    return new PyProjectExtractionResult(ConfigSourceRoots.empty(file), PackageResolutionResult.BuildSystem.NONE);
+  }
+
+  public boolean hasRoots() {
+    return !configRoots.relativeRoots().isEmpty();
+  }
+
+  public List<String> relativeRoots(){
+    return configRoots.relativeRoots();
+  }
+}