Avoid accessing SonarComponents at injection time to prevent NPE

Author: leonardo-pilastri-sonarsource

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

@@ -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
@@ -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;
+  }
+
 }

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

@@ -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;
@@ -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);
@@ -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) {
@@ -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;
-  }
-
 }