Improving unit test coverage for Cerberus server (#445)

Nike-Inc · Apr 12, 2021 · 165476c · 165476c
1 parent f1f965f
commit 165476c
Show file tree

Hide file tree

Showing 16 changed files with 850 additions and 18 deletions.
diff --git a/...r-athena/src/main/java/ch/qos/logback/core/rolling/AuditLogsS3TimeBasedRollingPolicy.java b/...r-athena/src/main/java/ch/qos/logback/core/rolling/AuditLogsS3TimeBasedRollingPolicy.java
@@ -20,6 +20,7 @@
 import com.nike.internal.util.StringUtils;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.stream.Stream;
+import lombok.Setter;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
@@ -30,7 +31,7 @@ public class AuditLogsS3TimeBasedRollingPolicy<E> extends TimeBasedRollingPolicy
 
   private final String bucket;
   private final String bucketRegion;
-  private LinkedBlockingQueue<String> logChunkFileS3Queue = new LinkedBlockingQueue<>();
+  @Setter private LinkedBlockingQueue<String> logChunkFileS3Queue = new LinkedBlockingQueue<>();
   private S3LogUploaderService s3LogUploaderService = null;
 
   @Autowired
@@ -54,7 +55,7 @@ private boolean isS3AuditLogCopyingEnabled() {
 
   @Override
   public void rollover() throws RolloverFailure {
-    super.rollover();
+    superRollOver();
 
     if (isS3AuditLogCopyingEnabled()) {
       String filename = timeBasedFileNamingAndTriggeringPolicy.getElapsedPeriodsFileName() + ".gz";
@@ -65,4 +66,9 @@ public void rollover() throws RolloverFailure {
       }
     }
   }
+
+  void superRollOver() {
+    super.rollover();
+    ;
+  }
 }
diff --git a/...ena/src/main/java/com/nike/cerberus/audit/logger/listener/AthenaLoggingEventListener.java b/...ena/src/main/java/com/nike/cerberus/audit/logger/listener/AthenaLoggingEventListener.java
@@ -71,30 +71,20 @@ public void onApplicationEvent(AuditableEvent event) {
                       .put(
                           "principal_type",
                           cerberusPrincipal
-                              .map(p -> cerberusPrincipal.get().getPrincipalType().getName())
+                              .map(p -> p.getPrincipalType().getName())
                               .orElse(AuditableEventContext.UNKNOWN))
                       .put(
                           "principal_token_created",
                           cerberusPrincipal
-                              .map(
-                                  p ->
-                                      cerberusPrincipal
-                                          .get()
-                                          .getCreated()
-                                          .format(ATHENA_DATE_FORMATTER))
+                              .map(p -> p.getCreated().format(ATHENA_DATE_FORMATTER))
                               .orElseGet(
                                   () ->
                                       OffsetDateTime.parse(PARTY_LIKE_ITS_99, ISO_OFFSET_DATE_TIME)
                                           .format(ATHENA_DATE_FORMATTER)))
                       .put(
                           "principal_token_expires",
                           cerberusPrincipal
-                              .map(
-                                  p ->
-                                      cerberusPrincipal
-                                          .get()
-                                          .getExpires()
-                                          .format(ATHENA_DATE_FORMATTER))
+                              .map(p -> p.getExpires().format(ATHENA_DATE_FORMATTER))
                               .orElseGet(
                                   () ->
                                       OffsetDateTime.parse(PARTY_LIKE_ITS_99, ISO_OFFSET_DATE_TIME)

diff --git a/...ger-athena/src/main/java/com/nike/cerberus/audit/logger/service/S3LogUploaderService.java b/...ger-athena/src/main/java/com/nike/cerberus/audit/logger/service/S3LogUploaderService.java
@@ -31,6 +31,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import javax.annotation.PreDestroy;
+import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.io.FileUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -52,7 +53,7 @@ public class S3LogUploaderService {
   private static final String ATHENA_LOG_NAME = "athena-audit-logger";
   private static final String ATHENA_LOG_APPENDER = "athena-log-appender";
 
-  private final ExecutorService executor = Executors.newSingleThreadExecutor();
+  @Setter private ExecutorService executor = Executors.newSingleThreadExecutor();
   private final AmazonS3 amazonS3;
   private final String bucket;
   private final String bucketRegion;

diff --git a/...hena/src/test/java/ch/qos/logback/core/rolling/AuditLogsS3TimeBasedRollingPolicyTest.java b/...hena/src/test/java/ch/qos/logback/core/rolling/AuditLogsS3TimeBasedRollingPolicyTest.java
@@ -0,0 +1,76 @@
+package ch.qos.logback.core.rolling;
+
+import com.nike.cerberus.audit.logger.service.S3LogUploaderService;
+import java.util.concurrent.LinkedBlockingQueue;
+import org.junit.Assert;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+public class AuditLogsS3TimeBasedRollingPolicyTest {
+
+  private AuditLogsS3TimeBasedRollingPolicy auditLogsS3TimeBasedRollingPolicy;
+
+  @Test
+  public void testLogUploaderServiceIfLogChunkFileS3QueueIsEmpty() {
+    auditLogsS3TimeBasedRollingPolicy =
+        new AuditLogsS3TimeBasedRollingPolicy("bucket", "bucketRegion");
+    S3LogUploaderService s3LogUploaderService = Mockito.mock(S3LogUploaderService.class);
+    auditLogsS3TimeBasedRollingPolicy.setS3LogUploaderService(s3LogUploaderService);
+    Mockito.verify(s3LogUploaderService, Mockito.never()).ingestLog(Mockito.anyString());
+  }
+
+  @Test
+  public void testRollOverIfAuditCopyIsNotEnabled() {
+    auditLogsS3TimeBasedRollingPolicy = Mockito.spy(new AuditLogsS3TimeBasedRollingPolicy("", ""));
+    Mockito.doNothing().when(auditLogsS3TimeBasedRollingPolicy).superRollOver();
+    S3LogUploaderService s3LogUploaderService = Mockito.mock(S3LogUploaderService.class);
+    auditLogsS3TimeBasedRollingPolicy.setS3LogUploaderService(s3LogUploaderService);
+    TimeBasedFileNamingAndTriggeringPolicy timeBasedFileNamingAndTriggeringPolicy =
+        Mockito.spy(TimeBasedFileNamingAndTriggeringPolicy.class);
+    auditLogsS3TimeBasedRollingPolicy.setTimeBasedFileNamingAndTriggeringPolicy(
+        timeBasedFileNamingAndTriggeringPolicy);
+    auditLogsS3TimeBasedRollingPolicy.rollover();
+    Mockito.verify(timeBasedFileNamingAndTriggeringPolicy, Mockito.never())
+        .getElapsedPeriodsFileName();
+    Mockito.verify(s3LogUploaderService, Mockito.never()).ingestLog(Mockito.anyString());
+  }
+
+  @Test
+  public void testRollOverIfAuditCopyIsEnabled() {
+    auditLogsS3TimeBasedRollingPolicy =
+        Mockito.spy(new AuditLogsS3TimeBasedRollingPolicy("bucket", "region"));
+    Mockito.doNothing().when(auditLogsS3TimeBasedRollingPolicy).superRollOver();
+    S3LogUploaderService s3LogUploaderService = Mockito.mock(S3LogUploaderService.class);
+    auditLogsS3TimeBasedRollingPolicy.setS3LogUploaderService(s3LogUploaderService);
+    TimeBasedFileNamingAndTriggeringPolicy timeBasedFileNamingAndTriggeringPolicy =
+        Mockito.spy(TimeBasedFileNamingAndTriggeringPolicy.class);
+    Mockito.when(timeBasedFileNamingAndTriggeringPolicy.getElapsedPeriodsFileName())
+        .thenReturn("elapsedfilename");
+    auditLogsS3TimeBasedRollingPolicy.setTimeBasedFileNamingAndTriggeringPolicy(
+        timeBasedFileNamingAndTriggeringPolicy);
+    LinkedBlockingQueue<String> logChunkFileS3Queue = new LinkedBlockingQueue<>();
+    auditLogsS3TimeBasedRollingPolicy.setLogChunkFileS3Queue(logChunkFileS3Queue);
+    auditLogsS3TimeBasedRollingPolicy.rollover();
+    Mockito.verify(timeBasedFileNamingAndTriggeringPolicy).getElapsedPeriodsFileName();
+    Mockito.verify(s3LogUploaderService).ingestLog("elapsedfilename.gz");
+    Assert.assertTrue(logChunkFileS3Queue.size() == 0);
+  }
+
+  @Test
+  public void testRollOverIfAuditCopyIsEnabledAndS3UploaderIsNull() {
+    auditLogsS3TimeBasedRollingPolicy =
+        Mockito.spy(new AuditLogsS3TimeBasedRollingPolicy("bucket", "region"));
+    Mockito.doNothing().when(auditLogsS3TimeBasedRollingPolicy).superRollOver();
+    TimeBasedFileNamingAndTriggeringPolicy timeBasedFileNamingAndTriggeringPolicy =
+        Mockito.spy(TimeBasedFileNamingAndTriggeringPolicy.class);
+    Mockito.when(timeBasedFileNamingAndTriggeringPolicy.getElapsedPeriodsFileName())
+        .thenReturn("elapsedfilename");
+    auditLogsS3TimeBasedRollingPolicy.setTimeBasedFileNamingAndTriggeringPolicy(
+        timeBasedFileNamingAndTriggeringPolicy);
+    LinkedBlockingQueue<String> logChunkFileS3Queue = new LinkedBlockingQueue<>();
+    auditLogsS3TimeBasedRollingPolicy.setLogChunkFileS3Queue(logChunkFileS3Queue);
+    auditLogsS3TimeBasedRollingPolicy.rollover();
+    Mockito.verify(timeBasedFileNamingAndTriggeringPolicy).getElapsedPeriodsFileName();
+    Assert.assertTrue(logChunkFileS3Queue.size() > 0);
+  }
+}
diff --git a/...t-logger-athena/src/test/java/com/nike/cerberus/audit/logger/AthenaClientFactoryTest.java b/...t-logger-athena/src/test/java/com/nike/cerberus/audit/logger/AthenaClientFactoryTest.java
@@ -0,0 +1,28 @@
+package com.nike.cerberus.audit.logger;
+
+import com.amazonaws.services.athena.AmazonAthena;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class AthenaClientFactoryTest {
+
+  @Test
+  public void testGetClientAlwaysReturnsSameAthenaInstance() {
+    AthenaClientFactory athenaClientFactory = new AthenaClientFactory();
+    AmazonAthena clientInstance1 = athenaClientFactory.getClient("region-2");
+    AmazonAthena clientInstance2 = athenaClientFactory.getClient("region-2");
+    Assert.assertSame(clientInstance1, clientInstance2);
+  }
+
+  @Test
+  public void testGetClientDoesNotThrowNPEWhenRegionIsEmptyString() {
+    AthenaClientFactory athenaClientFactory = new AthenaClientFactory();
+    athenaClientFactory.getClient("");
+  }
+
+  @Test(expected = NullPointerException.class)
+  public void testGetClientThrowsNPEWhenRegionIsNull() {
+    AthenaClientFactory athenaClientFactory = new AthenaClientFactory();
+    athenaClientFactory.getClient(null);
+  }
+}
diff --git a/...audit-logger-athena/src/test/java/com/nike/cerberus/audit/logger/S3ClientFactoryTest.java b/...audit-logger-athena/src/test/java/com/nike/cerberus/audit/logger/S3ClientFactoryTest.java
@@ -0,0 +1,28 @@
+package com.nike.cerberus.audit.logger;
+
+import com.amazonaws.services.s3.AmazonS3;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class S3ClientFactoryTest {
+
+  @Test
+  public void testS3ClientFactoryAlwaysReturnSameInstance() {
+    S3ClientFactory s3ClientFactory = new S3ClientFactory();
+    AmazonS3 s3Instance1 = s3ClientFactory.getClient("region-1");
+    AmazonS3 s3Instance2 = s3ClientFactory.getClient("region-1");
+    Assert.assertSame(s3Instance1, s3Instance2);
+  }
+
+  @Test
+  public void testS3ClientFactoryDoesNotThrowsNPEWhenEmptyStringIsPassedAsRegion() {
+    S3ClientFactory s3ClientFactory = new S3ClientFactory();
+    s3ClientFactory.getClient("");
+  }
+
+  @Test(expected = NullPointerException.class)
+  public void testS3ClientFactoryThrowsNPEWhenNullRegionIsPassed() {
+    S3ClientFactory s3ClientFactory = new S3ClientFactory();
+    s3ClientFactory.getClient(null);
+  }
+}