Skip to content

SONARJAVA-5845 Add new ModuleMetadata public API #5343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leonardo-pilastri-sonarsource merged 5 commits into from
Nov 21, 2025
Merged

SONARJAVA-5845 Add new ModuleMetadata public API #5343

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
73192ad
SONARJAVA-5845 Add new ModuleMetadata public API
leonardo-pilastri-sonarsource Nov 4, 2025
42902e9
Improve coverage
leonardo-pilastri-sonarsource Nov 6, 2025
30fef41
Avoid accessing SonarComponents at injection time to prevent NPE
leonardo-pilastri-sonarsource Nov 11, 2025
77f09c9
Improve coverage
leonardo-pilastri-sonarsource Nov 20, 2025
dd13053
Review changes
leonardo-pilastri-sonarsource Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions java-frontend/src/main/java/org/sonar/java/DefaultModuleMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,25 @@
*/
package org.sonar.java;

import javax.annotation.CheckForNull;
import org.sonar.api.batch.bootstrap.ProjectDefinition;
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;

import static org.sonar.java.SonarComponents.SONAR_IGNORE_UNNAMED_MODULE_FOR_SPLIT_PACKAGE;

public class DefaultModuleMetadata implements ModuleMetadata {

private final JavaVersion javaVersion;
private final String moduleKey;
private final ProjectDefinition projectDefinition;
private final boolean ignoreUnnamedModuleForSplitPackage;

public DefaultModuleMetadata(SonarComponents sonarComponents, Configuration configuration) {
public DefaultModuleMetadata(ProjectDefinition projectDefinition, Configuration configuration) {
this.javaVersion = JavaVersionImpl.readFromConfiguration(configuration);
this.moduleKey = sonarComponents.getModuleKey();
this.ignoreUnnamedModuleForSplitPackage = sonarComponents.shouldIgnoreUnnamedModuleForSplitPackage();
this.projectDefinition = projectDefinition;
this.ignoreUnnamedModuleForSplitPackage = configuration.getBoolean(SONAR_IGNORE_UNNAMED_MODULE_FOR_SPLIT_PACKAGE).orElse(false);
}

@Override
Expand All @@ -40,12 +44,30 @@ public JavaVersion javaVersion() {

@Override
public String moduleKey() {
return moduleKey;
var root = getRootProject();
if (root != null && projectDefinition != null) {
var rootBase = root.getBaseDir().toPath();
var moduleBase = projectDefinition.getBaseDir().toPath();
return rootBase.relativize(moduleBase).toString().replace('\\', '/');
}
return "";
}

@Override
public boolean shouldIgnoreUnnamedModuleForSplitPackage() {
return ignoreUnnamedModuleForSplitPackage;
}

@CheckForNull
private ProjectDefinition getRootProject() {
ProjectDefinition current = projectDefinition;
if (current == null) {
return null;
}
while (current.getParent() != null) {
current = current.getParent();
}
return current;
}

}
26 changes: 8 additions & 18 deletions java-frontend/src/test/java/org/sonar/java/DefaultModuleMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
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;
Expand All @@ -31,10 +30,9 @@ class DefaultModuleMetadataTest {

@Test
void test() {
var sonarComponents = mockSonarComponents();
var projectDefinition = mockProjectDefinition();
var config = mockConfiguration();
sonarComponents.setSensorContext(mockSensorContext(config));
var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
var defaultModuleMetadata = new DefaultModuleMetadata(projectDefinition, config);

assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
assertThat(defaultModuleMetadata.javaVersion().asInt()).isEqualTo(-1);
Expand All @@ -43,34 +41,32 @@ void test() {

@Test
void testWithJavaVersion() {
var sonarComponents = mockSonarComponents();
var projectDefinition = mockProjectDefinition();
var config = mockConfiguration("sonar.java.source", "11");
sonarComponents.setSensorContext(mockSensorContext(config));
var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
var defaultModuleMetadata = new DefaultModuleMetadata(projectDefinition, config);

assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
assertThat(defaultModuleMetadata.javaVersion().asInt()).isEqualTo(11);
}

@Test
void testWithShouldIgnoreUnnamed() {
var sonarComponents = mockSonarComponents();
var projectDefinition = mockProjectDefinition();
var config = mockConfiguration("sonar.java.ignoreUnnamedModuleForSplitPackage", "true");
sonarComponents.setSensorContext(mockSensorContext(config));
var defaultModuleMetadata = new DefaultModuleMetadata(sonarComponents, config);
var defaultModuleMetadata = new DefaultModuleMetadata(projectDefinition, config);

assertThat(defaultModuleMetadata.moduleKey()).isEqualTo("pmodule/cmodule");
assertThat(defaultModuleMetadata.shouldIgnoreUnnamedModuleForSplitPackage()).isTrue();
}

private SonarComponents mockSonarComponents() {
private ProjectDefinition mockProjectDefinition() {
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);
return childModule;
}

private Configuration mockConfiguration(String... keysAndValues) {
Expand All @@ -86,10 +82,4 @@ private Configuration mockConfiguration(String... keysAndValues) {
return configuration;
}

private SensorContext mockSensorContext(Configuration config) {
var sctx = mock(SensorContext.class);
doReturn(config).when(sctx).config();
return sctx;
}

}
Loading