Refactor usage of actions whiteboard tags (fixes #89) (#100)

* Update README to new way of configuring

* Change models and reformat configuration files

* Update powered by JBI template

* Remove the whiteboard_tag parameter

* Bugzilla.lookup_action()

* Adjust API unit tests

* Raise if duplicated action tag

* Do not change /whiteboard_tags/ endpoint

* Test both configuration files

* Rename action_tag to whiteboard_tag

* Update src/jbi/models.py

Co-authored-by: grahamalama <[email protected]>

* Update src/jbi/whiteboard_actions/README.md

Co-authored-by: grahamalama <[email protected]>

* Update src/templates/powered_by_template.html

Co-authored-by: grahamalama <[email protected]>

* Document instead of promote

* Use Field from pydantic

Co-authored-by: grahamalama <[email protected]>

Author: leplatrem

.secrets.baseline

@@ -106,7 +106,7 @@
         "filename": "README.md",
         "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
         "is_verified": false,
-        "line_number": 152
+        "line_number": 183
       }
     ],
     "config/local_dev.env": [
@@ -126,5 +126,5 @@
       }
     ]
   },
-  "generated_at": "2022-07-13T07:01:04Z"
+  "generated_at": "2022-07-13T09:34:14Z"
 }

.yamllint

@@ -13,7 +13,6 @@ ignore: |
 
 rules:
   key-duplicates: enable
-  key-ordering: enable
 
 
 yaml-files:

README.md

@@ -7,31 +7,30 @@ System to sync Bugzilla bugs to Jira issues.
 
 ### Caveats
 - The system accepts webhook events from Bugzilla
-- Bugs' whiteboard tags are used to determine if they should be synchronized or ignored
+- Bugs' `whiteboard` tags are used to determine if they should be synchronized or ignored
 - The events are transformed into Jira issues
 - The system sets the `see_also` field of the Bugzilla bug with the URL to the Jira issue
 
 ## Action Configuration
-The system reads the action configuration from a YAML file, one per environment. Each entry controls the synchronization between Bugzilla tickets with Jira issues.
+The system reads the actions configuration from a YAML file, one per environment. Each entry controls the synchronization between Bugzilla tickets and the Jira issues.
 
 
 Below is a full example of an action configuration:
 ```yaml
-    action: src.jbi.whiteboard_actions.default
-    allow_private: false
-    contact: [email protected]
-    description: example configuration
-    enabled: true
-    parameters:
-      jira_project_key: EXMPL
-      whiteboard_tag: example
+- whiteboard_tag: example
+  allow_private: false
+  contact: [email protected]
+  description: example configuration
+  enabled: true
+  module: src.jbi.whiteboard_actions.default
+  parameters:
+    jira_project_key: EXMPL
 ```
 
 A bit more about the different fields...
-- `action` (optional)
+- `whiteboard_tag`
     - string
-    - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
-    - The specified Python module must be available in the `PYTHONPATH`
+    - The tag to be matched in the Bugzilla `whiteboard` field
 - `allow_private` (optional)
     - bool [true, false]
     - default: false
@@ -49,39 +48,71 @@ A bit more about the different fields...
     - bool [true, false]
     - default: false
     - If false, matching events will not be synchronized
+- `module` (optional)
+    - string
+    - default: [src.jbi.whiteboard_actions.default](src/jbi/whiteboard_actions/default.py)
+    - The specified Python module must be available in the `PYTHONPATH`
 - `parameters` (optional)
     - dict
     - default: {}
     - The parameters will be validated to ensure the selected action accepts the specified values
-    - The [default action](src/jbi/whiteboard_actions/default.py) expects both the `whiteboard_tag` and `jira_project_key` fields
 
 
 [View 'nonprod'  configurations here.](config/config.nonprod.yaml)
 
 [View 'prod' configurations here.](config/config.prod.yaml)
 
 
-## Default with assignee and status action
+## Available Actions
+
+### Default
+The `src.jbi.whiteboard_actions.default` action will create or update the Jira issue and its comments.
+It will also set the Jira issue URL in the Bugzilla bug `see_also` field.
+
+**Parameters**
+
+- `jira_project_key`
+    - string
+    - The Jira project identifier
+
+Example configuration:
+```yaml
+    whiteboard_tag: example
+    contact: [email protected]
+    description: example configuration
+    module: src.jbi.whiteboard_actions.default
+    parameters:
+      jira_project_key: EXMPL
+```
+
+### Default with assignee and status action
 The `src.jbi.whiteboard_actions.default_with_assignee_and_status` action adds some additional
 features on top of the default.
 
 It will attempt to assign the Jira issue the same person as the bug is assigned to. This relies on
 the user using the same email address in both Bugzilla and Jira. If the user does not exist in Jira
 then the assignee is cleared from the Jira issue.
 
