Merge remote-tracking branch 'origin/master'

Author: paulcruse3

Pipfile

@@ -15,7 +15,6 @@ dynamodb_json = "*"
 jsonpickle = "*"
 jsonref = "*"
 jsonschema = "*"
-icecream = "*"
 pydantic = "*"
 pyyaml = "*"
 simplejson = "*"

Pipfile.lock

@@ -4,11 +4,15 @@
 
 class DirectoryModeResolver(BaseModeResolver):
 
+    INIT_FILE = '__init__.py'
+
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.__handler_path = self.importer.clean_path(kwargs['handlers'])
 
     def _get_file_and_import_path(self, request_path):
+        # ensure previous lookups don't leave behind path/dynamic state
+        self.reset()
         split_path = self.get_request_path_as_list(request_path)
         route_path = self.__get_route_path(split_path)
         file_path = self.__handler_path + self.importer.file_separator + route_path
@@ -23,8 +27,12 @@ def __get_route_path(self, split_path):
     def __get_import_path_file_tree(self, split_path, split_index, file_tree):
         if split_index < len(split_path):
             part = split_path[split_index]
-            possible_directory = part.replace('-', '_')
-            possible_file = f'{possible_directory}.py'
+            if part == '':
+                possible_directory = None
+                possible_file = self.INIT_FILE
+            else:
+                possible_directory = part.replace('-', '_')
+                possible_file = f'{possible_directory}.py'
             if possible_directory in file_tree:
                 self.__handle_directory_path_part(possible_directory, split_path, split_index, file_tree)
             elif possible_file in file_tree:
