chore: Make logger name into shared constants (aws#1773)

aahung · Oct 10, 2020 · 4c6ac99 · 4c6ac99
1 parent cf88a49
commit 4c6ac99
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 11 deletions.
diff --git a/samcli/cli/context.py b/samcli/cli/context.py
@@ -12,7 +12,11 @@
 import click
 
 from samcli.commands.exceptions import CredentialsError
-from samcli.lib.utils.sam_logging import SAM_CLI_FORMATTER_WITH_TIMESTAMP
+from samcli.lib.utils.sam_logging import (
+    SAM_CLI_FORMATTER_WITH_TIMESTAMP,
+    SAM_CLI_LOGGER_NAME,
+    LAMBDA_BULDERS_LOGGER_NAME,
+)
 
 
 class Context:
@@ -52,7 +56,7 @@ def debug(self, value):
 
         if self._debug:
             # Turn on debug logging and display timestamps
-            for logger_name in ["samcli", "aws_lambda_builders"]:
+            for logger_name in [SAM_CLI_LOGGER_NAME, LAMBDA_BULDERS_LOGGER_NAME]:
                 logger = logging.getLogger(logger_name)
                 logger.setLevel(logging.DEBUG)
                 for handler in logger.handlers:

diff --git a/samcli/cli/main.py b/samcli/cli/main.py
@@ -8,7 +8,12 @@
 
 from samcli import __version__
 from samcli.lib.telemetry.metrics import send_installed_metric
-from samcli.lib.utils.sam_logging import SamCliLogger, SAM_CLI_FORMATTER
+from samcli.lib.utils.sam_logging import (
+    SamCliLogger,
+    SAM_CLI_FORMATTER,
+    SAM_CLI_LOGGER_NAME,
+    LAMBDA_BULDERS_LOGGER_NAME,
+)
 from .options import debug_option, region_option, profile_option
 from .context import Context
 from .command import BaseCommand
@@ -94,8 +99,8 @@ def cli(ctx):
         except (IOError, ValueError) as ex:
             LOG.debug("Unable to write telemetry flag", exc_info=ex)
 
-    sam_cli_logger = logging.getLogger("samcli")
-    lambda_builders_logger = logging.getLogger("aws_lambda_builders")
+    sam_cli_logger = logging.getLogger(SAM_CLI_LOGGER_NAME)
+    lambda_builders_logger = logging.getLogger(LAMBDA_BULDERS_LOGGER_NAME)
     botocore_logger = logging.getLogger("botocore")
 
     SamCliLogger.configure_logger(sam_cli_logger, SAM_CLI_FORMATTER, logging.INFO)

diff --git a/samcli/lib/utils/sam_logging.py b/samcli/lib/utils/sam_logging.py
@@ -7,6 +7,9 @@
 SAM_CLI_FORMATTER = logging.Formatter("%(message)s")
 SAM_CLI_FORMATTER_WITH_TIMESTAMP = logging.Formatter("%(asctime)s | %(message)s")
 
+SAM_CLI_LOGGER_NAME = "samcli"
+LAMBDA_BULDERS_LOGGER_NAME = "aws_lambda_builders"
+
 
 class SamCliLogger:
     @staticmethod

diff --git a/tests/unit/cli/test_context.py b/tests/unit/cli/test_context.py
@@ -7,7 +7,12 @@
 from unittest.mock import patch, ANY
 
 from samcli.cli.context import Context
-from samcli.lib.utils.sam_logging import SamCliLogger, SAM_CLI_FORMATTER
+from samcli.lib.utils.sam_logging import (
+    SamCliLogger,
+    SAM_CLI_FORMATTER,
+    SAM_CLI_LOGGER_NAME,
+    LAMBDA_BULDERS_LOGGER_NAME,
+)
 
 
 class TestContext(TestCase):
@@ -21,21 +26,23 @@ def test_must_set_get_debug_flag(self):
 
         ctx.debug = True
         self.assertEqual(ctx.debug, True, "debug must be set to True")
-        self.assertEqual(logging.getLogger("samcli").getEffectiveLevel(), logging.DEBUG)
-        self.assertEqual(logging.getLogger("aws_lambda_builders").getEffectiveLevel(), logging.DEBUG)
+        self.assertEqual(logging.getLogger(SAM_CLI_LOGGER_NAME).getEffectiveLevel(), logging.DEBUG)
+        self.assertEqual(logging.getLogger(LAMBDA_BULDERS_LOGGER_NAME).getEffectiveLevel(), logging.DEBUG)
 
     def test_must_unset_get_debug_flag(self):
         ctx = Context()
 
         message_record = logging.makeLogRecord({"msg": "hello world"})
         timestamp_log_regex = re.compile(r"^[0-9:\- ,]+ \| .*$")
 
-        sam_cli_logger = logging.getLogger("samcli")
-        lambda_builders_logger = logging.getLogger("aws_lambda_builders")
+        sam_cli_logger = logging.getLogger(SAM_CLI_LOGGER_NAME)
+        lambda_builders_logger = logging.getLogger(LAMBDA_BULDERS_LOGGER_NAME)
         SamCliLogger.configure_logger(sam_cli_logger, SAM_CLI_FORMATTER, logging.INFO)
         SamCliLogger.configure_logger(lambda_builders_logger, SAM_CLI_FORMATTER, logging.INFO)
 
-        handlers = logging.getLogger("samcli").handlers + logging.getLogger("aws_lambda_builders").handlers
+        handlers = (
+            logging.getLogger(SAM_CLI_LOGGER_NAME).handlers + logging.getLogger(LAMBDA_BULDERS_LOGGER_NAME).handlers
+        )
         # timestamp should not be output
         for handler in handlers:
             self.assertNotRegex(handler.formatter.format(message_record), timestamp_log_regex)