SONARJAVA-6000 New public API to access module fully qualified key in ModuleScannerContext (#5394)

Author: pauloreilly-sonarsource

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

@@ -531,6 +531,15 @@ public String getModuleKey() {
     return ModuleMetadataUtils.getModuleKey(projectDefinition);
   }
 
+  /**
+   * Returns an OS-independent key that should identify the module and its hierarchy within the project
+   *
+   * @return A fully-qualified key representing the module
+   */
+  public Optional<String> getFullyQualifiedModuleKey() {
+    return ModuleMetadataUtils.getFullyQualifiedModuleKey(projectDefinition);
+  }
+
   public boolean canSkipUnchangedFiles() throws ApiMismatchException {
     if (context == null) {
       return false;

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

@@ -17,6 +17,7 @@
 package org.sonar.java.model;
 
 import java.io.File;
+import java.util.Optional;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import org.sonar.api.SonarProduct;
@@ -87,6 +88,11 @@ public String getModuleKey() {
     return sonarComponents.getModuleKey();
   }
 
+  @Override
+  public Optional<String> getFullyQualifiedModuleKey() {
+    return sonarComponents.getFullyQualifiedModuleKey();
+  }
+  
   @CheckForNull
   @Override
   public SonarProduct sonarProduct() {

java-frontend/src/main/java/org/sonar/java/utils/ModuleMetadataUtils.java

@@ -16,6 +16,7 @@
  */
 package org.sonar.java.utils;
 
+import java.util.Optional;
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
@@ -39,13 +40,33 @@ public static String getModuleKey(@Nullable ProjectDefinition projectDefinition)
   @CheckForNull
   public static ProjectDefinition getRootProject(@Nullable ProjectDefinition projectDefinition) {
     ProjectDefinition current = projectDefinition;
-    if (current == null) {
-      return null;
-    }
-    while (current.getParent() != null) {
+    while (current != null && current.getParent() != null) {
       current = current.getParent();
     }
     return current;
   }
 
+  public static Optional<String> getFullyQualifiedModuleKey(@Nullable ProjectDefinition current) {
+    StringBuilder builder = new StringBuilder();
+    // we do not want to include root module as this is usually the sonar project key
+    while (current != null && current.getParent() != null) {
+      // get module key property
+      var property = current.properties().get("sonar.moduleKey");
+      if (property != null) {
+        // prepend separator if not first module
+        if (!builder.isEmpty()) {
+          // as modules can have dots in names, separator should be :
+          builder.insert(0, ":");
+        }
+        var leafModule = property.lastIndexOf(":") >= 0
+          ? property.substring(property.lastIndexOf(":") + 1)
+          : property;
+        builder.insert(0, leafModule);
+        current = current.getParent();
+      } else {
+        break;
+      }
+    }
+    return builder.isEmpty() ? Optional.empty() : Optional.of(builder.toString());
+  }
 }

java-frontend/src/main/java/org/sonar/plugins/java/api/ModuleScannerContext.java

@@ -17,6 +17,7 @@
 package org.sonar.plugins.java.api;
 
 import java.io.File;
+import java.util.Optional;
 import javax.annotation.CheckForNull;
 import org.sonar.api.SonarProduct;
 import org.sonar.api.SonarRuntime;
@@ -79,9 +80,17 @@ public interface ModuleScannerContext {
 
   /**
    * @return A key that uniquely identifies the current module, provided that this project consists of multiple modules.
+   * This key is not fully qualified, meaning that it does not contain the parent modules keys.
    */
   String getModuleKey();
-
+  
+  /**
+   * @return A key that uniquely identifies the current module, provided that this project consists of multiple modules.
+   * This key is fully qualified, meaning that it contains the parent modules keys as well.
+   * E.g. instead of "level4", it will return the full hierarchy key "level1:level2:level3:level4"
+   */
+  Optional<String> getFullyQualifiedModuleKey();
+  
   /**
    * @return The Sonar product (SONARQUBE/SONARLINT) which forms the current execution context of the scan.
    * See also {@link SonarRuntime#getProduct()}.

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

@@ -27,6 +27,7 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.LongSupplier;
@@ -1308,20 +1309,29 @@ void should_return_generated_code_visitors() {
   void moduleKey_empty() {
     var sonarComponents = new SonarComponents(null, null, null, null, null, null);
     assertThat(sonarComponents.getModuleKey()).isEmpty();
+    assertThat(sonarComponents.getFullyQualifiedModuleKey()).isEmpty();
   }
 
   @Test
   void moduleKey_non_empty() {
     var rootProj = mock(ProjectDefinition.class);
     doReturn(new File("/foo/bar/proj")).when(rootProj).getBaseDir();
     var parentModule = mock(ProjectDefinition.class);
+    var parentProperties = new HashMap<String, String>();
+    parentProperties.put("sonar.moduleKey", "proj1:pmodule");
+    when(parentModule.properties()).thenReturn(parentProperties);
     doReturn(rootProj).when(parentModule).getParent();
     var childModule = mock(ProjectDefinition.class);
+    var childProperties = new HashMap<String, String>();
+    childProperties.put("sonar.moduleKey", "proj1:pmodule:cmodule");
+    when(childModule.properties()).thenReturn(childProperties);
     doReturn(new File("/foo/bar/proj/pmodule/cmodule")).when(childModule).getBaseDir();
     doReturn(parentModule).when(childModule).getParent();
 
     var sonarComponents = new SonarComponents(null, null, null, null, null, null, childModule);
     assertThat(sonarComponents.getModuleKey()).isEqualTo("pmodule/cmodule");
+    assertThat(sonarComponents.getFullyQualifiedModuleKey()).isPresent();
+    assertThat(sonarComponents.getFullyQualifiedModuleKey()).contains("pmodule:cmodule");
   }
 
   @Rule(key = "jsp")

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

@@ -19,6 +19,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
+import java.util.HashMap;
 import java.util.List;
 import java.util.stream.Stream;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
@@ -157,4 +158,24 @@ public static ProjectDefinition mockProjectDefinition() {
     return childModule;
   }
 
+  public static ProjectDefinition mockProjectDefinitionWithModuleKeys() {
+    var rootProj = mock(ProjectDefinition.class);
+    doReturn(new File("/foo/bar/proj")).when(rootProj).getBaseDir();
+    
+    var child1Module = mock(ProjectDefinition.class);
+    doReturn(new File("/foo/bar/proj/pmodule/cmodule")).when(child1Module).getBaseDir();
+    doReturn(rootProj).when(child1Module).getParent();
+    var child1Properties = new HashMap<String, String>();
+    child1Properties.put("sonar.moduleKey", "propj:module1");
+    when(child1Module.properties()).thenReturn(child1Properties);
+
+    var child2Module = mock(ProjectDefinition.class);
+    doReturn(new File("/foo/bar/proj/pmodule/cmodule/c2module")).when(child2Module).getBaseDir();
+    doReturn(child1Module).when(child2Module).getParent();
+    var child2Properties = new HashMap<String, String>();
+    child2Properties.put("sonar.moduleKey", "module2");
+    when(child2Module.properties()).thenReturn(child2Properties);
+
+    return child2Module;
+  }
 }

java-frontend/src/test/java/org/sonar/java/model/DefaultInputFileScannerContextTest.java

@@ -18,6 +18,7 @@
 
 import java.io.File;
 import java.util.Arrays;
+import java.util.Optional;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.batch.fs.InputComponent;
@@ -78,6 +79,16 @@ void getModuleKey() {
     assertThat(ctx.getModuleKey()).isEqualTo(moduleKey);
   }
 
+  @Test
+  void getFullyQualifiedModuleKey() {
+    var moduleKey = Optional.of("some/random/module/key");
+    doReturn(moduleKey).when(sonarComponents).getFullyQualifiedModuleKey();
+    var ctx = new DefaultJavaFileScannerContext(null, null, null, sonarComponents, null, false, false);
+    assertThat(ctx.getFullyQualifiedModuleKey())
+      .isPresent()
+      .hasValue(moduleKey.get());
+  }
+
   private SonarComponents createSonarComponentsMock() {
     SonarComponents specificSonarComponents = mock(SonarComponents.class);
     doAnswer(invocation -> {

java-frontend/src/test/java/org/sonar/java/utils/ModuleMetadataUtilsTest.java

@@ -22,6 +22,7 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertSame;
 import static org.sonar.java.TestUtils.mockProjectDefinition;
+import static org.sonar.java.TestUtils.mockProjectDefinitionWithModuleKeys;
 
 class ModuleMetadataUtilsTest {
 
@@ -30,8 +31,18 @@ void getModuleKey() {
     var projectDefinition = mockProjectDefinition();
     assertThat(ModuleMetadataUtils.getModuleKey(projectDefinition)).isEqualTo("pmodule/cmodule");
     assertThat(ModuleMetadataUtils.getModuleKey(null)).isEmpty();
+    assertThat(ModuleMetadataUtils.getFullyQualifiedModuleKey(projectDefinition)).isEmpty();
+    assertThat(ModuleMetadataUtils.getFullyQualifiedModuleKey(null)).isEmpty();
   }
-  
+
+  @Test
+  void getFullyQualifiedModuleKey() {
+    var projectDefinition = mockProjectDefinitionWithModuleKeys();
+    assertThat(ModuleMetadataUtils.getFullyQualifiedModuleKey(projectDefinition)).isPresent();
+    assertThat(ModuleMetadataUtils.getFullyQualifiedModuleKey(projectDefinition)).contains("module1:module2");
+    assertThat(ModuleMetadataUtils.getFullyQualifiedModuleKey(null)).isEmpty();
+  }
+
   @Test
   void getRootProject() {
     var projectDefinition = mockProjectDefinition();

sonar-java-plugin/src/main/resources/static/documentation.md

@@ -151,6 +151,10 @@ The tutorial [Writing Custom Java Rules 101](https://redirect.sonarsource.com/do
 
 ### API changes
 
+#### **8.22**
+
+* New method: `ModuleMetadataUtils#getFullyQualifiedModuleKey(@Nullable ProjectDefinition current)`.
+
 #### **8.19**
 
 * New methods: `SymbolMetadata#symbolAnnotations()` and `SymbolMetadata#parametersMetadata()`.