Add logging filename, level and format

csp_billing_adapter_local/plugin.py

@@ -28,11 +28,13 @@
 
 from csp_billing_adapter.config import Config
 
-log = logging.getLogger('CSPBillingAdapter')
-
 ADAPTER_DATA_DIR = '/var/lib/csp-billing-adapter'
 CACHE_FILE = 'cache.json'
 CSP_CONFIG_FILE = 'csp-config.json'
+CSP_LOG_FILEPATH = '/var/log/csp_billing_adapter.log'
+LOGGER_NAME = 'CSPBillingAdapter'
+
+log = logging.getLogger(LOGGER_NAME)
 
 
 def get_local_path(filename):
@@ -44,6 +46,13 @@ def get_local_path(filename):
     return local_storage_path
 
 
+@csp_billing_adapter.hookimpl
+def setup_adapter(config: Config):
+    log_to_file = logging.FileHandler(CSP_LOG_FILEPATH)
+    log.addHandler(log_to_file)
+    log.info(f'Logger file handler set to {CSP_LOG_FILEPATH}')
+
+
 @csp_billing_adapter.hookimpl(trylast=True)
 def save_cache(config: Config, cache: dict):
     """Save specified content as new local cache contents."""

tests/data/config.yaml

@@ -26,4 +26,6 @@ usage_metrics:
       min: 1001
     min_consumption: 5
     usage_aggregation: average
-version: 1.1.1
+logging:
+  level: WARN
+version: 1.1.1

tests/unit/test_plugin.py

@@ -22,6 +22,8 @@
 test_plugin.py is part of csp-billing-adapter-local and provides units tests
 for the local plugin functions.
 """
+import logging
+
 from pathlib import Path
 from tempfile import NamedTemporaryFile
 from unittest.mock import patch
@@ -36,7 +38,8 @@
     update_cache,
     update_csp_config,
     save_cache,
-    save_csp_config
+    save_csp_config,
+    setup_adapter
 )
 
 config_file = 'tests/data/config.yaml'
@@ -295,3 +298,25 @@ def test_local_csp_config_save():
             )
 
             assert get_csp_config(config=local_config) == test_data2
+
+
+@patch('csp_billing_adapter_local.plugin.logging.Logger.info')
+@patch('csp_billing_adapter_local.plugin.logging.Logger.addHandler')
+@patch('csp_billing_adapter_local.plugin.logging.FileHandler')
+def test_local_csp_setup_adapter_log_with_config_settings(
+    mock_logging_file_handler, mock_logger_add_handler,
+    mock_logging_info
+):
+    file_handler = logging.FileHandler('foo')
+    log = logging.getLogger('CSPBillingAdapter')
+    mock_logging_file_handler.return_value = file_handler
+
+    setup_adapter(config=local_config)
+
+    log.addHandler.assert_called_with(file_handler)
+    mock_logging_file_handler.assert_called_with(
+        '/var/log/csp_billing_adapter.log'
+    )
+    mock_logging_info.assert_called_with(
+        'Logger file handler set to /var/log/csp_billing_adapter.log'
+    )