SONARIAC-1475 Should not throw ClassCastException when decorator contains a dot (#1548)

Author: petertrr

iac-extensions/arm/src/main/java/org/sonar/iac/arm/checks/elementsorder/ElementsOrderResourceCheckBicep.java

@@ -21,14 +21,21 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
+import javax.annotation.CheckForNull;
 import org.sonar.iac.arm.checks.ElementsOrderResourceCheck;
+import org.sonar.iac.arm.tree.ArmTreeUtils;
 import org.sonar.iac.arm.tree.api.FunctionCall;
+import org.sonar.iac.arm.tree.api.Identifier;
 import org.sonar.iac.arm.tree.api.Property;
+import org.sonar.iac.arm.tree.api.Variable;
 import org.sonar.iac.arm.tree.api.bicep.Decorator;
+import org.sonar.iac.arm.tree.api.bicep.MemberExpression;
 import org.sonar.iac.arm.tree.impl.bicep.ResourceDeclarationImpl;
 import org.sonar.iac.common.api.checks.CheckContext;
 import org.sonar.iac.common.api.checks.IacCheck;
 import org.sonar.iac.common.api.checks.InitContext;
+import org.sonar.iac.common.api.tree.impl.TextRange;
 import org.sonar.iac.common.api.tree.impl.TextRanges;
 
 /**
@@ -63,7 +70,9 @@ public class ElementsOrderResourceCheckBicep implements IacCheck {
     ELEMENTS_ORDER.put("properties", 100);
 
     DECORATORS_ORDER.put("description", 1);
+    DECORATORS_ORDER.put("sys.description", 1);
     DECORATORS_ORDER.put("batchSize", 2);
+    DECORATORS_ORDER.put("sys.batchSize", 2);
   }
 
   @Override
@@ -87,16 +96,51 @@ private static void checkResource(CheckContext checkContext, ResourceDeclaration
   private static void checkResourceDecorators(CheckContext checkContext, ResourceDeclarationImpl resourceDeclaration) {
     var prevIndex = 0;
     for (Decorator decorator : resourceDeclaration.decorators()) {
-      var identifier = ((FunctionCall) decorator.expression()).name();
-      var index = DECORATORS_ORDER.getOrDefault(identifier.value(), DEFAULT_ORDER_FOR_UNKNOWN_PROPERTY);
+      var valueAndHighlight = toValueAndHighlight(decorator);
+      if (valueAndHighlight == null) {
+        continue;
+      }
+      var index = DECORATORS_ORDER.getOrDefault(valueAndHighlight.value, DEFAULT_ORDER_FOR_UNKNOWN_PROPERTY);
       if (index < prevIndex) {
         var textRange = TextRanges.merge(
           decorator.keyword().textRange(),
-          identifier.textRange());
+          valueAndHighlight.highlight);
         checkContext.reportIssue(textRange, MESSAGE_DECORATOR);
         break;
       }
       prevIndex = index;
     }
   }
+
+  @CheckForNull
+  private static ValueAndHighlight toValueAndHighlight(Decorator decorator) {
+    if (decorator.expression() instanceof FunctionCall functionCall) {
+      var identifier = ArmTreeUtils.functionCallNameOrNull(functionCall);
+      return new ValueAndHighlight(identifier.value(), identifier.textRange());
+    } else if (decorator.expression() instanceof MemberExpression memberExpression) {
+      var prefix = Optional.ofNullable(memberExpression.memberAccess())
+        .filter(Variable.class::isInstance)
+        .map(it -> ((Variable) it).identifier())
+        .filter(Identifier.class::isInstance)
+        .map(it -> ((Identifier) it).value())
+        .map(it -> it + memberExpression.separatingToken().value())
+        .orElse(null);
+
+      var identifier = Optional.ofNullable(memberExpression.expression())
+        .map(ArmTreeUtils::functionCallNameOrNull)
+        .orElse(null);
+
+      if (identifier != null && prefix != null) {
+        var highlight = TextRanges.merge(
+          memberExpression.memberAccess().textRange(),
+          memberExpression.separatingToken().textRange(),
+          identifier.textRange());
+        return new ValueAndHighlight(prefix + identifier.value(), highlight);
+      }
+    }
+    return null;
+  }
+
+  record ValueAndHighlight(String value, TextRange highlight) {
+  }
 }

iac-extensions/arm/src/main/java/org/sonar/iac/arm/tree/ArmTreeUtils.java

@@ -34,6 +34,7 @@
 import org.sonar.iac.arm.tree.api.ArrayExpression;
 import org.sonar.iac.arm.tree.api.Expression;
 import org.sonar.iac.arm.tree.api.File;
+import org.sonar.iac.arm.tree.api.FunctionCall;
 import org.sonar.iac.arm.tree.api.HasIdentifier;
 import org.sonar.iac.arm.tree.api.Identifier;
 import org.sonar.iac.arm.tree.api.ParameterDeclaration;
@@ -132,4 +133,14 @@ public static <T extends ArmTree> Stream<T> findAllNodes(ArmTree tree, Class<T>
       .filter(type::isInstance)
       .map(type::cast));
   }
+
+  /**
+   * If the provided expression is a function call, return the function name, otherwise return null.
+   */
+  public static Identifier functionCallNameOrNull(Expression expression) {
+    if (expression instanceof FunctionCall functionCall) {
+      return functionCall.name();
+    }
+    return null;
+  }
 }