-The action supports setting the Jira issues's status when the Bugzilla status and resolution change.
-This is defined using a mapping on a per-project basis configured in the `status_map` field of the
-`parameters` field.
+If configured, the action supports setting the Jira issues's status when the Bugzilla status and resolution change.
+
+**Parameters**
 
-An example configuration:
+- `jira_project_key`
+    - string
+    - The Jira project identifier
+- `status_map` (optional)
+    - mapping [str, str]
+    - If defined, map the Bugzilla bug status to Jira issue status
+
+Example configuration:
 ```yaml
-    action: src.jbi.whiteboard_actions.default_with_assignee_and_status
+    whiteboard_tag: example
     contact: [email protected]
     description: example configuration
     enabled: true
+    module: src.jbi.whiteboard_actions.default_with_assignee_and_status
     parameters:
       jira_project_key: EXMPL
-      whiteboard_tag: example
       status_map:
         NEW: "In Progress"
         FIXED: "Closed"
@@ -93,7 +124,7 @@ linked Jira issue status to "Closed". If the bug changes to a status not listed
 no change will be made to the Jira issue.
 
 ### Custom Actions
-If you're looking for a unique capability for your team's data flow, you can add your own python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)
+If you're looking for a unique capability for your team's data flow, you can add your own Python methods and functionality[...read more here.](src/jbi/whiteboard_actions/README.md)
 
 
 ## Diagram Overview
@@ -165,15 +196,15 @@ For the list of configured whiteboard tags:
 GET /whiteboard_tags/
 {
     "addons": {
-        "action": "src.jbi.whiteboard_actions.default",
+        "whiteboard_tag": "addons",
         "contact": "[email protected]",
         "description": "Addons whiteboard tag for AMO Team",
         "enabled": true,
+        "module": "src.jbi.whiteboard_actions.default",
         "parameters": {
-            "jira_project_key": "WEBEXT",
-            "whiteboard_tag": "addons"
+            "jira_project_key": "WEBEXT"
         }
-    },
+    }
     ...
 }
 ```

config/config.nonprod.yaml

@@ -1,22 +1,21 @@
 ---
 # Action Config
-devtest:
+- whiteboard_tag: devtest
   contact: tbd
   description: DevTest whiteboard tag
   enabled: true
   parameters:
     jira_project_key: JST
-    whiteboard_tag: devtest
-flowstate:
-  action: src.jbi.whiteboard_actions.default_with_assignee_and_status
+
+- whiteboard_tag: flowstate
   allow_private: true
   contact: [email protected]
   description: Flowstate whiteboard tag
   enabled: true
+  module: src.jbi.whiteboard_actions.default_with_assignee_and_status
   parameters:
     jira_project_key: MR2
     status_map:
       ASSIGNED: In Progress
       FIXED: In Review
       REOPENED: In Progress
-    whiteboard_tag: flowstate

config/config.prod.yaml

@@ -1,107 +1,106 @@
 ---
 # Action Config
-addons:
-  #  action: src.jbi.whiteboard_actions.default
+- whiteboard_tag: addons
   contact: tbd
   description: Addons whiteboard tag for AMO Team
   enabled: true
+  # module: src.jbi.whiteboard_actions.default
   parameters:
     jira_project_key: WEBEXT
-    whiteboard_tag: addons
-fidedi:
+
+- whiteboard_tag: fidedi
   contact: tbd
   description: Firefox Desktop Integration whiteboard tag
   enabled: true
   parameters:
     jira_project_key: FIDEDI
-    whiteboard_tag: fidedi
-fidefe:
+
+- whiteboard_tag: fidefe
   contact: tbd
   description: Firefox Front End whiteboard tag
   enabled: true
   parameters:
     jira_project_key: FIDEFE
-    whiteboard_tag: fidefe
-flowstate:
-  action: src.jbi.whiteboard_actions.default_with_assignee_and_status
+
+- whiteboard_tag: flowstate
   allow_private: true
   contact: [email protected]
   description: Flowstate whiteboard tag
   enabled: true
+  module: src.jbi.whiteboard_actions.default_with_assignee_and_status
   parameters:
     jira_project_key: MR2
     status_map:
       ASSIGNED: In Progress
       FIXED: In Review
       REOPENED: In Progress
