org.sonar.plugins.buildbreaker.AlertThresholdChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-build-breaker-plugin Show documentation

Break the analysis batch if at least one alert threshold is hit

There is a newer version: 1.1

Show newest version

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2009 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.buildbreaker;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.batch.BuildBreaker;
import org.sonar.api.batch.SensorContext;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.Measure;
import org.sonar.api.measures.MeasuresFilters;
import org.sonar.api.measures.Metric;
import org.sonar.api.resources.Project;

import java.util.Collection;

public class AlertThresholdChecker extends BuildBreaker {

  public void executeOn(Project project, SensorContext context) {
    analyseMeasures(context, LoggerFactory.getLogger(getClass()));
  }

  protected void analyseMeasures(SensorContext context, Logger logger) {
    int count = countErrors(context, logger);
    if (count > 0) {
      fail("Alert thresholds have been hit (" + count + " times).");
    }
  }

  private int countErrors(SensorContext context, Logger logger) {
    Collection measures = context.getMeasures(MeasuresFilters.all());
    int count = 0;
    for (Measure measure : measures) {
      if (isErrorAlert(measure)) {
        logger.error(measure.getAlertText());
        count++;
      } else if (isWarningAlert(measure)) {
        logger.warn(measure.getAlertText());
      }
    }
    return count;
  }

  private boolean isWarningAlert(Measure measure) {
    return !measure.getMetric().equals(CoreMetrics.ALERT_STATUS) && Metric.Level.WARN.equals(measure.getAlertStatus());
  }

  private boolean isErrorAlert(Measure measure) {
    return !measure.getMetric().equals(CoreMetrics.ALERT_STATUS) && Metric.Level.ERROR.equals(measure.getAlertStatus());
  }
}