Pair OpenTelemetryAppender install/reset symmetrically in logging appender tests

Author: trask

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/AbstractOpenTelemetryAppenderTest.java

@@ -21,7 +21,6 @@
 import org.apache.logging.log4j.ThreadContext;
 import org.apache.logging.log4j.core.impl.Log4jLogEvent;
 import org.apache.logging.log4j.message.FormattedMessage;
-import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
@@ -44,12 +43,6 @@ static void generalBeforeEachSetup() {
     ThreadContext.clearAll();
   }
 
-  @AfterAll
-  static void cleanupAll() {
-    // This is to make sure that other test classes don't have issues with the logger provider set
-    OpenTelemetryAppender.resetForTest();
-  }
-
   protected abstract InstrumentationExtension getTesting();
 
   @Test

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/Log4j2Test.java

@@ -12,7 +12,7 @@
 import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
 import java.util.ArrayList;
 import java.util.List;
-import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -26,8 +26,8 @@ void setup() {
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
   }
 
-  @AfterAll
-  static void cleanup() {
+  @AfterEach
+  void cleanup() {
     OpenTelemetryAppender.resetForTest();
   }
 

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/LogReplayOpenTelemetryAppenderTest.java

@@ -10,13 +10,13 @@
 import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID;
 import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME;
 
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
 import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
 import java.util.List;
 import org.apache.logging.log4j.message.StringMapMessage;
 import org.apache.logging.log4j.message.StructuredDataMessage;
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assumptions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -28,16 +28,13 @@ class LogReplayOpenTelemetryAppenderTest extends AbstractOpenTelemetryAppenderTe
   private static final LibraryInstrumentationExtension testing =
       LibraryInstrumentationExtension.create();
 
+  @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
   @BeforeEach
   void setup() {
     generalBeforeEachSetup();
   }
 
-  @AfterEach
-  void resetOpenTelemetry() {
-    OpenTelemetryAppender.resetForTest();
-  }
-
   @Override
   protected InstrumentationExtension getTesting() {
     return testing;
@@ -46,6 +43,7 @@ protected InstrumentationExtension getTesting() {
   @Override
   void executeAfterLogsExecution() {
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
   }
 
   private static boolean isAsyncLogger() {
@@ -63,6 +61,7 @@ void twoLogs() {
         "log message 2"); // Won't be instrumented because cache size is 1 (see log4j2.xml file)
 
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
 
     testing.waitAndAssertLogRecords(
         logRecord ->
@@ -91,6 +90,7 @@ void twoLogsStringMapMessage() {
     logger.info(message2); // Won't be instrumented because cache size is 1 (see log4j2.xml file)
 
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
 
     testing.waitAndAssertLogRecords(
         logRecord ->
@@ -124,6 +124,7 @@ void twoLogsStructuredDataMessage() {
     logger.info(message2); // Won't be instrumented because cache size is 1 (see log4j2.xml file)
 
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
 
     testing.waitAndAssertLogRecords(
         logRecord ->

instrumentation/log4j/log4j-appender-2.17/library/src/test/java/io/opentelemetry/instrumentation/log4j/appender/v2_17/OpenTelemetryAppenderTest.java

@@ -7,6 +7,7 @@
 
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -22,6 +23,11 @@ void setup() {
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
   }
 
+  @AfterEach
+  void cleanup() {
+    OpenTelemetryAppender.resetForTest();
+  }
+
   @Override
   protected InstrumentationExtension getTesting() {
     return testing;

instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/LogReplayOpenTelemetryAppenderTest.java

@@ -10,6 +10,7 @@
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.util.ContextInitializer;
 import ch.qos.logback.core.spi.ContextAware;
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
 import java.net.URL;
@@ -24,6 +25,8 @@ class LogReplayOpenTelemetryAppenderTest extends AbstractOpenTelemetryAppenderTe
   private static final LibraryInstrumentationExtension testing =
       LibraryInstrumentationExtension.create();
 
+  @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
   @BeforeEach
   void setup() throws Exception {
     // to make sure we start fresh with a new OpenTelemetryAppender for each test
@@ -59,6 +62,7 @@ private static void reloadLoggerConfiguration() throws Exception {
   @Override
   void executeAfterLogsExecution() {
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
   }
 
   @Test
@@ -69,6 +73,7 @@ void twoLogs() {
     // file)
 
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
+    cleanup.deferCleanup(OpenTelemetryAppender::resetForTest);
 
     testing.waitAndAssertLogRecords(
         logRecord ->

instrumentation/logback/logback-appender-1.0/library/src/test/java/io/opentelemetry/instrumentation/logback/appender/v1_0/OpenTelemetryAppenderTest.java

@@ -9,6 +9,7 @@
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -24,6 +25,11 @@ void setup() {
     OpenTelemetryAppender.install(testing.getOpenTelemetry());
   }
 
+  @AfterEach
+  void cleanup() {
+    OpenTelemetryAppender.resetForTest();
+  }
+
   @Override
   protected InstrumentationExtension getTesting() {
     return testing;