|
| 1 | +"""aws_lambda_logging tests.""" |
| 2 | + |
| 3 | +import io |
| 4 | +import json |
| 5 | +import random |
| 6 | +import string |
| 7 | +from collections import namedtuple |
| 8 | + |
| 9 | +import pytest |
| 10 | + |
| 11 | +from aws_lambda_powertools import Logger |
| 12 | +from aws_lambda_powertools.logging.buffer import LoggerBufferConfig |
| 13 | + |
| 14 | + |
| 15 | +@pytest.fixture |
| 16 | +def lambda_context(): |
| 17 | + lambda_context = { |
| 18 | + "function_name": "test", |
| 19 | + "memory_limit_in_mb": 128, |
| 20 | + "invoked_function_arn": "arn:aws:lambda:eu-west-1:809313241:function:test", |
| 21 | + "aws_request_id": "52fdfc07-2182-154f-163f-5f0f9a621d72", |
| 22 | + } |
| 23 | + |
| 24 | + return namedtuple("LambdaContext", lambda_context.keys())(*lambda_context.values()) |
| 25 | + |
| 26 | + |
| 27 | +def check_log_dict(log_dict): |
| 28 | + assert "timestamp" in log_dict |
| 29 | + assert "level" in log_dict |
| 30 | + assert "location" in log_dict |
| 31 | + assert "message" in log_dict |
| 32 | + |
| 33 | + |
| 34 | +@pytest.fixture |
| 35 | +def stdout(): |
| 36 | + return io.StringIO() |
| 37 | + |
| 38 | + |
| 39 | +@pytest.fixture |
| 40 | +def service_name(): |
| 41 | + chars = string.ascii_letters + string.digits |
| 42 | + return "".join(random.SystemRandom().choice(chars) for _ in range(15)) |
| 43 | + |
| 44 | + |
| 45 | +def capture_logging_output(stdout): |
| 46 | + return [json.loads(d.strip()) for d in stdout.getvalue().strip().split("\n")] |
| 47 | + |
| 48 | + |
| 49 | +def test_logger_buffer_is_enabled(): |
| 50 | + |
| 51 | + buffer_config = LoggerBufferConfig(max_size=10240) |
| 52 | + logger = Logger(level="INFO", buffer_config=buffer_config) |
| 53 | + |
| 54 | + leo = logger.info("A") |
| 55 | + |
| 56 | + assert leo is True |
| 57 | + |
| 58 | + |
| 59 | +@pytest.mark.parametrize("level", ["DEBUG", "WARNING", "ERROR", "INFO", "CRITICAL"]) |
| 60 | +def test_setup_with_valid_log_levels(stdout, level, service_name): |
| 61 | + logger = Logger(service=service_name, level=level, stream=stdout, request_id="request id!", another="value") |
| 62 | + msg = "This is a test" |
| 63 | + log_command = { |
| 64 | + "INFO": logger.info, |
| 65 | + "ERROR": logger.error, |
| 66 | + "WARNING": logger.warning, |
| 67 | + "DEBUG": logger.debug, |
| 68 | + "CRITICAL": logger.critical, |
| 69 | + } |
| 70 | + |
| 71 | + log_message = log_command[level] |
| 72 | + log_message(msg) |
| 73 | + |
| 74 | + log_dict = json.loads(stdout.getvalue().strip()) |
| 75 | + |
| 76 | + check_log_dict(log_dict) |
| 77 | + |
| 78 | + assert level == log_dict["level"] |
| 79 | + assert "This is a test" == log_dict["message"] |
| 80 | + assert "request id!" == log_dict["request_id"] |
| 81 | + assert "exception" not in log_dict |
| 82 | + |
| 83 | + |
| 84 | +def test_logging_exception_traceback(stdout, service_name): |
| 85 | + logger = Logger(service=service_name, level="DEBUG", stream=stdout) |
| 86 | + |
| 87 | + try: |
| 88 | + raise ValueError("Boom") |
| 89 | + except ValueError: |
| 90 | + logger.exception("A value error occurred") |
| 91 | + |
| 92 | + log_dict = json.loads(stdout.getvalue()) |
| 93 | + |
| 94 | + check_log_dict(log_dict) |
| 95 | + assert "ERROR" == log_dict["level"] |
| 96 | + assert "exception" in log_dict |
0 commit comments