SONARPY-3423 S112: Do not raise when exception is not instantiated in the function (#897)

GitOrigin-RevId: 501565ebf7df5fa9f9a83d924f48a023576f863f

Author: thomas-serre-sonarsource

python-checks/src/main/java/org/sonar/python/checks/GenericExceptionRaisedCheck.java

@@ -19,18 +19,31 @@
 import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
-import org.sonar.plugins.python.api.TriBool;
+import org.sonar.plugins.python.api.symbols.v2.SymbolV2;
+import org.sonar.plugins.python.api.symbols.v2.UsageV2;
 import org.sonar.plugins.python.api.tree.Expression;
+import org.sonar.plugins.python.api.tree.Name;
 import org.sonar.plugins.python.api.tree.RaiseStatement;
+import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.tree.Tree.Kind;
 import org.sonar.plugins.python.api.types.v2.PythonType;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatcher;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatchers;
+import org.sonar.python.tree.TreeUtils;
 
 import static org.sonar.plugins.python.api.types.BuiltinTypes.BASE_EXCEPTION;
 import static org.sonar.plugins.python.api.types.BuiltinTypes.EXCEPTION;
 
 @Rule(key = "S112")
 public class GenericExceptionRaisedCheck extends PythonSubscriptionCheck {
 
+  private final TypeMatcher isExceptionOrBaseExceptionMatcher = TypeMatchers.any(
+    TypeMatchers.isObjectOfType(EXCEPTION),
+    TypeMatchers.isObjectOfType(BASE_EXCEPTION),
+    TypeMatchers.isType(EXCEPTION),
+    TypeMatchers.isType(BASE_EXCEPTION)
+  );
+
   @Override
   public void initialize(Context context) {
     context.registerSyntaxNodeConsumer(Kind.RAISE_STMT, ctx -> {
@@ -39,13 +52,34 @@ public void initialize(Context context) {
       if (expressions.isEmpty()) {
         return;
       }
+
       Expression expression = expressions.get(0);
-      PythonType pythonType = expression.typeV2();
-      TriBool isException = ctx.typeChecker().typeCheckBuilder().isBuiltinWithName(EXCEPTION).check(pythonType);
-      TriBool isBaseException = ctx.typeChecker().typeCheckBuilder().isBuiltinWithName(BASE_EXCEPTION).check(pythonType);
-      if (isException == TriBool.TRUE || isBaseException == TriBool.TRUE) {
-        ctx.addIssue(expression, "Replace this generic exception class with a more specific one.");
+      if (!isExceptionOrBaseExceptionMatcher.isTrueFor(expression, ctx)) {
+        return;
       }
+      if (!isExceptionFunctionLocal(expression, raise)) {
+        return;
+      }
+
+      ctx.addIssue(expression, "Replace this generic exception class with a more specific one.");
     });
   }
+
+  private static boolean isExceptionFunctionLocal(Expression expression, RaiseStatement raise) {
+    if (!(expression instanceof Name name)) return true;
+    SymbolV2 symbolV2 = name.symbolV2();
+    return symbolV2 == null || isLocalVariable(symbolV2, raise);
+  }
+
+  private static boolean isLocalVariable(SymbolV2 symbol, Tree raiseStatement) {
+    Tree function = TreeUtils.firstAncestorOfKind(raiseStatement, Kind.FUNCDEF);
+    if (function == null) {
+      return false;
+    }
+
+    return symbol.getSingleBindingUsage()
+      .filter(u -> !u.kind().equals(UsageV2.Kind.PARAMETER))
+      .map(usage -> TreeUtils.firstAncestor(usage.tree(), t -> t == function) != null)
+      .orElse(false);
+  }
 }

python-checks/src/test/resources/checks/genericException/genericExceptionRaised.py

@@ -48,3 +48,10 @@ def python2_multiple_expressions(cond):
 
 def no_issue_with_self_return_type():
     raise MyException().with_traceback("foo")
+
+def raised_exception_is_the_parameter(exception: BaseException):
+    raise exception
+
+global_exception = BaseException()
+def raise_global_exception():
+    raise global_exception