aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-telemetry/src/test/java/org/sonar/telemetry/metrics/TelemetryMetricsMapperTest.java
blob: 193566b5f6898838fe2cc45dbed20a555aaf7b08 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
 * SonarQube
 * Copyright (C) 2009-2025 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.telemetry.metrics;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.assertj.core.groups.Tuple;
import org.junit.jupiter.api.Test;
import org.sonar.telemetry.core.Dimension;
import org.sonar.telemetry.core.Granularity;
import org.sonar.telemetry.core.TelemetryDataProvider;
import org.sonar.telemetry.core.TelemetryDataType;
import org.sonar.telemetry.core.schema.InstallationMetric;
import org.sonar.telemetry.core.schema.LanguageMetric;
import org.sonar.telemetry.core.schema.Metric;
import org.sonar.telemetry.core.schema.ProjectMetric;
import org.sonar.telemetry.core.schema.UserMetric;

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

class TelemetryMetricsMapperTest {

  @Test
  void mapFromDataProvider_withInstallationProviderSingleValue_returnsSingleValue() {
    // Override multi-value method to return empty. Keep the single-value method defined in TestTelemetryBean.
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.INSTALLATION) {
      @Override
      public Map<String, String> getValues() {
        return Map.of();
      }
    };

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics)
      .extracting(InstallationMetric::getKey, InstallationMetric::getType, InstallationMetric::getValue, InstallationMetric::getGranularity)
      .containsExactlyInAnyOrder(
        tuple("telemetry-bean-a", TelemetryDataType.STRING, "value", Granularity.DAILY));
  }

  @Test
  void mapFromDataProvider_withInstallationProviderMultiValues_returnsMultipleValues() {
    // Override single-value method to return empty. Keep the multi-value method defined in TestTelemetryBean.
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.INSTALLATION) {
      @Override
      public Optional<String> getValue() {
        return Optional.empty();
      }
    };

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics)
      .extracting(InstallationMetric::getKey, InstallationMetric::getType, InstallationMetric::getValue, InstallationMetric::getGranularity)
      .containsExactlyInAnyOrder(
        tuple("telemetry-bean-a.key-1", TelemetryDataType.STRING, "value-1", Granularity.DAILY),
        tuple("telemetry-bean-a.key-2", TelemetryDataType.STRING, "value-2", Granularity.DAILY));
  }

  @Test
  void mapFromDataProvider_withInstallationProviderAdhocNoValues_returnEmptySet() {
    // Override single-value and multi-value methods to return empty.
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.INSTALLATION) {
      @Override
      public Granularity getGranularity() {
        return Granularity.ADHOC;
      }

      @Override
      public Optional<String> getValue() {
        return Optional.empty();
      }

      @Override
      public Map<String, String> getValues() {
        return Map.of();
      }
    };

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics)
      .extracting(InstallationMetric::getKey, InstallationMetric::getType, InstallationMetric::getValue, InstallationMetric::getGranularity)
      .isEmpty();
  }

  @Test
  void mapFromDataProvider_withInstallationProviderDailyNoValues_returnTelemetryWithNullValue() {
    // Override single-value and multi-value methods to return empty.
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.INSTALLATION) {
      @Override
      public Optional<String> getValue() {
        return Optional.empty();
      }

      @Override
      public Map<String, String> getValues() {
        return Map.of();
      }
    };

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics)
      .extracting(InstallationMetric::getKey, InstallationMetric::getType, InstallationMetric::getValue, InstallationMetric::getGranularity)
      .containsExactlyInAnyOrder(
        tuple("telemetry-bean-a", TelemetryDataType.STRING, null, Granularity.DAILY));
  }

  @Test
  void mapFromDataProvider_whenUserProvider() {
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.USER);

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<UserMetric> list = retrieveList(metrics);

    assertThat(list)
      .extracting(UserMetric::getKey, UserMetric::getType, UserMetric::getUserUuid, UserMetric::getValue, UserMetric::getGranularity)
      .containsExactlyInAnyOrder(
        expected());
  }

  @Test
  void mapFromDataProvider_whenLanguageProvider() {
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.LANGUAGE);

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<LanguageMetric> list = retrieveList(metrics);

    assertThat(list)
      .extracting(LanguageMetric::getKey, LanguageMetric::getType, LanguageMetric::getLanguage, LanguageMetric::getValue, LanguageMetric::getGranularity)
      .containsExactlyInAnyOrder(
        expected());
  }

  @Test
  void mapFromDataProvider_whenProjectProvider() {
    TelemetryDataProvider<String> provider = new TestTelemetryBean(Dimension.PROJECT);

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<ProjectMetric> list = retrieveList(metrics);

    assertThat(list)
      .extracting(ProjectMetric::getKey, ProjectMetric::getType, ProjectMetric::getProjectUuid, ProjectMetric::getValue, ProjectMetric::getGranularity)
      .containsExactlyInAnyOrder(
        expected());
  }

  @Test
  void mapFromDataProvider_whenAdhocInstallationProviderWithoutValue_shouldNotMapToMetric() {
    TestTelemetryAdhocBean provider = new TestTelemetryAdhocBean(Dimension.INSTALLATION, false); // Force the value so that nothing is returned

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics).isEmpty();
  }

  @Test
  void mapFromDataProvider_whenAdhocInstallationProviderWithValue_shouldMapToMetric() {
    TestTelemetryAdhocBean provider = new TestTelemetryAdhocBean(Dimension.INSTALLATION, true); // Force the value to be returned

    Set<Metric> metrics = TelemetryMetricsMapper.mapFromDataProvider(provider);
    List<InstallationMetric> userMetrics = retrieveList(metrics);

    assertThat(userMetrics)
      .extracting(InstallationMetric::getKey, InstallationMetric::getType, InstallationMetric::getValue, InstallationMetric::getGranularity)
      .containsExactlyInAnyOrder(
        tuple("telemetry-adhoc-bean", TelemetryDataType.BOOLEAN, true, Granularity.ADHOC));
  }

  private static Tuple[] expected() {
    return new Tuple[] {
      tuple("telemetry-bean-a", TelemetryDataType.STRING, "key-1", "value-1", Granularity.DAILY),
      tuple("telemetry-bean-a", TelemetryDataType.STRING, "key-2", "value-2", Granularity.DAILY)
    };
  }

  private static <T extends Metric> List<T> retrieveList(Set<Metric> metrics) {
    return new ArrayList<>((Set<T>) metrics);
  }

}