From 8c64400b40efdb9c9beb14b639eb1045890b494c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johan=20Andr=C3=A9n?= <johan@markatta.com>
Date: Fri, 11 Feb 2022 13:40:51 +0100
Subject: [PATCH] Add log capturing for typed stream tests (to pin down pubsub
 stream failures) (#31118)

---
 .../src/test/resources/logback-test.xml       | 31 +++++++++++++++++++
 .../typed/scaladsl/ActorSourceSinkSpec.scala  |  2 +-
 .../scaladsl/MaterializerForTypedSpec.scala   |  5 ++-
 .../stream/typed/scaladsl/PubSubSpec.scala    |  3 +-
 4 files changed, 36 insertions(+), 5 deletions(-)
 create mode 100644 akka-stream-typed/src/test/resources/logback-test.xml

diff --git a/akka-stream-typed/src/test/resources/logback-test.xml b/akka-stream-typed/src/test/resources/logback-test.xml
new file mode 100644
index 0000000000..f2e0d8c016
--- /dev/null
+++ b/akka-stream-typed/src/test/resources/logback-test.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <!-- Silence initial setup logging from Logback -->
+    <statusListener class="ch.qos.logback.core.status.NopStatusListener" />
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%date{ISO8601} %-5level %logger %marker - %msg MDC: {%mdc}%n</pattern>
+        </encoder>
+    </appender>
+
+    <!--
+    Logging from tests are silenced by this appender. When there is a test failure
+    the captured logging events are flushed to the appenders defined for the
+    akka.actor.testkit.typed.internal.CapturingAppenderDelegate logger.
+    -->
+    <appender name="CapturingAppender" class="akka.actor.testkit.typed.internal.CapturingAppender" />
+
+    <!--
+    The appenders defined for this CapturingAppenderDelegate logger are used
+    when there is a test failure and all logging events from the test are
+    flushed to these appenders.
+    -->
+    <logger name="akka.actor.testkit.typed.internal.CapturingAppenderDelegate" >
+      <appender-ref ref="STDOUT"/>
+    </logger>
+
+    <root level="TRACE">
+        <appender-ref ref="CapturingAppender"/>
+    </root>
+</configuration>
diff --git a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/ActorSourceSinkSpec.scala b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/ActorSourceSinkSpec.scala
index c570d8d7fd..df4a507fe2 100644
--- a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/ActorSourceSinkSpec.scala
+++ b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/ActorSourceSinkSpec.scala
@@ -23,7 +23,7 @@ object ActorSourceSinkSpec {
   case object Failed extends AckProto
 }
 
-class ActorSourceSinkSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike {
+class ActorSourceSinkSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike with LogCapturing {
   import ActorSourceSinkSpec._
 
   "ActorSink" should {
diff --git a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/MaterializerForTypedSpec.scala b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/MaterializerForTypedSpec.scala
index 0f052f28bc..a6ad011d4c 100644
--- a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/MaterializerForTypedSpec.scala
+++ b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/MaterializerForTypedSpec.scala
@@ -6,10 +6,9 @@ package akka.stream.typed.scaladsl
 
 import scala.concurrent.Future
 import scala.util.Success
-
 import org.scalatest.wordspec.AnyWordSpecLike
-
 import akka.Done
+import akka.actor.testkit.typed.scaladsl.LogCapturing
 import akka.actor.testkit.typed.scaladsl.ScalaTestWithActorTestKit
 import akka.actor.typed.scaladsl.Behaviors
 import akka.stream.AbruptStageTerminationException
@@ -17,7 +16,7 @@ import akka.stream.Materializer
 import akka.stream.scaladsl.Sink
 import akka.stream.scaladsl.Source
 
-class MaterializerForTypedSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike {
+class MaterializerForTypedSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike with LogCapturing {
 
   "Materialization in typed" should {
 
diff --git a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/PubSubSpec.scala b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/PubSubSpec.scala
index 62bd992242..68cb2553db 100644
--- a/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/PubSubSpec.scala
+++ b/akka-stream-typed/src/test/scala/akka/stream/typed/scaladsl/PubSubSpec.scala
@@ -4,6 +4,7 @@
 
 package akka.stream.typed.scaladsl
 
+import akka.actor.testkit.typed.scaladsl.LogCapturing
 import akka.actor.testkit.typed.scaladsl.ScalaTestWithActorTestKit
 import akka.actor.typed.internal.pubsub.TopicImpl
 import akka.actor.typed.pubsub.Topic
@@ -12,7 +13,7 @@ import akka.stream.scaladsl.Source
 import akka.stream.testkit.scaladsl.TestSink
 import org.scalatest.wordspec.AnyWordSpecLike
 
-class PubSubSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike {
+class PubSubSpec extends ScalaTestWithActorTestKit with AnyWordSpecLike with LogCapturing {
 
   "PubSub.source" should {