Ensure Actions are validated before app startup

Author: grahamalama

jbi/configuration.py

@@ -2,7 +2,6 @@
 Parsing and validating the YAML configuration occurs within this module
 """
 import logging
-from functools import lru_cache
 
 from pydantic import ValidationError
 from pydantic_yaml import parse_yaml_raw_as
@@ -18,12 +17,6 @@ class ConfigError(Exception):
     """Error when an exception occurs during processing config"""
 
 
-@lru_cache
-def get_actions() -> Actions:
-    """Load actions from file determined by ENV name"""
-    return get_actions_from_file(f"config/config.{settings.env}.yaml")
-
-
 def get_actions_from_file(jbi_config_file: str) -> Actions:
     """Convert and validate YAML configuration to `Action` objects"""
     try:
@@ -34,3 +27,10 @@ def get_actions_from_file(jbi_config_file: str) -> Actions:
     except ValidationError as exception:
         logger.exception(exception)
         raise ConfigError("Errors exist.") from exception
+
+
+def get_actions(env=settings.env):
+    return get_actions_from_file(f"config/config.{env}.yaml")
+
+
+ACTIONS = get_actions()

jbi/router.py

@@ -9,14 +9,14 @@
 from fastapi.responses import HTMLResponse
 from fastapi.templating import Jinja2Templates
 
-from jbi.configuration import get_actions
+from jbi.configuration import ACTIONS
 from jbi.environment import Settings, get_settings, get_version
 from jbi.models import Actions, BugzillaWebhookRequest
 from jbi.runner import IgnoreInvalidRequestError, execute_action
 from jbi.services import bugzilla, jira
 
 SettingsDep = Annotated[Settings, Depends(get_settings)]
-ActionsDep = Annotated[Actions, Depends(get_actions)]
+ActionsDep = Annotated[Actions, Depends(lambda: ACTIONS)]
 VersionDep = Annotated[dict, Depends(get_version)]
 BugzillaServiceDep = Annotated[bugzilla.BugzillaService, Depends(bugzilla.get_service)]
 JiraServiceDep = Annotated[jira.JiraService, Depends(jira.get_service)]

tests/conftest.py

@@ -83,8 +83,7 @@ def settings():
 
 @pytest.fixture(autouse=True)
 def actions():
-    get_actions.cache_clear()
-    return get_actions()
+    return get_actions
 
 
 @pytest.fixture(autouse=True)

tests/unit/test_configuration.py

@@ -1,8 +1,6 @@
-from unittest import mock
-
 import pytest
 
-from jbi import configuration, environment
+from jbi import configuration
 
 
 def test_mock_jbi_files():
@@ -22,8 +20,10 @@ def test_actual_jbi_files():
     )
 
 
-def test_filename_uses_env():
-    configuration.get_actions.cache_clear()
-    with mock.patch("jbi.configuration.get_actions_from_file") as mocked:
-        configuration.get_actions()
-    mocked.assert_called_with("config/config.local.yaml")
+def test_filename_uses_env(mocker, actions, settings):
+    get_actions_from_file_spy = mocker.spy(configuration, "get_actions_from_file")
+    assert settings.env == "local"
+
+    configuration.get_actions()
+
+    get_actions_from_file_spy.assert_called_with("config/config.local.yaml")