Do not require settings environment vars to just run linting

Author: leplatrem

jbi/app.py

@@ -23,14 +23,15 @@
 
 import jbi
 import jbi.queue
-from jbi.configuration import ACTIONS
+from jbi.configuration import get_actions
 from jbi.environment import get_settings
 from jbi.log import CONFIG
 from jbi.router import router
 
 SRC_DIR = Path(__file__).parent
 APP_DIR = Path(__file__).parents[1]
 
+ACTIONS = get_actions()
 settings = get_settings()
 version_info: dict[str, str] = get_version(APP_DIR)
 VERSION: str = version_info["version"]
@@ -60,8 +61,8 @@ def traces_sampler(sampling_context: dict[str, Any]) -> float:
 # https://github.com/tiangolo/fastapi/discussions/9241
 @asynccontextmanager
 async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
-    jira_service = jbi.jira.get_service()
-    bugzilla_service = jbi.bugzilla.get_service()
+    jira_service = jbi.jira.service.get_service()
+    bugzilla_service = jbi.bugzilla.service.get_service()
     queue = jbi.queue.get_dl_queue()
 
     checks.register(bugzilla_service.check_bugzilla_connection, name="bugzilla.up")

jbi/bugzilla/__init__.py

@@ -1,7 +0,0 @@
-from .models import (
-    Bug,
-    BugId,
-    WebhookEvent,
-    WebhookRequest,
-)
-from .service import BugzillaService, get_service

jbi/configuration.py

@@ -10,7 +10,6 @@
 from jbi import environment
 from jbi.models import Actions
 
-settings = environment.get_settings()
 logger = logging.getLogger(__name__)
 
 
@@ -30,9 +29,9 @@ def get_actions_from_file(jbi_config_file: str) -> Actions:
         raise ConfigError("Errors exist.") from exception
 
 
-def get_actions(env=settings.env):
+def get_actions(env=None) -> Actions:
     """Load actions from file determined by ENV name"""
+    if env is None:
+        settings = environment.get_settings()
+        env = settings.env
     return get_actions_from_file(f"config/config.{env}.yaml")
-
-
-ACTIONS = get_actions()

jbi/jira/service.py

@@ -14,7 +14,8 @@
 from dockerflow import checks
 from requests import exceptions as requests_exceptions
 
-from jbi import Operation, bugzilla, environment
+from jbi import Operation, environment
+from jbi.bugzilla import models as bugzilla_models
 from jbi.jira.utils import markdown_to_jira
 from jbi.models import ActionContext
 
@@ -184,7 +185,7 @@ def add_jira_comments_for_changes(self, context: ActionContext):
         return jira_response_comments
 
     def delete_jira_issue_if_duplicate(
-        self, context: ActionContext, latest_bug: bugzilla.Bug
+        self, context: ActionContext, latest_bug: bugzilla_models.Bug
     ):
         """Rollback the Jira issue creation if there is already a linked Jira issue
         on the Bugzilla ticket"""

jbi/models.py

@@ -18,7 +18,7 @@
 )
 
 from jbi import Operation, steps
-from jbi.bugzilla import Bug, BugId, WebhookEvent
+from jbi.bugzilla.models import Bug, BugId, WebhookEvent
 
 logger = logging.getLogger(__name__)
 
@@ -51,7 +51,6 @@ class ActionSteps(BaseModel, frozen=True):
     @classmethod
     def validate_steps(cls, function_names: list[str]):
         """Validate that all configure step functions exist in the steps module"""
-
         invalid_functions = [
             func_name for func_name in function_names if not hasattr(steps, func_name)
         ]

jbi/queue.py

@@ -37,7 +37,7 @@
 import dockerflow.checks
 from pydantic import BaseModel, FileUrl, ValidationError, computed_field
 
-from jbi import bugzilla
+from jbi.bugzilla import models as bugzilla_models
 from jbi.environment import get_settings
 
 logger = logging.getLogger(__name__)
@@ -85,7 +85,7 @@ def from_exc(cls, exc: Exception):
 class QueueItem(BaseModel, frozen=True):
     """Dead Letter Queue entry."""
 
