Merge pull request #175 from AikidoSec/recognize-aikido-debug-env

Allow setting log level to debug via AIKIDO_DEBUG

Author: bitterpanda63

agent_api/src/main/java/dev/aikido/agent_api/helpers/logging/Logger.java

@@ -1,5 +1,7 @@
 package dev.aikido.agent_api.helpers.logging;
 
+import dev.aikido.agent_api.helpers.env.BooleanEnv;
+
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
@@ -17,6 +19,7 @@ public Logger(Class<?> logClass) {
         this.logLevel = DEFAULT_LOG_LEVEL;
         this.logClass = logClass;
 
+        // We first check "AIKIDO_LOG_LEVEL", because "AIKIDO_DEBUG" takes precedent.
         String logLevelString = System.getenv("AIKIDO_LOG_LEVEL");
         if (logLevelString != null) {
             try {
@@ -25,6 +28,11 @@ public Logger(Class<?> logClass) {
                 this.error("Unknown log level `%s`", logLevelString);
             }
         }
+        // "AIKIDO_DEBUG"
+        BooleanEnv aikidoDebug = new BooleanEnv("AIKIDO_DEBUG", false);
+        if (aikidoDebug.getValue()) {
+            this.logLevel = LogLevel.TRACE;
+        }
     }
     public Logger(Class<?> logClass, LogLevel logLevel) {
         this.logLevel = logLevel;

agent_api/src/test/java/helpers/LoggingTest.java

@@ -6,6 +6,7 @@
 import dev.aikido.agent_api.helpers.logging.Logger;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junitpioneer.jupiter.ClearEnvironmentVariable;
 import org.junitpioneer.jupiter.SetEnvironmentVariable;
 import org.junitpioneer.jupiter.StdIo;
 import org.junitpioneer.jupiter.StdOut;
@@ -65,8 +66,75 @@ public void testLoggerReadsEnv1(StdOut out) {
         assertFalse(out.capturedString().contains("TEST2"));
         assertFalse(out.capturedString().contains("TEST3"));
     }
+
+    @Test
+    @SetEnvironmentVariable(key = "AIKIDO_LOG_LEVEL", value = "debug")
+    @StdIo
+    public void testLoggerIsDebug(StdOut out) {
+        // Check it reads environment variable
+        Logger logger = new Logger(FileCollector.class);
+        logger.info("TEST1");
+        logger.trace("TEST2");
+        logger.debug("TEST3");
+        logger.error("TEST4");
+        logger.fatal("TEST5");
+        logger.warn("TEST6");
+
+        assertTrue(out.capturedString().contains("INFO dev.aikido.agent_api.collectors.FileCollector: TEST1"));
+        assertTrue(out.capturedString().contains("ERROR dev.aikido.agent_api.collectors.FileCollector: TEST4"));
+        assertTrue(out.capturedString().contains("FATAL dev.aikido.agent_api.collectors.FileCollector: TEST5"));
+        assertTrue(out.capturedString().contains("WARN dev.aikido.agent_api.collectors.FileCollector: TEST6"));
+        assertFalse(out.capturedString().contains("TEST2"));
+        assertTrue(out.capturedString().contains("TEST3"));
+    }
+
+    @Test
+    @SetEnvironmentVariable(key = "AIKIDO_DEBUG", value = "true")
+    @ClearEnvironmentVariable(key = "AIKIDO_LOG_LEVEL")
+    @StdIo
+    public void testLoggerIsAikidoDebug(StdOut out) {
+        // Check it reads environment variable
+        Logger logger = new Logger(FileCollector.class);
+        logger.info("TEST1");
+        logger.trace("TEST2");
+        logger.debug("TEST3");
+        logger.error("TEST4");
+        logger.fatal("TEST5");
+        logger.warn("TEST6");
+
+        assertTrue(out.capturedString().contains("INFO dev.aikido.agent_api.collectors.FileCollector: TEST1"));
+        assertTrue(out.capturedString().contains("ERROR dev.aikido.agent_api.collectors.FileCollector: TEST4"));
+        assertTrue(out.capturedString().contains("FATAL dev.aikido.agent_api.collectors.FileCollector: TEST5"));
+        assertTrue(out.capturedString().contains("WARN dev.aikido.agent_api.collectors.FileCollector: TEST6"));
+        assertTrue(out.capturedString().contains("TEST2"));
+        assertTrue(out.capturedString().contains("TEST3"));
+    }
+
+    @Test
+    @SetEnvironmentVariable(key = "AIKIDO_LOG_LEVEL", value = "error")
+    @SetEnvironmentVariable(key = "AIKIDO_DEBUG", value = "true")
+    @StdIo
+    public void testDebugEnvTakesPrecedent(StdOut out) {
+        // Check it reads environment variable
+        Logger logger = new Logger(FileCollector.class);
+        logger.info("TEST1");
+        logger.trace("TEST2");
+        logger.debug("TEST3");
+        logger.error("TEST4");
+        logger.fatal("TEST5");
+        logger.warn("TEST6");
+
+        assertTrue(out.capturedString().contains("INFO dev.aikido.agent_api.collectors.FileCollector: TEST1"));
+        assertTrue(out.capturedString().contains("ERROR dev.aikido.agent_api.collectors.FileCollector: TEST4"));
+        assertTrue(out.capturedString().contains("FATAL dev.aikido.agent_api.collectors.FileCollector: TEST5"));
+        assertTrue(out.capturedString().contains("WARN dev.aikido.agent_api.collectors.FileCollector: TEST6"));
+        assertTrue(out.capturedString().contains("TEST2"));
+        assertTrue(out.capturedString().contains("TEST3"));
+    }
+
     @Test
     @SetEnvironmentVariable(key = "AIKIDO_LOG_LEVEL", value = "fatal")
+    @ClearEnvironmentVariable(key = "AIKIDO_DEBUG")
     @StdIo
     public void testLoggerReadsEnv2(StdOut out) {
         // Check it reads environment variable