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.Optional;
23 import org.sonar.api.measures.CoreMetrics;
24 import org.sonar.ce.task.projectanalysis.component.Component;
25 import org.sonar.ce.task.projectanalysis.measure.Measure;
26 import org.sonar.ce.task.projectanalysis.measure.MeasureRepository;
27 import org.sonar.ce.task.projectanalysis.metric.Metric;
28 import org.sonar.ce.task.projectanalysis.metric.MetricRepository;
29 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRule;
30 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRulesHolder;
31 import org.sonar.server.rule.CommonRuleKeys;
33 import static java.lang.String.format;
35 public class SkippedTestRule extends CommonRule {
37 private final MeasureRepository measureRepository;
38 private final Metric skippedTestsMetric;
40 public SkippedTestRule(ActiveRulesHolder activeRulesHolder, MeasureRepository measureRepository, MetricRepository metricRepository) {
41 super(activeRulesHolder, CommonRuleKeys.SKIPPED_UNIT_TESTS);
42 this.measureRepository = measureRepository;
43 this.skippedTestsMetric = metricRepository.getByKey(CoreMetrics.SKIPPED_TESTS_KEY);
47 protected CommonRuleIssue doProcessFile(Component file, ActiveRule activeRule) {
48 Optional<Measure> measure = measureRepository.getRawMeasure(file, skippedTestsMetric);
50 int skipped = measure.map(Measure::getIntValue).orElse(0);
52 String message = format("Fix or remove skipped unit tests in file \"%s\".", file.getName());
53 return new CommonRuleIssue(skipped, message);