Eliminate SonarQube warnings (#88)

Author: stefanseifert

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/crypto/impl/AesCryptoSupport.java

@@ -37,6 +37,7 @@
 /**
  * AES crypto support implementation with the same algorithms as used by AEM 6.3 and up.
  */
+@SuppressWarnings("java:S5542") // cannot use a more secure cipher mode, we have to be compatible with AEM
 public class AesCryptoSupport extends CryptoSupport {
 
   private static final String AES_KEY_ALGORITHM = "AES";
@@ -54,7 +55,7 @@ private static Random initRandom() {
       return SecureRandom.getInstance(SECURE_RANDOM_ALGORITHM);
     }
     catch (NoSuchAlgorithmException ex) {
-      throw new RuntimeException(ex);
+      throw new IllegalStateException(ex);
     }
   }
 

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AemCryptoEncryptHelper.java

@@ -63,6 +63,7 @@ public String getName() {
   }
 
   @Override
+  @SuppressWarnings({ "java:S3776", "java:S5411" }) // ignore complexity
   public Object apply(Object context, Options options, HelperContext pluginContext) throws IOException {
     if (context == null) {
       return null;

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/handlebars/helper/AemHttpdFilterHelper.java

@@ -73,6 +73,7 @@ protected String generateFilter(Map<String, Object> filterMap, Options options)
         allowFrom, allowFromHost);
   }
 
+  @SuppressWarnings("java:S3776") // ignore complexity
   private String generateRule(String ruleType, String ruleExpression, HttpdFilterType filterType,
       String allowFrom, String allowFromHost) {
     StringBuilder sb = new StringBuilder();

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOsgiConfigPostProcessor.java

@@ -153,6 +153,7 @@ private boolean generateOsgiConfigurations(Model model, ContentPackage contentPa
     List<Void> result = ProvisioningUtil.visitOsgiConfigurations(model, new ConfigConsumer<Void>() {
       @Override
       @SuppressFBWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE")
+      @SuppressWarnings("java:S3457") // log placeholders
       public Void accept(String path, Dictionary<String, Object> properties) throws IOException {
         String contentPath = rootPath + (StringUtils.contains(path, "/") ? "." : "/") + path;
         context.getLogger().info("  Include " + contentPath);

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePostProcessor.java

@@ -24,6 +24,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Files;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -106,7 +107,7 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
       }
 
       // delete provisioning file after transformation
-      file.delete();
+      Files.delete(file.toPath());
 
       // set force to true by default for CONGA-generated packages (but allow override from role definition)
       Map<String, Object> modelOptions = new HashMap<>();

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentElementHandler.java

@@ -44,11 +44,11 @@ public void resource(String path, Map<String, Object> properties) {
     }
     else {
       if (root == null) {
-        throw new RuntimeException("Root resource not set.");
+        throw new IllegalArgumentException("Root resource not set.");
       }
       Matcher matcher = PATH_PATTERN.matcher(path);
       if (!matcher.matches()) {
-        throw new RuntimeException("Unexpected path:" + path);
+        throw new IllegalArgumentException("Unexpected path:" + path);
       }
       String relativeParentPath = StringUtils.stripStart(matcher.group(1), "/");
       String name = matcher.group(4);
@@ -60,7 +60,7 @@ public void resource(String path, Map<String, Object> properties) {
         parent = root.getChild(relativeParentPath);
       }
       if (parent == null) {
-        throw new RuntimeException("Parent '" + relativeParentPath + "' does not exist.");
+        throw new IllegalArgumentException("Parent '" + relativeParentPath + "' does not exist.");
       }
       parent.getChildren().put(name, new ContentElementImpl(name, properties));
     }

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageBinaryFile.java

@@ -24,6 +24,7 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.Files;
 
 import org.apache.commons.lang3.StringUtils;
 
@@ -101,7 +102,7 @@ public void deleteIfRequired(UrlFileManager urlFileManager, File targetDir) thro
       }
       File file = getFile(targetDir);
       if (file != null) {
-        file.delete();
+        Files.delete(file.toPath());
       }
     }
   }

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java

@@ -47,6 +47,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.apache.commons.lang3.BooleanUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -184,6 +185,7 @@ private static String mergeDescriptionFileHeader(String description, FileHeaderC
    * @param options Options
    * @return Filters list
    */
+  @SuppressWarnings("java:S3776") // ignore complexity
   private static List<PackageFilter> getFilters(Map<String, Object> options) {
     List<PackageFilter> filters = new ArrayList<>();
 
@@ -384,6 +386,7 @@ public static List<ContentPackageBinaryFile> getFiles(Map<String, Object> option
     return files;
   }
 
+  @SuppressWarnings("java:S1075") // no filesystem path
   private static List<ContentPackageBinaryFile> getMatchingFiles(File targetDir, String fileMatch,
       String dir, String path, boolean delete) throws IOException {
     File fileTargetDir = targetDir;
@@ -395,24 +398,25 @@ private static List<ContentPackageBinaryFile> getMatchingFiles(File targetDir, S
     Pattern pattern = Pattern.compile(fileMatch);
 
     // collect all files below the target dir
-    return Files.walk(Paths.get(fileTargetDir.toURI()))
-        .filter(Files::isRegularFile)
-        // strip off the target dir paths, keep only the relative path/file name
-        .map(ContentPackageUtil::normalizedAbsolutePath)
-        .map(file -> StringUtils.removeStart(file, targetPathPrefix))
-        // check if file matches with the regex, apply matching input groups to path
-        .map(file -> {
-          Matcher matcher = pattern.matcher(file);
-          if (matcher.matches()) {
-            String adaptedPath = matcher.replaceAll(path);
-            return new ContentPackageBinaryFile(file, dir, null, adaptedPath, delete);
-          }
-          else {
-            return null;
-          }
-        })
-        .filter(Objects::nonNull)
-        .collect(Collectors.toList());
+    try (Stream<Path> paths = Files.walk(Paths.get(fileTargetDir.toURI()))) {
+      return paths.filter(Files::isRegularFile)
+          // strip off the target dir paths, keep only the relative path/file name
+          .map(ContentPackageUtil::normalizedAbsolutePath)
+          .map(file -> StringUtils.removeStart(file, targetPathPrefix))
+          // check if file matches with the regex, apply matching input groups to path
+          .map(file -> {
+            Matcher matcher = pattern.matcher(file);
+            if (matcher.matches()) {
+              String adaptedPath = matcher.replaceAll(path);
+              return new ContentPackageBinaryFile(file, dir, null, adaptedPath, delete);
+            }
+            else {
+              return null;
+            }
+          })
+          .filter(Objects::nonNull)
+          .collect(Collectors.toList());
+    }
   }
 
   private static String normalizedAbsolutePath(Path path) {

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/validator/AnyValidator.java

@@ -32,7 +32,6 @@
 
 import com.day.any.BaseHandler;
 import com.day.any.Parser;
-import com.day.any.ResourceExpander;
 
 import io.wcm.devops.conga.generator.spi.ValidationException;
 import io.wcm.devops.conga.generator.spi.ValidatorPlugin;
@@ -70,12 +69,7 @@ public Void apply(FileContext file, ValidatorContext context) throws ValidationE
 
     // set resource expander and entity resolver that do not resolve anything
     // just make sure they are in place to allow any parser parsing files with include directives
-    parser.setResourceExpander(new ResourceExpander() {
-      @Override
-      public String[] expand(String arg0) {
-        return new String[0];
-      }
-    });
+    parser.setResourceExpander(arg -> new String[0]);
     parser.setEnitiyResolver(new EntityResolver() {
       @Override
       public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException {

conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/validator/ContentPackageValidator.java

@@ -133,7 +133,7 @@ private void setProperty(Object object, String propertyName, Object value)
     setProperty(object, object.getClass(), propertyName, value);
   }
 
-  @SuppressWarnings("PMD.AvoidAccessibilityAlteration")
+  @SuppressWarnings({ "PMD.AvoidAccessibilityAlteration", "java:S3011" })
   private void setProperty(Object object, Class<?> clazz, String propertyName, Object value)
       throws IllegalArgumentException, IllegalAccessException {
     try {