SONARJAVA-5691 Report dependencies

Author: tomasz-tylenda-sonarsource

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

@@ -23,6 +23,8 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import java.util.function.Consumer;
 import java.util.stream.Stream;
@@ -35,33 +37,48 @@
 import org.sonar.java.ast.visitors.FileLinesVisitor;
 import org.sonar.java.ast.visitors.SyntaxHighlighterVisitor;
 import org.sonar.java.caching.CacheContextImpl;
+import org.sonar.java.classpath.DependencyVersionInference;
 import org.sonar.java.collections.CollectionUtils;
 import org.sonar.java.exceptions.ApiMismatchException;
 import org.sonar.java.filters.SonarJavaIssueFilter;
 import org.sonar.java.model.JParserConfig;
 import org.sonar.java.model.VisitorsBridge;
+import org.sonar.java.telemetry.Telemetry;
+import org.sonar.java.telemetry.TelemetryKey;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonar.plugins.java.api.JavaResourceLocator;
 import org.sonar.plugins.java.api.JavaVersion;
+import org.sonar.plugins.java.api.Version;
 import org.sonarsource.performance.measure.PerformanceMeasure;
 import org.sonarsource.performance.measure.PerformanceMeasure.Duration;
 
+import static org.sonar.java.telemetry.TelemetryKey.JAVA_DEPENDENCY_LOMBOK;
+import static org.sonar.java.telemetry.TelemetryKey.JAVA_DEPENDENCY_SPRING_BOOT;
+
 public class JavaFrontend {
 
   private static final Logger LOG = LoggerFactory.getLogger(JavaFrontend.class);
   private static final String BATCH_ERROR_MESSAGE = "Batch Mode failed, analysis of Java Files stopped.";
 
+  /** List of libraries, whose presence or absence we want to report. */
+  private static final Map<TelemetryKey, String> REPORTED_DEPENDENCIES = Map.of(
+    JAVA_DEPENDENCY_LOMBOK, "lombok",
+    JAVA_DEPENDENCY_SPRING_BOOT, "spring-boot"
+  );
+
   private final JavaVersion javaVersion;
   private final SonarComponents sonarComponents;
+  private final Telemetry telemetry;
   private final List<File> globalClasspath;
   private final JavaAstScanner astScanner;
   private final JavaAstScanner astScannerForTests;
   private final JavaAstScanner astScannerForGeneratedFiles;
 
-  public JavaFrontend(JavaVersion javaVersion, SonarComponents sonarComponents, Measurer measurer,
+  public JavaFrontend(JavaVersion javaVersion, SonarComponents sonarComponents, Measurer measurer, Telemetry telemetry,
                       JavaResourceLocator javaResourceLocator, @Nullable SonarJavaIssueFilter postAnalysisIssueFilter, JavaCheck... visitors) {
     this.javaVersion = javaVersion;
     this.sonarComponents = sonarComponents;
+    this.telemetry = telemetry;
     List<JavaCheck> commonVisitors = new ArrayList<>();
     commonVisitors.add(javaResourceLocator);
     if (postAnalysisIssueFilter != null) {
@@ -145,6 +162,15 @@ public void scan(Iterable<InputFile> sourceFiles, Iterable<InputFile> testFiles,
       scanAsBatch(new DefaultBatchModeContext(astScannerForTests, "Test"), testFiles);
       scanAsBatch(new DefaultBatchModeContext(astScannerForGeneratedFiles, "Generated"), generatedFiles);
     }
+
+    DependencyVersionInference dependencyService = new DependencyVersionInference();
+    for (Map.Entry<TelemetryKey, String> dep : REPORTED_DEPENDENCIES.entrySet()) {
+      dependencyService
+        .infer(dep.getValue(), globalClasspath)
+        .ifPresent(version ->
+          telemetry.aggregateAsSortedSet(dep.getKey(), version.toString())
+        );
+    }
   }
 
   /**

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

@@ -22,7 +22,11 @@
 public enum TelemetryKey {
   JAVA_LANGUAGE_VERSION("java.language.version"),
   JAVA_SCANNER_APP("java.scanner_app"),
-  JAVA_MODULE_COUNT("java.module_count");
+  JAVA_MODULE_COUNT("java.module_count"),
+
+  // The last element of dependency keys should be the same as the name of its jar.
+  JAVA_DEPENDENCY_LOMBOK("java.dependency.lombok"),
+  JAVA_DEPENDENCY_SPRING_BOOT("java.dependency.spring-boot");
 
   private final String key;
 

java-frontend/src/test/java/org/sonar/java/JavaFrontendTest.java

@@ -57,6 +57,7 @@
 import org.sonar.java.exceptions.ApiMismatchException;
 import org.sonar.java.filters.SonarJavaIssueFilter;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.telemetry.NoOpTelemetry;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonar.plugins.java.api.JavaFileScanner;
@@ -181,7 +182,7 @@ void scanning_empty_project_should_be_logged_in_file_by_file_sonarlint() {
 
   @Test
   void scanning_empty_project_should_be_logged_in_batch() {
-    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), new Measurer(sensorContext, mock(NoSonarFilter.class)), mock(JavaResourceLocator.class), mainCodeIssueScannerAndFilter);
+    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), new Measurer(sensorContext, mock(NoSonarFilter.class)), new NoOpTelemetry(), mock(JavaResourceLocator.class), mainCodeIssueScannerAndFilter);
     frontend.scan(Collections.emptyList(), Collections.emptyList(), Collections.emptyList());
 
     assertThat(logTester.logs(Level.INFO)).containsExactly(
@@ -254,6 +255,7 @@ void test_scan_logs_when_caching_is_enabled_and_can_skip_unchanged_files() throw
       new JavaVersionImpl(),
       specificSonarComponents,
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -287,6 +289,7 @@ void test_scan_logs_when_caching_is_enabled_and_cannot_skip_unchanged_files() th
       new JavaVersionImpl(),
       specificSonarComponents,
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -320,6 +323,7 @@ void test_scan_logs_when_caching_is_enabled_and_cannot_determine_if_unchanged_fi
       new JavaVersionImpl(),
       specificSonarComponents,
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -352,6 +356,7 @@ void test_scan_logs_when_caching_is_disabled_and_can_skip_unchanged_files() thro
       new JavaVersionImpl(),
       specificSonarComponents,
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -384,6 +389,7 @@ void test_scan_logs_when_caching_is_disabled_and_cannot_skip_unchanged_files() t
       new JavaVersionImpl(),
       specificSonarComponents,
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -409,6 +415,7 @@ void test_scan_logs_when_caching_is_disabled_when_sonar_components_is_null() {
       new JavaVersionImpl(),
       mockSonarComponents(),
       mock(Measurer.class),
+      new NoOpTelemetry(),
       mock(JavaResourceLocator.class),
       mainCodeIssueScannerAndFilter
     );
@@ -778,8 +785,13 @@ private List<InputFile> scan(MapSettings settings, SonarRuntime sonarRuntime, Li
     JavaVersion javaVersion = settings.asConfig().get(JavaVersion.SOURCE_VERSION)
       .map(JavaVersionImpl::fromString)
       .orElse(new JavaVersionImpl());
-    JavaFrontend frontend = new JavaFrontend(javaVersion, sonarComponents, new Measurer(sensorContext, mock(NoSonarFilter.class)), mock(JavaResourceLocator.class),
-      null, sonarComponents.mainChecks().toArray(new JavaCheck[0]));
+    JavaFrontend frontend = new JavaFrontend(javaVersion,
+      sonarComponents,
+      new Measurer(sensorContext, mock(NoSonarFilter.class)),
+      new NoOpTelemetry(),
+      mock(JavaResourceLocator.class),
+      null,
+      sonarComponents.mainChecks().toArray(new JavaCheck[0]));
     frontend.scan(inputFiles, Collections.emptyList(), Collections.emptyList());
 
     return inputFiles;

java-frontend/src/test/java/org/sonar/java/JavaVersionAwareVisitorTest.java

@@ -22,6 +22,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.telemetry.NoOpTelemetry;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonar.plugins.java.api.JavaFileScannerContext;
@@ -78,7 +79,7 @@ void no_java_version_matching() {
 
   private void checkIssues(JavaVersion version) {
     messages.clear();
-    JavaFrontend frontend = new JavaFrontend(version, mockSonarComponents(), mock(Measurer.class), null, null, javaChecks);
+    JavaFrontend frontend = new JavaFrontend(version, mockSonarComponents(), mock(Measurer.class), new NoOpTelemetry(), null, null, javaChecks);
     frontend.scan(Collections.singletonList(TestUtils.inputFile("src/test/files/JavaVersionAwareChecks.java")),
       Collections.emptyList(), Collections.emptyList());
   }

java-frontend/src/test/java/org/sonar/java/MeasurerTest.java

@@ -25,6 +25,7 @@
 import org.sonar.api.issue.NoSonarFilter;
 import org.sonar.api.utils.PathUtils;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.telemetry.NoOpTelemetry;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
@@ -92,7 +93,7 @@ private void checkMetric(String filename, String metric, Number expectedValue) {
     context.fileSystem().add(inputFile);
 
     Measurer measurer = new Measurer(context, mock(NoSonarFilter.class));
-    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), measurer, null, null);
+    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), measurer, new NoOpTelemetry(), null, null);
 
     frontend.scan(Collections.singletonList(inputFile), Collections.emptyList(), Collections.emptyList());
 

java-frontend/src/test/java/org/sonar/java/MeasurerTester.java

@@ -30,6 +30,7 @@
 import org.sonar.api.batch.sensor.measure.Measure;
 import org.sonar.api.issue.NoSonarFilter;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.telemetry.NoOpTelemetry;
 import org.sonar.plugins.java.api.JavaResourceLocator;
 
 import static org.mockito.Mockito.mock;
@@ -50,7 +51,7 @@ public void setUp() {
       .forEach(fs::add);
 
     Measurer measurer = new Measurer(context, mock(NoSonarFilter.class));
-    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), measurer, mock(JavaResourceLocator.class), null);
+    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), measurer, new NoOpTelemetry(), mock(JavaResourceLocator.class), null);
     List<InputFile> files = StreamSupport.stream(fs.inputFiles().spliterator(), false).toList();
     frontend.scan(files, Collections.emptyList(), Collections.emptyList());
   }

java-frontend/src/test/java/org/sonar/java/ast/visitors/FileLinesVisitorTest.java

@@ -29,6 +29,7 @@
 import org.sonar.java.SonarComponents;
 import org.sonar.java.TestUtils;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.telemetry.NoOpTelemetry;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
@@ -51,7 +52,7 @@ private void checkLines(String filename, FileLinesContext context) {
     SonarComponents sonarComponents = mock(SonarComponents.class);
     when(sonarComponents.fileLinesContextFor(Mockito.any(InputFile.class))).thenReturn(context);
 
-    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), mock(Measurer.class), null, null, new FileLinesVisitor(sonarComponents));
+    JavaFrontend frontend = new JavaFrontend(new JavaVersionImpl(), mockSonarComponents(), mock(Measurer.class), new NoOpTelemetry(), null, null, new FileLinesVisitor(sonarComponents));
 
     frontend.scan(Collections.singletonList(inputFile), Collections.emptyList(), Collections.emptyList());
   }

java-frontend/src/test/java/org/sonar/java/ast/visitors/SyntaxHighlighterVisitorTest.java

@@ -40,6 +40,7 @@
 import org.sonar.java.classpath.ClasspathForMain;
 import org.sonar.java.classpath.ClasspathForTest;
 import org.sonar.java.model.JParserConfig;
+import org.sonar.java.telemetry.NoOpTelemetry;
 import org.sonar.plugins.java.api.JavaVersion;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -255,7 +256,7 @@ void sealed_classes() {
 
   private void scan(InputFile inputFile) {
     JavaVersion javaVersion = JParserConfig.MAXIMUM_SUPPORTED_JAVA_VERSION;
-    JavaFrontend frontend = new JavaFrontend(javaVersion, mockSonarComponents(), mock(Measurer.class), null, null, syntaxHighlighterVisitor);
+    JavaFrontend frontend = new JavaFrontend(javaVersion, mockSonarComponents(), mock(Measurer.class), new NoOpTelemetry(), null, null, syntaxHighlighterVisitor);
     frontend.scan(Collections.singletonList(inputFile), Collections.emptyList(), Collections.emptyList());
   }
 

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

@@ -116,7 +116,12 @@ public void execute(SensorContext context) {
 
     telemetry.aggregateAsSortedSet(JAVA_SCANNER_APP, settings.get("sonar.scanner.app").orElse("none"));
 
-    JavaFrontend frontend = new JavaFrontend(javaVersion, sonarComponents, measurer, javaResourceLocator, postAnalysisIssueFilter,
+    JavaFrontend frontend = new JavaFrontend(javaVersion,
+      sonarComponents,
+      measurer,
+      telemetry,
+      javaResourceLocator,
+      postAnalysisIssueFilter,
       sonarComponents.mainChecks().toArray(new JavaCheck[0]));
     frontend.scan(getSourceFiles(), getTestFiles(), runJasper(context));