SONARXML-218 Remove queries to non-persisted metrics

Author: alban-auzeill

its/plugin/src/test/java/com/sonar/it/xml/XmlTest.java

@@ -22,9 +22,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
-import org.sonarqube.ws.Measures.Measure;
 
-import static com.sonar.it.xml.XmlTestSuite.getMeasure;
 import static com.sonar.it.xml.XmlTestSuite.getMeasureAsDouble;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -51,16 +49,6 @@ void testBaseMetrics() {
     assertThat(getProjectMeasureAsDouble("violations")).isEqualTo(13);
   }
 
-  @Test
-  void should_be_compatible_with_DevCockpit() {
-    assertThat(getFileMeasure("ncloc_data").getValue())
-      .contains(";7=1")
-      .doesNotContain("8=1")
-      .doesNotContain("9=1")
-      .doesNotContain("10=1")
-      .contains(";11=1");
-  }
-
   @Test
     // SONARXML-19
   void should_correctly_count_lines_when_char_before_prolog() {
@@ -86,8 +74,4 @@ private Double getFileMeasureAsDouble(String metricKey) {
     return getMeasureAsDouble(FILE_TOKEN_PARSER, metricKey.trim());
   }
 
-  private Measure getFileMeasure(String metricKey) {
-    return getMeasure(FILE_TOKEN_PARSER, metricKey.trim());
-  }
-
 }

pom.xml

@@ -169,10 +169,15 @@
         <version>3.12.4</version>
         <scope>test</scope>
       </dependency>
+      <dependency>
+        <groupId>com.google.code.gson</groupId>
+        <artifactId>gson</artifactId>
+        <version>2.11.0</version>
+        <scope>test</scope>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
-
   <profiles>
     <profile>
       <id>its</id>

sonar-xml-plugin/pom.xml

@@ -99,6 +99,11 @@
       <artifactId>sonar-plugin-api-impl</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

sonar-xml-plugin/src/test/java/org/sonar/plugins/xml/FileLinesContextTester.java

@@ -0,0 +1,75 @@
+/*
+ * SonarQube XML Plugin
+ * Copyright (C) 2010-2025 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 Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.plugins.xml;
+
+import java.util.Map;
+import java.util.TreeMap;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.measures.FileLinesContext;
+import org.sonar.api.measures.FileLinesContextFactory;
+
+public class FileLinesContextTester implements FileLinesContextFactory {
+
+  // String inputFileKey -> String metricKey -> Integer line -> Object value
+  private final Map<String, Map<String, Map<Integer, Object>>> storage = new TreeMap<>();
+
+  @Override
+  public FileLinesContext createFor(InputFile inputFile) {
+    return new Metrics(inputFile.key());
+  }
+
+  public Map<String, Map<Integer, Object>> metrics(InputFile inputFile) {
+    return storage.getOrDefault(inputFile.key(), Map.of());
+  }
+
+  private class Metrics implements FileLinesContext {
+
+    // String metricKey -> Integer line -> Object value
+    private final Map<String, Map<Integer, Object>> storageBuffer = new TreeMap<>();
+    private final String inputFileKey;
+
+    public Metrics(String inputFileKey) {
+      this.inputFileKey = inputFileKey;
+    }
+
+    @Override
+    public void setIntValue(String metricKey, int line, int value) {
+      put(metricKey, line, value);
+    }
+
+    @Override
+    public void setStringValue(String metricKey, int line, String value) {
+      put(metricKey, line, value);
+    }
+
+    private void put(String metricKey, int line, Object value) {
+      storageBuffer
+        .computeIfAbsent(metricKey, k -> new TreeMap<>())
+        .put(line, value);
+    }
+
+    @Override
+    public void save() {
+      storage
+        .computeIfAbsent(inputFileKey, k -> new TreeMap<>())
+        .putAll(storageBuffer);
+      storageBuffer.clear();
+    }
+
+  }
+
+}

sonar-xml-plugin/src/test/java/org/sonar/plugins/xml/LineCounterTest.java

@@ -16,77 +16,58 @@
  */
 package org.sonar.plugins.xml;
 
+import com.google.gson.Gson;
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
-import java.util.Arrays;
-import org.junit.jupiter.api.BeforeEach;
+import java.util.Map;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
 import org.sonar.api.batch.sensor.internal.SensorContextTester;
 import org.sonar.api.measures.CoreMetrics;