-    whiteboard_tag: flowstate
-fxatps:
+
+- whiteboard_tag: fxatps
   contact: tbd
   description: Privacy & Security and Anti-Tracking Team whiteboard tag
   enabled: true
   parameters:
     jira_project_key: FXATPS
-    whiteboard_tag: fxatps
-fxcm:
+
+- whiteboard_tag: fxcm
   contact: tbd
   description: Firefox Credential Management Team whiteboard tag
   enabled: true
   parameters:
     jira_project_key: FXCM
-    whiteboard_tag: fxcm
-fxsync:
+
+- whiteboard_tag: fxsync
   contact: tbd
   description: Firefox Sync Team whiteboard tag
   enabled: true
   parameters:
     jira_project_key: SYNC
-    whiteboard_tag: fxsync
-gv:
+
+- whiteboard_tag: gv
   contact: tbd
   description: GeckoView Team whiteboard tag
   enabled: true
   parameters:
     jira_project_key: ANDP
-    whiteboard_tag: gv
-mv3:
+
+- whiteboard_tag: mv3
   contact: tbd
   description: MV3 whiteboard tag
   enabled: true
   parameters:
     jira_project_key: WEBEXT
-    whiteboard_tag: mv3
-nimbus:
+
+- whiteboard_tag: nimbus
   contact: tbd
   description: Nimbus whiteboard tag
   enabled: true
   parameters:
     jira_project_key: EXP
-    whiteboard_tag: nimbus
-prodtest:
+
+- whiteboard_tag: prodtest
   contact: tbd
   description: ProdTest tag
   enabled: true
   parameters:
     jira_project_key: OSS
-    whiteboard_tag: prodtest
-proton:
+
+- whiteboard_tag: proton
   contact: tbd
   description: Proton whiteboard tag for Firefox Frontend
   enabled: true
   parameters:
     jira_project_key: FIDEFE
-    whiteboard_tag: proton
-relops:
+
+- whiteboard_tag: relops
   contact: tbd
   description: Release Operations Team Tag
   enabled: true
   parameters:
     jira_project_key: RELOPS
-    whiteboard_tag: relops
-snt:
+
+- whiteboard_tag: snt
   contact: tbd
   description: Search/NewTab Team Tag
   enabled: true
   parameters:
     jira_project_key: SNT
-    whiteboard_tag: snt

src/app/api.py

@@ -111,7 +111,7 @@ def get_whiteboard_tag(
     """API for viewing whiteboard_tags and associated data"""
     if existing := actions.get(whiteboard_tag):
         return {whiteboard_tag: existing}
-    return actions
+    return actions.by_tag
 
 
 @app.get("/jira_projects/")
@@ -132,8 +132,7 @@ def powered_by_jbi(
     context = {
         "request": request,
         "title": "Powered by JBI",
-        "num_configs": len(actions),
-        "data": jsonable_encoder(actions),
+        "actions": jsonable_encoder(actions),
         "enable_query": enabled,
     }
     return templates.TemplateResponse("powered_by_template.html", context)

src/jbi/bugzilla.py

@@ -7,7 +7,7 @@
 import json
 import logging
 from functools import cached_property
-from typing import Dict, List, Optional, Tuple
+from typing import Dict, List, Optional
 from urllib.parse import ParseResult, urlparse
 
 from pydantic import BaseModel  # pylint: disable=no-name-in-module
@@ -148,7 +148,7 @@ def get_jira_labels(self) -> List[str]:
         return ["bugzilla"] + wb_list + wb_bracket_list
 
     def get_potential_whiteboard_config_list(self) -> List[str]:
-        """Get all possible whiteboard_tag configuration values"""
+        """Get all possible tags from `whiteboard` field"""
         converted_list: List = []
         for whiteboard in self.get_whiteboard_as_list():
             first_tag = whiteboard.strip().lower().split(sep="-", maxsplit=1)[0]
@@ -198,13 +198,12 @@ def extract_from_see_also(self):
 
         return None
 
-    def lookup_action(self, actions: Actions) -> Tuple[str, Action]:
+    def lookup_action(self, actions: Actions) -> Action:
         """Find first matching action from bug's whiteboard list"""
         tags: List[str] = self.get_potential_whiteboard_config_list()
         for tag in tags:
-            tag = tag.lower()
             if action := actions.get(tag):
-                return tag, action
+                return action
         raise ActionNotFoundError(", ".join(tags))