Feature/logging system

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "cSpell.ignoreWords": [
+        "smtpdfix"
+    ]
+}

app/config.py.example

@@ -4,7 +4,7 @@ from fastapi_mail import ConnectionConfig
 
 # flake8: noqa
 
-# general
+# GENERAL
 DOMAIN = 'Our-Domain'
 
 # DATABASE
@@ -18,7 +18,7 @@ AVATAR_SIZE = (120, 120)
 # API-KEYS
 WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
 
-# export
+# EXPORT
 ICAL_VERSION = '2.0'
 PRODUCT_ID = '-//Our product id//'
 
@@ -33,3 +33,17 @@ email_conf = ConnectionConfig(
     MAIL_SSL=False,
     USE_CREDENTIALS=True,
 )
+
+# LOGGER
+LOGGER = {
+    "logger": {
+        "path": "./var/log",
+        "filename": "calendar.log",
+        "level": "error",
+        "rotation": "20 days",
+        "retention": "1 month",
+        "format": ("<level>{level: <8}</level> <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+                   " - <cyan>{name}</cyan>:<cyan>{function}</cyan>"
+                   " - <level>{message}</level>")
+    }
+}

app/internal/logger_customizer.py

@@ -0,0 +1,110 @@
+import json
+import sys
+from typing import Union, Dict
+
+from pathlib import Path
+from loguru import logger, _Logger as Logger
+
+
+class LoggerConfigError(Exception):
+    pass
+
+
+class LoggerCustomizer:
+
+    @classmethod
+    def make_logger(cls, config_file_or_dict: Union[Path, Dict],
+                    logger_name: str) -> Logger:
+        """Creates a loguru logger from given configuration path or dict.
+
+        Args:
+            config_file_or_dict (Union[Path, Dict]): Path to logger
+            configuration file or dictionary of configuration
+            logger_name (str): Logger instance created from configuration
+
+        Raises:
+            LoggerConfigError: Error raised when the configuration is invalid
+
+        Returns:
+            Logger: Loguru logger instance
+        """
+
+        config = cls.load_logging_config(config_file_or_dict)
+        try:
+            logging_config = config.get(logger_name)
+            logs_path = logging_config.get('path')
+            log_file_path = logging_config.get('filename')
+
+            logger = cls.customize_logging(
+                file_path=Path(logs_path) / Path(log_file_path),
+                level=logging_config.get('level'),
+                retention=logging_config.get('retention'),
+                rotation=logging_config.get('rotation'),
+                format=logging_config.get('format')
+            )
+        except (TypeError, ValueError) as err:
+            raise LoggerConfigError(
+                f"You have an issue with the logger configuration: {err!r}, "
+                "fix it please")
+
+        return logger
+
+    @classmethod
+    def customize_logging(cls,
+                          file_path: Path,
+                          level: str,
+                          rotation: str,
+                          retention: str,
+                          format: str
+                          ) -> Logger:
+        """Used to customize the logger instance
+
+        Args:
+            file_path (Path): Path where the log file is located
+            level (str): The level wanted to start logging from
+            rotation (str): Every how long the logs would be
+                rotated(creation of new file)
+            retention (str): Amount of time in words defining how
+                long a log is kept
+            format (str): The logging format
+
+        Returns:
+            Logger: Instance of a logger mechanism
+        """
+        logger.remove()
+        logger.add(
+            sys.stdout,
+            enqueue=True,
+            backtrace=True,
+            level=level.upper(),
+            format=format
+        )
+        logger.add(
+            str(file_path),
+            rotation=rotation,
+            retention=retention,
+            enqueue=True,
+            backtrace=True,
+            level=level.upper(),
+            format=format
+        )
+
+        return logger
+
+    @classmethod
+    def load_logging_config(cls, config: Union[Path, Dict]) -> Dict:
+        """Loads logging configuration from file or dict
+
+        Args:
+            config (Union[Path, Dict]): Path to logging configuration file
+
+        Returns:
+            Dict: Configuration parsed as dictionary
+        """
+        if isinstance(config, Path):
+            with open(config) as config_file:
+                used_config = json.load(config_file)
+        else:
+            used_config = config
+
+        return used_config

app/main.py

@@ -7,12 +7,21 @@
     MEDIA_PATH, STATIC_PATH, templates)
 from app.routers import agenda, event, profile, email, invitation
 
+from app.internal.logger_customizer import LoggerCustomizer
+
+from app import config
+
 models.Base.metadata.create_all(bind=engine)
 
 app = FastAPI()
 app.mount("/static", StaticFiles(directory=STATIC_PATH), name="static")
 app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")
 
