3 * Copyright (C) 2009-2023 SonarSource SA
4 * mailto:info AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.ce.task.projectanalysis.issue.commonrule;
22 import java.util.Collections;
23 import org.junit.Rule;
24 import org.junit.Test;
25 import org.sonar.api.measures.CoreMetrics;
26 import org.sonar.api.rule.RuleKey;
27 import org.sonar.api.rule.Severity;
28 import org.sonar.ce.task.projectanalysis.component.Component;
29 import org.sonar.ce.task.projectanalysis.component.FileAttributes;
30 import org.sonar.ce.task.projectanalysis.component.ReportComponent;
31 import org.sonar.ce.task.projectanalysis.component.TreeRootHolderRule;
32 import org.sonar.ce.task.projectanalysis.measure.Measure;
33 import org.sonar.ce.task.projectanalysis.measure.MeasureRepositoryRule;
34 import org.sonar.ce.task.projectanalysis.metric.MetricRepositoryRule;
35 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRule;
36 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRulesHolderRule;
37 import org.sonar.core.issue.DefaultIssue;
38 import org.sonar.server.rule.CommonRuleKeys;
40 import static org.assertj.core.api.Assertions.assertThat;
41 import static org.sonar.ce.task.projectanalysis.component.ReportComponent.DUMB_PROJECT;
43 public class TestErrorRuleTest {
45 private static final String PLUGIN_KEY = "java";
46 private static final String QP_KEY = "qp1";
48 static RuleKey RULE_KEY = RuleKey.of(CommonRuleKeys.commonRepositoryForLang("java"), CommonRuleKeys.FAILED_UNIT_TESTS);
50 static ReportComponent FILE = ReportComponent.builder(Component.Type.FILE, 1)
51 .setFileAttributes(new FileAttributes(true, "java", 1))
52 .setName("FooTest.java")
56 public ActiveRulesHolderRule activeRuleHolder = new ActiveRulesHolderRule();
59 public MetricRepositoryRule metricRepository = new MetricRepositoryRule()
60 .add(CoreMetrics.TEST_ERRORS)
61 .add(CoreMetrics.TEST_FAILURES);
64 public TreeRootHolderRule treeRootHolder = new TreeRootHolderRule().setRoot(DUMB_PROJECT);
67 public MeasureRepositoryRule measureRepository = MeasureRepositoryRule.create(treeRootHolder, metricRepository);
69 CommonRule underTest = new TestErrorRule(activeRuleHolder, measureRepository, metricRepository);
72 public void issue_if_errors_or_failures() {
73 activeRuleHolder.put(new ActiveRule(RULE_KEY, Severity.CRITICAL, Collections.emptyMap(), 1_000L, PLUGIN_KEY, QP_KEY));
74 measureRepository.addRawMeasure(FILE.getReportAttributes().getRef(), CoreMetrics.TEST_ERRORS_KEY, Measure.newMeasureBuilder().create(2));
75 measureRepository.addRawMeasure(FILE.getReportAttributes().getRef(), CoreMetrics.TEST_FAILURES_KEY, Measure.newMeasureBuilder().create(1));
77 DefaultIssue issue = underTest.processFile(FILE, "java");
79 assertThat(issue.ruleKey()).isEqualTo(RULE_KEY);
80 assertThat(issue.severity()).isEqualTo(Severity.CRITICAL);
81 assertThat(issue.gap()).isEqualTo(3.0);
82 assertThat(issue.message()).isEqualTo("Fix failing unit tests on file \"FooTest.java\".");
86 public void no_issues_if_zero_errors_and_failures() {
87 activeRuleHolder.put(new ActiveRule(RULE_KEY, Severity.CRITICAL, Collections.emptyMap(), 1_000L, PLUGIN_KEY, QP_KEY));
88 measureRepository.addRawMeasure(FILE.getReportAttributes().getRef(), CoreMetrics.TEST_ERRORS_KEY, Measure.newMeasureBuilder().create(0));
89 measureRepository.addRawMeasure(FILE.getReportAttributes().getRef(), CoreMetrics.TEST_FAILURES_KEY, Measure.newMeasureBuilder().create(0));
91 DefaultIssue issue = underTest.processFile(FILE, "java");
93 assertThat(issue).isNull();
97 public void no_issues_if_test_measures_are_absent() {
98 activeRuleHolder.put(new ActiveRule(RULE_KEY, Severity.CRITICAL, Collections.emptyMap(), 1_000L, PLUGIN_KEY, QP_KEY));
100 DefaultIssue issue = underTest.processFile(FILE, "java");
102 assertThat(issue).isNull();