iac-extensions/arm/src/test/java/org/sonar/iac/arm/checks/ElementsOrderResourceCheckTest.java

@@ -93,9 +93,11 @@ void shouldVerifyUnexpectedResourceBicep(String filename) {
 
   @ParameterizedTest
   @ValueSource(strings = {"decoratorExpected.bicep",
+    "decoratorExpectedFullyQualified.bicep",
     "decoratorExpectedAndOthers.bicep",
     "decoratorExpectedBatchSizeOnly.bicep",
-    "decoratorExpectedDescriptionOnly.bicep"})
+    "decoratorExpectedDescriptionOnly.bicep"
+  })
   void shouldVerifyDecorator(String filename) {
     BicepVerifier.verifyNoIssue(DIR + filename, CHECK);
   }

iac-extensions/arm/src/test/java/org/sonar/iac/arm/tree/ArmTreeUtilsTest.java

@@ -0,0 +1,50 @@
+/*
+ * SonarQube IaC Plugin
+ * Copyright (C) 2021-2024 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.iac.arm.tree;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.sonar.iac.arm.parser.BicepParser;
+import org.sonar.iac.arm.parser.bicep.BicepLexicalGrammar;
+import org.sonar.iac.arm.tree.api.Expression;
+import org.sonar.iac.arm.tree.api.Identifier;
+
+class ArmTreeUtilsTest {
+  @Test
+  void shouldReturnFunctionNameForFunctionCall() {
+    var code = "foo()";
+    var expression = (Expression) BicepParser.create(BicepLexicalGrammar.EXPRESSION).parse(code);
+    var functionName = ArmTreeUtils.functionCallNameOrNull(expression);
+
+    Assertions.assertThat(functionName)
+      .isNotNull()
+      .extracting(Identifier::value)
+      .isEqualTo("foo");
+  }
+
+  @Test
+  void shouldReturnNullForNonFunctionCall() {
+    var code = "bar";
+    var expression = (Expression) BicepParser.create(BicepLexicalGrammar.EXPRESSION).parse(code);
+    var functionName = ArmTreeUtils.functionCallNameOrNull(expression);
+
+    Assertions.assertThat(functionName).isNull();
+  }
+}

iac-extensions/arm/src/test/resources/checks/ElementsOrderResource/decoratorExpectedFullyQualified.bicep

@@ -0,0 +1,11 @@
+@sys.description('some description')
+@batchSize(5)
+resource resourceName 'type@version' = {
+}
+
+// Compliant, because it's invalid syntax for decorators; the rule does nothing
+@foo::sys.description('some description')
+@foo.sys().batchSize(5)
+@foo.bar!.baz()
+resource resourceName1 'type@version' = {
+}