Fix formatting for secrets which contain new lines #363

sksamuel · Mar 20, 2023 · 07cb4cc · 07cb4cc
1 parent 08b0e82
commit 07cb4cc
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 2 deletions.
diff --git a/hoplite-core/src/main/kotlin/com/sksamuel/hoplite/report/Reporter.kt b/hoplite-core/src/main/kotlin/com/sksamuel/hoplite/report/Reporter.kt
@@ -98,9 +98,9 @@ class Reporter(
     val obfuscated: List<NodeState> = nodes.sortedBy { it.node.path.flatten() }.map { state ->
 
       val value = if (state.secret && state.node is PrimitiveNode)
-        obfuscator.obfuscate(state.node)
+        obfuscator.obfuscate(state.node).replace("\n", "")
       else
-        state.node.valueOrNull()
+        state.node.valueOrNull()?.replace("\n", "")
 
       state.copy(
         node = StringNode(

diff --git a/hoplite-core/src/test/kotlin/com/sksamuel/hoplite/ReporterTest.kt b/hoplite-core/src/test/kotlin/com/sksamuel/hoplite/ReporterTest.kt
@@ -71,6 +71,46 @@ Property sources (highest to lowest priority):
 
   }
 
+  test("report should remove new lines") {
+
+    data class Test(
+      val name: String,
+      val host: String,
+      val port: Int,
+      val password: Secret,
+    )
+
+    captureStandardOut {
+      ConfigLoaderBuilder.default()
+        .addPropertySource(
+          PropertySource.string(
+            """
+          name = my database
+          host = l\nremotehost
+          port = 3306
+          password = ssm://mysecretkey
+          """.trimIndent(), "props"
+          )
+        )
+        .withReport()
+        .build()
+        .loadConfigOrThrow<Test>()
+    }.shouldContain(
+      """
+Used keys: 4
++----------+---------------------+----------+
+| Key      | Source              | Value    |
++----------+---------------------+----------+
+| host     | props string source | lr*****  |
+| name     | props string source | my ***** |
+| password | props string source | ssm***** |
+| port     | props string source | 3306     |
++----------+---------------------+----------+
+"""
+    )
+
+  }
+
   test("should print report on failed config") {
 
     data class Config(val name: String, val host: String, val port: Int)