SONARPY-3781 Detect package root from setup.py (#847)

GitOrigin-RevId: 549d33f6887bc6624be25eb09e74753d09095ebb

Author: thomas-serre-sonarsource

…thon/indexer/BuildSystemSourceRoots.java …on/indexer/PyProjectTomlSourceRoots.javapython-commons/src/main/java/org/sonar/plugins/python/indexer/BuildSystemSourceRoots.java renamed to python-commons/src/main/java/org/sonar/plugins/python/indexer/PyProjectTomlSourceRoots.java python-commons/src/main/java/org/sonar/plugins/python/indexer/BuildSystemSourceRoots.java renamed to python-commons/src/main/java/org/sonar/plugins/python/indexer/PyProjectTomlSourceRoots.java

@@ -44,15 +44,15 @@
  *   <li>Flit: auto-detects src/ layout by convention</li>
  * </ul>
  */
-public class BuildSystemSourceRoots {
+public class PyProjectTomlSourceRoots {
 
   private static final TomlMapper TOML_MAPPER = new TomlMapper();
 
   static {
     TOML_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
   }
 
-  private BuildSystemSourceRoots() {
+  private PyProjectTomlSourceRoots() {
   }
 
   /**
@@ -149,7 +149,7 @@ private static List<String> extractFromHatchling(@Nullable Hatch hatch) {
     // Fall back to parsing directory from packages
     if (!wheel.packages().isEmpty()) {
       return wheel.packages().stream()
-        .map(BuildSystemSourceRoots::extractDirectoryFromPackagePath)
+        .map(PyProjectTomlSourceRoots::extractDirectoryFromPackagePath)
         .filter(dir -> dir != null && !dir.isEmpty())
         .distinct()
         .toList();

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

@@ -0,0 +1,150 @@
+/*
+ * 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 com.sonar.sslr.api.AstNode;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.tree.AssignmentStatement;
+import org.sonar.plugins.python.api.tree.BaseTreeVisitor;
+import org.sonar.plugins.python.api.tree.CallExpression;
+import org.sonar.plugins.python.api.tree.DictionaryLiteral;
+import org.sonar.plugins.python.api.tree.Expression;
+import org.sonar.plugins.python.api.tree.ExpressionList;
+import org.sonar.plugins.python.api.tree.FileInput;
+import org.sonar.plugins.python.api.tree.KeyValuePair;
+import org.sonar.plugins.python.api.tree.Name;
+import org.sonar.plugins.python.api.tree.RegularArgument;
+import org.sonar.plugins.python.api.tree.StringLiteral;
+import org.sonar.python.parser.PythonParser;
+import org.sonar.python.tree.PythonTreeMaker;
+import org.sonar.python.tree.TreeUtils;
+
+/**
+ * Extracts source root directories from setup.py files.
+ */
+public class SetupPySourceRoots {
+
+  private SetupPySourceRoots() {
+  }
+
+  public static List<String> extract(String setupPyContent) {
+    try {
+      PythonParser parser = PythonParser.create();
+      AstNode astNode = parser.parse(setupPyContent);
+      PythonTreeMaker treeMaker = new PythonTreeMaker();
+      FileInput fileInput = treeMaker.fileInput(astNode);
+
+      SetupCallVisitor visitor = new SetupCallVisitor();
+      fileInput.accept(visitor);
+
+      return new ArrayList<>(visitor.sourceRoots);
+    } catch (Exception e) {
+      return List.of();
+    }
+  }
+
+  private static class SetupCallVisitor extends BaseTreeVisitor {
+    private final Set<String> sourceRoots = new LinkedHashSet<>();
+    private final Map<String, Expression> variables = new HashMap<>();
+
+    @Override
+    public void visitAssignmentStatement(AssignmentStatement assignmentStatement) {
+      ExpressionList lhs = assignmentStatement.lhsExpressions().get(0);
+      if (lhs.expressions().size() == 1 && lhs.expressions().get(0) instanceof Name name) {
+        variables.put(name.name(), assignmentStatement.assignedValue());
+      }
+      super.visitAssignmentStatement(assignmentStatement);
+    }
+
+    @Override
+    public void visitCallExpression(CallExpression callExpression) {
+      Expression callee = callExpression.callee();
+
+      if (callee instanceof Name name && "setup".equals(name.name())) {
+        RegularArgument packagesArgument = TreeUtils.argumentByKeyword("packages", callExpression.arguments());
+        if (packagesArgument != null) {
+          Expression packagesExpr = resolveExpression(packagesArgument.expression());
+          if (packagesExpr instanceof CallExpression call) {
+            extractFromFindPackages(call);
+          }
+        }
+
+        RegularArgument packageDirArgument = TreeUtils.argumentByKeyword("package_dir", callExpression.arguments());
+        if (packageDirArgument != null) {
+          Expression packageDirExpr = resolveExpression(packageDirArgument.expression());
+          if (packageDirExpr instanceof DictionaryLiteral dictLiteral) {
+            extractFromDictionary(dictLiteral);
+          } else if (packageDirExpr instanceof CallExpression call) {
+            extractFromFindPackages(call);
+          }
+        }
+      }
+
+      super.visitCallExpression(callExpression);
+    }
+
+    private void extractFromDictionary(DictionaryLiteral dictLiteral) {
+      for (var element : dictLiteral.elements()) {
+        if (element instanceof KeyValuePair keyValuePair) {
+          Expression value = keyValuePair.value();
+          String resolvedValue = resolveToString(value);
+          if (resolvedValue != null && !resolvedValue.isEmpty()) {
+            sourceRoots.add(resolvedValue);
+          }
+        }
+      }
+    }
+
+    private void extractFromFindPackages(CallExpression callExpression) {
+      Expression callee = callExpression.callee();
+      if (callee instanceof Name name && "find_packages".equals(name.name())) {
+        RegularArgument whereArgument = TreeUtils.argumentByKeyword("where", callExpression.arguments());
+        if(whereArgument!= null) {
+          String whereValue = resolveToString(whereArgument.expression());
+          if (whereValue != null && !whereValue.isEmpty()) {
+            sourceRoots.add(whereValue);
+          }
+        }
+      }
+    }
+
+    @Nullable
+    private String resolveToString(Expression expression) {
+      Expression resolved = resolveExpression(expression);
+      if (resolved instanceof StringLiteral stringLiteral) {
+        return stringLiteral.trimmedQuotesValue();
+      }
+      return null;
+    }
+
+    private Expression resolveExpression(Expression expression) {
+      if (expression instanceof Name name) {
+        Expression resolved = variables.get(name.name());
+        if (resolved != null) {
+          return resolveExpression(resolved);
+        }
+      }
+      return expression;
+    }
+  }
+}