Review changes

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

@@ -16,17 +16,21 @@
  */
 package org.sonar.java;
 
-import javax.annotation.CheckForNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
 import org.sonar.api.config.Configuration;
 import org.sonar.java.model.JavaVersionImpl;
+import org.sonar.java.utils.ModuleMetadataUtils;
 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 static final Logger LOG = LoggerFactory.getLogger(DefaultModuleMetadata.class);
+
   private final JavaVersion javaVersion;
   private final ProjectDefinition projectDefinition;
   private final boolean ignoreUnnamedModuleForSplitPackage;
@@ -44,30 +48,16 @@ public JavaVersion javaVersion() {
 
   @Override
   public String 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('\\', '/');
+    var moduleKey = ModuleMetadataUtils.getModuleKey(projectDefinition);
+    if (moduleKey.isEmpty()) {
+      LOG.warn("Unable to determine module key, using empty string as fallback");
     }
-    return "";
+    return moduleKey;
   }
 
   @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/main/java/org/sonar/java/SonarComponents.java

@@ -68,6 +68,7 @@
 import org.sonar.java.model.LineUtils;
 import org.sonar.java.reporting.AnalyzerMessage;
 import org.sonar.java.reporting.JavaIssue;
+import org.sonar.java.utils.ModuleMetadataUtils;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonar.plugins.java.api.JavaFileScanner;
@@ -513,7 +514,7 @@ private static long computeIdealBatchSize() {
   }
 
   public File projectLevelWorkDir() {
-    var root = getRootProject();
+    var root = ModuleMetadataUtils.getRootProject(projectDefinition);
     if (root != null) {
       return root.getWorkDir();
     } else {
@@ -527,25 +528,7 @@ public File projectLevelWorkDir() {
    * @return A key representing the module
    */
   public String getModuleKey() {
-    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 "";
-  }
-
-  @CheckForNull
-  private ProjectDefinition getRootProject() {
-    ProjectDefinition current = projectDefinition;
-    if (current == null) {
-      return null;
-    }
-    while (current.getParent() != null) {
-      current = current.getParent();
-    }
-    return current;
+    return ModuleMetadataUtils.getModuleKey(projectDefinition);
   }
 
   public boolean canSkipUnchangedFiles() throws ApiMismatchException {

java-frontend/src/main/java/org/sonar/java/utils/ModuleMetadataUtils.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.utils;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nullable;
+import org.sonar.api.batch.bootstrap.ProjectDefinition;
+
+public class ModuleMetadataUtils {
+
+  private ModuleMetadataUtils() {
+    // utility class
+  }
+
+  public static String getModuleKey(@Nullable ProjectDefinition projectDefinition) {
+    var root = getRootProject(projectDefinition);
+    if (root != null && projectDefinition != null) {
+      var rootBase = root.getBaseDir().toPath();
+      var moduleBase = projectDefinition.getBaseDir().toPath();
+      return rootBase.relativize(moduleBase).toString().replace('\\', '/');
+    }
+    return "";
+  }
+
+  @CheckForNull
+  public static ProjectDefinition getRootProject(ProjectDefinition projectDefinition) {
+    ProjectDefinition current = projectDefinition;
+    if (current == null) {
+      return null;
+    }
+    while (current.getParent() != null) {
+      current = current.getParent();
+    }
+    return current;
+  }
+
+}

java-frontend/src/main/java/org/sonar/java/utils/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * 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/
+ */
+@ParametersAreNonnullByDefault
+package org.sonar.java.utils;
+
+import javax.annotation.ParametersAreNonnullByDefault;
+

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

@@ -16,15 +16,14 @@
  */
 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.config.Configuration;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
+import static org.sonar.java.TestUtils.mockProjectDefinition;
 
 class DefaultModuleMetadataTest {
 
@@ -67,23 +66,13 @@ void testWithShouldIgnoreUnnamed() {
     assertThat(defaultModuleMetadata.shouldIgnoreUnnamedModuleForSplitPackage()).isTrue();
   }
 
-  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 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")) {
+      if (value.equals("true") || value.equals("false")) {
         doReturn(Optional.of(Boolean.valueOf(value))).when(configuration).getBoolean(key);
       }
     }

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

@@ -21,11 +21,13 @@
 import java.nio.file.Files;
 import java.util.List;
 import java.util.stream.Stream;
+import org.sonar.api.batch.bootstrap.ProjectDefinition;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
@@ -144,4 +146,15 @@ public static SonarComponents mockSonarComponents() {
     when(mock.jspChecks()).thenReturn(List.of());
     return mock;
   }
+
+  public static 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 childModule;
+  }
+
 }

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

@@ -0,0 +1,25 @@
+package org.sonar.java.utils;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.sonar.java.TestUtils.mockProjectDefinition;
+
+class ModuleMetadataUtilsTest {
+
+  @Test
+  void getModuleKey() {
+    var projectDefinition = mockProjectDefinition();
+    assertThat(ModuleMetadataUtils.getModuleKey(projectDefinition)).isEqualTo("pmodule/cmodule");
+    assertThat(ModuleMetadataUtils.getModuleKey(null)).isEmpty();
+  }
+  
+  @Test
+  void getRootProject() {
+    var projectDefinition = mockProjectDefinition();
+    assertSame(ModuleMetadataUtils.getRootProject(projectDefinition), ModuleMetadataUtils.getRootProject(projectDefinition.getParent()));
+    assertNull(ModuleMetadataUtils.getRootProject(null));
+  }
+}