NCL-6462: Sort dumpCurrentConfig output by key

project-ncl · Apr 24, 2021 · 77112d3 · 77112d3
1 parent 5154b3e
commit 77112d3
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 12 deletions.
diff --git a/common/src/main/java/org/jboss/gm/common/Configuration.java b/common/src/main/java/org/jboss/gm/common/Configuration.java
@@ -1,9 +1,13 @@
 package org.jboss.gm.common;
 
 import java.lang.reflect.Method;
+import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Properties;
+import java.util.stream.Collectors;
 
 import org.aeonbits.owner.Accessible;
 import org.aeonbits.owner.Config;
@@ -224,20 +228,24 @@ public Map<String, String> convert(Method method, String input) {
 
     /**
      * Return the current configuration as a formatted string.
+     *
+     * @return the current configuration as a formatted string
      */
     default String dumpCurrentConfig() {
-
-        StringBuilder currentProperties = new StringBuilder();
-        for (Method method : Configuration.class.getMethods()) {
-            if (method.isAnnotationPresent(Config.Key.class)) {
-                Config.Key val = method.getAnnotation(Config.Key.class);
-                currentProperties.append(System.lineSeparator());
-                currentProperties.append('\t');
-                currentProperties.append(val.value());
-                currentProperties.append(" : ");
-                currentProperties.append(this.getProperties().get(val.value()));
-            }
+        final List<String> values = Arrays.stream(Configuration.class.getMethods())
+                .map(method -> method.getAnnotation(Key.class)).filter(Objects::nonNull).map(Key::value).sorted()
+                .collect(Collectors.toList());
+        final StringBuilder currentProperties = new StringBuilder();
+        currentProperties.append(System.lineSeparator());
+
+        for (String value : values) {
+            currentProperties.append('\t');
+            currentProperties.append(value);
+            currentProperties.append(" : ");
+            currentProperties.append(this.getProperties().get(value));
+            currentProperties.append(System.lineSeparator());
         }
+
         return currentProperties.toString();
     }
 }
diff --git a/common/src/test/java/org/jboss/gm/common/ConfigurationTest.java b/common/src/test/java/org/jboss/gm/common/ConfigurationTest.java
@@ -1,6 +1,8 @@
 package org.jboss.gm.common;
 
+import java.util.Arrays;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import org.aeonbits.owner.ConfigFactory;
 import org.commonjava.maven.ext.io.rest.Translator;
@@ -11,6 +13,7 @@
 import org.junit.contrib.java.lang.system.SystemOutRule;
 import org.junit.rules.TestRule;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
@@ -57,7 +60,7 @@ public void verifyEnv() {
 
         assertEquals(deploy, c.deployUrl());
 
-        assertEquals(c.restRetryDuration(), Translator.RETRY_DURATION_SEC);
+        assertEquals(Translator.RETRY_DURATION_SEC, c.restRetryDuration());
     }
 
     @Test
@@ -78,4 +81,18 @@ public void verifyDefaultState() {
         Configuration c = ConfigFactory.create(Configuration.class);
         assertNull(c.overrideTransitive());
     }
+
+    @Test
+    public void verifyDumpCurrentConfig() {
+        final Configuration c = ConfigFactory.create(Configuration.class);
+        final String currentConfig = c.dumpCurrentConfig();
+        final String lineEnding = "(\\u000D\\u000A|[\\u000A\\u000D])";
+        final String keyValue = "(\\t(.*) : (.*))" + lineEnding;
+        final Pattern p = Pattern.compile("^" + lineEnding + "(" + keyValue + ")*$");
+        assertThat(currentConfig).matches(p);
+        final String[] lines = currentConfig.split(System.lineSeparator());
+        assertThat(lines).isNotEmpty();
+        final String[] keys = Arrays.stream(lines).map(line -> line.split(":")[0].trim()).toArray(String[]::new);
+        assertThat(keys).hasSize(lines.length).isSorted();
+    }
 }