From 0fd70dc8e19e25777d8e4eb2e8b2ef8a9e251fb5 Mon Sep 17 00:00:00 2001
From: Torkel Rogstad <torkel@rogstad.io>
Date: Fri, 7 Jun 2019 14:29:40 +0200
Subject: [PATCH] Refactor logback configuration to reduce repetition (#499)

---
 bench/src/main/resources/logback.xml        | 23 ---------------------
 build.sbt                                   |  9 ++++++--
 core/src/main/resources/common-logback.xml  |  8 +++++--
 core/src/main/resources/logback.xml         |  7 +++++++
 doc/src/main/resources/logback.xml          | 22 --------------------
 node/src/main/resources/logback.xml         |  3 ---
 scripts/src/main/resources/logback.xml      | 22 --------------------
 testkit/src/main/resources/logback-test.xml |  3 ---
 8 files changed, 20 insertions(+), 77 deletions(-)
 delete mode 100644 bench/src/main/resources/logback.xml
 create mode 100644 core/src/main/resources/logback.xml
 delete mode 100644 doc/src/main/resources/logback.xml
 delete mode 100644 node/src/main/resources/logback.xml
 delete mode 100644 scripts/src/main/resources/logback.xml
 delete mode 100644 testkit/src/main/resources/logback-test.xml

diff --git a/bench/src/main/resources/logback.xml b/bench/src/main/resources/logback.xml
deleted file mode 100644
index 2cc83148f6..0000000000
--- a/bench/src/main/resources/logback.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<configuration>
-
-    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
-        <file>log/bench.log</file>
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-
-    <root level="INFO">
-        <appender-ref ref="STDOUT" />
-        <appender-ref ref="FILE"/>
-    </root>
-
-
-</configuration>
\ No newline at end of file
diff --git a/build.sbt b/build.sbt
index fe3085cbc3..87ad7bbdc6 100644
--- a/build.sbt
+++ b/build.sbt
@@ -75,8 +75,13 @@ lazy val commonSettings = List(
   testOptions in Test += Tests.Argument(TestFrameworks.ScalaTest, "-oD"),
   assemblyOption in assembly := (assemblyOption in assembly).value
     .copy(includeScala = false),
+  /**
+    * We want to exclude loback config from our published library, so that users don't
+    * get our config forced on them
+    */
+  Compile / unmanagedResources := (Compile / unmanagedResources).value
+    .filterNot { _.getName.endsWith(".xml") },
   licenses += ("MIT", url("http://opensource.org/licenses/MIT")),
-  
   /**
     * Adding Ammonite REPL to test scope, can access both test and compile
     * sources. Docs: http://ammonite.io/#Ammonite-REPL
@@ -96,7 +101,7 @@ lazy val commonSettings = List(
 )
 
 lazy val commonTestSettings = Seq(
-  publish / skip := true,
+  publish / skip := true
 ) ++ commonSettings
 
 lazy val commonTestWithDbSettings = Seq(
diff --git a/core/src/main/resources/common-logback.xml b/core/src/main/resources/common-logback.xml
index cd505a8958..2ae8f82657 100644
--- a/core/src/main/resources/common-logback.xml
+++ b/core/src/main/resources/common-logback.xml
@@ -1,4 +1,8 @@
 <included>
+    <!-- Stop output INFO at start -->
+    <statusListener class="ch.qos.logback.core.status.NopStatusListener" />
+
+
     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
         <file>logs/application.log</file>
         <encoder>
@@ -8,13 +12,13 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
+            <pattern>%d{HH:mm:ss.SSS} %level %logger{0} - %msg%n</pattern>
         </encoder>
     </appender>
 
 
 
-    <root level="OFF">
+    <root level="INFO">
         <appender-ref ref="FILE" />
         <appender-ref ref="STDOUT" />
     </root>
diff --git a/core/src/main/resources/logback.xml b/core/src/main/resources/logback.xml
new file mode 100644
index 0000000000..132e39347e
--- /dev/null
+++ b/core/src/main/resources/logback.xml
@@ -0,0 +1,7 @@
+<configuration>
+    <!-- Although this file is on the core project classpath, 
+    we exclude all XML files from being included in published 
+    artifacts. This way users of Bitcoin-S won't get our config
+    pushed on them. -->
+    <include resource="common-logback.xml" />
+</configuration>
diff --git a/doc/src/main/resources/logback.xml b/doc/src/main/resources/logback.xml
deleted file mode 100644
index f6d9b39c34..0000000000
--- a/doc/src/main/resources/logback.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-<configuration>
-
-    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
-        <file>logs/doc.log</file>
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-    <logger name="slick" level="INFO"/>
-    <root level="DEBUG">
-        <appender-ref ref="STDOUT" />
-        <appender-ref ref="FILE"/>
-    </root>
-
-</configuration>
diff --git a/node/src/main/resources/logback.xml b/node/src/main/resources/logback.xml
deleted file mode 100644
index a84a24c11d..0000000000
--- a/node/src/main/resources/logback.xml
+++ /dev/null
@@ -1,3 +0,0 @@
-<configuration>
-    <include resource="common-logback.xml" />
-</configuration>
\ No newline at end of file
diff --git a/scripts/src/main/resources/logback.xml b/scripts/src/main/resources/logback.xml
deleted file mode 100644
index f6d9b39c34..0000000000
--- a/scripts/src/main/resources/logback.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-<configuration>
-
-    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
-        <file>logs/doc.log</file>
-        <encoder>
-            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{5}.%M\(%line\) - %msg%n</pattern>
-        </encoder>
-    </appender>
-
-    <logger name="slick" level="INFO"/>
-    <root level="DEBUG">
-        <appender-ref ref="STDOUT" />
-        <appender-ref ref="FILE"/>
-    </root>
-
-</configuration>
diff --git a/testkit/src/main/resources/logback-test.xml b/testkit/src/main/resources/logback-test.xml
deleted file mode 100644
index a84a24c11d..0000000000
--- a/testkit/src/main/resources/logback-test.xml
+++ /dev/null
@@ -1,3 +0,0 @@
-<configuration>
-    <include resource="common-logback.xml" />
-</configuration>
\ No newline at end of file