SONARPY-2140 add containsSpreadOperator to Expressions (#1971)

Author: Seppli11

python-checks/src/main/java/org/sonar/python/checks/utils/Expressions.java

@@ -32,6 +32,7 @@
 import javax.annotation.Nullable;
 import org.sonar.plugins.python.api.symbols.Symbol;
 import org.sonar.plugins.python.api.symbols.Usage;
+import org.sonar.plugins.python.api.tree.Argument;
 import org.sonar.plugins.python.api.tree.AssignmentStatement;
 import org.sonar.plugins.python.api.tree.CallExpression;
 import org.sonar.plugins.python.api.tree.DictionaryLiteral;
@@ -379,4 +380,8 @@ public static boolean isGenericTypeAnnotation(Expression expression) {
       .filter(TYPE_VAR_FQN::equals)
       .isPresent();
   }
+
+  public static boolean containsSpreadOperator(List<Argument> arguments) {
+    return arguments.stream().anyMatch(UnpackingExpression.class::isInstance);
+  }
 }

python-checks/src/test/java/org/sonar/python/checks/utils/ExpressionsTest.java

@@ -22,7 +22,9 @@
 import java.util.ArrayList;
 import java.util.List;
 import org.junit.jupiter.api.Test;
+import org.sonar.plugins.python.api.tree.Argument;
 import org.sonar.plugins.python.api.tree.BaseTreeVisitor;
+import org.sonar.plugins.python.api.tree.CallExpression;
 import org.sonar.plugins.python.api.tree.Expression;
 import org.sonar.plugins.python.api.tree.FileInput;
 import org.sonar.plugins.python.api.tree.Name;
@@ -37,6 +39,7 @@
 import org.sonar.python.tree.TreeUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.sonar.python.checks.utils.Expressions.containsSpreadOperator;
 import static org.sonar.python.checks.utils.Expressions.getAssignedName;
 import static org.sonar.python.checks.utils.Expressions.isFalsy;
 import static org.sonar.python.checks.utils.Expressions.isTruthy;
@@ -213,6 +216,26 @@ void unescape_string_element_invalid_escape_sequences() {
 
   }
 
+  @Test
+  void testContainsSpreadOperator() {
+    assertThat(containsSpreadOperator(args("some(**some_dict)"))).isTrue();
+    assertThat(containsSpreadOperator(args("some(**{})"))).isTrue();
+    assertThat(containsSpreadOperator(args("some(1, test=True, **some_dict)"))).isTrue();
+    assertThat(containsSpreadOperator(args("some(*some_list)"))).isTrue();
+    assertThat(containsSpreadOperator(args("some(*[])"))).isTrue();
+    assertThat(containsSpreadOperator(args("some(1, test=True, *some_list)"))).isTrue();
+
+
+    assertThat(containsSpreadOperator(args("some(1, test=True)"))).isFalse();
+    assertThat(containsSpreadOperator(args("some()"))).isFalse();
+  }
+
+  private List<Argument> args(String source) {
+    Expression callExpr = exp(source);
+    assertThat(callExpr).isInstanceOf(CallExpression.class);
+    return ((CallExpression) callExpr).arguments();
+  }
+
   private StringElement stringElement(String source) {
     return stringLiteral(source).stringElements().get(0);
   }