HCL: fix possible NPE-s, in List.of() and asString()

apache · Apr 21, 2024 · 383ffa3 · 383ffa3
1 parent 553bcec
commit 383ffa3
Show file tree

Hide file tree

Showing 16 changed files with 329 additions and 40 deletions.
diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLArithmeticOperation.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLArithmeticOperation.java
@@ -19,6 +19,8 @@
 package org.netbeans.modules.languages.hcl.ast;
 
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.Stream;
 
 /**
  *
@@ -64,24 +66,26 @@ public String toString() {
     public record Binary(Operator op, HCLExpression left, HCLExpression right) implements HCLArithmeticOperation {
         @Override
         public String asString() {
-            return left.toString() + op.toString() + right.toString();
+            return HCLExpression.asString(left) + op.toString() + HCLExpression.asString(right);
         }
 
         @Override
         public List<? extends HCLExpression> elements() {
-            return List.of(left, right);
+            return Stream.of(left, right)
+                    .filter(Objects::nonNull)
+                    .toList();
         }
     } 
 
     public record Unary(Operator op, HCLExpression operand) implements HCLArithmeticOperation {
         @Override
         public String asString() {
-            return op.toString() + operand.toString();
+            return op.toString() + HCLExpression.asString(operand);
         }
 
         @Override
         public List<? extends HCLExpression> elements() {
-            return List.of(operand);
+            return operand != null ? List.of(operand) : List.of();
         }
     } 
 }
diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLCollection.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLCollection.java
@@ -19,7 +19,9 @@
 package org.netbeans.modules.languages.hcl.ast;
 
 import java.util.List;
+import java.util.Objects;
 import java.util.StringJoiner;
+import java.util.stream.Stream;
 
 /**
  *
@@ -37,7 +39,7 @@ public record Tuple(List<HCLExpression> elements) implements  HCLCollection<HCLE
         public String asString() {
             StringJoiner sj = new StringJoiner(",", "[", "]");
             for (HCLExpression element : elements) {
-                sj.add(element.asString());
+                sj.add(HCLExpression.asString(element));
             }
             return sj.toString();
         }
@@ -47,12 +49,14 @@ public String asString() {
     public record ObjectElement(HCLExpression key, HCLExpression value) implements HCLExpression {
         @Override
         public String asString() {
-            return key.asString() + "=" + value.asString();
+            return HCLExpression.asString(key) + "=" + HCLExpression.asString(value);
         }
 
         @Override
         public List<? extends HCLExpression> elements() {
-            return List.of(key, value);
+            return Stream.of(key, value)
+                    .filter(Objects::nonNull)
+                    .toList();
         }
     }
 
@@ -66,7 +70,7 @@ public record Object(List<ObjectElement> elements) implements HCLCollection<Obje
         public String asString() {
             StringJoiner sj = new StringJoiner(",", "{", "}");
             for (ObjectElement element : elements) {
-                sj.add(element.toString());
+                sj.add(HCLExpression.asString(element));
             }
             return sj.toString();
         }        

diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLConditionalOperation.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLConditionalOperation.java
@@ -18,8 +18,9 @@
  */
 package org.netbeans.modules.languages.hcl.ast;
 
-import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.Stream;
 
 /**
  *
@@ -29,12 +30,14 @@ public record HCLConditionalOperation(HCLExpression condition, HCLExpression tru
 
     @Override
     public String asString() {
-        return condition.toString() + "?" + trueValue.toString() + ":" + falseValue.toString();
+        return HCLExpression.asString(condition) + "?" + HCLExpression.asString(trueValue) + ":" + HCLExpression.asString(falseValue);
     }
 
     @Override
     public List<? extends HCLExpression> elements() {
-        return Arrays.asList(condition, trueValue, falseValue);
+        return Stream.of(condition, trueValue, falseValue)
+                .filter(Objects::nonNull)
+                .toList();
     }
 
 

diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLElement.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLElement.java
@@ -24,6 +24,6 @@
  *
  * @author Laszlo Kishalmi
  */