+# Configure logger
+logger = LoggerCustomizer.make_logger(config.LOGGER, "logger")
+app.logger = logger
+
+
 app.include_router(profile.router)
 app.include_router(event.router)
 app.include_router(agenda.router)
@@ -21,6 +30,7 @@
 
 
 @app.get("/")
+@app.logger.catch()
 async def home(request: Request):
     return templates.TemplateResponse("home.html", {
         "request": request,

requirements.txt

@@ -21,6 +21,7 @@ idna==2.10
 importlib-metadata==3.3.0
 iniconfig==1.1.1
 Jinja2==2.11.2
+loguru==0.5.3
 MarkupSafe==1.1.1
 packaging==20.8
 Pillow==8.1.0
@@ -49,4 +50,4 @@ uvicorn==0.13.3
 watchgod==0.6
 websockets==8.1
 wsproto==1.0.0
-zipp==3.4.0
+zipp==3.4.0

tests/conftest.py

@@ -10,6 +10,7 @@
     'tests.invitation_fixture',
     'tests.association_fixture',
     'tests.client_fixture',
+    'tests.logger_fixture',
     'smtpdfix',
 ]
 

tests/logger_fixture.py

@@ -0,0 +1,36 @@
+import logging
+
+import pytest
+from _pytest.logging import caplog as _caplog  # noqa: F401
+from loguru import logger
+
+from app import config
+from app.internal.logger_customizer import LoggerCustomizer
+
+
+@pytest.fixture(scope='module')
+def logger_instance():
+    _logger = LoggerCustomizer.make_logger(config.LOGGER, "logger")
+
+    return _logger
+
+
+@pytest.fixture(scope='module')
+def logger_external_configuration():
+    from pathlib import Path
+    config_path = Path(__file__).parent
+    config_path = config_path.absolute() / 'logging_config.json'
+    _logger = LoggerCustomizer.make_logger(config_path, "logger1")
+
+    return _logger
+
+
+@pytest.fixture
+def caplog(_caplog):  # noqa: F811
+    class PropagateHandler(logging.Handler):
+        def emit(self, record):
+            logging.getLogger(record.name).handle(record)
+
+    handler_id = logger.add(PropagateHandler(), format="{message} {extra}")
+    yield _caplog
+    logger.remove(handler_id)

tests/logging_config.json

@@ -0,0 +1,10 @@
+{
+  "logger1": {
+    "path": "./var/log4",
+    "filename": "calendar3.log",
+    "level": "debug",
+    "rotation": "20 days",
+    "retention": "1 month",
+    "format": "<level>{level: <8}</level> <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> - <cyan>{name}</cyan>:<cyan>{function}</cyan> - <level>{message}</level>"
+  }
+}

tests/test_logger.py

@@ -0,0 +1,55 @@
+import logging
+
+import pytest
+
+from app.internal.logger_customizer import LoggerCustomizer, LoggerConfigError
+
+
+class TestLogger:
+    @staticmethod
+    def test_configuration_file(caplog, logger_external_configuration):
+        with caplog.at_level(logging.ERROR):
+            logger_external_configuration.error('Testing configuration ERROR')
+            assert 'Testing configuration' in caplog.text
+
+    @staticmethod
+    def test_log_debug(caplog, logger_instance):
+        with caplog.at_level(logging.DEBUG):
+            logger_instance.debug('Is it debugging now?')
+            assert 'Is it debugging now?' in caplog.text
+
+    @staticmethod
+    def test_log_info(caplog, logger_instance):
+        with caplog.at_level(logging.INFO):
+            logger_instance.info('App started')
+            assert 'App started' in caplog.text
+
+    @staticmethod
+    def test_log_error(caplog, logger_instance):
+        with caplog.at_level(logging.ERROR):
+            logger_instance.error('Something bad happened!')
+            assert 'Something bad happened!' in caplog.text
+
+    @staticmethod
+    def test_log_critical(caplog, logger_instance):
+        with caplog.at_level(logging.CRITICAL):
+            logger_instance.critical("WE'RE DOOMED!")
+            assert "WE'RE DOOMED!" in caplog.text
+
+    @staticmethod
+    def test_bad_configuration():
+        bad_config = {
+            "logger": {
+                "path": "./var/log",
+                "filename": "calendar.log",
+                "level": "eror",
+                "rotation": "20 days",
+                "retention": "1 month",
+                "format": ("<level>{level: <8}</level> "
+                           "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green>"
+                           "- <cyan>{name}</cyan>:<cyan>{function}</cyan>"
+                           " - <level>{message}</level>")
+            }
+        }
+        with pytest.raises(LoggerConfigError):
+            LoggerCustomizer.make_logger(bad_config, 'logger')