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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2022 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.server.telemetry;
  21
  22 import com.tngtech.java.junit.dataprovider.DataProvider;
  23 import com.tngtech.java.junit.dataprovider.DataProviderRunner;
  24 import com.tngtech.java.junit.dataprovider.UseDataProvider;
  25 import java.io.StringWriter;
  26 import java.util.Arrays;
  27 import java.util.Collections;
  28 import java.util.List;
  29 import java.util.Locale;
  30 import java.util.Map;
  31 import java.util.Random;
  32 import java.util.stream.Collectors;
  33 import java.util.stream.IntStream;
  34 import org.apache.commons.codec.digest.DigestUtils;
  35 import org.jetbrains.annotations.NotNull;
  36 import org.junit.Test;
  37 import org.junit.runner.RunWith;
  38 import org.sonar.api.utils.text.JsonWriter;
  39 import org.sonar.core.platform.EditionProvider;
  40 import org.sonar.core.util.stream.MoreCollectors;
  41 import org.sonar.db.user.UserTelemetryDto;
  42
  43 import static java.util.Arrays.asList;
  44 import static java.util.stream.Collectors.joining;
  45 import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
  46 import static org.assertj.core.api.Assertions.assertThat;
  47 import static org.sonar.test.JsonAssert.assertJson;
  48
  49 @RunWith(DataProviderRunner.class)
  50 public class TelemetryDataJsonWriterTest {
  51
  52   private static final TelemetryData.Builder SOME_TELEMETRY_DATA = TelemetryData.builder()
  53     .setServerId("foo")
  54     .setVersion("bar")
  55     .setPlugins(Collections.emptyMap())
  56     .setExternalAuthenticationProviders(asList("github", "gitlab"))
  57     .setDatabase(new TelemetryData.Database("H2", "11"));
  58
  59   private final Random random = new Random();
  60
  61   private final TelemetryDataJsonWriter underTest = new TelemetryDataJsonWriter();
  62
  63   @Test
  64   public void write_server_id_and_version() {
  65     TelemetryData data = SOME_TELEMETRY_DATA.build();
  66
  67     String json = writeTelemetryData(data);
  68
  69     assertJson(json).isSimilarTo("{" +
  70       "  \"id\": \"" + data.getServerId() + "\"," +
  71       "  \"version\": \"" + data.getVersion() + "\"" +
  72       "}");
  73   }
  74
  75   @Test
  76   public void does_not_write_edition_if_null() {
  77     TelemetryData data = SOME_TELEMETRY_DATA.build();
  78
  79     String json = writeTelemetryData(data);
  80
  81     assertThat(json).doesNotContain("edition");
  82   }
  83
  84   @Test
  85   public void write_external_auth_providers() {
  86     TelemetryData data = SOME_TELEMETRY_DATA.build();
  87
  88     String json = writeTelemetryData(data);
  89
  90     assertJson(json).isSimilarTo("{ \"externalAuthProviders\": [ \"github\", \"gitlab\" ] }");
  91   }
  92
  93   @Test
  94   @UseDataProvider("allEditions")
  95   public void writes_edition_if_non_null(EditionProvider.Edition edition) {
  96     TelemetryData data = SOME_TELEMETRY_DATA
  97       .setEdition(edition)
  98       .build();
  99
 100     String json = writeTelemetryData(data);
 101
 102     assertJson(json).isSimilarTo("{" +
 103       "  \"edition\": \"" + edition.name().toLowerCase(Locale.ENGLISH) + "\"" +
 104       "}");
 105   }
 106
 107   @Test
 108   public void does_not_write_license_type_if_null() {
 109     TelemetryData data = SOME_TELEMETRY_DATA.build();
 110
 111     String json = writeTelemetryData(data);
 112
 113     assertThat(json).doesNotContain("licenseType");
 114   }
 115
 116   @Test
 117   public void writes_licenseType_if_non_null() {
 118     String expected = randomAlphabetic(12);
 119     TelemetryData data = SOME_TELEMETRY_DATA
 120       .setLicenseType(expected)
 121       .build();
 122
 123     String json = writeTelemetryData(data);
 124
 125     assertJson(json).isSimilarTo("{" +
 126       "  \"licenseType\": \"" + expected + "\"" +
 127       "}");
 128   }
 129
 130   @Test
 131   public void writes_database() {
 132     String name = randomAlphabetic(12);
 133     String version = randomAlphabetic(10);
 134     TelemetryData data = SOME_TELEMETRY_DATA
 135       .setDatabase(new TelemetryData.Database(name, version))
 136       .build();
 137
 138     String json = writeTelemetryData(data);
 139
 140     assertJson(json).isSimilarTo("{" +
 141       "  \"database\": {" +
 142       "    \"name\": \"" + name + "\"," +
 143       "    \"version\": \"" + version + "\"" +
 144       "  }" +
 145       "}");
 146   }
 147
 148   @Test
 149   public void writes_no_plugins() {
 150     TelemetryData data = SOME_TELEMETRY_DATA
 151       .setPlugins(Collections.emptyMap())
 152       .build();
 153
 154     String json = writeTelemetryData(data);
 155
 156     assertJson(json).isSimilarTo("{" +
 157       "  \"plugins\": []" +
 158       "}");
 159   }
 160
 161   @Test
 162   public void writes_all_plugins() {
 163     Map<String, String> plugins = IntStream.range(0, 1 + random.nextInt(10))
 164       .boxed()
 165       .collect(MoreCollectors.uniqueIndex(i -> "P" + i, i -> "V" + i));
 166     TelemetryData data = SOME_TELEMETRY_DATA
 167       .setPlugins(plugins)
 168       .build();
 169
 170     String json = writeTelemetryData(data);
 171
 172     assertJson(json).isSimilarTo("{" +
 173       "  \"plugins\": " +
 174       "[" +
 175       plugins.entrySet().stream().map(e -> "{\"name\":\"" + e.getKey() + "\",\"version\":\"" + e.getValue() + "\"}").collect(joining(",")) +
 176       "]" +
 177       "}");
 178   }
 179
 180   @Test
 181   public void does_not_write_installation_date_if_null() {
 182     TelemetryData data = SOME_TELEMETRY_DATA
 183       .setInstallationDate(null)
 184       .build();
 185
 186     String json = writeTelemetryData(data);
 187
 188     assertThat(json).doesNotContain("installationDate");
 189   }
 190
 191   @Test
 192   public void write_installation_date_in_utc_format() {
 193     TelemetryData data = SOME_TELEMETRY_DATA
 194       .setInstallationDate(1_000L)
 195       .build();
 196
 197     String json = writeTelemetryData(data);
 198
 199     assertJson(json).isSimilarTo("{" +
 200       "  \"installationDate\":\"1970-01-01T00:00:01+0000\"," +
 201       "}");
 202   }
 203
 204   @Test
 205   public void does_not_write_installation_version_if_null() {
 206     TelemetryData data = SOME_TELEMETRY_DATA
 207       .setInstallationVersion(null)
 208       .build();
 209
 210     String json = writeTelemetryData(data);
 211
 212     assertThat(json).doesNotContain("installationVersion");
 213   }
 214
 215   @Test
 216   public void write_installation_version() {
 217     String installationVersion = randomAlphabetic(5);
 218     TelemetryData data = SOME_TELEMETRY_DATA
 219       .setInstallationVersion(installationVersion)
 220       .build();
 221
 222     String json = writeTelemetryData(data);
 223
 224     assertJson(json).isSimilarTo("{" +
 225       "  \"installationVersion\":\"" + installationVersion + "\"" +
 226       "}");
 227   }
 228
 229   @Test
 230   public void write_docker_flag() {
 231     boolean inDocker = random.nextBoolean();
 232     TelemetryData data = SOME_TELEMETRY_DATA
 233       .setInDocker(inDocker)
 234       .build();
 235
 236     String json = writeTelemetryData(data);
 237
 238     assertJson(json).isSimilarTo("{" +
 239       "  \"docker\":" + inDocker +
 240       "}");
 241   }
 242
 243   @Test
 244   public void writes_has_unanalyzed_languages() {
 245     TelemetryData data = SOME_TELEMETRY_DATA
 246       .setHasUnanalyzedC(true)
 247       .setHasUnanalyzedCpp(false)
 248       .build();
 249
 250     String json = writeTelemetryData(data);
 251
 252     assertJson(json).isSimilarTo("{" +
 253       "  \"hasUnanalyzedC\":true," +
 254       "  \"hasUnanalyzedCpp\":false," +
 255       "}");
 256   }
 257
 258   @Test
 259   public void writes_security_custom_config() {
 260     TelemetryData data = SOME_TELEMETRY_DATA
 261       .setCustomSecurityConfigs(Arrays.asList("php", "java"))
 262       .build();
 263
 264     String json = writeTelemetryData(data);
 265
 266     assertJson(json).isSimilarTo("{" +
 267       "  \"customSecurityConfig\": [\"php\", \"java\"]" +
 268       "}");
 269   }
 270
 271   @Test
 272   public void writes_all_users_with_anonymous_md5_uuids() {
 273     TelemetryData data = SOME_TELEMETRY_DATA
 274       .setUsers(getUsers())
 275       .build();
 276
 277     String json = writeTelemetryData(data);
 278
 279     assertJson(json).isSimilarTo("{" +
 280       "  \"users\": [" +
 281       "    {" +
 282       "      \"userUuid\":\"" + DigestUtils.sha3_224Hex("uuid-0") + "\"," +
 283       "      \"lastActivity\":\"1970-01-01T00:00:00+0000\"," +
 284       "      \"lastSonarlintActivity\":\"1970-01-01T00:00:00+0000\"," +
 285       "      \"status\":\"active\"" +
 286       "    }," +
 287       "    {" +
 288       "      \"userUuid\":\"" + DigestUtils.sha3_224Hex("uuid-1") + "\"," +
 289       "      \"lastActivity\":\"1970-01-01T00:00:00+0000\"," +
 290       "      \"lastSonarlintActivity\":\"1970-01-01T00:00:00+0000\"," +
 291       "      \"status\":\"inactive\"" +
 292       "    }," +
 293       "    {" +
 294       "      \"userUuid\":\"" + DigestUtils.sha3_224Hex("uuid-2") + "\"," +
 295       "      \"lastActivity\":\"1970-01-01T00:00:00+0000\"," +
 296       "      \"lastSonarlintActivity\":\"1970-01-01T00:00:00+0000\"," +
 297       "      \"status\":\"active\"" +
 298       "    }" +
 299       "  ]" +
 300       "}");
 301   }
 302
 303   @Test
 304   public void writes_all_projects() {
 305     TelemetryData data = SOME_TELEMETRY_DATA
 306       .setProjects(getProjects())
 307       .build();
 308
 309     String json = writeTelemetryData(data);
 310
 311     assertJson(json).isSimilarTo("{" +
 312       "  \"projects\": [" +
 313       "    {" +
 314       "      \"projectUuid\": \"uuid-0\"," +
 315       "      \"language\": \"lang-0\"," +
 316       "      \"lastAnalysis\":\"1970-01-01T00:00:00+0000\"," +
 317       "      \"loc\": 2" +
 318       "    }," +
 319       "    {" +
 320       "      \"projectUuid\": \"uuid-1\"," +
 321       "      \"language\": \"lang-1\"," +
 322       "      \"lastAnalysis\":\"1970-01-01T00:00:00+0000\"," +
 323       "      \"loc\": 4" +
 324       "    }," +
 325       "    {" +
 326       "      \"projectUuid\": \"uuid-2\"," +
 327       "      \"language\": \"lang-2\"," +
 328       "      \"lastAnalysis\":\"1970-01-01T00:00:00+0000\"," +
 329       "      \"loc\": 6" +
 330       "    }" +
 331       "  ]" +
 332       "}");
 333   }
 334
 335   @Test
 336   public void writes_all_projects_stats() {
 337     TelemetryData data = SOME_TELEMETRY_DATA
 338       .setProjectStatistics(getProjectStats())
 339       .build();
 340
 341     String json = writeTelemetryData(data);
 342
 343     assertJson(json).isSimilarTo("{" +
 344       "  \"projects-general-stats\": [" +
 345       "    {" +
 346       "      \"projectUuid\": \"uuid-0\"," +
 347       "      \"branchCount\": 2," +
 348       "      \"pullRequestCount\": 2," +
 349       "      \"scm\": \"scm-0\"," +
 350       "      \"ci\": \"ci-0\"," +
 351       "      \"alm\": \"alm-0\"" +
 352       "    }," +
 353       "    {" +
 354       "      \"projectUuid\": \"uuid-1\"," +
 355       "      \"branchCount\": 4," +
 356       "      \"pullRequestCount\": 4," +
 357       "      \"scm\": \"scm-1\"," +
 358       "      \"ci\": \"ci-1\"," +
 359       "      \"alm\": \"alm-1\"" +
 360       "    }," +
 361       "    {" +
 362       "      \"projectUuid\": \"uuid-2\"," +
 363       "      \"branchCount\": 6," +
 364       "      \"pullRequestCount\": 6," +
 365       "      \"scm\": \"scm-2\"," +
 366       "      \"ci\": \"ci-2\"," +
 367       "      \"alm\": \"alm-2\"" +
 368       "    }" +
 369       "  ]" +
 370       "}");
 371   }
 372
 373   @NotNull
 374   private static List<UserTelemetryDto> getUsers() {
 375     return IntStream.range(0, 3).mapToObj(i -> new UserTelemetryDto().setUuid("uuid-" + i).setActive(i % 2 == 0).setLastConnectionDate(1L).setLastSonarlintConnectionDate(2L))
 376       .collect(Collectors.toList());
 377   }
 378
 379   private static List<TelemetryData.Project> getProjects() {
 380     return IntStream.range(0, 3).mapToObj(i -> new TelemetryData.Project("uuid-" + i, 1L, "lang-" + i, (i + 1L) * 2L)).collect(Collectors.toList());
 381   }
 382
 383   private List<TelemetryData.ProjectStatistics> getProjectStats() {
 384     return IntStream.range(0, 3).mapToObj(i -> new TelemetryData.ProjectStatistics("uuid-" + i, (i + 1L) * 2L, (i + 1L) * 2L, "scm-" + i, "ci-" + i, "alm-" + i))
 385       .collect(Collectors.toList());
 386   }
 387
 388   @DataProvider
 389   public static Object[][] allEditions() {
 390     return Arrays.stream(EditionProvider.Edition.values())
 391       .map(t -> new Object[] {t})
 392       .toArray(Object[][]::new);
 393   }
 394
 395   private String writeTelemetryData(TelemetryData data) {
 396     StringWriter jsonString = new StringWriter();
 397     try (JsonWriter json = JsonWriter.of(jsonString)) {
 398       underTest.writeTelemetryData(json, data);
 399     }
 400     return jsonString.toString();
 401   }
 402 }