test(logger): add tests for POWERTOOLS_DEV env var and for pretty printing logs when var is set to truthy value

Author: shdq

packages/logger/tests/unit/Logger.test.ts

@@ -11,7 +11,7 @@ import * as dummyEvent from '../../../../tests/resources/events/custom/hello-wor
 import { createLogger, Logger } from '../../src';
 import { EnvironmentVariablesService } from '../../src/config';
 import { PowertoolLogFormatter } from '../../src/formatter';
-import { ClassThatLogs } from '../../src/types';
+import { ClassThatLogs, LogJsonIndent } from '../../src/types';
 import { Context, Handler } from 'aws-lambda';
 import { Console } from 'console';
 
@@ -1411,4 +1411,49 @@ describe('Class: Logger', () => {
     });
   });
 
+  describe('Feature: Pretty indentation for a local or non-production environment', () => {
+    
+    test('when the `POWERTOOLS_DEV` env var is SET it makes log output has multiple lines', () => {
+      
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'true';
+      const INDENTATION = LogJsonIndent.PRETTY;
+      const logger = new Logger();
+      const consoleSpy = jest.spyOn(logger['console'], 'info').mockImplementation();
+
+      // Act
+      logger.info('Message with pretty identation');
+      
+      // Assess
+      expect(consoleSpy).toBeCalledTimes(1);
+      expect(consoleSpy).toHaveBeenNthCalledWith(1, JSON.stringify({
+        level: 'INFO',
+        message: 'Message with pretty identation',
+        service: 'hello-world',
+        timestamp: '2016-06-20T12:08:10.000Z',
+        xray_trace_id: '1-5759e988-bd862e3fe1be46a994272793',
+      }, null, INDENTATION));
+    });
+
+    test('when the `POWERTOOLS_DEV` env var is NOT SET it makes log output as one-liner', () => {
+        
+      // Prepare
+      const logger = new Logger();
+      const consoleSpy = jest.spyOn(logger['console'], 'info').mockImplementation();
+
+      // Act
+      logger.info('Message without pretty identation');
+      
+      // Assess
+      expect(consoleSpy).toBeCalledTimes(1);
+      expect(consoleSpy).toHaveBeenNthCalledWith(1, JSON.stringify({
+        level: 'INFO',
+        message: 'Message without pretty identation',
+        service: 'hello-world',
+        timestamp: '2016-06-20T12:08:10.000Z',
+        xray_trace_id: '1-5759e988-bd862e3fe1be46a994272793',
+      }));
+    });
+  });
+
 });

packages/logger/tests/unit/config/EnvironmentVariablesService.test.ts

@@ -220,4 +220,112 @@ describe('Class: EnvironmentVariablesService', () => {
 
   });
 
+  describe('Method: getDevMode', () => {
+
+    test('It returns true if the environment variable POWERTOOLS_DEV is "true"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'true';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(true);
+    });
+
+    test('It returns true if the environment variable POWERTOOLS_DEV is "TRUE"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'TRUE';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(true);
+    });
+
+    test('It returns true if the environment variable POWERTOOLS_DEV is "1"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = '1';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(true);
+    });
+
+    test('It returns false if the environment variable POWERTOOLS_DEV is "false"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'false';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(false);
+    });
+
+    test('It returns false if the environment variable POWERTOOLS_DEV is "FALSE"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'FALSE';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(false);
+    });
+
+    test('It returns false if the environment variable POWERTOOLS_DEV is "0"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = '0';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(false);
+    });
+
+    test('It returns false if the environment variable POWERTOOLS_DEV is NOT set', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'somethingsilly';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(false);
+    });
+
+    test('It returns false if the environment variable POWERTOOLS_DEV is "somethingsilly"', () => {
+
+      // Prepare
+      process.env.POWERTOOLS_DEV = 'somethingsilly';
+      const service = new EnvironmentVariablesService();
+
+      // Act
+      const value = service.getDevMode();
+
+      // Assess
+      expect(value).toEqual(false);
+    });
+
+  });
+
 });