aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src/test/java/org/sonar/api/measures/MetricTest.java
blob: d4bb10443c3438804c6924a35525d4406873cd5f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * SonarQube
 * Copyright (C) 2009-2021 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.api.measures;

import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;

import static org.assertj.core.api.Assertions.assertThat;

public class MetricTest {

  @Rule
  public ExpectedException expectedException = ExpectedException.none();

  @Test
  public void shouldCreateMetric() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.INT)
      .setDomain("my domain")
      .create();

    assertThat(metric.getKey()).isEqualTo("foo");
    assertThat(metric.getName()).isEqualTo("Foo");
    assertThat(metric.getDomain()).isEqualTo("my domain");
  }

  @Test
  public void shouldCreateMetricWithDefaultValues() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.INT)
      .create();

    assertThat(metric.getBestValue()).isNull();
    assertThat(metric.getDescription()).isNull();
    assertThat(metric.getWorstValue()).isNull();
    assertThat(metric.getDirection()).isEqualTo(Metric.DIRECTION_NONE);
    assertThat(metric.getEnabled()).isTrue();
    assertThat(metric.getUuid()).isNull();
    assertThat(metric.getUserManaged()).isFalse();
    assertThat(metric.isHidden()).isFalse();
    assertThat(metric.isOptimizedBestValue()).isFalse();
  }

  @Test
  public void shouldCreatePercentMetricWithDefaultValues() {
    Metric better = new Metric.Builder("foo", "Foo", Metric.ValueType.PERCENT)
      .setDirection(Metric.DIRECTION_BETTER)
      .create();
    Metric worst = new Metric.Builder("foo", "Foo", Metric.ValueType.PERCENT)
      .setDirection(Metric.DIRECTION_WORST)
      .create();

    assertThat(better.getBestValue()).isEqualTo(100.0);
    assertThat(better.getWorstValue()).isEqualTo(0.0);
    assertThat(worst.getBestValue()).isEqualTo(0.0);
    assertThat(worst.getWorstValue()).isEqualTo(100.0);
  }

  @Test
  public void override_decimal_scale_of_float_metric() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.FLOAT)
      .setDecimalScale(3)
      .create();
    assertThat(metric.getDecimalScale()).isEqualTo(3);
  }

  @Test
  public void fail_if_decimal_scale_is_greater_than_max_supported_value() {
    expectedException.expect(IllegalArgumentException.class);
    expectedException.expectMessage("Scale of decimal metric [foo] must be less than or equal 5: 6");

    new Metric.Builder("foo", "Foo", Metric.ValueType.FLOAT)
      .setDecimalScale(6)
      .create();
  }

  @Test
  public void override_decimal_scale_of_percent_metric() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.PERCENT)
      .setDecimalScale(3)
      .create();
    assertThat(metric.getDecimalScale()).isEqualTo(3);
  }

  @Test
  public void default_decimal_scale_is_1() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.FLOAT)
      .create();
    assertThat(metric.getDecimalScale()).isEqualTo(1);
  }

  @Test
  public void non_decimal_metric_has_no_scale() {
    Metric metric = new Metric.Builder("foo", "Foo", Metric.ValueType.INT)
      .create();
    assertThat(metric.getDecimalScale()).isNull();
  }
}