-import org.sonar.api.measures.FileLinesContext;
-import org.sonar.api.measures.FileLinesContextFactory;
 import org.sonarsource.analyzer.commons.xml.ParseException;
 import org.sonarsource.analyzer.commons.xml.XmlFile;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyNoMoreInteractions;
-import static org.mockito.Mockito.when;
 
 class LineCounterTest {
 
-  private FileLinesContextFactory fileLinesContextFactory;
-  private FileLinesContext fileLinesContext;
-
-  @BeforeEach
-  void setUp() {
-    fileLinesContextFactory = mock(FileLinesContextFactory.class);
-    fileLinesContext = mock(FileLinesContext.class);
-    when(fileLinesContextFactory.createFor(any(InputFile.class))).thenReturn(fileLinesContext);
-  }
-
   @Test
   void test_simple_file() throws IOException {
-    verifyMetrics("simple.xml", 1,
-      1, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18);
+    verifyMetrics("simple.xml", 1, """
+        {"ncloc_data":{"1":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":1,"10":1,"12":1,"13":1,"14":1,"15":1,"16":1,"17":1,"18":1}}""");
   }
 
   @Test
   void test_complex_file() throws IOException {
-    verifyMetrics("complex.xml", 17,
-      1, 2, 3, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 25, 26, 27, 34, 35, 36, 37, 38, 39);
+    verifyMetrics("complex.xml", 17, """
+      {"ncloc_data":{"1":1,"2":1,"3":1,"11":1,"12":1,"13":1,"14":1,"15":1,"16":1,"17":1,"18":1,"19":1,"20":1,"22":1,"25":1,"26":1,"27":1,"34":1,"35":1,"36":1,"37":1,"38":1,"39":1}}""");
   }
 
   @Test
   void test_invalid_file() {
-    assertThrows(ParseException.class, () -> verifyMetrics("invalid.xml", -1));
+    assertThrows(ParseException.class, () -> verifyMetrics("invalid.xml", -1, ""));
   }
 
   @Test // SONARXML-19
   void test_file_with_char_before_prolog() throws Exception {
-    verifyMetrics("char_before_prolog.xml", 1, 3, 6, 7, 8, 9, 10, 11, 12, 13);
+    verifyMetrics("char_before_prolog.xml", 1, """
+      {"ncloc_data":{"3":1,"6":1,"7":1,"8":1,"9":1,"10":1,"11":1,"12":1,"13":1}}""");
   }
 
-  private void verifyMetrics(String filename, int commentLinesNumber, int... linesOfCode) throws IOException {
+  private void verifyMetrics(String filename, int commentLinesNumber, String linesMetrics) throws IOException {
     File moduleBaseDir = new File("src/test/resources/parsers/linecount");
     SensorContextTester context = SensorContextTester.create(moduleBaseDir);
     InputFile inputFile = createInputFile(moduleBaseDir.toPath(), filename);
-    LineCounter.analyse(context, fileLinesContextFactory,  XmlFile.create(inputFile));
-
-    Arrays.stream(linesOfCode).forEach(line ->
-      verify(fileLinesContext).setIntValue(CoreMetrics.NCLOC_DATA_KEY, line, 1));
-
-    verify(fileLinesContext).save();
-    verifyNoMoreInteractions(fileLinesContext);
-
-    assertThat(context.measure(inputFile.key(), CoreMetrics.NCLOC).value()).isEqualTo(linesOfCode.length);
+    var fileLinesContext = new FileLinesContextTester();
+    LineCounter.analyse(context, fileLinesContext, XmlFile.create(inputFile));
+    Map<String, Map<Integer, Object>> metrics = fileLinesContext.metrics(inputFile);
+    assertThat(new Gson().toJson(metrics)).isEqualTo(linesMetrics);
+    int expectedNcloc = metrics.get(CoreMetrics.NCLOC_DATA_KEY).size();
+    assertThat(context.measure(inputFile.key(), CoreMetrics.NCLOC).value()).isEqualTo(expectedNcloc);
     assertThat(context.measure(inputFile.key(), CoreMetrics.COMMENT_LINES).value()).isEqualTo(commentLinesNumber);
   }