-public sealed interface HCLElement permits HCLExpression, HCLIdentifier, HCLContainer, HCLAttribute {
+public sealed interface HCLElement permits HCLExpression, HCLContainer, HCLAttribute {
     List<? extends HCLElement> elements();
 }
diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLExpression.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLExpression.java
@@ -36,17 +36,18 @@ public sealed interface HCLExpression extends HCLElement permits
         HCLConditionalOperation,
         HCLForExpression,
         HCLFunction,
+        HCLIdentifier,
         HCLLiteral,
         HCLResolveOperation,
         HCLTemplate,
         HCLVariable {
 
-    public static HCLExpression parse(String expr) {
-        HCLLexer lexer = new HCLLexer(CharStreams.fromString(expr));
-        HCLParser parser = new HCLParser(new CommonTokenStream(lexer));
-        return new HCLExpressionFactory().process(parser.expression());
+
+    public static String asString(HCLExpression expr) {
+        return expr != null ? expr.asString() : "";
     }
 
+    @Override
     default List<? extends HCLExpression> elements() {
         return Collections.emptyList();
     }

diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLForExpression.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLForExpression.java
@@ -19,6 +19,8 @@
 package org.netbeans.modules.languages.hcl.ast;
 
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.Stream;
 
 /**
  *
@@ -39,10 +41,10 @@ public String asString() {
             StringBuilder sb = new StringBuilder();
             sb.append("[for ");
             if (keyVar != null) {
-                sb.append(keyVar).append(',');
+                sb.append(keyVar.asString()).append(',');
             }
-            sb.append(valueVar).append(" in ").append(iterable.asString()).append(':');
-            sb.append(result.asString());
+            sb.append(HCLExpression.asString(valueVar)).append(" in ").append(HCLExpression.asString(iterable)).append(':');
+            sb.append(HCLExpression.asString(result));
             if (condition != null) { 
                 sb.append(" if ").append(condition.asString());
             }
@@ -52,7 +54,9 @@ public String asString() {
 
         @Override
         public List<? extends HCLExpression> elements() {
-            return List.of(iterable, result, condition);
+            return Stream.of(iterable, result, condition)
+                    .filter(Objects::nonNull)
+                    .toList();
         }
     }
 
@@ -62,10 +66,10 @@ public String asString() {
             StringBuilder sb = new StringBuilder();
             sb.append("{for ");
             if (keyVar != null) {
-                sb.append(keyVar).append(',');
+                sb.append(keyVar.asString()).append(',');
             }
-            sb.append(valueVar).append(" in ").append(iterable.asString()).append(':');
-            sb.append(resultKey.asString()).append("=>").append(resultValue.asString());
+            sb.append(HCLExpression.asString(valueVar)).append(" in ").append(HCLExpression.asString(iterable)).append(':');
+            sb.append(HCLExpression.asString(resultKey)).append("=>").append(HCLExpression.asString(resultValue));
             if (grouping) {
                 sb.append("...");
             }
@@ -78,7 +82,9 @@ public String asString() {
 
         @Override
         public List<? extends HCLExpression> elements() {
-            return List.of(iterable, resultKey, resultValue, condition);
+            return Stream.of(iterable, resultKey, resultValue, condition)
+                    .filter(Objects::nonNull)
+                    .toList();
         }
 
     }

diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLFunction.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLFunction.java
@@ -34,8 +34,8 @@ public record HCLFunction(HCLIdentifier name, List<HCLExpression> args, boolean
     @Override
     public String asString() {
         StringJoiner sargs = new StringJoiner(",", "(", expand ? "...)" : ")");
-        args.forEach((arg) -> sargs.add(arg.toString()));
-        return name + sargs.toString();
+        args.forEach((arg) -> sargs.add(HCLExpression.asString(arg)));
+        return HCLExpression.asString(name) + sargs.toString();
     }
 
     @Override

diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLIdentifier.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLIdentifier.java
@@ -24,18 +24,36 @@
  *
  * @author Laszlo Kishalmi
  */
-public sealed interface HCLIdentifier extends HCLElement {
+public sealed interface HCLIdentifier extends HCLExpression {
 
     String id();
 
     @Override
-    default List<? extends HCLElement> elements() {
+    default List<? extends HCLExpression> elements() {
         return List.of();
     }
 
-    public record SimpleId(String id) implements HCLIdentifier {}
+    public record SimpleId(String id) implements HCLIdentifier {
 
-    public record StringId(String id) implements HCLIdentifier {}
+        @Override
+        public String asString() {
+            return id;
+        }
+    }
+
+    public record StringId(String id) implements HCLIdentifier {
+
+        @Override
+        public String asString() {
+            return id;
+        }
+    }
+
+    public record ScopedId(HCLIdentifier parent, String id) implements HCLIdentifier {
 
-    public record ScopedId(HCLIdentifier parent, String id) implements HCLIdentifier {}
+        @Override
+        public String asString() {
+            return HCLExpression.asString(parent) + "::" + id;
+        }
+    }
 }
diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLResolveOperation.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLResolveOperation.java
@@ -28,22 +28,30 @@ public sealed interface HCLResolveOperation extends HCLExpression {
 
 
     HCLExpression base();
+
     default List<? extends HCLExpression> elements() {
             return List.of(base());
     }
 
     public record Attribute(HCLExpression base, HCLIdentifier attr) implements HCLResolveOperation {
+
+        public Attribute {
+            if (base == null) {
+                throw new NullPointerException("base cannot be null");
+            }
+        }
+
         @Override
         public String asString() {
-            return base.asString() + "." + attr;
+            return HCLExpression.asString(base) + "." + HCLExpression.asString(attr);
         }
 
     }
 
     public record Index(HCLExpression base, HCLExpression index, boolean legacy) implements HCLResolveOperation {
         @Override
         public String asString() {
-            return base.asString() + (legacy ? "." + index : "[" + index + "]");
+            return HCLExpression.asString(base) + (legacy ? "." + HCLExpression.asString(index) : "[" + HCLExpression.asString(index) + "]");
         }
         @Override
         public List<? extends HCLExpression> elements() {
@@ -54,14 +62,14 @@ public List<? extends HCLExpression> elements() {
     public record AttrSplat(HCLExpression base) implements HCLResolveOperation {
         @Override
         public String asString() {
-            return base.asString() + ".*";
+            return HCLExpression.asString(base) + ".*";
         }
     }
 
     public record FullSplat(HCLExpression base) implements HCLResolveOperation {
         @Override
         public String asString() {
-            return base.asString() + "[*]";
+            return HCLExpression.asString(base) + "[*]";
         }
     }
 }
diff --git a/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLVariable.java b/ide/languages.hcl/src/org/netbeans/modules/languages/hcl/ast/HCLVariable.java
@@ -26,6 +26,6 @@ public record HCLVariable(HCLIdentifier name) implements HCLExpression {
 
     @Override
     public String asString() {
-        return name.id();
+        return HCLExpression.asString(name);
     }
 }
diff --git a/...languages.hcl/test/unit/src/org/netbeans/modules/languages/hcl/ast/HCLCollectionTest.java b/...languages.hcl/test/unit/src/org/netbeans/modules/languages/hcl/ast/HCLCollectionTest.java
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.netbeans.modules.languages.hcl.ast;
+
+import static org.netbeans.modules.languages.hcl.ast.HCLExpressionTestSupport.*;
+import org.junit.Test;
+
+/**
+ *
+ * @author lkishalmi
+ */
+public class HCLCollectionTest {
+
+    @Test
+    public void testTupleSelf() {
+        assertExpr("[]");
+        assertExpr("[a]");
+        assertExpr("[a,b]");
+    }
+
+    @Test
+    public void testObjectSelf() {
+        assertExpr("{}");
+        assertExpr("{a=b}");
+        assertExpr("{a=b,b=c}");
+    }
+}