Approperiate formatting

Author: Veinar

dracan/core/app_factory.py

@@ -11,7 +11,11 @@
 from ..validators.headers_validator import create_header_validator
 from ..middleware.payload_limiter import create_payload_size_limiter
 from ..utils.metrics import start_metrics_server, register_metrics
-from ..utils.config_load import load_proxy_config, load_rules_config, check_required_files
+from ..utils.config_load import (
+    load_proxy_config,
+    load_rules_config,
+    check_required_files,
+)
 
 
 def create_app():

dracan/core/proxy.py

@@ -7,6 +7,7 @@
 # Set a default timeout in seconds if PROXY_TIMEOUT is not specified in the environment
 PROXY_TIMEOUT = int(os.getenv("PROXY_TIMEOUT", 180))
 
+
 def forward_request(request, config, sub=None):
     """
     Forward the incoming request to the destination service.

dracan/utils/config_load.py

@@ -2,6 +2,7 @@
 import json
 import sys
 
+
 def get_config_file_path(filename):
     """
     Determine the configuration file path, using CONFIG_LOCATION if set,
@@ -10,6 +11,7 @@ def get_config_file_path(filename):
     config_location = os.getenv("CONFIG_LOCATION", "")
     return os.path.join(config_location, filename) if config_location else filename
 
+
 def check_required_files(required_files):
     """
     Check for the presence of required configuration files and exit if any are missing.
@@ -21,6 +23,7 @@ def check_required_files(required_files):
             print("Visit https://github.com/Veinar/dracan for more information.")
             sys.exit(1)
 
+
 def load_proxy_config():
     """
     Load the destination service configuration from a JSON file.
@@ -39,7 +42,9 @@ def load_proxy_config():
     destination_config = config["destination"]
     if not required_keys.issubset(destination_config.keys()):
         missing_keys = required_keys - destination_config.keys()
-        raise KeyError(f"Missing required fields in 'destination': {', '.join(missing_keys)}")
+        raise KeyError(
+            f"Missing required fields in 'destination': {', '.join(missing_keys)}"
+        )
 
     # Ensure no extra fields are present
     extra_keys = set(destination_config.keys()) - required_keys
@@ -48,6 +53,7 @@ def load_proxy_config():
 
     return config
 
+
 def load_rules_config():
     """
     Load the filtering, limiting, and validation rules from a JSON file.

tests/test_config_load.py

@@ -1,6 +1,11 @@
 import json
 import pytest
-from dracan.utils.config_load import load_proxy_config, load_rules_config, check_required_files
+from dracan.utils.config_load import (
+    load_proxy_config,
+    load_rules_config,
+    check_required_files,
+)
+
 
 @pytest.fixture
 def setup_default_config(tmp_path):
@@ -10,11 +15,16 @@ def setup_default_config(tmp_path):
     # Create default config files in the temporary directory
     proxy_config = tmp_path / "proxy_config.json"
     rules_config = tmp_path / "rules_config.json"
-    proxy_config.write_text('{"destination": {"host": "127.0.0.1", "port": 8080, "path": "/"}}')
-    rules_config.write_text('{"allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"}')
+    proxy_config.write_text(
+        '{"destination": {"host": "127.0.0.1", "port": 8080, "path": "/"}}'
+    )
+    rules_config.write_text(
+        '{"allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"}'
+    )
 
     return tmp_path
 
+
 @pytest.fixture
 def setup_custom_config(tmp_path):
     """
@@ -25,23 +35,31 @@ def setup_custom_config(tmp_path):
     custom_config_dir.mkdir()
     proxy_config = custom_config_dir / "proxy_config.json"
     rules_config = custom_config_dir / "rules_config.json"
-    proxy_config.write_text('{"destination": {"host": "127.0.0.1", "port": 8080, "path": "/"}}')
-    rules_config.write_text('{"allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"}')
+    proxy_config.write_text(
+        '{"destination": {"host": "127.0.0.1", "port": 8080, "path": "/"}}'
+    )
+    rules_config.write_text(
+        '{"allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"}'
+    )
 
     return custom_config_dir
 
+
 def test_load_default_config(setup_default_config, monkeypatch):
     """
     Test loading configuration from the default location.
     """
-    monkeypatch.chdir(setup_default_config)  # Change to temporary directory with default config files
+    monkeypatch.chdir(
+        setup_default_config
+    )  # Change to temporary directory with default config files
 
     proxy_config = load_proxy_config()
     rules_config = load_rules_config()
 
     assert proxy_config["destination"]["host"] == "127.0.0.1"
     assert rules_config["allowed_methods"] == ["GET", "POST"]
 
+
 def test_load_custom_config_location(setup_custom_config, monkeypatch):
     """
     Test loading configuration from a custom location specified by CONFIG_LOCATION.
@@ -54,6 +72,7 @@ def test_load_custom_config_location(setup_custom_config, monkeypatch):
     assert proxy_config["destination"]["host"] == "127.0.0.1"
     assert rules_config["allowed_methods"] == ["GET", "POST"]
 
+
 def test_missing_config_in_custom_location(tmp_path, monkeypatch):
     """
     Test behavior when config files are missing from the custom CONFIG_LOCATION.
@@ -68,6 +87,7 @@ def test_missing_config_in_custom_location(tmp_path, monkeypatch):
     with pytest.raises(FileNotFoundError, match="rules_config.json"):
         load_rules_config()
 
+
 def test_missing_config_location_var(setup_default_config, monkeypatch):
     """
     Test that config loads from the default location when CONFIG_LOCATION is not set.
@@ -80,6 +100,7 @@ def test_missing_config_location_var(setup_default_config, monkeypatch):
     assert proxy_config["destination"]["host"] == "127.0.0.1"
     assert rules_config["rate_limit"] == "10 per minute"
 
+
 @pytest.fixture
 def setup_invalid_json_config(tmp_path):
     """