-    payload: bugzilla.WebhookRequest
+    payload: bugzilla_models.WebhookRequest
     error: Optional[PythonException] = None
     rid: Optional[str] = None
 
@@ -316,15 +316,15 @@ async def check_readable(self) -> list[dockerflow.checks.CheckMessage]:
             )
         return results
 
-    async def postpone(self, payload: bugzilla.WebhookRequest, rid: str) -> None:
+    async def postpone(self, payload: bugzilla_models.WebhookRequest, rid: str) -> None:
         """
         Postpone the specified request for later.
         """
         item = QueueItem(payload=payload, rid=rid)
         await self.backend.put(item)
 
     async def track_failed(
-        self, payload: bugzilla.WebhookRequest, exc: Exception, rid: str
+        self, payload: bugzilla_models.WebhookRequest, exc: Exception, rid: str
     ) -> QueueItem:
         """
         Store the specified payload and exception information into the queue.
@@ -337,7 +337,7 @@ async def track_failed(
         await self.backend.put(item)
         return item
 
-    async def is_blocked(self, payload: bugzilla.WebhookRequest) -> bool:
+    async def is_blocked(self, payload: bugzilla_models.WebhookRequest) -> bool:
         """
         Return `True` if the specified `payload` is blocked and should be
         queued instead of being processed.

jbi/retry.py

@@ -8,7 +8,7 @@
 from dockerflow.logging import JsonLogFormatter, request_id_context
 
 import jbi.runner as runner
-from jbi.configuration import ACTIONS
+from jbi.configuration import get_actions
 from jbi.errors import IgnoreInvalidRequestError
 from jbi.queue import get_dl_queue
 
@@ -22,6 +22,8 @@
 lsh.setFormatter(JsonLogFormatter(logger_name=__name__))
 logger.addHandler(lsh)
 
+ACTIONS = get_actions()
+
 
 async def retry_failed(item_executor=runner.execute_action, queue=get_dl_queue()):
     min_event_timestamp = datetime.now(UTC) - timedelta(days=int(RETRY_TIMEOUT_DAYS))

jbi/router.py

@@ -12,16 +12,20 @@
 from fastapi.security import APIKeyHeader, HTTPBasic, HTTPBasicCredentials
 from fastapi.templating import Jinja2Templates
 
-from jbi import bugzilla, jira
-from jbi.configuration import ACTIONS
+from jbi import jira
+from jbi.bugzilla import models as bugzilla_models
+from jbi.bugzilla import service as bugzilla_service
+from jbi.configuration import get_actions
 from jbi.environment import Settings, get_settings
 from jbi.models import Actions
 from jbi.queue import DeadLetterQueue, get_dl_queue
 from jbi.runner import execute_or_queue
 
 SettingsDep = Annotated[Settings, Depends(get_settings)]
-ActionsDep = Annotated[Actions, Depends(lambda: ACTIONS)]
-BugzillaServiceDep = Annotated[bugzilla.BugzillaService, Depends(bugzilla.get_service)]
+ActionsDep = Annotated[Actions, Depends(get_actions)]
+BugzillaServiceDep = Annotated[
+    bugzilla_service.BugzillaService, Depends(bugzilla_service.get_service)
+]
 JiraServiceDep = Annotated[jira.JiraService, Depends(jira.get_service)]
 
 router = APIRouter()
@@ -69,7 +73,7 @@ async def bugzilla_webhook(
     request: Request,
     actions: ActionsDep,
     queue: Annotated[DeadLetterQueue, Depends(get_dl_queue)],
-    webhook_request: bugzilla.WebhookRequest = Body(..., embed=False),
+    webhook_request: bugzilla_models.WebhookRequest = Body(..., embed=False),
 ):
     """API endpoint that Bugzilla Webhook Events request"""
     return await execute_or_queue(webhook_request, queue, actions)

jbi/runner.py

@@ -11,9 +11,11 @@
 from dockerflow.logging import request_id_context
 from statsd.defaults.env import statsd
 
