source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20 package org.sonar.ce.task.projectanalysis.metric;
  21
  22 import java.util.HashMap;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Optional;
  26 import java.util.stream.Collectors;
  27
  28 import org.junit.rules.ExternalResource;
  29
  30 import static com.google.common.base.Preconditions.checkState;
  31 import static java.lang.String.format;
  32 import static java.util.Objects.requireNonNull;
  33
  34 public class MetricRepositoryRule extends ExternalResource implements MetricRepository {
  35   private final Map<String, Metric> metricsByKey = new HashMap<>();
  36   private final Map<String, Metric> metricsByUuid = new HashMap<>();
  37
  38   /**
  39    * Convenience method to add a {@link Metric} to the repository created from a {@link org.sonar.api.measures.Metric},
  40    * most of the time it will be a constant of the {@link org.sonar.api.measures.CoreMetrics} class.
  41    * <p>
  42    * For the id of the created metric, this method uses the hashCode of the metric's key. If you want to specify
  43    * the id of the create {@link Metric}, use {@link #add(String, org.sonar.api.measures.Metric)}
  44    * </p>
  45    */
  46   public MetricRepositoryRule add(org.sonar.api.measures.Metric<?> coreMetric) {
  47     add(from(coreMetric));
  48     return this;
  49   }
  50
  51   /**
  52    * Convenience method to add a {@link Metric} to the repository created from a {@link org.sonar.api.measures.Metric}
  53    * and with the specified id, most of the time it will be a constant of the {@link org.sonar.api.measures.CoreMetrics}
  54    * class.
  55    */
  56   public MetricRepositoryRule add(String uuid, org.sonar.api.measures.Metric<?> coreMetric) {
  57     add(from(uuid, coreMetric));
  58     return this;
  59   }
  60
  61   private static Metric from(org.sonar.api.measures.Metric<?> coreMetric) {
  62     return from(Long.toString(coreMetric.getKey().hashCode()), coreMetric);
  63   }
  64
  65   private static Metric from(String uuid, org.sonar.api.measures.Metric<?> coreMetric) {
  66     return new MetricImpl(
  67       uuid, coreMetric.getKey(), coreMetric.getName(),
  68       convert(coreMetric.getType()),
  69       coreMetric.getDecimalScale(),
  70       coreMetric.getBestValue(), coreMetric.isOptimizedBestValue(), coreMetric.getDeleteHistoricalData());
  71   }
  72
  73   private static Metric.MetricType convert(org.sonar.api.measures.Metric.ValueType coreMetricType) {
  74     return Metric.MetricType.valueOf(coreMetricType.name());
  75   }
  76
  77   public MetricRepositoryRule add(Metric metric) {
  78     requireNonNull(metric.getKey(), "key can not be null");
  79
  80     checkState(!metricsByKey.containsKey(metric.getKey()), format("Repository already contains a metric for key %s", metric.getKey()));
  81     checkState(!metricsByUuid.containsKey(metric.getUuid()), format("Repository already contains a metric for id %s", metric.getUuid()));
  82
  83     metricsByKey.put(metric.getKey(), metric);
  84     metricsByUuid.put(metric.getUuid(), metric);
  85
  86     return this;
  87   }
  88
  89   @Override
  90   protected void after() {
  91     this.metricsByUuid.clear();
  92     this.metricsByUuid.clear();
  93   }
  94
  95   @Override
  96   public Metric getByKey(String key) {
  97     Metric res = metricsByKey.get(key);
  98     checkState(res != null, format("No Metric can be found for key %s", key));
  99     return res;
 100   }
 101
 102   @Override
 103   public Metric getByUuid(String uuid) {
 104     Metric res = metricsByUuid.get(uuid);
 105     checkState(res != null, format("No Metric can be found for uuid %s", uuid));
 106     return res;
 107   }
 108
 109   @Override
 110   public Optional<Metric> getOptionalByUuid(String uuid) {
 111     return Optional.of(metricsByUuid.get(uuid));
 112   }
 113
 114   @Override
 115   public Iterable<Metric> getAll() {
 116     return metricsByKey.values();
 117   }
 118
 119   @Override
 120   public List<Metric> getMetricsByType(Metric.MetricType type) {
 121     return metricsByKey.values().stream().filter(m -> m.getType() == type).collect(Collectors.toList());
 122   }
 123 }