3 * Copyright (C) 2009-2017 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.server.computation.task.projectanalysis.step;
22 import java.util.Collection;
23 import javax.annotation.Nullable;
24 import org.sonar.api.measures.CoreMetrics;
25 import org.sonar.server.computation.task.projectanalysis.component.Component;
26 import org.sonar.server.computation.task.projectanalysis.measure.Measure;
27 import org.sonar.server.computation.task.projectanalysis.measure.MeasureRepository;
28 import org.sonar.server.computation.task.projectanalysis.metric.MetricRepository;
29 import org.sonar.server.computation.task.projectanalysis.qualitygate.EvaluationResult;
31 import static java.util.Arrays.asList;
33 public class SmallChangesetQualityGateSpecialCase {
36 * Some metrics will only produce warnings (never errors) on very small change sets.
38 private static final Collection<String> METRICS_THAT_CAN_ONLY_PRODUCE_WARNINGS_ON_SMALL_CHANGESETS = asList(
39 CoreMetrics.NEW_COVERAGE_KEY,
40 CoreMetrics.NEW_LINE_COVERAGE_KEY,
41 CoreMetrics.NEW_BRANCH_COVERAGE_KEY,
42 CoreMetrics.NEW_DUPLICATED_LINES_DENSITY_KEY,
43 CoreMetrics.NEW_DUPLICATED_LINES_KEY,
44 CoreMetrics.NEW_BLOCKS_DUPLICATED_KEY
46 private static final int MAXIMUM_NEW_LINES_FOR_SMALL_CHANGESETS = 19;
48 private final MeasureRepository measureRepository;
49 private final MetricRepository metricRepository;
51 public SmallChangesetQualityGateSpecialCase(MeasureRepository measureRepository, MetricRepository metricRepository) {
52 this.measureRepository = measureRepository;
53 this.metricRepository = metricRepository;
56 QualityGateMeasuresStep.MetricEvaluationResult applyIfNeeded(Component project, @Nullable QualityGateMeasuresStep.MetricEvaluationResult metricEvaluationResult) {
57 if (metricEvaluationResult == null) {
58 return metricEvaluationResult;
60 if (metricEvaluationResult.evaluationResult.getLevel() == Measure.Level.OK) {
61 return metricEvaluationResult;
63 if (!METRICS_THAT_CAN_ONLY_PRODUCE_WARNINGS_ON_SMALL_CHANGESETS.contains(metricEvaluationResult.condition.getMetric().getKey())) {
64 return metricEvaluationResult;
66 if (!isSmallChangeset(project)) {
67 return metricEvaluationResult;
69 return calculateModifiedResult(metricEvaluationResult);
72 private QualityGateMeasuresStep.MetricEvaluationResult calculateModifiedResult(@Nullable QualityGateMeasuresStep.MetricEvaluationResult metricEvaluationResult) {
73 return new QualityGateMeasuresStep.MetricEvaluationResult(
74 new EvaluationResult(Measure.Level.OK, metricEvaluationResult.evaluationResult.getValue()), metricEvaluationResult.condition);
77 private boolean isSmallChangeset(Component project) {
78 return measureRepository.getRawMeasure(project, metricRepository.getByKey(CoreMetrics.NEW_LINES_KEY))
79 .transform(newLines -> newLines.hasVariation() && newLines.getVariation() <= MAXIMUM_NEW_LINES_FOR_SMALL_CHANGESETS)