org.sonar.commonrules.internal.checks.BranchCoverageCheck Maven / Gradle / Ivy

Go to download
/*
 * Sonar Common Rules
 * Copyright (C) 2012 SonarSource
 * [email protected]
 *
 * 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  02
 */
package org.sonar.commonrules.internal.checks;

import org.sonar.api.batch.DecoratorContext;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.MeasureUtils;
import org.sonar.api.resources.Resource;
import org.sonar.api.resources.ResourceUtils;
import org.sonar.api.rules.Violation;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;

@Rule(
  key = "InsufficientBranchCoverage",
  name = "Insufficient branch coverage by unit tests",
  priority = Priority.MAJOR,
  description = "A violation is created on a file as soon as the branch coverage on this file is less than the required threshold."
    + "It gives the number of lines to be covered in order to reach the required threshold.")
public class BranchCoverageCheck extends CommonCheck {

  private static final double DEFAULT_RATIO = 65;

  @RuleProperty(description = "The minimum required branch coverage ratio.", defaultValue = "" + DEFAULT_RATIO)
  private double minimumBranchCoverageRatio = DEFAULT_RATIO;

  @SuppressWarnings("rawtypes")
  @Override
  public void checkResource(Resource resource, DecoratorContext context, org.sonar.api.rules.Rule rule) {
    double lineCoverage = MeasureUtils.getValue(context.getMeasure(CoreMetrics.BRANCH_COVERAGE), 0.0);
    if (ResourceUtils.isEntity(resource) && context.getMeasure(CoreMetrics.BRANCH_COVERAGE) != null
      && lineCoverage < minimumBranchCoverageRatio) {
      double uncoveredConditions = MeasureUtils.getValue(context.getMeasure(CoreMetrics.UNCOVERED_CONDITIONS), 0.0);
      double conditionsToCover = MeasureUtils.getValue(context.getMeasure(CoreMetrics.CONDITIONS_TO_COVER), 0.0);
      double conditionsToCoverToReachThreshold = Math.ceil((conditionsToCover * minimumBranchCoverageRatio / 100)
        - (conditionsToCover - uncoveredConditions));

      Violation violation = createViolation(resource, rule, conditionsToCoverToReachThreshold);
      context.saveViolation(violation);
    }
  }

  @SuppressWarnings("rawtypes")
  private Violation createViolation(Resource resource, org.sonar.api.rules.Rule rule, double conditionsToCoverToReachThreshold) {
    Violation violation = Violation.create(rule, resource).setCost(conditionsToCoverToReachThreshold);
    violation.setMessage((int) conditionsToCoverToReachThreshold
      + " more branches need to be covered by unit tests to reach the minimum threshold of " + minimumBranchCoverageRatio
      + "% branch coverage.");
    return violation;
  }

  public void setMinimumBranchCoverageRatio(int threshold) {
    this.minimumBranchCoverageRatio = threshold;
  }
}