SONARIAC-2056 S7020 should not raise on RUN instruction on heredoc form with comments (#674)

GitOrigin-RevId: 299c6b42b49fef2f4f2d218a56cf3e38b71c116b

Author: maksim-grebeniuk-sonarsource

iac-extensions/docker/src/main/java/org/sonar/iac/docker/checks/LongRunInstructionCheck.java

@@ -20,6 +20,7 @@
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -32,10 +33,12 @@
 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.HasComments;
 import org.sonar.iac.common.api.tree.Tree;
 import org.sonar.iac.common.api.tree.impl.TextRanges;
 import org.sonar.iac.common.extension.visitors.TreeContext;
 import org.sonar.iac.common.extension.visitors.TreeVisitor;
+import org.sonar.iac.docker.tree.TreeUtils;
 import org.sonar.iac.docker.tree.api.Argument;
 import org.sonar.iac.docker.tree.api.ArgumentList;
 import org.sonar.iac.docker.tree.api.ExpandableStringCharacters;
@@ -114,6 +117,7 @@ private void processShellCode(ShellCode shellCode, RunInstruction runInstruction
     if (originalSourceCode == null) {
       return;
     }
+    var commentsByLine = getCommentLengthsByLine(shellCode);
     var codeLines = originalSourceCode.lines().toList();
     for (int i = 0; i < codeLines.size(); i++) {
       var line = codeLines.get(i);
@@ -132,12 +136,22 @@ private void processShellCode(ShellCode shellCode, RunInstruction runInstruction
         // lineLength is only the part belonging to ShellCode; add the length of preceding parts of the Run instruction
         lineLength += shellCode.textRange().start().lineOffset();
       }
+      lineLength -= commentsByLine.getOrDefault(lineNumber, 0);
       if (lineLength > maxLength) {
+
         runInstructionData.tooLongLinesWithLastOffset.put(lineNumber, lineLength);
       }
     }
   }
 
+  private static Map<Integer, Integer> getCommentLengthsByLine(Tree from) {
+    return TreeUtils.descendants(from).filter(HasComments.class::isInstance)
+      .map(HasComments.class::cast)
+      .map(HasComments::comments)
+      .flatMap(Collection::stream)
+      .collect(Collectors.toMap(comment -> comment.textRange().start().line(), comment -> comment.contentText().length(), (c1, c2) -> c1));
+  }
+
   private void processSyntaxToken(SyntaxToken token, RunInstructionData runInstructionData) {
     if (token.parent() instanceof SyntaxTokenShellCode) {
       // Skip tokens that are part of ShellCode, as they are already handled by processShellCode

iac-extensions/docker/src/main/java/org/sonar/iac/docker/tree/TreeUtils.java

@@ -16,9 +16,11 @@
  */
 package org.sonar.iac.docker.tree;
 
+import java.util.ArrayDeque;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.Spliterator;
 import java.util.Spliterators;
 import java.util.function.Predicate;
 import java.util.stream.Stream;
@@ -48,13 +50,40 @@ public static Optional<Tree> lastDescendant(@Nullable Tree root, Predicate<Tree>
     return descendants(root).filter(predicate).reduce((first, second) -> second);
   }
 
-  private static Stream<Tree> descendants(@Nullable Tree root) {
-    if (root == null || root.children().isEmpty()) {
-      return Stream.empty();
+  public static Stream<Tree> descendants(@Nullable Tree root) {
+    if (root == null) {
+      return Stream.of();
     }
-    Spliterator<Tree> spliterator = Spliterators.spliteratorUnknownSize(root.children().iterator(), Spliterator.ORDERED);
-    Stream<Tree> stream = StreamSupport.stream(spliterator, false);
-    return stream.flatMap(tree -> Stream.concat(Stream.of(tree), descendants(tree)));
+    // A queue to hold the nodes to visit, maintaining BFS order
+    var queue = new ArrayDeque<Tree>();
+    queue.add(root);
+
+    // Create an Iterator based on the BFS logic
+    var iterator = new Iterator<Tree>() {
+      @Override
+      public boolean hasNext() {
+        return !queue.isEmpty();
+      }
+
+      @Override
+      public Tree next() {
+        // Get the next node
+        var node = queue.poll();
+        if (node == null) {
+          throw new NoSuchElementException();
+        }
+
+        // Add all children of the current node to the queue for later processing
+        queue.addAll(node.children());
+        return node;
+      }
+    };
+
+    // Create a Spliterator from the iterator, specifying it's unordered,
+    // non-null, and finite, then convert it to a sequential stream.
+    return StreamSupport.stream(
+      Spliterators.spliteratorUnknownSize(iterator, 0),
+      false);
   }
 
   public static Optional<DockerTree> firstAncestor(DockerTree node, Predicate<DockerTree> predicate) {