SONARJAVA-5845 Add new ModuleMetadata public API

Author: leonardo-pilastri-sonarsource

java-checks-test-sources/default/src/test/java/checks/tests/SpringBootEmptyMethodsCheckSample.java

@@ -7,8 +7,7 @@
 class SpringBootSanityTest {
   // Compliant, first time we encounter a spring sanity test
   @Test
-  void contextLoads() {
-  }
+  void contextLoads() {}
 
   // Noncompliant@+2
   @Test

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

@@ -0,0 +1,51 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-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 Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java;
+
+import org.sonar.api.config.Configuration;
+import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.plugins.java.api.JavaVersion;
+import org.sonar.plugins.java.api.internal.ModuleMetadata;
+
+public class DefaultModuleMetadata implements ModuleMetadata {
+
+  private final JavaVersion javaVersion;
+  private final String moduleKey;
+  private final boolean ignoreUnnamedModuleForSplitPackage;
+
+  public DefaultModuleMetadata(SonarComponents sonarComponents, Configuration configuration) {
+    this.javaVersion = JavaVersionImpl.readFromConfiguration(configuration);
+    this.moduleKey = sonarComponents.getModuleKey();
+    this.ignoreUnnamedModuleForSplitPackage = sonarComponents.shouldIgnoreUnnamedModuleForSplitPackage();
+  }
+
+  @Override
+  public JavaVersion javaVersion() {
+    return javaVersion;
+  }
+
+  @Override
+  public String moduleKey() {
+    return moduleKey;
+  }
+
+  @Override
+  public boolean shouldIgnoreUnnamedModuleForSplitPackage() {
+    return ignoreUnnamedModuleForSplitPackage;
+  }
+
+}

java-frontend/src/main/java/org/sonar/java/model/JavaVersionImpl.java

@@ -17,8 +17,10 @@
 package org.sonar.java.model;
 
 import java.util.Locale;
+import java.util.Optional;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.sonar.api.config.Configuration;
 import org.sonar.plugins.java.api.JavaVersion;
 
 public class JavaVersionImpl implements JavaVersion {
@@ -230,4 +232,22 @@ private static int convertJavaVersionString(String javaVersion) {
     return Integer.parseInt(cleanedVersion);
   }
 
+  public static JavaVersion readFromConfiguration(Configuration config) {
+    Optional<String> javaVersionAsString = config.get(SOURCE_VERSION);
+    if (!javaVersionAsString.isPresent()) {
+      return new JavaVersionImpl();
+    }
+    String enablePreviewAsString = config.get(ENABLE_PREVIEW).orElse("false");
+
+    JavaVersion javaVersion = fromString(javaVersionAsString.get(), enablePreviewAsString);
+    if (javaVersion.arePreviewFeaturesEnabled() && javaVersion.asInt() < MAX_SUPPORTED) {
+      LOG.warn("sonar.java.enablePreview is set but will be discarded as the Java version is less than the max" +
+        " supported version ({} < {})", javaVersion.asInt(), MAX_SUPPORTED);
+      javaVersion = new JavaVersionImpl(javaVersion.asInt(), false);
+    }
+    LOG.info("Configured Java source version ({}): {}, preview features enabled ({}): {}",
+      SOURCE_VERSION, javaVersion.asInt(), ENABLE_PREVIEW, javaVersion.arePreviewFeaturesEnabled());
+    return javaVersion;
+  }
+
 }

java-frontend/src/main/java/org/sonar/plugins/java/api/internal/ModuleMetadata.java

@@ -0,0 +1,48 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-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 Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.plugins.java.api.internal;
+
+import org.sonar.api.batch.ScannerSide;
+import org.sonar.java.annotations.Beta;
+import org.sonar.plugins.java.api.JavaVersion;
+
+
+/**
+ * Interface to access metadata about the module being analyzed by a Sensor.
+ * For internal use only, this API will not be supported for custom plugins.
+ */
+@Beta
+@ScannerSide
+public interface ModuleMetadata {
+
+  /**
+   * Returns the Java version of the module being analyzed.
+   */
+  JavaVersion javaVersion();
+
+  /**
+   * Returns the module key of the module being analyzed.
+   */
+  String moduleKey();
+
+  /**
+   * Describes whether input files should be parsed while ignoring unnamed split modules.
+   */
+  boolean shouldIgnoreUnnamedModuleForSplitPackage();
+
+}
+

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

@@ -0,0 +1,95 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-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 Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * 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 Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java;
+
+import java.io.File;
+import java.util.Optional;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.batch.bootstrap.ProjectDefinition;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.config.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+
+class DefaultModuleMetadataTest {
+
+  @Test
+  void test() {
+    var sonarComponents = mockSonarComponents();
+    var config = mockConfiguration();
+    sonarComponents.setSensorContext(mockSensorContext(config));
+    var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
+
+    assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
+    assertThat(defaultModuleMetadata.javaVersion().asInt()).isEqualTo(-1);
+    assertThat(defaultModuleMetadata.shouldIgnoreUnnamedModuleForSplitPackage()).isFalse();
+  }
+
+  @Test
+  void testWithJavaVersion() {
+    var sonarComponents = mockSonarComponents();
+    var config = mockConfiguration("sonar.java.source", "11");
+    sonarComponents.setSensorContext(mockSensorContext(config));
+    var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
+
+    assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
+    assertThat(defaultModuleMetadata.javaVersion().asInt()).isEqualTo(11);
+  }
+
+  @Test
+  void testWithShouldIgnoreUnnamed() {
+    var sonarComponents = mockSonarComponents();
+    var config = mockConfiguration("sonar.java.ignoreUnnamedModuleForSplitPackage", "true");
+    sonarComponents.setSensorContext(mockSensorContext(config));
+    var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
+
+    assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
+    assertThat(defaultModuleMetadata.shouldIgnoreUnnamedModuleForSplitPackage()).isTrue();
+  }
+
+  private SonarComponents mockSonarComponents() {
+    var rootProj = mock(ProjectDefinition.class);
+    doReturn(new File("/foo/bar/proj")).when(rootProj).getBaseDir();
+    var childModule = mock(ProjectDefinition.class);
+    doReturn(new File("/foo/bar/proj/pmodule/cmodule")).when(childModule).getBaseDir();
+    doReturn(rootProj).when(childModule).getParent();
+
+    return new SonarComponents(null, null, null, null, null, null, childModule);
+  }
+
+  private Configuration mockConfiguration(String... keysAndValues) {
+    Configuration configuration = mock(Configuration.class);
+    for (int i = 0; i < keysAndValues.length; i++) {
+      String key = keysAndValues[i++];
+      String value = keysAndValues[i];
+      doReturn(Optional.of(value)).when(configuration).get(key);
+      if(value.equals("true") || value.equals("false")) {
+        doReturn(Optional.of(Boolean.valueOf(value))).when(configuration).getBoolean(key);
+      }
+    }
+    return configuration;
+  }
+
+  private SensorContext mockSensorContext(Configuration config) {
+    var sctx = mock(SensorContext.class);
+    doReturn(config).when(sctx).config();
+    return sctx;
+  }
+
+}

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

@@ -28,6 +28,7 @@
 import org.sonar.api.config.PropertyDefinition;
 import org.sonar.java.AnalysisWarningsWrapper;
 import org.sonar.java.DefaultJavaResourceLocator;
+import org.sonar.java.DefaultModuleMetadata;
 import org.sonar.java.JavaConstants;
 import org.sonar.java.SonarComponents;
 import org.sonar.java.classpath.ClasspathForMain;
@@ -117,6 +118,7 @@ public void define(Context context) {
       PostAnalysisIssueFilter.class));
 
     list.add(AnalysisWarningsWrapper.class);
