SONARPY-919 Match / case statement: OR patterns (#986)

pynicolas · web-flow · commit 54e74cf2ae7c · 2021-11-05T19:55:27.000+01:00
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/BaseTreeVisitor.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/BaseTreeVisitor.java
@@ -496,6 +496,11 @@ public void visitAsPattern(AsPattern asPattern) {
     scan(asPattern.alias());
   }
 
+  @Override
+  public void visitOrPattern(OrPattern orPattern) {
+    scan(orPattern.patterns());
+  }
+
   @Override
   public void visitGuard(Guard guard) {
     scan(guard.condition());
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/OrPattern.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/OrPattern.java
@@ -0,0 +1,39 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2021 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 GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.python.api.tree;
+
+import java.util.List;
+
+/**
+ * OR pattern
+ *
+ * <pre>
+ *   case "foo" | "bar": ...
+ * </pre>
+ *
+ * See https://docs.python.org/3/reference/compound_stmts.html#or-patterns
+ */
+public interface OrPattern extends Pattern {
+
+  List<Pattern> patterns();
+
+  List<Token> separators();
+
+}
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/Tree.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/Tree.java
@@ -126,6 +126,8 @@ enum Kind {
 
     NUMERIC_LITERAL(NumericLiteral.class),
 
+    OR_PATTERN(OrPattern.class),
+
     PASS_STMT(PassStatement.class),
 
     PRINT_STMT(PrintStatement.class),
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/TreeVisitor.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/tree/TreeVisitor.java
@@ -181,6 +181,8 @@ public interface TreeVisitor {
 
   void visitAsPattern(AsPattern asPattern);
 
+  void visitOrPattern(OrPattern orPattern);
+
   void visitGuard(Guard guard);
 
   void visitCapturePattern(CapturePattern capturePattern);
diff --git a/python-frontend/src/main/java/org/sonar/python/api/PythonGrammar.java b/python-frontend/src/main/java/org/sonar/python/api/PythonGrammar.java
@@ -157,6 +157,7 @@ public enum PythonGrammar implements GrammarRuleKey {
   PATTERNS,
   PATTERN,
   AS_PATTERN,
+  OR_PATTERN,
   CLOSED_PATTERN,
   LITERAL_PATTERN,
   CAPTURE_PATTERN,
@@ -465,9 +466,10 @@ public static void compoundStatements(LexerfulGrammarBuilder b) {
     b.rule(GUARD).is("if", NAMED_EXPR_TEST);
 
     b.rule(PATTERNS).is(b.firstOf(OPEN_SEQUENCE_PATTERN, PATTERN));
-    b.rule(PATTERN).is(b.firstOf(AS_PATTERN, CLOSED_PATTERN));
+    b.rule(PATTERN).is(b.firstOf(AS_PATTERN, OR_PATTERN));
     b.rule(CLOSED_PATTERN).is(b.firstOf(LITERAL_PATTERN, CAPTURE_PATTERN, SEQUENCE_PATTERN));
-    b.rule(AS_PATTERN).is(CLOSED_PATTERN, "as", CAPTURE_PATTERN);
+    b.rule(AS_PATTERN).is(OR_PATTERN, "as", CAPTURE_PATTERN);
+    b.rule(OR_PATTERN).is(CLOSED_PATTERN, b.zeroOrMore("|", CLOSED_PATTERN));
     b.rule(CAPTURE_PATTERN).is(NAME);
 
     b.rule(SEQUENCE_PATTERN).is(b.firstOf(
diff --git a/python-frontend/src/main/java/org/sonar/python/tree/OrPatternImpl.java b/python-frontend/src/main/java/org/sonar/python/tree/OrPatternImpl.java
@@ -0,0 +1,73 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2021 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 GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.tree;
+
+import java.util.ArrayList;
+import java.util.List;
+import org.sonar.plugins.python.api.tree.OrPattern;
+import org.sonar.plugins.python.api.tree.Pattern;
+import org.sonar.plugins.python.api.tree.Token;
+import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.plugins.python.api.tree.TreeVisitor;
+
+public class OrPatternImpl extends PyTree implements OrPattern {
+
+  private final List<Pattern> patterns;
+  private final List<Token> separators;
+
+  public OrPatternImpl(List<Pattern> patterns, List<Token> separators) {
+    this.patterns = patterns;
+    this.separators = separators;
+  }
+
+  @Override
+  public List<Pattern> patterns() {
+    return patterns;
+  }
+
+  @Override
+  public List<Token> separators() {
+    return separators;
+  }
+
+  @Override
+  public void accept(TreeVisitor visitor) {
+    visitor.visitOrPattern(this);
+  }
+
+  @Override
+  public Kind getKind() {
+    return Tree.Kind.OR_PATTERN;
+  }
+
+  @Override
+  List<Tree> computeChildren() {
+    List<Tree> children = new ArrayList<>();
+    int i = 0;
+    for (Pattern element : patterns) {
+      children.add(element);
+      if (i < separators.size()) {
+        children.add(separators.get(i));
+      }
+      i++;
+    }
+    return children;
+  }
+}
diff --git a/python-frontend/src/main/java/org/sonar/python/tree/PythonTreeMaker.java b/python-frontend/src/main/java/org/sonar/python/tree/PythonTreeMaker.java
@@ -827,20 +827,31 @@ public Guard guard(AstNode guardNode) {
   }
 
   public static Pattern pattern(AstNode pattern) {
-    if (pattern.is(PythonGrammar.CLOSED_PATTERN)) {
-      return closedPattern(pattern);
+    if (pattern.is(PythonGrammar.OR_PATTERN)) {
+      return orPattern(pattern);
     }
     return asPattern(pattern);
   }
 
+  private static Pattern orPattern(AstNode pattern) {
+    List<Token> separators = punctuators(pattern, PythonPunctuator.OR);
+    if (separators.isEmpty()) {
+      return closedPattern(pattern.getFirstChild(PythonGrammar.CLOSED_PATTERN));
+    }
+    List<Pattern> patterns = pattern.getChildren(PythonGrammar.CLOSED_PATTERN).stream()
+      .map(PythonTreeMaker::closedPattern)
+      .collect(Collectors.toList());
+    return new OrPatternImpl(patterns, separators);
+  }
+
   private static AsPattern asPattern(AstNode asPattern) {
-    Pattern pattern = closedPattern(asPattern.getFirstChild(PythonGrammar.CLOSED_PATTERN));
+    Pattern pattern = orPattern(asPattern.getFirstChild(PythonGrammar.OR_PATTERN));
     Token asKeyword = toPyToken(asPattern.getFirstChild(PythonKeyword.AS).getToken());
     Name alias = name(asPattern.getFirstChild(PythonGrammar.CAPTURE_PATTERN).getFirstChild());
     return new AsPatternImpl(pattern, asKeyword, alias);
   }
 
-  private static Pattern closedPattern(AstNode closedPattern) {
+  public static Pattern closedPattern(AstNode closedPattern) {
     AstNode astNode = closedPattern.getFirstChild();
     if (astNode.is(PythonGrammar.LITERAL_PATTERN)) {
       return literalPattern(astNode);
diff --git a/python-frontend/src/test/java/org/sonar/plugins/python/api/tree/BaseTreeVisitorTest.java b/python-frontend/src/test/java/org/sonar/plugins/python/api/tree/BaseTreeVisitorTest.java
@@ -412,10 +412,21 @@ public void as_pattern() {
     verify(visitor).visitName(pattern.alias());
   }
 
+  @Test
+  public void or_pattern() {
+    setRootRule(PythonGrammar.OR_PATTERN);
+    OrPattern pattern = ((OrPattern) parse("'foo' | 'bar'", PythonTreeMaker::pattern));
+    FirstLastTokenVerifierVisitor visitor = spy(FirstLastTokenVerifierVisitor.class);
+    pattern.accept(visitor);
+
+    verify(visitor).visitLiteralPattern((LiteralPattern) pattern.patterns().get(0));
+    verify(visitor).visitLiteralPattern((LiteralPattern) pattern.patterns().get(1));
+  }
+
   @Test
   public void capture_pattern() {
     setRootRule(PythonGrammar.CLOSED_PATTERN);
-    CapturePattern pattern = ((CapturePattern) parse("x", PythonTreeMaker::pattern));
+    CapturePattern pattern = ((CapturePattern) parse("x", PythonTreeMaker::closedPattern));
     FirstLastTokenVerifierVisitor visitor = spy(FirstLastTokenVerifierVisitor.class);
     pattern.accept(visitor);
 
@@ -425,7 +436,7 @@ public void capture_pattern() {
   @Test
   public void sequence_pattern() {
     setRootRule(PythonGrammar.CLOSED_PATTERN);
-    SequencePattern pattern = ((SequencePattern) parse("[x, y]", PythonTreeMaker::pattern));
+    SequencePattern pattern = ((SequencePattern) parse("[x, y]", PythonTreeMaker::closedPattern));
     FirstLastTokenVerifierVisitor visitor = spy(FirstLastTokenVerifierVisitor.class);
     pattern.accept(visitor);
 
@@ -436,7 +447,7 @@ public void sequence_pattern() {
   @Test
   public void star_pattern() {
     setRootRule(PythonGrammar.CLOSED_PATTERN);
-    SequencePattern pattern = ((SequencePattern) parse("[x, *rest]", PythonTreeMaker::pattern));
+    SequencePattern pattern = ((SequencePattern) parse("[x, *rest]", PythonTreeMaker::closedPattern));
     FirstLastTokenVerifierVisitor visitor = spy(FirstLastTokenVerifierVisitor.class);
     pattern.accept(visitor);
 
diff --git a/python-frontend/src/test/java/org/sonar/python/tree/PythonTreeMakerMatchStatementTest.java b/python-frontend/src/test/java/org/sonar/python/tree/PythonTreeMakerMatchStatementTest.java
@@ -29,9 +29,11 @@
 import org.sonar.plugins.python.api.tree.ListLiteral;
 import org.sonar.plugins.python.api.tree.LiteralPattern;
 import org.sonar.plugins.python.api.tree.MatchStatement;
+import org.sonar.plugins.python.api.tree.OrPattern;
 import org.sonar.plugins.python.api.tree.Pattern;
 import org.sonar.plugins.python.api.tree.SequencePattern;
 import org.sonar.plugins.python.api.tree.StarPattern;
+import org.sonar.plugins.python.api.tree.Token;
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.tree.Tree.Kind;
 import org.sonar.plugins.python.api.tree.Tuple;
@@ -153,6 +155,16 @@ public void literal_patterns() {
     assertThat(literalPattern.valueAsString()).isEqualTo("False");
   }
 
+  @Test
+  public void or_pattern() {
+    OrPattern pattern = pattern("case 42 | None | True: ...");
+    assertThat(pattern.patterns()).extracting(p -> ((LiteralPattern) p).valueAsString()).containsExactly("42", "None", "True");
+    assertThat(pattern.separators()).extracting(Token::value).containsExactly("|", "|");
+
+    AsPattern asPattern = pattern("case 'foo' | 'bar' as x: ...");
+    assertThat(asPattern.pattern().getKind()).isEqualTo(Kind.OR_PATTERN);
+  }
+
   @Test
   public void as_pattern() {
     setRootRule(PythonGrammar.CASE_BLOCK);
