SONARPY-3407 Untangling PythonTreeMaker and ExceptGroupJumpInstructionsCheck (#535)

GitOrigin-RevId: c445837fcbbf056855af47b66ae5c5361129edec

Author: joke1196

python-frontend/src/main/java/org/sonar/python/tree/ExceptGroupJumpInstructionsCheck.java

@@ -48,7 +48,7 @@ public void visitReturnStatement(ReturnStatement returnStatement) {
   private static void checkExceptGroupStatement(Tree statement, String message, Tree.Kind... possibleParents) {
     Tree parent = TreeUtils.firstAncestorOfKind(statement, possibleParents);
     if (parent != null && parent.is(Tree.Kind.EXCEPT_GROUP_CLAUSE)) {
-      PythonTreeMaker.recognitionException(statement.firstToken().line(), message);
+      PythonTreeMakerUtils.throwRecognitionException(statement.firstToken().line(), message);
     }
   }
 }

python-frontend/src/main/java/org/sonar/python/tree/PythonTreeMaker.java

@@ -18,7 +18,6 @@
 
 import com.sonar.sslr.api.AstNode;
 import com.sonar.sslr.api.GenericTokenType;
-import com.sonar.sslr.api.RecognitionException;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -121,10 +120,6 @@ public FileInput fileInput(AstNode astNode) {
     return pyFileInputTree;
   }
 
-  public static void recognitionException(int line, String message) {
-    throw new RecognitionException(line, "Parse error at line " + line + ": " + message + ".");
-  }
-
   protected Token toPyToken(@Nullable com.sonar.sslr.api.Token token) {
     if (token == null) {
       return null;
@@ -839,10 +834,10 @@ public void checkExceptClauses(List<ExceptClause> excepts) {
     Tree.Kind firstExceptKind = excepts.get(0).getKind();
     for (ExceptClause except : excepts) {
       if (firstExceptKind != except.getKind()) {
-        recognitionException(except.exceptKeyword().line(), "Try statement cannot contain both except and except* clauses");
+        PythonTreeMakerUtils.throwRecognitionException(except.exceptKeyword().line(), "Try statement cannot contain both except and except* clauses");
       }
       if (except.is(Tree.Kind.EXCEPT_GROUP_CLAUSE) && except.exception() == null) {
-        recognitionException(except.exceptKeyword().line(), "except* clause must specify the type of the expected exception");
+        PythonTreeMakerUtils.throwRecognitionException(except.exceptKeyword().line(), "except* clause must specify the type of the expected exception");
       }
     }
   }
@@ -1010,7 +1005,7 @@ private static void checkPositionalAndKeywordArgumentsConstraint(List<Pattern> p
         positionalArgs = false;
       } else if (!positionalArgs) {
         int line = pattern.firstToken().line();
-        recognitionException(line, "Positional patterns follow keyword patterns");
+        PythonTreeMakerUtils.throwRecognitionException(line, "Positional patterns follow keyword patterns");
       }
     }
   }
@@ -1295,7 +1290,7 @@ private Expression assignmentExpression(AstNode astNode) {
     Expression nameExpression = expression(nameNode);
     if (!nameExpression.is(Tree.Kind.NAME)) {
       int line = nameNode.getTokenLine();
-      recognitionException(line, "The left-hand side of an assignment expression must be a name");
+      PythonTreeMakerUtils.throwRecognitionException(line, "The left-hand side of an assignment expression must be a name");
     }
     Name name = (Name) nameExpression;
     AstNode operatorNode = astNode.getFirstChild(PythonPunctuator.WALRUS_OPERATOR);
@@ -1557,7 +1552,7 @@ private static void checkGeneratorExpressionInArgument(List<Argument> arguments)
       .collect(Collectors.toList());
     if (!nonParenthesizedGeneratorExpressions.isEmpty() && arguments.size() > 1) {
       int line = nonParenthesizedGeneratorExpressions.get(0).firstToken().line();
-      recognitionException(line, "Generator expression must be parenthesized if not sole argument");
+      PythonTreeMakerUtils.throwRecognitionException(line, "Generator expression must be parenthesized if not sole argument");
     }
   }
 

python-frontend/src/main/java/org/sonar/python/tree/PythonTreeMakerUtils.java

@@ -0,0 +1,27 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource SA
+ * 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.python.tree;
+
+import com.sonar.sslr.api.RecognitionException;
+
+public class PythonTreeMakerUtils {
+
+  private PythonTreeMakerUtils(){}
+  public static void throwRecognitionException(int line, String message) {
+    throw new RecognitionException(line, "Parse error at line " + line + ": " + message + ".");
+  }
+}

python-frontend/src/test/java/org/sonar/python/tree/PythonTreeMakerTest.java

@@ -120,6 +120,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.assertj.core.api.Assertions.fail;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertThrowsExactly;
 
 class PythonTreeMakerTest extends RuleTest {
@@ -1520,6 +1521,15 @@ void try_statement() {
     assertThat(children.get(children.size() - 2)).isSameAs(tryStatement.elseClause());
     assertThat(children.get(children.size() - 1)).isSameAs(tryStatement.finallyClause());
 
+    var ast = p.parse("try:\n    pass\nexcept* :\n    pass");
+    Exception exception = assertThrows(RecognitionException.class, () -> treeMaker.tryStatement(ast));
+
+    assertThat(exception.getMessage()).isEqualTo("Parse error at line 3: except* clause must specify the type of the expected exception.");
+
+    var astExcept = p.parse("try:\n    pass\nexcept Error:\n    pass\nexcept* Error:\n    pass");
+    exception = assertThrows(RecognitionException.class, () -> treeMaker.tryStatement(astExcept));
+
+    assertThat(exception.getMessage()).isEqualTo("Parse error at line 5: Try statement cannot contain both except and except* clauses.");
   }
 
   @Test

python-frontend/src/test/java/org/sonar/python/tree/PythonTreeMakerUtilsTest.java

@@ -0,0 +1,33 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource SA
+ * 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.python.tree;
+
+import com.sonar.sslr.api.RecognitionException;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.assertj.core.api.Assertions.assertThat;
+
+class PythonTreeMakerUtilsTest {
+
+  @Test
+  void shouldThrowTheExceptionWithTheProvidedMessage(){
+    Exception exception = assertThrows(RecognitionException.class, () -> PythonTreeMakerUtils.throwRecognitionException(12, "TEST"));
+    assertThat(exception.getMessage()).isEqualTo("Parse error at line 12: TEST.");
+  }
+}
+