+    list.add(DefaultModuleMetadata.class);
     context.addExtensions(Collections.unmodifiableList(list));
   }
 

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

@@ -111,7 +111,7 @@ public void execute(SensorContext context) {
 
     Measurer measurer = new Measurer(context, noSonarFilter);
 
-    JavaVersion javaVersion = getJavaVersion();
+    JavaVersion javaVersion = JavaVersionImpl.readFromConfiguration(settings);
     telemetry.aggregateAsSortedSet(JAVA_LANGUAGE_VERSION, javaVersion.toString());
     telemetry.aggregateAsCounter(JAVA_MODULE_COUNT, 1L);
 
@@ -181,24 +181,6 @@ private Iterable<InputFile> javaFiles(InputFile.Type type) {
     return fs.inputFiles(fs.predicates().and(fs.predicates().hasLanguage(Java.KEY), fs.predicates().hasType(type)));
   }
 
-  private JavaVersion getJavaVersion() {
-    Optional<String> javaVersionAsString = settings.get(JavaVersion.SOURCE_VERSION);
-    if (!javaVersionAsString.isPresent()) {
-      return new JavaVersionImpl();
-    }
-    String enablePreviewAsString = settings.get(JavaVersion.ENABLE_PREVIEW).orElse("false");
-
-    JavaVersion javaVersion = JavaVersionImpl.fromString(javaVersionAsString.get(), enablePreviewAsString);
-    if (javaVersion.arePreviewFeaturesEnabled() && javaVersion.asInt() < JavaVersionImpl.MAX_SUPPORTED) {
-      LOG.warn("sonar.java.enablePreview is set but will be discarded as the Java version is less than the max" +
-        " supported version ({} < {})", javaVersion.asInt(), JavaVersionImpl.MAX_SUPPORTED);
-      javaVersion = new JavaVersionImpl(javaVersion.asInt(), false);
-    }
-    LOG.info("Configured Java source version ({}): {}, preview features enabled ({}): {}",
-      JavaVersion.SOURCE_VERSION, javaVersion.asInt(), JavaVersion.ENABLE_PREVIEW, javaVersion.arePreviewFeaturesEnabled());
-    return javaVersion;
-  }
-
   @Override
   public String toString() {
     return getClass().getSimpleName();

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

@@ -40,7 +40,7 @@ void sonarLint_9_9_extensions() {
     Plugin.Context context = new Plugin.Context(runtime);
     javaPlugin.define(context);
     assertThat(context.getExtensions())
-      .hasSize(19)
+      .hasSize(20)
       .contains(SonarLintCache.class);
   }
 
@@ -51,7 +51,7 @@ void sonarqube_9_9_extensions() {
     Plugin.Context context = new Plugin.Context(sqCommunity);
     javaPlugin.define(context);
     assertThat(context.getExtensions())
-      .hasSize(35)
+      .hasSize(36)
       .doesNotContain(Jasper.class);
   }
 
@@ -61,7 +61,7 @@ void sonarqube_9_9_commercial_extensions() {
     Plugin.Context context = new Plugin.Context(sqEnterprise);
     javaPlugin.define(context);
     assertThat(context.getExtensions())
-      .hasSize(36)
+      .hasSize(37)
       .contains(Jasper.class);
   }