All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.server.qualitygate.ConditionEvaluator Maven / Gradle / Ivy

There is a newer version: 7.2.1
Show newest version
/*
 * SonarQube
 * Copyright (C) 2009-2018 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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  02110-1301, USA.
 */
package org.sonar.server.qualitygate;

import java.util.EnumSet;
import java.util.Optional;
import java.util.Set;
import javax.annotation.CheckForNull;
import org.sonar.api.measures.Metric.ValueType;
import org.sonar.server.qualitygate.EvaluatedCondition.EvaluationStatus;

import static java.util.Optional.of;
import static org.sonar.api.measures.Metric.ValueType.BOOL;
import static org.sonar.api.measures.Metric.ValueType.FLOAT;
import static org.sonar.api.measures.Metric.ValueType.INT;
import static org.sonar.api.measures.Metric.ValueType.MILLISEC;
import static org.sonar.api.measures.Metric.ValueType.PERCENT;
import static org.sonar.api.measures.Metric.ValueType.RATING;
import static org.sonar.api.measures.Metric.ValueType.WORK_DUR;

class ConditionEvaluator {

  private static final Set NUMERICAL_TYPES = EnumSet.of(BOOL, INT, RATING, FLOAT, MILLISEC, PERCENT, WORK_DUR);

  private ConditionEvaluator() {
    // prevent instantiation
  }

  /**
   * Evaluates the condition for the specified measure
   */
  static EvaluatedCondition evaluate(Condition condition, QualityGateEvaluator.Measures measures) {
    Optional measure = measures.get(condition.getMetricKey());
    if (!measure.isPresent()) {
      return new EvaluatedCondition(condition, EvaluationStatus.OK, null);
    }

    Optional value = getMeasureValue(condition, measure.get());
    if (!value.isPresent()) {
      return new EvaluatedCondition(condition, EvaluationStatus.OK, null);
    }

    ValueType type = measure.get().getType();
    return evaluateCondition(condition, type, value.get(), true)
      .orElseGet(() -> evaluateCondition(condition, type, value.get(), false)
        .orElseGet(() -> new EvaluatedCondition(condition, EvaluationStatus.OK, value.get().toString())));
  }

  /**
   * Evaluates the error or warning condition. Returns empty if threshold or measure value is not defined.
   */
  private static Optional evaluateCondition(Condition condition, ValueType type, Comparable value, boolean error) {
    Optional threshold = getThreshold(condition, type, error);
    if (!threshold.isPresent()) {
      return Optional.empty();
    }

    if (reachThreshold(value, threshold.get(), condition)) {
      EvaluationStatus status = error ? EvaluationStatus.ERROR : EvaluationStatus.WARN;
      return of(new EvaluatedCondition(condition, status, value.toString()));
    }
    return Optional.empty();
  }

  private static Optional getThreshold(Condition condition, ValueType valueType, boolean error) {
    Optional valString = error ? condition.getErrorThreshold() : condition.getWarningThreshold();
    return valString.map(s -> {
      try {
        switch (valueType) {
          case BOOL:
            return parseInteger(s) == 1;
          case INT:
          case RATING:
            return parseInteger(s);
          case MILLISEC:
          case WORK_DUR:
            return Long.parseLong(s);
          case FLOAT:
          case PERCENT:
            return Double.parseDouble(s);
          case STRING:
          case LEVEL:
            return s;
          default:
            throw new IllegalArgumentException(String.format("Unsupported value type %s. Cannot convert condition value", valueType));
        }
      } catch (NumberFormatException badValueFormat) {
        throw new IllegalArgumentException(String.format(
          "Quality Gate: unable to parse threshold '%s' to compare against %s", s, condition.getMetricKey()));
      }
    });
  }

  private static Optional getMeasureValue(Condition condition, QualityGateEvaluator.Measure measure) {
    if (condition.isOnLeakPeriod()) {
      return Optional.ofNullable(getLeakValue(measure));
    }

    return Optional.ofNullable(getValue(measure));
  }

  @CheckForNull
  private static Comparable getValue(QualityGateEvaluator.Measure measure) {
    if (NUMERICAL_TYPES.contains(measure.getType())) {
      return measure.getValue().isPresent() ? getNumericValue(measure.getType(), measure.getValue().getAsDouble()) : null;
    }

    switch (measure.getType()) {
      case LEVEL:
      case STRING:
      case DISTRIB:
        return measure.getStringValue().orElse(null);
      default:
        throw new IllegalArgumentException("Condition on leak period is not allowed for type " + measure.getType());
    }
  }

  @CheckForNull
  private static Comparable getLeakValue(QualityGateEvaluator.Measure measure) {
    if (NUMERICAL_TYPES.contains(measure.getType())) {
      return measure.getLeakValue().isPresent() ? getNumericValue(measure.getType(), measure.getLeakValue().getAsDouble()) : null;
    }

    throw new IllegalArgumentException("Condition on leak period is not allowed for type " + measure.getType());
  }

  private static Comparable getNumericValue(ValueType type, double value) {
    switch (type) {
      case BOOL:
        return Double.compare(value, 1.0) == 1;
      case INT:
      case RATING:
        return (int) value;
      case FLOAT:
      case PERCENT:
        return value;
      case MILLISEC:
      case WORK_DUR:
        return (long) value;
      default:
        throw new IllegalArgumentException("Condition on numeric value is not allowed for type " + type);
    }
  }

  private static int parseInteger(String value) {
    return value.contains(".") ? Integer.parseInt(value.substring(0, value.indexOf('.'))) : Integer.parseInt(value);
  }

  private static boolean reachThreshold(Comparable measureValue, Comparable threshold, Condition condition) {
    int comparison = measureValue.compareTo(threshold);
    switch (condition.getOperator()) {
      case EQUALS:
        return comparison == 0;
      case NOT_EQUALS:
        return comparison != 0;
      case GREATER_THAN:
        return comparison > 0;
      case LESS_THAN:
        return comparison < 0;
      default:
        throw new IllegalArgumentException(String.format("Unsupported operator '%s'", condition.getOperator()));
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy