SONARJAVA-5686 Report the scanner app using telemetry (#5250)

Author: tomasz-tylenda-sonarsource

its/plugin/tests/src/test/java/com/sonar/it/java/suite/JavaTutorialTest.java

@@ -16,6 +16,7 @@
  */
 package com.sonar.it.java.suite;
 
+import com.sonar.orchestrator.build.BuildResult;
 import com.sonar.orchestrator.build.MavenBuild;
 import com.sonar.orchestrator.junit4.OrchestratorRule;
 import java.util.List;
@@ -33,7 +34,10 @@ public class JavaTutorialTest {
 
   @Test
   public void test() {
-    MavenBuild build = TestUtils.createMavenBuild().setPom(TestUtils.projectPom("java-tutorial")).setCleanPackageSonarGoals();
+    MavenBuild build = TestUtils.createMavenBuild()
+      .setPom(TestUtils.projectPom("java-tutorial"))
+      .setCleanPackageSonarGoals()
+      .setDebugLogs(true);
     String projectKey = "org.sonarsource.it.projects:java-tutorial";
     TestUtils.provisionProject(orchestrator, projectKey, "java-tutorial", "java", "java-tutorial");
     executeAndAssertBuild(build, projectKey);
@@ -47,13 +51,14 @@ public void test_as_batch_mode() {
       .setCleanPackageSonarGoals()
       .setProperty("sonar.projectKey", projectKey)
       .setProperty("sonar.projectName", projectName)
-      .setProperty("sonar.java.experimental.batchModeSizeInKB", "8000");
+      .setProperty("sonar.java.experimental.batchModeSizeInKB", "8000")
+      .setDebugLogs(true);
     TestUtils.provisionProject(orchestrator, projectKey, projectName, "java", "java-tutorial");
     executeAndAssertBuild(build, projectKey);
   }
 
   private void executeAndAssertBuild(MavenBuild build, String projectKey) {
-    orchestrator.executeBuild(build);
+    BuildResult buildResult = orchestrator.executeBuild(build);
 
     List<Issue> issues = TestUtils.issuesForComponent(orchestrator, projectKey);
     assertThat(issues).hasSize(31);
@@ -63,6 +68,8 @@ private void executeAndAssertBuild(MavenBuild build, String projectKey) {
     assertThat(issuesForRule(issues, "mycompany-java:AvoidBrandInMethodNames")).hasSize(2);
     assertThat(issuesForRule(issues, "mycompany-java:SecurityAnnotationMandatory")).hasSize(2);
     assertThat(issuesForRule(issues, "mycompany-java:SpringControllerRequestMappingEntity")).hasSize(1);
+
+    assertThat(buildResult.getLogs()).containsOnlyOnce("java.scanner_app=ScannerMaven");
   }
 
   private static Stream<String> issuesForRule(List<Issue> issues, String key) {

java-frontend/src/main/java/org/sonar/java/TelemetryKey.java

@@ -20,7 +20,8 @@
  * Telemetry keys used by the Java analyzer.
  */
 public enum TelemetryKey {
-  JAVA_LANGUAGE_VERSION("java.language.version");
+  JAVA_LANGUAGE_VERSION("java.language.version"),
+  JAVA_SCANNER_APP("java.scanner_app");
 
   private final String key;
 

sonar-java-plugin/src/main/java/org/sonar/plugins/java/JavaSensor.java

@@ -53,6 +53,7 @@
 
 import static org.sonar.api.rules.RuleAnnotationUtils.getRuleKey;
 import static org.sonar.java.TelemetryKey.JAVA_LANGUAGE_VERSION;
+import static org.sonar.java.TelemetryKey.JAVA_SCANNER_APP;
 
 @Phase(name = Phase.Name.PRE)
 @DependedUpon("org.sonar.plugins.java.JavaSensor")
@@ -110,6 +111,8 @@ public void execute(SensorContext context) {
     JavaVersion javaVersion = getJavaVersion();
     telemetry.addMetric(JAVA_LANGUAGE_VERSION, javaVersion.toString());
 
+    telemetry.addMetric(JAVA_SCANNER_APP, settings.get("sonar.scanner.app").orElse("none"));
+
     JavaFrontend frontend = new JavaFrontend(javaVersion, sonarComponents, measurer, javaResourceLocator, postAnalysisIssueFilter,
       sonarComponents.mainChecks().toArray(new JavaCheck[0]));
     frontend.scan(getSourceFiles(), getTestFiles(), runJasper(context));

sonar-java-plugin/src/main/java/org/sonar/plugins/java/SensorTelemetry.java

@@ -16,6 +16,8 @@
  */
 package org.sonar.plugins.java;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.java.Telemetry;
 import org.sonar.java.TelemetryKey;
@@ -24,6 +26,8 @@
  * Wraps up {@link SensorContext} to allow passing it around without exposing other APIs.
  */
 public class SensorTelemetry implements Telemetry {
+  private static final Logger LOG = LoggerFactory.getLogger(SensorTelemetry.class);
+
   private final SensorContext context;
 
   public SensorTelemetry(SensorContext context) {
@@ -32,6 +36,7 @@ public SensorTelemetry(SensorContext context) {
 
   @Override
   public void addMetric(TelemetryKey key, String value) {
+    LOG.debug("{}={}", key.key(), value);
     this.context.addTelemetryProperty(key.key(), value);
   }
 }

sonar-java-plugin/src/test/java/org/sonar/plugins/java/JavaSensorTest.java

@@ -122,6 +122,8 @@ void test_issues_creation_on_test_file() throws IOException { // NOSONAR require
   private void testIssueCreation(InputFile.Type onType, int expectedIssues) throws IOException {
     MapSettings settings = new MapSettings();
     settings.setProperty(JavaVersion.SOURCE_VERSION, "22");
+    settings.setProperty("sonar.scanner.app", "ScannerJavaSensorTest");
+
     NoSonarFilter noSonarFilter = mock(NoSonarFilter.class);
     SensorContextTester context = spy(createContext(onType).setRuntime(SonarRuntimeImpl.forSonarLint(Version.create(6, 7))));
     DefaultFileSystem fs = context.fileSystem();
@@ -135,6 +137,7 @@ private void testIssueCreation(InputFile.Type onType, int expectedIssues) throws
     verify(noSonarFilter, times(1)).noSonarInFile(fs.inputFiles().iterator().next(), Collections.singleton(118));
     verify(sonarComponents, times(expectedIssues)).reportIssue(any(AnalyzerMessage.class));
     verify(context).addTelemetryProperty("java.language.version", "22");
+    verify(context).addTelemetryProperty("java.scanner_app", "ScannerJavaSensorTest");
 
 
     settings.setProperty(JavaVersion.SOURCE_VERSION, "wrongFormat");