removed logback testing solution and test the annotation not logging

aws-powertools · Nov 14, 2023 · 5b33d85 · 5b33d85
1 parent 391c9cf
commit 5b33d85
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 52 deletions.
diff --git a/powertools-tracing/pom.xml b/powertools-tracing/pom.xml
@@ -48,10 +48,6 @@
         </developer>
     </developers>
 
-    <properties>
-        <logback.version>1.2.11</logback.version>
-    </properties>
-
     <distributionManagement>
         <snapshotRepository>
             <id>ossrh</id>
@@ -119,13 +115,6 @@
             <artifactId>assertj-core</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <version>${logback.version}</version>
-            <scope>test</scope>
-        </dependency>
-
     </dependencies>
 
     <build>

diff --git a/...ols-tracing/src/test/java/software/amazon/lambda/powertools/tracing/TracingUtilsTest.java b/...ols-tracing/src/test/java/software/amazon/lambda/powertools/tracing/TracingUtilsTest.java
@@ -20,21 +20,14 @@
 import static org.mockito.Mockito.verify;
 import static software.amazon.lambda.powertools.tracing.TracingUtils.withEntitySubsegment;
 
-import ch.qos.logback.classic.Level;
-import ch.qos.logback.classic.Logger;
-import ch.qos.logback.classic.spi.ILoggingEvent;
-import ch.qos.logback.core.read.ListAppender;
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.xray.AWSXRay;
 import com.amazonaws.xray.entities.Entity;
-import java.util.List;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.slf4j.LoggerFactory;
 
 class TracingUtilsTest {
-
     @BeforeEach
     void setUp() {
         AWSXRay.beginSegment("test");
@@ -130,45 +123,21 @@ void shouldInvokeCodeBlockWrappedWithinSubsegment() {
     }
 
     @Test
-    void shouldEmitNoLogWarnIfValidCharacterInKey() {
+    void shouldNotAddAnnotationIfInvalidCharacterInKey() {
         AWSXRay.beginSubsegment("subSegment");
-        Logger logger = (Logger) LoggerFactory.getLogger(TracingUtils.class);
-
-        // create and start a ListAppender
-        ListAppender<ILoggingEvent> listAppender = new ListAppender<>();
-        listAppender.start();
-
-        // add the appender to the logger
-        logger.addAppender(listAppender);
-
-        TracingUtils.putAnnotation("stringKey", "val");
-
-        List<ILoggingEvent> logsList = listAppender.list;
-        assertThat(AWSXRay.getTraceEntity().getAnnotations())
-                .hasSize(1)
-                .contains(
-                        entry("stringKey", "val")
-                );
-        assertThat(logsList.size()).isZero();
+        String inputKey = "stringKey with spaces";
+        TracingUtils.putAnnotation(inputKey, "val");
+        AWSXRay.getCurrentSubsegmentOptional()
+                .ifPresent(segment -> assertThat(segment.getAnnotations()).size().isEqualTo(0));
     }
 
     @Test
-    void shouldEmitLogWarnIfInvalidCharacterInKey() {
+    void shouldAddAnnotationIfValidCharactersInKey() {
         AWSXRay.beginSubsegment("subSegment");
-        Logger logger = (Logger) LoggerFactory.getLogger(TracingUtils.class);
-
-        // create and start a ListAppender
-        ListAppender<ILoggingEvent> listAppender = new ListAppender<>();
-        listAppender.start();
-
-        // add the appender to the logger
-        logger.addAppender(listAppender);
-        String inputKey = "stringKey with spaces";
+        String inputKey = "validKey";
         TracingUtils.putAnnotation(inputKey, "val");
-
-        List<ILoggingEvent> logsList = listAppender.list;
-        assertThat(logsList.get(0).getLevel()).isEqualTo(Level.WARN);
-        assertThat(logsList.get(0).getMessage()).isEqualTo("Ignoring annotation with unsupported characters in key: {}",inputKey);
+        AWSXRay.getCurrentSubsegmentOptional()
+                .ifPresent(segment -> assertThat(segment.getAnnotations()).size().isEqualTo(1));
     }
 
     @Test
@@ -269,4 +238,4 @@ void shouldInvokeCodeBlockWrappedWithinNamespacedEntitySubsegment() throws Inter
                             .containsEntry("key", "val");
                 });
     }
-}
+}