Eliminate SonarQube warnings

wcm-io-devops · Jan 22, 2024 · c1e44b3 · c1e44b3
1 parent b36286a
commit c1e44b3
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/generator/src/main/java/io/wcm/devops/conga/generator/util/VariableMapResolver.java b/generator/src/main/java/io/wcm/devops/conga/generator/util/VariableMapResolver.java
@@ -26,6 +26,7 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.regex.Matcher;
 
 import io.wcm.devops.conga.generator.spi.context.ValueProviderGlobalContext;
@@ -176,7 +177,7 @@ private Map<String, Object> replaceMap(Map<String, Object> map, Map<String, Obje
     boolean replacedAny = mapCopy.remove(LIST_VARIABLE_ITERATE) != null;
     for (Map.Entry<String, Object> entry : mapCopy.entrySet()) {
       Object replacedValue = replaceAny(entry.getValue(), variables);
-      if (entry.getValue() != replacedValue) {
+      if (!Objects.equals(entry.getValue(), replacedValue)) {
         entry.setValue(replacedValue);
         replacedAny = true;
       }
@@ -254,7 +255,7 @@ private Map<String, Object> deescapeMap(Map<String, Object> map) {
     Map<String, Object> mapCopy = new HashMap<>(map);
     for (Map.Entry<String, Object> entry : mapCopy.entrySet()) {
       Object deescapedValue = deescapeAny(entry.getValue());
-      if (entry.getValue() != deescapedValue) {
+      if (!Objects.equals(entry.getValue(), deescapedValue)) {
         entry.setValue(deescapedValue);
       }
     }

diff --git a/model/src/main/java/io/wcm/devops/conga/model/util/MapSplitter.java b/model/src/main/java/io/wcm/devops/conga/model/util/MapSplitter.java
@@ -57,12 +57,11 @@ private MapSplitter() {
         continue;
       }
 
-      else if (entry.getValue() instanceof List) {
-        if (listHasSubStructures((List<Object>)entry.getValue())) {
-          // process nested "structural" lists
-          processListValue(entry, matching, unmatching, matcher);
-          continue;
-        }
+      else if ((entry.getValue() instanceof List)
+          && listHasSubStructures((List<Object>)entry.getValue())) {
+        // process nested "structural" lists
+        processListValue(entry, matching, unmatching, matcher);
+        continue;
       }
 
       // value is not a structural (map/list) value - apply matching

diff --git a/model/src/main/java/io/wcm/devops/conga/model/util/MergingList.java b/model/src/main/java/io/wcm/devops/conga/model/util/MergingList.java
@@ -25,6 +25,7 @@
  * Special list that marks a list as "mergeable" in downstream and preservers the merge position.
  * @param <T> List type
  */
+@SuppressWarnings("java:S2160") // equals/hashCode is implemented in base class
 final class MergingList<T> extends LinkedList<T> {
   private static final long serialVersionUID = 1L;
 

diff --git a/...en-plugin/src/main/java/io/wcm/devops/conga/tooling/maven/plugin/MavenSlf4jLogFacade.java b/...en-plugin/src/main/java/io/wcm/devops/conga/tooling/maven/plugin/MavenSlf4jLogFacade.java
@@ -29,6 +29,7 @@
 /**
  * Facade to rout SLF4J logging calls to maven plugin logger.
  */
+@SuppressWarnings("java:S2629")
 class MavenSlf4jLogFacade implements Logger {
 
   private static final Pattern ARGUMENT_PATTERN = Pattern.compile("\\{\\}");

diff --git a/...nga-maven-plugin/src/main/java/io/wcm/devops/conga/tooling/maven/plugin/ValidateMojo.java b/...nga-maven-plugin/src/main/java/io/wcm/devops/conga/tooling/maven/plugin/ValidateMojo.java
@@ -224,6 +224,7 @@ private <T> List<T> validateFiles(ResourceCollection sourceDir, ResourceCollecti
     return result;
   }
 
+  @SuppressWarnings("java:S1075") // no filesystem path
   private static String getPathForLog(ResourceCollection rootSourceDir, Resource file) {
     String path = PathUtil.unifySlashes(file.getCanonicalPath());
     String rootPath = PathUtil.unifySlashes(rootSourceDir.getCanonicalPath()) + "/";

diff --git a/...a/io/wcm/devops/conga/tooling/maven/plugin/validation/NoValueProviderInRoleValidator.java b/...a/io/wcm/devops/conga/tooling/maven/plugin/validation/NoValueProviderInRoleValidator.java
@@ -67,7 +67,7 @@ else if (value instanceof List) {
 
   private void validate(String value) {
     if (VariableStringResolver.hasValueProviderReference(value)) {
-      throw new RuntimeException("Role definitions must not reference value providers: " + value);
+      throw new IllegalStateException("Role definitions must not reference value providers: " + value);
     }
   }
 

diff --git a/.../src/main/java/io/wcm/devops/conga/tooling/maven/plugin/validation/TemplateValidator.java b/.../src/main/java/io/wcm/devops/conga/tooling/maven/plugin/validation/TemplateValidator.java
@@ -52,7 +52,10 @@ public TemplateValidator(ResourceCollection templateDir, HandlebarsManager handl
   }
 
   @Override
-  @SuppressWarnings("PMD.PreserveStackTrace")
+  @SuppressWarnings({
+      "PMD.PreserveStackTrace",
+      "java:S1075" // uses / by intention
+  })
   public Void validate(Resource resource, String pathForLog) throws MojoFailureException {
     if (StringUtils.equalsIgnoreCase(resource.getFileExtension(), FILE_EXTENSION)) {
       String templatePath = StringUtils.substringAfter(PathUtil.unifySlashes(resource.getCanonicalPath()),