custom log data key-value pairs are injected multiple times per opera…

…tion (DAT-15572) (#4605)
liquibase · Aug 15, 2023 · 9cc5697 · 9cc5697
1 parent 1678d5a
commit 9cc5697
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 24 deletions.
diff --git a/liquibase-standard/src/main/java/liquibase/util/ValueHandlerUtil.java b/liquibase-standard/src/main/java/liquibase/util/ValueHandlerUtil.java
@@ -0,0 +1,50 @@
+package liquibase.util;
+
+import java.util.Arrays;
+
+public class ValueHandlerUtil {
+    /**
+     * Get the valid enum value from a configuration parameter if possible.
+     *
+     * @param enumClass     the enum to use
+     * @param input         the configuration input to search the enumClass
+     * @param parameterName the name to report to the user if no valid enum values are found
+     * @return the enum value or null
+     */
+    public static <T extends Enum<T>> T getEnum(Class<T> enumClass, Object input, String parameterName) {
+        if (input == null) {
+            return null;
+        }
+        if (input instanceof String) {
+            String stringInput = (String) input;
+
+            if (Arrays.stream(enumClass.getEnumConstants()).noneMatch(enumValue -> enumValue.toString().equalsIgnoreCase(stringInput))) {
+                throw new IllegalArgumentException(String.format("WARNING: The %s value '%s' is not valid. Valid values include: '%s'",
+                        parameterName.toLowerCase(),
+                        stringInput,
+                        StringUtil.join(enumClass.getEnumConstants(), "', '", Object::toString)));
+            }
+            return Enum.valueOf(enumClass, stringInput.toUpperCase());
+        } else if (enumClass.isAssignableFrom(input.getClass())) {
+            return enumClass.cast(input);
+        } else {
+            return null;
+        }
+    }
+
+    public static Boolean booleanValueHandler(Object input) {
+        if (input == null) {
+            return true;
+        }
+        if (input instanceof Boolean) {
+            return (Boolean) input;
+        }
+        String verboseString = (String) input;
+        if (verboseString.equalsIgnoreCase("true") || verboseString.equalsIgnoreCase("false")) {
+            return Boolean.valueOf(verboseString);
+        }
+        String messageString =
+                "\nWARNING:  The input '" + verboseString + "' is not valid.  Options: 'true' or 'false'.";
+        throw new IllegalArgumentException(messageString);
+    }
+}
diff --git a/liquibase-standard/src/main/resources/liquibase/examples/json/liquibase.customlogdata.yaml b/liquibase-standard/src/main/resources/liquibase/examples/json/liquibase.customlogdata.yaml
@@ -11,8 +11,7 @@
 
 ## template of standalone object for all commands
 liquibase.userMetadata:
-  - outputTologlevel: INFO
-    data:
+  - data:
       FINDME: "example custom log data"
       teamsize: 3
       members:
@@ -24,12 +23,10 @@ liquibase.userMetadata:
 ## By specifying the command, these objects will be added only
 ## to the logs of the update command, in this example.
 liquibase.command.update:
-  - outputToLoglevel: INFO
-    data:
+  - data:
       awsRegion: "us-east"
       deploymentlead: "name@example.com"
-  - outputToLogLevel: FINE
-    excludeData:
+  - excludeData:
       - liquibaseTargetUrl
       - commandLabelFilter
       - commandContextFilter

diff --git a/liquibase-standard/src/main/resources/liquibase/examples/sql/liquibase.customlogdata.yaml b/liquibase-standard/src/main/resources/liquibase/examples/sql/liquibase.customlogdata.yaml
@@ -11,8 +11,7 @@
 
 ## template of standalone object for all commands
 liquibase.userMetadata:
-  - outputTologlevel: INFO
-    data:
+  - data:
       FINDME: "example custom log data"
       teamsize: 3
       members:
@@ -24,12 +23,10 @@ liquibase.userMetadata:
 ## By specifying the command, these objects will be added only
 ## to the logs of the update command, in this example.
 liquibase.command.update:
-  - outputToLoglevel: INFO
-    data:
+  - data:
       awsRegion: "us-east"
       deploymentlead: "name@example.com"
-  - outputToLogLevel: FINE
-    excludeData:
+  - excludeData:
       - liquibaseTargetUrl
       - commandLabelFilter
       - commandContextFilter

diff --git a/liquibase-standard/src/main/resources/liquibase/examples/xml/liquibase.customlogdata.yaml b/liquibase-standard/src/main/resources/liquibase/examples/xml/liquibase.customlogdata.yaml
@@ -11,8 +11,7 @@
 
 ## template of standalone object for all commands
 liquibase.userMetadata:
-  - outputTologlevel: INFO
-    data:
+  - data:
       FINDME: "example custom log data"
       teamsize: 3
       members:
@@ -24,12 +23,10 @@ liquibase.userMetadata:
 ## By specifying the command, these objects will be added only
 ## to the logs of the update command, in this example.
 liquibase.command.update:
-  - outputToLoglevel: INFO
-    data:
+  - data:
       awsRegion: "us-east"
       deploymentlead: "name@example.com"
-  - outputToLogLevel: FINE
-    excludeData:
+  - excludeData:
       - liquibaseTargetUrl
       - commandLabelFilter
       - commandContextFilter

diff --git a/liquibase-standard/src/main/resources/liquibase/examples/yaml/liquibase.customlogdata.yaml b/liquibase-standard/src/main/resources/liquibase/examples/yaml/liquibase.customlogdata.yaml
@@ -11,8 +11,7 @@
 
 ## template of standalone object for all commands
 liquibase.userMetadata:
-  - outputTologlevel: INFO
-    data:
+  - data:
       FINDME: "example custom log data"
       teamsize: 3
       members:
@@ -24,12 +23,10 @@ liquibase.userMetadata:
 ## By specifying the command, these objects will be added only
 ## to the logs of the update command, in this example.
 liquibase.command.update:
-  - outputToLoglevel: INFO
-    data:
+  - data:
       awsRegion: "us-east"
       deploymentlead: "name@example.com"
-  - outputToLogLevel: FINE
-    excludeData:
+  - excludeData:
       - liquibaseTargetUrl
       - commandLabelFilter
       - commandContextFilter