Remove the interface "ChecksGoTemplate" (#1474)

Author: jonas-wielage-sonarsource

iac-common/src/main/java/org/sonar/iac/common/extension/analyzer/CrossFileAnalyzer.java

@@ -59,7 +59,7 @@ public boolean analyseFiles(SensorContext sensorContext, Collection<InputFile> i
       .toList();
 
     // Parse files
-    List<FileWithAsts> filesWithAst = new ArrayList<>();
+    List<FileWithAst> filesWithAst = new ArrayList<>();
     for (InputFileContext inputFileContext : inputFileContextList) {
       if (sensorContext.isCancelled()) {
         progressReportParser.cancel();
@@ -70,7 +70,7 @@ public boolean analyseFiles(SensorContext sensorContext, Collection<InputFile> i
         var content = readContent(inputFileContext);
         if (content != null) {
           Tree tree = statistics.time("Parse", () -> parse(content, inputFileContext));
-          filesWithAst.add(fileWithAsts(inputFileContext, tree));
+          filesWithAst.add(new FileWithAst(inputFileContext, tree));
         }
       } catch (ParseException e) {
         reportParseError(e, inputFileContext);
@@ -83,37 +83,26 @@ public boolean analyseFiles(SensorContext sensorContext, Collection<InputFile> i
     var progressReportVisitors = new ProgressReport(progressReportThreadName(languageName, " analysis"),
       PROGRESS_REPORT_PERIOD_MILLIS, "analyzed");
     progressReportVisitors.start(filenames);
-    if (!applyVisitors(sensorContext, filesWithAst, visitors, progressReportVisitors, false)) {
+    if (!applyVisitors(sensorContext, filesWithAst, visitors, progressReportVisitors)) {
       return false;
     }
 
     var progressReportCheckVisitor = new ProgressReport(progressReportThreadName(languageName, " analysis"),
       PROGRESS_REPORT_PERIOD_MILLIS, "checked");
     progressReportCheckVisitor.start(filenames);
-    return applyVisitors(sensorContext, filesWithAst, List.of(checksVisitor), progressReportCheckVisitor, true);
+    return applyVisitors(sensorContext, filesWithAst, List.of(checksVisitor), progressReportCheckVisitor);
   }
 
-  /**
-   * @param visitAdditionalTrees indicates whether additional trees associated with the same input file should be visited. This applies for example
-   *                             for Helm files where the main tree is the Kubernetes tree and the additional tree is the Go template tree.
-   *                             We don't want to run metrics and highlighting visitors on the additional tree, because it's been already measured
-   *                             as part of the main tree. We want to run checks visitors on it though.
-   */
-  private boolean applyVisitors(SensorContext sensorContext, List<FileWithAsts> filesWithAsts, List<TreeVisitor<InputFileContext>> visitorsToBeApplied,
-    ProgressReport progressReport, boolean visitAdditionalTrees) {
+  private boolean applyVisitors(SensorContext sensorContext, List<FileWithAst> filesWithAsts, List<TreeVisitor<InputFileContext>> visitorsToBeApplied,
+    ProgressReport progressReport) {
     // Visit files
-    for (FileWithAsts fileWithAsts : filesWithAsts) {
+    for (FileWithAst fileWithAsts : filesWithAsts) {
       if (sensorContext.isCancelled()) {
         progressReport.cancel();
         return false;
       }
 
       visit(visitorsToBeApplied, fileWithAsts.inputFileContext, fileWithAsts.tree);
-      if (visitAdditionalTrees) {
-        for (Tree additionalTree : fileWithAsts.additionalTrees) {
-          visit(visitorsToBeApplied, fileWithAsts.inputFileContext, additionalTree);
-        }
-      }
       progressReport.nextFile();
     }
     progressReport.stop();
@@ -124,10 +113,6 @@ private static String progressReportThreadName(String language, String phase) {
     return "Progress of the " + language + " " + phase;
   }
 
-  protected FileWithAsts fileWithAsts(InputFileContext inputFileContext, Tree tree) {
-    return new FileWithAsts(inputFileContext, tree, List.of());
-  }
-
-  public record FileWithAsts(InputFileContext inputFileContext, Tree tree, Collection<Tree> additionalTrees) {
+  private record FileWithAst(InputFileContext inputFileContext, Tree tree) {
   }
 }

iac-common/src/test/java/org/sonar/iac/common/extension/analyzer/CrossFileAnalyzerTest.java

@@ -35,9 +35,7 @@
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.spy;
-import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 class CrossFileAnalyzerTest extends AbstractAnalyzerTest {
@@ -106,22 +104,4 @@ void shouldAlsoBeCancellableDuringTheChecksVisitorPart() {
     List<InputFile> files = List.of(fileWithContent);
     assertThat(analyzer.analyseFiles(context, files, "iac")).isFalse();
   }
-
-  @Test
-  void shouldExecuteChecksVisitorOnAdditionalTrees() {
-    TreeVisitor<InputFileContext> visitor = mock(TreeVisitor.class);
-    TreeVisitor<InputFileContext> checksVisitor = mock(TreeVisitor.class);
-    var additionalTree = mock(Tree.class);
-
-    var analyzer = new CrossFileAnalyzer("iac", parser, List.of(visitor), checksVisitor, durationStatistics) {
-      @Override
-      protected FileWithAsts fileWithAsts(InputFileContext inputFileContext, Tree tree) {
-        return new FileWithAsts(inputFileContext, tree, List.of(additionalTree));
-      }
-    };
-
-    assertThat(analyzer.analyseFiles(context, List.of(fileWithContent), "iac")).isTrue();
-    verify(visitor, never()).scan(any(), eq(additionalTree));
-    verify(checksVisitor).scan(any(), eq(additionalTree));
-  }
 }

iac-extensions/kubernetes/src/main/java/org/sonar/iac/kubernetes/checks/DeprecatedCodeCheck.java

@@ -31,7 +31,7 @@
 import org.sonar.iac.kubernetes.visitors.KubernetesCheckContext;
 
 @Rule(key = "S1874")
-public class DeprecatedCodeCheck implements ChecksGoTemplate, IacCheck {
+public class DeprecatedCodeCheck implements IacCheck {
   private static final String MESSAGE = "Remove this deprecated use of \"Capabilities.KubeVersion.GitVersion\", use \"Capabilities" +
     ".KubeVersion.Version\" instead.";
 

iac-extensions/kubernetes/src/main/java/org/sonar/iac/kubernetes/checks/VariableNameConventionCheck.java

@@ -33,7 +33,7 @@
 import org.sonar.iac.kubernetes.visitors.KubernetesCheckContext;
 
 @Rule(key = "S117")
-public class VariableNameConventionCheck implements ChecksGoTemplate, IacCheck {
+public class VariableNameConventionCheck implements IacCheck {
   private static final String MESSAGE = "Rename this variable \"%s\" to match the regular expression '%s'.";
   private static final String DEFAULT_FORMAT = "^\\$[a-z][a-zA-Z0-9]*$";
 

iac-extensions/kubernetes/src/main/java/org/sonar/iac/kubernetes/plugin/KubernetesAnalyzer.java

@@ -21,7 +21,6 @@
 
 import java.io.IOException;
 import java.util.List;
-import java.util.Set;
 import java.util.regex.Pattern;
 import javax.annotation.Nullable;
 import org.sonar.api.batch.fs.InputFile;
@@ -33,7 +32,6 @@
 import org.sonar.iac.common.extension.analyzer.CrossFileAnalyzer;
 import org.sonar.iac.common.extension.visitors.InputFileContext;
 import org.sonar.iac.common.extension.visitors.TreeVisitor;
-import org.sonar.iac.kubernetes.tree.impl.HelmFileTreeImpl;
 import org.sonar.iac.kubernetes.visitors.HelmInputFileContext;
 
 import static org.sonar.iac.common.yaml.YamlFileUtils.splitLines;
@@ -80,17 +78,6 @@ public Tree parse(String content, @Nullable InputFileContext inputFileContext) {
     }
   }
 
-  @Override
-  protected FileWithAsts fileWithAsts(InputFileContext inputFileContext, Tree tree) {
-    if (tree instanceof HelmFileTreeImpl helmFileTree) {
-      Tree additionalTree = helmFileTree.getGoTemplateAst();
-      if (additionalTree != null) {
-        return new FileWithAsts(inputFileContext, tree, Set.of(additionalTree));
-      }
-    }
-    return super.fileWithAsts(inputFileContext, tree);
-  }
-
   protected static boolean isHelmFile(InputFile inputFile) {
     try {
       return hasHelmContent(inputFile.contents());

iac-extensions/kubernetes/src/main/java/org/sonar/iac/kubernetes/tree/impl/HelmFileTreeImpl.java

@@ -22,6 +22,7 @@
 import java.util.List;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
+import org.sonar.iac.common.api.tree.Tree;
 import org.sonar.iac.common.yaml.tree.FileTree;
 import org.sonar.iac.common.yaml.tree.FileTreeImpl;
 import org.sonar.iac.common.yaml.tree.YamlTree;
@@ -47,4 +48,13 @@ public static HelmFileTreeImpl fromFileTree(FileTree fileTree, @Nullable GoTempl
   public GoTemplateTree getGoTemplateAst() {
     return goTemplateAst;
   }
+
+  @Override
+  public List<Tree> children() {
+    List<Tree> children = super.children();
+    if (goTemplateAst != null) {
+      children.add(goTemplateAst);
+    }
+    return children;
+  }
 }

…checks/AbstractChecksGoTemplateTest.java …es/checks/GoTemplateAstVerifierTest.javaiac-extensions/kubernetes/src/test/java/org/sonar/iac/kubernetes/checks/AbstractChecksGoTemplateTest.java renamed to iac-extensions/kubernetes/src/test/java/org/sonar/iac/kubernetes/checks/GoTemplateAstVerifierTest.java iac-extensions/kubernetes/src/test/java/org/sonar/iac/kubernetes/checks/AbstractChecksGoTemplateTest.java renamed to iac-extensions/kubernetes/src/test/java/org/sonar/iac/kubernetes/checks/GoTemplateAstVerifierTest.java

@@ -27,7 +27,7 @@
 import org.sonar.iac.helm.tree.api.FieldNode;
 import org.sonar.iac.kubernetes.visitors.KubernetesCheckContext;
 
-class ChecksGoTemplateTest {
+class GoTemplateAstVerifierTest {
   @Test
   void testVisitor() {
     KubernetesVerifier.verify("ChecksGoTemplate/helm/templates/capabilities-pod.yaml", new DummyChecksGoAst(), List.of(
@@ -40,7 +40,7 @@ void testVisitorWithGoComments() {
     KubernetesVerifier.verify("ChecksGoTemplate/helm/templates/capabilities-pod.yaml", new DummyChecksGoAst());
   }
 
-  private static class DummyChecksGoAst implements ChecksGoTemplate, IacCheck {
+  private static class DummyChecksGoAst implements IacCheck {
     @Override
     public void initialize(InitContext init) {
       init.register(FieldNode.class, (ctx, node) -> {

iac-extensions/kubernetes/src/test/java/org/sonar/iac/kubernetes/checks/KubernetesVerifier.java

@@ -64,7 +64,6 @@
 import org.sonar.iac.kubernetes.plugin.KubernetesLanguage;
 import org.sonar.iac.kubernetes.plugin.KubernetesParserStatistics;
 import org.sonar.iac.kubernetes.plugin.filesystem.DefaultFileSystemProvider;
-import org.sonar.iac.kubernetes.tree.impl.HelmFileTreeImpl;
 import org.sonar.iac.kubernetes.visitors.HelmInputFileContext;
 import org.sonar.iac.kubernetes.visitors.KubernetesCheckContext;
 import org.sonar.iac.kubernetes.visitors.LocationShifter;
@@ -85,23 +84,12 @@ public class KubernetesVerifier {
   private static final SensorContextTester SENSOR_CONTEXT = SensorContextTester.create(BASE_DIR.toAbsolutePath());
   private static final KubernetesAnalyzer KUBERNETES_ANALYZER = initializeKubernetesAnalyzer();
   private static final TreeParser<Tree> PARSER = KUBERNETES_ANALYZER::parse;
-  private static final TreeParser<Tree> GO_PARSER = (String content, InputFileContext inputFileContext) -> {
-    var yamlTree = PARSER.parse(content, inputFileContext);
-    return ((HelmFileTreeImpl) yamlTree).getGoTemplateAst();
-  };
-
-  private static TreeParser<? extends Tree> parserFor(IacCheck check) {
-    if (check instanceof ChecksGoTemplate) {
-      return GO_PARSER;
-    }
-    return PARSER;
-  }
 
   public static void verify(String templateFileName, IacCheck check, String... fileNames) {
     var initialization = initializeVerification(templateFileName, fileNames);
     var inputFileContext = initialization.first();
     var commentsVisitor = initialization.second();
-    Verifier.verify(parserFor(check), inputFileContext, check,
+    Verifier.verify(PARSER, inputFileContext, check,
       multiFileVerifier -> {
         // Prepare project context inside this lambda so that it happens after parsing. HelmInputFileContext
         // is fully initialized during parsing (i.e. additional files are discovered and added).
@@ -115,7 +103,7 @@ public static void verify(String templateFileName, IacCheck check, List<Verifier
     var initialization = initializeVerification(templateFileName, fileNames);
     var inputFileContext = initialization.first();
     var commentsVisitor = initialization.second();
-    Verifier.verify(parserFor(check), inputFileContext, check,
+    Verifier.verify(PARSER, inputFileContext, check,
       multiFileVerifier -> {
         var projectContext = prepareProjectContext(inputFileContext, fileNames);
         return new KubernetesTestContext(multiFileVerifier, inputFileContext, projectContext);
@@ -127,7 +115,7 @@ public static void verify(String templateFileName, IacCheck check, List<Verifier
     var initialization = initializeVerification(templateFileName);
     var inputFileContext = initialization.first();
     var commentsVisitor = initialization.second();
-    Verifier.verify(parserFor(check), inputFileContext, check,
+    Verifier.verify(PARSER, inputFileContext, check,
       multiFileVerifier -> {
         var projectContext = prepareProjectContext(inputFileContext);
         return new KubernetesTestContext(multiFileVerifier, inputFileContext, projectContext);
@@ -152,15 +140,15 @@ public static void verifyContent(String content, IacCheck check) {
     var tempFile = contentToTmp(content);
     var inputFileContext = new HelmInputFileContext(SENSOR_CONTEXT, inputFile(tempFile.getName(), tempFile.getParentFile().toPath(),
       KubernetesLanguage.NAME));
-    Verifier.verify(parserFor(check), tempFile.toPath(), check, multiFileVerifier -> new KubernetesTestContext(multiFileVerifier, inputFileContext,
+    Verifier.verify(PARSER, tempFile.toPath(), check, multiFileVerifier -> new KubernetesTestContext(multiFileVerifier, inputFileContext,
       new ProjectContext()));
   }
 
   public static void verifyNoIssue(String templateFileName, IacCheck check, String... fileNames) {
     var initialization = initializeVerification(templateFileName, fileNames);
     var inputFileContext = initialization.first();
     var commentsVisitor = initialization.second();
-    Verifier.verifyNoIssue(parserFor(check), inputFileContext, check,
+    Verifier.verifyNoIssue(PARSER, inputFileContext, check,
       multiFileVerifier -> {
         var projectContext = prepareProjectContext(inputFileContext, fileNames);
         return new KubernetesTestContext(multiFileVerifier, inputFileContext, projectContext);
@@ -355,7 +343,8 @@ protected void reportIssue(TextRange textRange, String message, List<SecondaryLo
       }
     }
 
-    private HelmInputFileContext computeHelmInputFileContextForSecondaryLocation(SecondaryLocation secondaryLocation, HelmInputFileContext defaultHelmContext) {
+    private HelmInputFileContext computeHelmInputFileContextForSecondaryLocation(SecondaryLocation secondaryLocation,
+      HelmInputFileContext defaultHelmContext) {
       InputFileContext context = null;
       if (secondaryLocation.filePath != null) {
         context = projectContext.getInputFileContext(secondaryLocation.filePath);