-from jbi import ActionResult, Operation, bugzilla, jira
+from jbi import ActionResult, Operation, jira
 from jbi import steps as steps_module
+from jbi.bugzilla import models as bugzilla_models
 from jbi.bugzilla.client import BugNotAccessibleError
+from jbi.bugzilla.service import get_service as get_bugzilla_service
 from jbi.environment import get_settings
 from jbi.errors import ActionNotFoundError, IgnoreInvalidRequestError
 from jbi.models import (
@@ -56,7 +58,7 @@ def groups2operation(steps: ActionSteps):
     return by_operation
 
 
-def lookup_action(bug: bugzilla.Bug, actions: Actions) -> Action:
+def lookup_action(bug: bugzilla_models.Bug, actions: Actions) -> Action:
     """
     Find first matching action from bug's whiteboard field.
 
@@ -82,7 +84,7 @@ def __init__(
     ):
         self.parameters = parameters
         if not bugzilla_service:
-            self.bugzilla_service = bugzilla.get_service()
+            self.bugzilla_service = get_bugzilla_service()
         if not jira_service:
             self.jira_service = jira.get_service()
         self.steps = self._initialize_steps(parameters.steps)
@@ -162,7 +164,7 @@ def __call__(self, context: ActionContext) -> ActionResult:
 
 
 async def execute_or_queue(
-    request: bugzilla.WebhookRequest, queue: DeadLetterQueue, actions: Actions
+    request: bugzilla_models.WebhookRequest, queue: DeadLetterQueue, actions: Actions
 ):
     request_id = request_id_context.get()
 
@@ -198,7 +200,7 @@ async def execute_or_queue(
 
 @statsd.timer("jbi.action.execution.timer")
 def execute_action(
-    request: bugzilla.WebhookRequest,
+    request: bugzilla_models.WebhookRequest,
     actions: Actions,
 ):
     """Execute the configured action for the specified `request`.
@@ -230,7 +232,7 @@ def execute_action(
             extra=runner_context.model_dump(),
         )
         try:
-            bug = bugzilla.get_service().refresh_bug_data(bug)
+            bug = get_bugzilla_service().refresh_bug_data(bug)
         except BugNotAccessibleError as err:
             # This can happen if the bug is made private after the webhook
             # is processed (eg. if it spent some time in the DL queue)

jbi/steps.py

@@ -4,7 +4,7 @@
 Each step takes an `ActionContext` and a list of arbitrary parameters.
 """
 
-# This import is needed (as of Pyhon 3.11) to enable type checking with modules
+# This import is needed (as of Python 3.11) to enable type checking with modules
 # imported under `TYPE_CHECKING`
 # https://docs.python.org/3/whatsnew/3.7.html#pep-563-postponed-evaluation-of-annotations
 # https://docs.python.org/3/whatsnew/3.11.html#pep-563-may-not-be-the-future
@@ -19,8 +19,6 @@
 from jbi import Operation
 from jbi.environment import get_settings
 
-settings = get_settings()
-
 
 class StepStatus(Enum):
     """
@@ -99,6 +97,7 @@ def add_link_to_jira(
     context: ActionContext, *, bugzilla_service: BugzillaService
 ) -> StepResult:
     """Add the URL to the Jira issue in the `see_also` field on the Bugzilla ticket"""
+    settings = get_settings()
     jira_url = f"{settings.jira_base_url}browse/{context.jira.issue}"
     logger.info(
         "Link %r on Bug %s",

tests/conftest.py

@@ -127,11 +127,11 @@ def dl_queue(tmp_path):
 def mocked_bugzilla(request):
     if "no_mocked_bugzilla" in request.keywords:
         yield None
-        bugzilla.get_service.cache_clear()
+        bugzilla.service.get_service.cache_clear()
     else:
         with mock.patch("jbi.bugzilla.service.BugzillaClient") as mocked_bz:
             yield mocked_bz()
-            bugzilla.get_service.cache_clear()
+            bugzilla.service.get_service.cache_clear()
 
 
 @pytest.fixture(autouse=True)