/* * SonarQube * Copyright (C) 2009-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 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.scanner.mediumtest.measures; import com.google.common.collect.ImmutableMap; import java.io.File; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.util.List; import java.util.Map; import org.apache.commons.io.FileUtils; import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import org.slf4j.event.Level; import org.sonar.api.testfixtures.log.LogTester; import org.sonar.scanner.mediumtest.AnalysisResult; import org.sonar.scanner.mediumtest.ScannerMediumTester; import org.sonar.scanner.protocol.output.ScannerReport.Measure; import org.sonar.xoo.XooPlugin; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.tuple; import static org.junit.Assert.fail; public class MeasuresMediumIT { @Rule public LogTester logTester = new LogTester(); @Rule public TemporaryFolder temp = new TemporaryFolder(); private File baseDir; private File srcDir; @Rule public ScannerMediumTester tester = new ScannerMediumTester() .registerPlugin("xoo", new XooPlugin()) .addDefaultQProfile("xoo", "Sonar Way"); @Before public void setUp() throws Exception { baseDir = temp.newFolder(); srcDir = new File(baseDir, "src"); srcDir.mkdir(); } @Test public void failIfTryingToSaveServerSideMeasure() throws IOException { File xooFile = new File(srcDir, "sample.xoo"); FileUtils.write(xooFile, "Sample xoo\n\ncontent", StandardCharsets.UTF_8); File measures = new File(srcDir, "sample.xoo.measures"); FileUtils.write(measures, "new_lines:2", StandardCharsets.UTF_8); try { tester.newAnalysis() .properties(ImmutableMap.builder() .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) .put("sonar.projectKey", "com.foo.project") .put("sonar.sources", "src") .build()) .execute(); fail("Expected exception"); } catch (Exception e) { assertThat(e) .hasCauseInstanceOf(UnsupportedOperationException.class) .hasStackTraceContaining("Metric 'new_lines' should not be computed by a Sensor"); } } @Test public void lineMeasures() throws IOException { File xooFile = new File(srcDir, "sample.xoo"); FileUtils.write(xooFile, "Sample xoo\n\n\ncontent", StandardCharsets.UTF_8); File lineMeasures = new File(srcDir, "sample.xoo.linemeasures"); FileUtils.write(lineMeasures, "ncloc_data:1=1;2=0;4=1", StandardCharsets.UTF_8); AnalysisResult result = tester.newAnalysis() .properties(ImmutableMap.builder() .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) .put("sonar.projectKey", "com.foo.project") .put("sonar.sources", "src") .build()) .execute(); Map> allMeasures = result.allMeasures(); assertThat(allMeasures.get("com.foo.project:src/sample.xoo")).extracting("metricKey", "intValue.value", "stringValue.value") .containsExactly(tuple("ncloc_data", 0, "1=1;4=1")); } @Test public void projectLevelMeasures() throws IOException { File xooFile = new File(srcDir, "sample.xoo"); FileUtils.write(xooFile, "Sample xoo\n\n\ncontent", StandardCharsets.UTF_8); File projectMeasures = new File(baseDir, "module.measures"); FileUtils.write(projectMeasures, "tests:10", StandardCharsets.UTF_8); AnalysisResult result = tester.newAnalysis() .properties(ImmutableMap.builder() .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) .put("sonar.projectKey", "com.foo.project") .put("sonar.sources", "src") .build()) .execute(); Map> allMeasures = result.allMeasures(); assertThat(allMeasures.get("com.foo.project")) .extracting("metricKey", "intValue.value", "stringValue.value") .containsExactly(tuple("tests", 10, "")); } @Test public void warnWhenSavingFolderMeasure() throws IOException { File xooFile = new File(srcDir, "sample.xoo"); FileUtils.write(xooFile, "Sample xoo\n\n\ncontent", StandardCharsets.UTF_8); File folderMeasures = new File(srcDir, "folder.measures"); FileUtils.write(folderMeasures, "tests:10", StandardCharsets.UTF_8); AnalysisResult result = tester.newAnalysis() .properties(ImmutableMap.builder() .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) .put("sonar.projectKey", "com.foo.project") .put("sonar.sources", "src") .build()) .execute(); assertThat(logTester.logs(Level.WARN)).contains("Storing measures on folders or modules is deprecated. Provided value of metric 'tests' is ignored."); } @Test public void warnWhenSavingModuleMeasure() throws IOException { File moduleDir = new File(baseDir, "moduleA"); moduleDir.mkdirs(); srcDir = new File(moduleDir, "src"); File xooFile = new File(srcDir, "sample.xoo"); FileUtils.write(xooFile, "Sample xoo\n\n\ncontent", StandardCharsets.UTF_8); File moduleMeasures = new File(moduleDir, "module.measures"); FileUtils.write(moduleMeasures, "tests:10", StandardCharsets.UTF_8); AnalysisResult result = tester.newAnalysis() .properties(ImmutableMap.builder() .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) .put("sonar.projectKey", "com.foo.project") .put("sonar.modules", "moduleA") .put("sonar.sources", "src") .build()) .execute(); assertThat(logTester.logs(Level.WARN)).contains("Storing measures on folders or modules is deprecated. Provided value of metric 'tests' is ignored."); } }