@@ -88,11 +109,16 @@ def setup_invalid_json_config(tmp_path):
     # Create files with invalid JSON in the temporary directory
     proxy_config = tmp_path / "proxy_config.json"
     rules_config = tmp_path / "rules_config.json"
-    proxy_config.write_text('{ "destination": { "host": "127.0.0.1", "port": 8080, "path": "/"')  # Malformed JSON
-    rules_config.write_text('{ "allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"')  # Malformed JSON
+    proxy_config.write_text(
+        '{ "destination": { "host": "127.0.0.1", "port": 8080, "path": "/"'
+    )  # Malformed JSON
+    rules_config.write_text(
+        '{ "allowed_methods": ["GET", "POST"], "rate_limit": "10 per minute"'
+    )  # Malformed JSON
 
     return tmp_path
 
+
 @pytest.fixture
 def setup_missing_fields_config(tmp_path):
     """
@@ -101,34 +127,43 @@ def setup_missing_fields_config(tmp_path):
     # Create files missing required fields in the temporary directory
     proxy_config = tmp_path / "proxy_config.json"
     rules_config = tmp_path / "rules_config.json"
-    proxy_config.write_text('{}')  # Missing "destination" key
-    rules_config.write_text('{}')  # Make it same...
+    proxy_config.write_text("{}")  # Missing "destination" key
+    rules_config.write_text("{}")  # Make it same...
     return tmp_path
 
+
 @pytest.fixture
 def setup_nonexistent_config_location(tmp_path):
     """
     Fixture for a nonexistent configuration directory to simulate invalid path.
     """
     return tmp_path / "nonexistent_config_dir"  # This directory does not exist
 
+
 def test_invalid_json_in_config_files(setup_invalid_json_config, monkeypatch):
     """
     Test loading configuration with invalid JSON syntax.
     """
-    monkeypatch.chdir(setup_invalid_json_config)  # Change to directory with invalid JSON files
+    monkeypatch.chdir(
+        setup_invalid_json_config
+    )  # Change to directory with invalid JSON files
 
     with pytest.raises(json.JSONDecodeError):
         load_proxy_config()
 
     with pytest.raises(json.JSONDecodeError):
         load_rules_config()
 
-def test_missing_required_fields_in_config_files(setup_missing_fields_config, monkeypatch):
+
+def test_missing_required_fields_in_config_files(
+    setup_missing_fields_config, monkeypatch
+):
     """
     Test loading configuration files that are missing required fields.
     """
-    monkeypatch.chdir(setup_missing_fields_config)  # Change to directory with missing fields
+    monkeypatch.chdir(
+        setup_missing_fields_config
+    )  # Change to directory with missing fields
 
     with pytest.raises(KeyError, match="destination"):
         load_proxy_config()
@@ -157,7 +192,7 @@ def test_check_required_files_all_present(tmp_path, monkeypatch, capsys):
 
     # Mock the CONFIG_LOCATION environment variable to use tmp_path
     monkeypatch.setenv("CONFIG_LOCATION", str(tmp_path))
-    
+
     # Call the function and capture output
     check_required_files(["proxy_config.json", "rules_config.json"])
 
@@ -182,7 +217,10 @@ def test_check_required_files_missing_one_file(tmp_path, monkeypatch, capsys):
 
     # Capture and check the output for the missing file message
     captured = capsys.readouterr()
-    assert "Error: Required configuration file 'rules_config.json' is missing." in captured.out
+    assert (
+        "Error: Required configuration file 'rules_config.json' is missing."
+        in captured.out
+    )
     assert exit_exception.value.code == 1
 
 
@@ -199,7 +237,10 @@ def test_check_required_files_missing_both_files(tmp_path, monkeypatch, capsys):
 
     # Capture and check the output for the missing files message
     captured = capsys.readouterr()
-    assert "Error: Required configuration file 'proxy_config.json' is missing." in captured.out # It is displayed first
+    assert (
+        "Error: Required configuration file 'proxy_config.json' is missing."
+        in captured.out
+    )  # It is displayed first
     assert exit_exception.value.code == 1
 
 
@@ -210,16 +251,21 @@ def setup_extra_fields_config(tmp_path):
     """
     proxy_config = tmp_path / "proxy_config.json"
     # Adding an unexpected field 'extra_field' to the 'destination' section
-    proxy_config.write_text(json.dumps({
-        "destination": {
-            "host": "127.0.0.1",
-            "port": 8080,
-            "path": "/",
-            "extra_field": "unexpected_value"  # Unexpected field
-        }
-    }))
+    proxy_config.write_text(
+        json.dumps(
+            {
+                "destination": {
+                    "host": "127.0.0.1",
+                    "port": 8080,
+                    "path": "/",
+                    "extra_field": "unexpected_value",  # Unexpected field
+                }
+            }
+        )
+    )
     return tmp_path
 
+
 def test_load_proxy_config_with_extra_fields(setup_extra_fields_config, monkeypatch):
     """
     Test loading a proxy configuration with unexpected fields in 'destination'.
@@ -228,5 +274,7 @@ def test_load_proxy_config_with_extra_fields(setup_extra_fields_config, monkeypa
     monkeypatch.setenv("CONFIG_LOCATION", str(setup_extra_fields_config))
 
     # Expect KeyError due to the unexpected 'extra_field' in the configuration
-    with pytest.raises(KeyError, match="Unexpected fields in 'destination': extra_field"):
-        load_proxy_config()
+    with pytest.raises(
+        KeyError, match="Unexpected fields in 'destination': extra_field"
+    ):
+        load_proxy_config()