/* * 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.report; import java.io.File; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import org.sonar.api.batch.rule.ActiveRules; import org.sonar.api.batch.rule.internal.DefaultActiveRules; import org.sonar.api.batch.rule.internal.NewActiveRule; import org.sonar.api.issue.impact.Severity; import org.sonar.api.issue.impact.SoftwareQuality; import org.sonar.api.rule.RuleKey; import org.sonar.core.util.CloseableIterator; import org.sonar.scanner.protocol.Constants; import org.sonar.scanner.protocol.output.FileStructure; import org.sonar.scanner.protocol.output.ScannerReport; import org.sonar.scanner.protocol.output.ScannerReportReader; import org.sonar.scanner.protocol.output.ScannerReportWriter; import static java.util.Collections.singletonList; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.groups.Tuple.tuple; public class ActiveRulesPublisherTest { @Rule public TemporaryFolder temp = new TemporaryFolder(); @Test public void write() throws Exception { File outputDir = temp.newFolder(); FileStructure fileStructure = new FileStructure(outputDir); ScannerReportWriter writer = new ScannerReportWriter(fileStructure); NewActiveRule ar = new NewActiveRule.Builder() .setRuleKey(RuleKey.of("java", "S001")) .setSeverity("BLOCKER") .setParam("p1", "v1") .setCreatedAt(1_000L) .setUpdatedAt(2_000L) .setQProfileKey("qp1") .setImpact(SoftwareQuality.MAINTAINABILITY, Severity.BLOCKER) .setImpact(SoftwareQuality.RELIABILITY, Severity.LOW) .build(); ActiveRules activeRules = new DefaultActiveRules(singletonList(ar)); ActiveRulesPublisher underTest = new ActiveRulesPublisher(activeRules); underTest.publish(writer); ScannerReportReader reader = new ScannerReportReader(fileStructure); try (CloseableIterator readIt = reader.readActiveRules()) { ScannerReport.ActiveRule reportAr = readIt.next(); assertThat(reportAr.getRuleRepository()).isEqualTo("java"); assertThat(reportAr.getRuleKey()).isEqualTo("S001"); assertThat(reportAr.getSeverity()).isEqualTo(Constants.Severity.BLOCKER); assertThat(reportAr.getCreatedAt()).isEqualTo(1_000L); assertThat(reportAr.getUpdatedAt()).isEqualTo(2_000L); assertThat(reportAr.getQProfileKey()).isEqualTo("qp1"); assertThat(reportAr.getParamsByKeyMap()).hasSize(1); assertThat(reportAr.getParamsByKeyMap().entrySet().iterator().next().getKey()).isEqualTo("p1"); assertThat(reportAr.getParamsByKeyMap().entrySet().iterator().next().getValue()).isEqualTo("v1"); assertThat(reportAr.getImpactsList()).extracting(ScannerReport.Impact::getSoftwareQuality, ScannerReport.Impact::getSeverity) .containsExactlyInAnyOrder( tuple(ScannerReport.SoftwareQuality.MAINTAINABILITY, ScannerReport.ImpactSeverity.ImpactSeverity_BLOCKER), tuple(ScannerReport.SoftwareQuality.RELIABILITY, ScannerReport.ImpactSeverity.ImpactSeverity_LOW)); assertThat(readIt.hasNext()).isFalse(); } } }