@@ -40,7 +48,7 @@ def __handle_directory_path_part(self, possible_directory, split_path, split_ind
             file_leaf = self.determine_which_file_leaf(file_tree, possible_directory)
             self.__get_import_path_file_tree(split_path, split_index+1, file_leaf)
         else:
-            self.append_import_path('__init__.py')
+            self.append_import_path(self.INIT_FILE)
 
     def __handle_file_path_part(self, possible_file, split_path, split_index, file_tree):
         self.append_import_path(possible_file)
@@ -51,7 +59,7 @@ def __handle_dynamic_path_part(self, split_path, split_index, file_tree):
         file_part = list(file_tree['__dynamic_files'])[0]
         self.append_import_path(file_part)
         if '.py' not in file_part and split_index+1 == len(split_path):
-            self.append_import_path('__init__.py')
+            self.append_import_path(self.INIT_FILE)
         file_leaf = self.determine_which_file_leaf(file_tree, file_part)
         self.has_dynamic_route = True
         self.dynamic_parts[split_index] = split_path[split_index]

acai_aws/apigateway/resolver/modes/directory.py

@@ -3,14 +3,14 @@
 import traceback
 
 import jsonpickle
-from icecream import ic
 
 
 class CommonLogger:
 
     def __init__(self):
         self.__json = jsonpickle
-        self.__format = os.getenv('LOG_FORMAT', 'JSON')
+        env_format = os.getenv('LOG_FORMAT', 'JSON') or 'JSON'
+        self.__format = env_format.strip().upper()
         self.__log_level = os.getenv('LOG_LEVEL', 'INFO')
         self.__json.set_encoder_options('simplejson', use_decimal=True)
         self.__json.set_preferred_backend('simplejson')
@@ -44,13 +44,17 @@ def __log_json(self, **kwargs):
         print(self.__json.encode({
             'level': kwargs['level'],
             'time': datetime.datetime.now(datetime.timezone.utc).isoformat(),
-            'error_trace': [trace.strip() for trace in self.__get_traceback().split('\n') if trace],
+            'trace': [trace.strip() for trace in self.__get_traceback().split('\n') if trace],
             'log': kwargs['log']
         }, indent=4))
 
     def __log_inline(self, **kwargs):
-        trace = self.__get_traceback()
-        prefix = f"{trace}{kwargs['level']}|"
-        log = kwargs['log']
-        ic.configureOutput(prefix=prefix, outputFunction=print)
-        ic(log)
+        timestamp = datetime.datetime.now(datetime.timezone.utc).isoformat()
+        trace = self.__get_traceback().strip().replace('\n', ' | ')
+        log_value = kwargs['log']
+        if not isinstance(log_value, str):
+            log_value = str(log_value)
+        inline_message = f"{kwargs['level']}|time={timestamp} log={log_value}"
+        if trace:
+            inline_message = f"{inline_message} trace={trace}"
+        print(inline_message)

acai_aws/common/logger/common_logger.py

@@ -60,6 +60,25 @@ def test_default_init_get_file_and_import_path(self):
         self.assertTrue('tests/mocks/apigateway/resolver/directory_handlers/home/__init__.py' in file_path)
         self.assertEqual('tests.mocks.apigateway.resolver.directory_handlers.home.__init__', import_path)
 
+    def test_base_path_get_file_and_import_path(self):
+        base_path_request = mock_request.get_basic()
+        base_path_request['path'] = self.base_path
+        request = Request(base_path_request)
+        file_path, import_path = self.directory_resolver._get_file_and_import_path(request.path)
+        self.assertTrue('tests/mocks/apigateway/resolver/directory_handlers/__init__.py' in file_path)
+        self.assertEqual('tests.mocks.apigateway.resolver.directory_handlers.__init__', import_path)
+
+    def test_base_path_raises_without_init_file(self):
+        handler_path = 'tests/mocks/apigateway/resolver/directory_handlers_no_root_init'
+        base_path_request = mock_request.get_basic()
+        base_path_request['path'] = self.base_path
+        request = Request(base_path_request)
+        directory_resolver = DirectoryModeResolver(base_path=self.base_path, handlers=handler_path)
+        with self.assertRaises(ApiException) as resolver_error:
+            directory_resolver._get_file_and_import_path(request.path)
+        self.assertEqual(resolver_error.exception.code, 404)
+        self.assertEqual(resolver_error.exception.message, 'route not found')
+
     def test_dynamic_get_file_and_import_path(self):
         request = Request(self.dynamic_request)
         file_path, import_path = self.directory_resolver._get_file_and_import_path(request.path)
@@ -103,3 +122,9 @@ def test_triple_nested_dynamic_get_file_and_import_path(self):
         self.assertTrue('tests/mocks/apigateway/resolver/directory_handlers/user/_user_id/item/_item_id.py' in file_path)
         self.assertEqual('tests.mocks.apigateway.resolver.directory_handlers.user._user_id.item._item_id', import_path)
 
+    def test_repeated_directory_request_resets_import_path(self):
+        request = Request(self.init_request)
+        first_file_path, first_import_path = self.directory_resolver._get_file_and_import_path(request.path)
+        second_file_path, second_import_path = self.directory_resolver._get_file_and_import_path(request.path)
+        self.assertEqual(first_file_path, second_file_path)
+        self.assertEqual(first_import_path, second_import_path)

tests/acai_aws/apigateway/resolver/modes/test_directory.py

@@ -1,4 +1,7 @@
+import io
+import json
 import os
+from contextlib import redirect_stdout
 from unittest import TestCase, mock
 
 from acai_aws.common import logger
@@ -54,6 +57,29 @@ def test_logger_logs_error_inline(self):
         except Exception as error:
             logger.log(level='ERROR', log=error)
 
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': ' inline '})
+    def test_logger_logs_error_inline_with_messy_env(self):
+        logger.log(level='INFO', log={'message': 'inline-format'})
+
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': 'JSON'})
+    def test_logger_json_output(self):
+        buffer = io.StringIO()
+        with redirect_stdout(buffer):
+            logger.log(level='WARN', log={'json': True})
+        log_output = buffer.getvalue().strip()
+        parsed = json.loads(log_output)
+        self.assertEqual('WARN', parsed['level'])
+        self.assertEqual({'json': True}, parsed['log'])
+
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': 'INLINE'})
+    def test_logger_inline_output(self):
+        buffer = io.StringIO()
+        with redirect_stdout(buffer):
+            logger.log(level='INFO', log={'inline': True})
+        log_output = buffer.getvalue().strip()
+        self.assertTrue(log_output.startswith('INFO|'))
+        self.assertIn("inline': True", log_output)
+
     @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local'})
     def test_logger_logs_error_as_object(self):
         try:
@@ -96,4 +122,3 @@ def test_logger_handles_bad_level(self):
     @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_LEVEL': 'ERROR', 'LOG_FORMAT': 'BAD'})
     def test_logger_handles_bad_format(self):
         logger.log(level='INFO', log={'INFO': 'ignore'})
-

tests/acai_aws/common/test_logger.py

@@ -0,0 +1,3 @@
+def post(request, response):
+    response.body = {'directory_basic': True}
+    return response