Updating based on reviews. Yamllint update. Config split: dev, prod. JBI powered_by_jbi api updated.

Author: Bryan Sieber

.pre-commit-config.yaml

@@ -62,3 +62,11 @@ repos:
         entry: poetry run black
         types: [python]
         language: system
+  - repo: local
+    hooks:
+      - id: yamllint
+        name: yamllint
+        entry: poetry run yamllint
+        args: ["-c", ".yamllint", 'config/']
+        types: [file, yaml]
+        language: system

.yamllint

@@ -2,10 +2,20 @@
 
 extends: default
 
+ignore: |
+  src/
+  tests/
+  infra/
+  .github/
+  docker-compose.yaml
+  .pre-commit-config.yaml
+
+
 rules:
   key-duplicates: enable
   key-ordering: enable
 
+
 yaml-files:
-  - 'config.yaml'
+  - 'config/*.yaml'
   - '.yamllint'

config/config.dev.yaml

@@ -0,0 +1,10 @@
+---
+
+# Action Config
+actions:
+  devtest:
+    contact: tbd
+    description: DevTest whiteboard tag
+    parameters:
+      jira_project_key: OSS
+      whiteboard_tag: devtest

config.yaml renamed to config/config.prod.yaml

@@ -3,82 +3,82 @@
 # Action Config
 actions:
   addons:
-    action: src.jbi.whiteboard_actions.default
+    #  action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Addons whiteboard tag for AMO Team
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: WEBEXT
       whiteboard_tag: addons
   fidedi:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Firefox Desktop Integration whiteboard tag
     enabled: true
     parameters:
       jira_project_key: FIDEDI
       whiteboard_tag: fidedi
   fidefe:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Firefox Front End whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: FIDEFE
       whiteboard_tag: fidefe
   fxatps:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Privacy & Security and Anti-Tracking Team whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: FXATPS
       whiteboard_tag: fxatps
   fxsync:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Firefox Sync Team whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: SYNC
       whiteboard_tag: fxsync
   gv:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: GeckoView Team whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: ANDP
       whiteboard_tag: gv
   mr2qa:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: MR2 whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: MR2
       whiteboard_tag: mr2qa
   mv3:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: MV3 whiteboard tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: WEBEXT
       whiteboard_tag: mv3
   prodtest:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: ProdTest tag
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: OSS
       whiteboard_tag: prodtest
   proton:
-    action: src.jbi.whiteboard_actions.default
+    # action: src.jbi.whiteboard_actions.default
     contact: tbd
     description: Proton whiteboard tag for Firefox Frontend
-    enabled: false
+    # enabled: false
     parameters:
       jira_project_key: FIDEFE
       whiteboard_tag: proton

infra/Dockerfile

@@ -88,7 +88,7 @@ RUN mypy src
 RUN black --config ./pyproject.toml --check src tests
 RUN isort --recursive --settings-path ./pyproject.toml --check-only src
 RUN pylint src tests/unit
-RUN yamllint .
+RUN yamllint -d "{extends: default, rules: {key-duplicates: enable, key-ordering: enable}}" ./config
 CMD ./infra/detect_secrets_helper.sh
 
 

src/app/environment.py

@@ -9,6 +9,7 @@ class Settings(BaseSettings):
     host: str = "0.0.0.0"
     port: str = "80"
     app_reload: bool = True
+    env: str = "dev"
 
     # Jira
     jira_base_url: str = "https://jira.allizom.org/"

src/app/log.py

@@ -26,6 +26,7 @@ def configure_logging():
         },
         "loggers": {
             "request.summary": {"handlers": ["console"], "level": "INFO"},
+            "src.jbi": {"handlers": ["console"], "level": "INFO"},
         },
     }
 

src/jbi/configuration.py

@@ -1,4 +1,5 @@
 import importlib
+import logging
 from inspect import signature
 from types import ModuleType
 from typing import Any, Dict, Optional
@@ -9,6 +10,7 @@
 from src.app import environment
 
 settings = environment.get_settings()
+jbi_logger = logging.getLogger("src.jbi")
 
 
 class ConfigError(Exception):
@@ -20,35 +22,32 @@ class ProcessError(Exception):
 
 
 def get_yaml_configurations(
-    jbi_config_file: str = "config.yaml", process_only_enabled: bool = True
+    jbi_config_file: str = f"config/config.{settings.env}.yaml",
 ) -> Dict[str, Dict]:
 
     with open(jbi_config_file, encoding="utf-8") as file:
         try:
             file_data = file.read()
             data = yaml.load(file_data, Loader)
             validated_action_dict = process_actions(
-                action_configuration=data.get("actions"),
-                process_only_enabled=process_only_enabled,
+                action_configuration=data.get("actions")
             )
             return validated_action_dict
         except (ValueError, ConfigError, yaml.YAMLError) as exception:
-            raise ProcessError("PROCESS ERROR: Errors exist.") from exception
+            jbi_logger.exception(exception)
+            raise ProcessError("Errors exist.") from exception
 
 
-def process_actions(
-    action_configuration, process_only_enabled: bool = True
-) -> Dict[str, Dict]:
+def process_actions(action_configuration) -> Dict[str, Dict]:
     requested_actions = {}
     for yaml_action_key, inner_action_dict in action_configuration.items():
-        # Check enabled state
-        enabled = inner_action_dict.get("enabled")
-        if enabled or not process_only_enabled:
-            validate_action_yaml_jbi_naming(
-                yaml_action_key=yaml_action_key, action_dict=inner_action_dict
-            )
-            validate_action_yaml_module(action_dict=inner_action_dict)
-            requested_actions[yaml_action_key] = inner_action_dict
+        inner_action_dict.setdefault("action", "src.jbi.whiteboard_actions.default")
+        inner_action_dict.setdefault("enabled", False)
+        validate_action_yaml_jbi_naming(
+            yaml_action_key=yaml_action_key, action_dict=inner_action_dict
+        )
+        validate_action_yaml_module(action_dict=inner_action_dict)
+        requested_actions[yaml_action_key] = inner_action_dict
     return requested_actions
 
 
@@ -59,17 +58,19 @@ def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
         wb_tag = action_parameters.get("whiteboard_tag")
         if yaml_action_key != wb_tag:
             raise ConfigError(
-                f"CONFIG ERROR: `{yaml_action_key}` setup, but expected '{wb_tag}'"
+                f"Expected action key '{wb_tag}', found `{yaml_action_key}."
                 "(from the `parameters.whiteboard_tag` field)."
             )
     except (TypeError, AttributeError) as exception:
-        raise ConfigError("CONFIG ERROR: Action is not properly setup.") from exception
+        raise ConfigError("Action is not properly setup.") from exception
 
 
 def validate_action_yaml_module(action_dict: Dict[str, Any]):
     # Validate action: exists, has init function, and has expected params
     try:
         action: str = action_dict.get("action")  # type: ignore
+        print(action_dict)
+        print(action)
         action_parameters: Optional[Dict[str, Any]] = action_dict.get("parameters")
         action_module: ModuleType = importlib.import_module(action)
         if not action_module:
@@ -79,6 +80,6 @@ def validate_action_yaml_module(action_dict: Dict[str, Any]):
 
         signature(action_module.init).bind(**action_parameters)  # type: ignore
     except ImportError as exception:
-        raise ConfigError(f"CONFIG ERROR: Unknown action `{action}`.") from exception
+        raise ConfigError(f"Unknown action `{action}`.") from exception
     except (TypeError, AttributeError) as exception:
-        raise ConfigError("CONFIG ERROR: Action is not properly setup.") from exception
+        raise ConfigError("Action is not properly setup.") from exception