Add flatten executor and logger (#24)

ctoestreich · web-flow · commit fc9925181089 · 2020-11-24T18:37:54.000-05:00
* Split up the flatten command
* Version bump to 0.4.1
* New flatten config logger
* new flatten config executor

* Cleanup code
diff --git a/bom/pom.xml b/bom/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>sourcehawk-bom</artifactId>
diff --git a/configuration/pom.xml b/configuration/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>sourcehawk-configuration</artifactId>
diff --git a/core/pom.xml b/core/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/core/src/main/java/com/optum/sourcehawk/core/scan/FlattenConfigResult.java b/core/src/main/java/com/optum/sourcehawk/core/scan/FlattenConfigResult.java
@@ -1,5 +1,6 @@
 package com.optum.sourcehawk.core.scan;
 
+import com.optum.sourcehawk.core.utils.StringUtils;
 import lombok.Builder;
 import lombok.NonNull;
 import lombok.Value;
@@ -37,7 +38,7 @@ public class FlattenConfigResult implements Serializable {
     @NonNull
     @Builder.Default
     @SuppressWarnings("squid:S1948") // Lombok generates private modifier
-            String formattedMessage = "Flatten successful";
+    String formattedMessage = "Flatten successful";
 
 
     /**
@@ -55,7 +56,7 @@ public static FlattenConfigResult success(final byte[] content) {
      * @return the flatten result
      */
     public static FlattenConfigResult error(final String message) {
-        return new FlattenConfigResult(null, true, message);
+        return new FlattenConfigResult(null, true, StringUtils.defaultString(message, "No error message provided"));
     }
 
 
diff --git a/distributions/debian/pom.xml b/distributions/debian/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-dist</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/distributions/docker/pom.xml b/distributions/docker/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-dist</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/distributions/linux/pom.xml b/distributions/linux/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-dist</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/distributions/pom.xml b/distributions/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/distributions/rpm/pom.xml b/distributions/rpm/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <artifactId>sourcehawk-dist</artifactId>
         <groupId>com.optum.sourcehawk</groupId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>sourcehawk-dist-rpm</artifactId>
diff --git a/enforcer/core/pom.xml b/enforcer/core/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/aot/pom.xml b/enforcer/file/aot/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/common/pom.xml b/enforcer/file/common/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/core/pom.xml b/enforcer/file/core/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/docker/pom.xml b/enforcer/file/docker/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/maven/pom.xml b/enforcer/file/maven/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/pom.xml b/enforcer/file/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/file/registry/pom.xml b/enforcer/file/registry/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk-enforcer-file</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/enforcer/pom.xml b/enforcer/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/exec/pom.xml b/exec/pom.xml
@@ -8,7 +8,7 @@
     <parent>
         <groupId>com.optum.sourcehawk</groupId>
         <artifactId>sourcehawk</artifactId>
-        <version>0.4.0-SNAPSHOT</version>
+        <version>0.4.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
diff --git a/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigCommand.java b/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigCommand.java
@@ -1,18 +1,13 @@
 package com.optum.sourcehawk.exec;
 
-import com.fasterxml.jackson.databind.ObjectWriter;
-import com.optum.sourcehawk.configuration.SourcehawkConfiguration;
 import com.optum.sourcehawk.core.constants.SourcehawkConstants;
-import com.optum.sourcehawk.core.repository.LocalRepositoryFileWriter;
 import com.optum.sourcehawk.core.scan.FlattenConfigResult;
 import com.optum.sourcehawk.core.utils.StringUtils;
 import lombok.extern.slf4j.Slf4j;
 import lombok.val;
 import picocli.CommandLine;
 
-import java.io.IOException;
 import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.concurrent.Callable;
 
 /**
@@ -29,9 +24,6 @@
 )
 class FlattenConfigCommand implements Callable<Integer> {
 
-    private static final ObjectWriter WRITER_WITH_DEFAULT_PRETTY_PRINTER = Sourcehawk.YAML_FORMATTER.writerWithDefaultPrettyPrinter();
-    private static final String SOURCEHAWK_FLATTENED_YML = "sourcehawk-flattened.yml";
-
     static final String COMMAND_NAME = "flatten-config";
 
     @CommandLine.Option(
@@ -70,9 +62,7 @@ public Integer call() {
             return CommandLine.ExitCode.SOFTWARE;
         }
         try {
-            flattenResult = ConfigurationReader.readConfiguration(Paths.get("."), configurationFileLocation)
-                    .map(sourcehawkConfiguration -> executeFlatten(configurationFileLocation, sourcehawkConfiguration))
-                    .orElseGet(() -> FlattenConfigResult.error(String.format("Configuration file %s not found or invalid", configurationFileLocation)));
+            flattenResult = FlattenConfigExecutor.flatten(configurationFileLocation);
         } catch (final Exception e) {
             flattenResult = FlattenConfigResult.error(e.getMessage());
         }
@@ -82,7 +72,7 @@ public Integer call() {
             return CommandLine.ExitCode.SOFTWARE;
         }
 
-        outputResults(flattenResult, output);
+        FlattenConfigResultLogger.log(flattenResult, output);
 
         return CommandLine.ExitCode.OK;
     }
@@ -98,80 +88,4 @@ private String getConfigurationFileLocation() {
         }
         return configurationFileLocation;
     }
-
-    /**
-     * Execute the flatten iterating over all configuration locations and aggregate the results
-     *
-     * @param configurationFileLocation the configuration location
-     * @param sourcehawkConfiguration   the flattened configuration object
-     * @return the aggregated flatten result
-     */
-    private static FlattenConfigResult executeFlatten(final String configurationFileLocation,
-                                                      final SourcehawkConfiguration sourcehawkConfiguration) {
-        byte[] content;
-        try {
-            content = WRITER_WITH_DEFAULT_PRETTY_PRINTER.writeValueAsBytes(sourcehawkConfiguration);
-        } catch (IOException e) {
-            return handleException(configurationFileLocation, e);
-        }
-
-        return FlattenConfigResult.success(content);
-    }
-
-    /**
-     * Handle exceptions from Serialization
-     *
-     * @param configurationFileLocation the configuration location
-     * @param e                         the exception
-     * @return an error flatten result
-     */
-    private static FlattenConfigResult handleException(final String configurationFileLocation, final IOException e) {
-        val message = String.format("Error flattening sourcehawk configuration at %s with error: %s", configurationFileLocation, e.getMessage());
-        return FlattenConfigResult.error(message);
-    }
-
-    /**
-     * Log the result of the flatten which will either output to a file or console based on params
-     *
-     * @param flattenResult      the flatten result
-     * @param repositoryFilePath the repository file path
-     */
-    void outputResults(final FlattenConfigResult flattenResult,
-                       final Path repositoryFilePath) {
-        if (repositoryFilePath == null || StringUtils.isBlankOrEmpty(repositoryFilePath.toString())) {
-            handleDryRunOutput(flattenResult);
-        } else {
-            handleFileSystemOutput(flattenResult, repositoryFilePath);
-        }
-    }
-
-    /**
-     * Log the result of the flatten to the file system
-     *
-     * @param flattenResult      the flatten result
-     * @param repositoryFilePath the repository file path
-     */
-    private static void handleFileSystemOutput(final FlattenConfigResult flattenResult, final Path repositoryFilePath) {
-        try {
-            val writerPath = StringUtils.defaultString(repositoryFilePath.toString(), SOURCEHAWK_FLATTENED_YML);
-            LocalRepositoryFileWriter.writer().write(writerPath, flattenResult.getContent());
-            Sourcehawk.CONSOLE_RAW_LOGGER.info(flattenResult.getFormattedMessage());
-            Sourcehawk.CONSOLE_RAW_LOGGER.info("Output to {}", writerPath);
-        } catch (IOException e) {
-            Sourcehawk.CONSOLE_RAW_LOGGER.error("Could not flatten file due to {}", e.getMessage());
-        }
-    }
-
-    /**
-     * Log the result of the flatten to the console
-     *
-     * @param flattenResult the flatten result
-     */
-    private static void handleDryRunOutput(final FlattenConfigResult flattenResult) {
-        if (flattenResult != null && flattenResult.getContent() != null) {
-            Sourcehawk.CONSOLE_RAW_LOGGER.info(new String(flattenResult.getContent()));
-        } else {
-            Sourcehawk.CONSOLE_RAW_LOGGER.error("No flattened file produced!");
-        }
-    }
 }
diff --git a/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigExecutor.java b/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigExecutor.java
@@ -0,0 +1,71 @@
+package com.optum.sourcehawk.exec;
+
+import com.fasterxml.jackson.databind.ObjectWriter;
+import com.optum.sourcehawk.configuration.SourcehawkConfiguration;
+import com.optum.sourcehawk.core.scan.FlattenConfigResult;
+import com.optum.sourcehawk.core.utils.StringUtils;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import lombok.val;
+
+import java.io.IOException;
+import java.nio.file.Paths;
+
+/**
+ * Entry point for executing Sourcehawk flatten command
+ *
+ * @author Christian Oestreich
+ */
+@Slf4j
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class FlattenConfigExecutor {
+
+    private static final ObjectWriter WRITER_WITH_DEFAULT_PRETTY_PRINTER = Sourcehawk.YAML_FORMATTER.writerWithDefaultPrettyPrinter();
+
+    /**
+     * Run the flatten config based on the provided configuration file location
+     *
+     * @param configurationFileLocation the sourcehawk configuration location
+     * @return the flatten config result
+     */
+    public static FlattenConfigResult flatten(final String configurationFileLocation) {
+        if (StringUtils.isBlankOrEmpty(configurationFileLocation)) {
+            return FlattenConfigResult.error(String.format("Configuration file %s not found or invalid", configurationFileLocation));
+        }
+        return ConfigurationReader.readConfiguration(Paths.get("."), configurationFileLocation)
+                .map(sourcehawkConfiguration -> executeFlatten(configurationFileLocation, sourcehawkConfiguration))
+                .orElseGet(() -> FlattenConfigResult.error(String.format("Configuration file %s not found or invalid", configurationFileLocation)));
+    }
+
+    /**
+     * Execute the flatten iterating over all configuration locations and aggregate the results
+     *
+     * @param configurationFileLocation the configuration location
+     * @param sourcehawkConfiguration   the flattened configuration object
+     * @return the aggregated flatten result
+     */
+    private static FlattenConfigResult executeFlatten(final String configurationFileLocation,
+                                                      final SourcehawkConfiguration sourcehawkConfiguration) {
+        byte[] content;
+        try {
+            content = WRITER_WITH_DEFAULT_PRETTY_PRINTER.writeValueAsBytes(sourcehawkConfiguration);
+        } catch (IOException e) {
+            return handleException(configurationFileLocation, e);
+        }
+
+        return FlattenConfigResult.success(content);
+    }
+
+    /**
+     * Handle exceptions from Serialization
+     *
+     * @param configurationFileLocation the configuration location
+     * @param e                         the exception
+     * @return an error flatten result
+     */
+    private static FlattenConfigResult handleException(final String configurationFileLocation, final IOException e) {
+        val message = String.format("Error flattening sourcehawk configuration at %s with error: %s", configurationFileLocation, e.getMessage());
+        return FlattenConfigResult.error(message);
+    }
+}
diff --git a/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigResultLogger.java b/exec/src/main/java/com/optum/sourcehawk/exec/FlattenConfigResultLogger.java
diff --git a/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigCommandSpec.groovy b/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigCommandSpec.groovy
diff --git a/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigExecutorSpec.groovy b/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigExecutorSpec.groovy
diff --git a/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigLoggerSpec.groovy b/exec/src/test/groovy/com/optum/sourcehawk/exec/FlattenConfigLoggerSpec.groovy
diff --git a/pom.xml b/pom.xml
diff --git a/protocol/core/pom.xml b/protocol/core/pom.xml
diff --git a/protocol/file/pom.xml b/protocol/file/pom.xml
diff --git a/protocol/pom.xml b/protocol/pom.xml
