Constrain Action.contact field to email address(es) (#90)

Constrain contact field so that it only accepts an email address or list of
email addresses.

For now, it also accepts a "tbd" string literal (since many actions have that
as their contact at the moment), but this will emit a warning since we want
that to be an email address eventually.

This commit also:
* Adds pydantic email extra for email address validation
* Changes bad-config.yaml so that it has a bad contact value

Co-authored-by: bsieber-mozilla <[email protected]>

Author: grahamalama

README.md

@@ -19,7 +19,7 @@ Below is a full example of an action configuration:
 ```yaml
     action: src.jbi.whiteboard_actions.default
     allow_private: false
-    contact: [[email protected]]
+    contact: [email protected]
     description: example configuration
     enabled: true
     parameters:
@@ -39,7 +39,7 @@ A bit more about the different fields...
       private bugs the bugzilla user that JBI runs as must be in the security groups that are making
       the bug private.
 - `contact`
-    - list of strings
+    - an email address, a list of email addresses, or a literal "tbd" to signify that no contact is available
     - If an issue arises with the workflow, communication will be established with these contacts
     - Please enter the contact information for one or more stakeholders
 - `description`
@@ -76,7 +76,7 @@ This is defined using a mapping on a per-project basis configured in the `status
 An example configuration:
 ```yaml
     action: src.jbi.whiteboard_actions.default_with_assignee_and_status
-    contact: [[email protected]]
+    contact: [email protected]
     description: example configuration
     enabled: true
     parameters:
@@ -166,7 +166,7 @@ GET /whiteboard_tags/
 {
     "addons": {
         "action": "src.jbi.whiteboard_actions.default",
-        "contact": "tbd",
+        "contact": "[email protected]",
         "description": "Addons whiteboard tag for AMO Team",
         "enabled": true,
         "parameters": {

poetry.lock

@@ -8,7 +8,7 @@ license = "MPL"
 [tool.poetry.dependencies]
 python = ">=3.8, <3.11"
 fastapi = "^0.73.0"
-pydantic = "^1.9.0"
+pydantic = {version = "^1.9.1", extras = ["email"]}
 uvicorn = {extras = ["standard"], version = "^0.17.4"}
 gunicorn = "^20.1.0"
 prometheus-client = "^0.13.1"

pyproject.toml

@@ -3,11 +3,12 @@
 """
 import functools
 import importlib
+import warnings
 from inspect import signature
 from types import ModuleType
-from typing import Any, Callable, Dict, Mapping, Optional
+from typing import Any, Callable, Dict, List, Literal, Mapping, Optional, Union
 
-from pydantic import Extra, root_validator, validator
+from pydantic import EmailStr, Extra, root_validator, validator
 from pydantic_yaml import YamlModel
 
 
@@ -16,7 +17,8 @@ class Action(YamlModel):
     Action is the inner model for each action in the configuration file"""
 
     action: str = "src.jbi.whiteboard_actions.default"
-    contact: str
+    # TODO: Remove the tbd literal option when all actions have contact info # pylint: disable=fixme
+    contact: Union[EmailStr, List[EmailStr], Literal["tbd"]]
     description: str
     enabled: bool = False
     allow_private: bool = False
@@ -75,16 +77,21 @@ def get(self, tag: Optional[str]) -> Optional[Action]:
         return self.__root__.get(tag.lower()) if tag else None
 
     @validator("__root__")
-    def validate_action_matches_whiteboard(
+    def validate_actions(
         cls, actions: Mapping[str, Action]
     ):  # pylint: disable=no-self-argument, no-self-use
         """
-        Validate that the inner actions are named as expected
+        Inspect action values with the context of the top-level key and:
+         - Validate that the inner actions are named as expected (key matches
+           whiteboard tag parameter)
+         - If the action's contact is "tbd", emit a warning.
         """
         if not actions:
             raise ValueError("no actions configured")
         for name, action in actions.items():
             if name.lower() != action.parameters["whiteboard_tag"]:
                 raise ValueError("action name must match whiteboard tag")
+            if action.contact == "tbd":
+                warnings.warn(f"Provide contact data for `{name}` action.")
 
         return actions

src/jbi/models.py

@@ -2,7 +2,7 @@
 # Action Config
 should-be-A:
   action: src.jbi.whiteboard_actions.default
-  contact: tbd
+  contact: foobar
   description: test config
   enabled: true
   parameters: