Updates to template, documentation, default_action.

Bryan Sieber · Bryan Sieber · commit 9dfc00260300 · 2022-03-02T13:57:38.000-08:00
diff --git a/src/app/api.py b/src/app/api.py
@@ -8,6 +8,7 @@
 import uvicorn  # type: ignore
 from fastapi import FastAPI, Request
 from fastapi.responses import RedirectResponse
+from fastapi.staticfiles import StaticFiles
 
 from src.app.environment import get_settings
 from src.app.log import configure_logging
@@ -24,6 +25,7 @@
 
 app.include_router(monitor_router)
 app.include_router(jbi_router)
+app.mount("/static", StaticFiles(directory="src/static"), name="static")
 
 
 @app.get("/", include_in_schema=False)
diff --git a/src/jbi/router.py b/src/jbi/router.py
@@ -6,7 +6,6 @@
 
 from fastapi import APIRouter, Depends, Request
 from fastapi.responses import HTMLResponse
-from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 
 from src.app import environment
@@ -15,7 +14,6 @@
 templates = Jinja2Templates(directory="src/templates")
 
 api_router = APIRouter(tags=["JBI"])
-api_router.mount("/static", StaticFiles(directory="src/static"), name="static")
 
 jbi_logger = logging.getLogger("src.jbi")
 
diff --git a/src/jbi/whiteboard_actions/README.md b/src/jbi/whiteboard_actions/README.md
@@ -8,13 +8,12 @@ Let's create a `new_action`!
 1. Add the python function `init` to a new "my_team_action" module, let's use the following:
     ```python
     def init(whiteboard_tag, jira_project_key, optional_param=42):
-        return lambda payload, context: print("Hi world!")
+        return lambda payload: print(f"{whiteboard_tag}, going to {jira_project_key}!")
     ```
     1. In the above example `whiteboard_tag` and `jira_project_key` parameters are required
     1. `optional_param`, which has a default value and is not required to run this action
     1. init returns a `__call__`able object that the system calls with the bugzilla request and yaml configuration objects
 1. Using `payload` and `context` perform the desired processing!
     1. `payload` is bugzilla webhook payload
-    1. `parameters` is the yaml section `parameters` as a python dict
     1. Use the available service calls from `src/jbi/services.py' (or make new ones)
 1. Now the action `src.jbi.whiteboard_actions.my_team_actions` can be added to a configuration yaml under the `action` key.
diff --git a/src/jbi/whiteboard_actions/default.py b/src/jbi/whiteboard_actions/default.py
@@ -15,11 +15,12 @@ def init(whiteboard_tag, jira_project_key, **kwargs):
 
 class DefaultExecutor:
     def __init__(self, **kwargs):
+        self.parameters = kwargs
         self.whiteboard_tag = kwargs.get("whiteboard_tag")
         self.jira_project_key = kwargs.get("jira_project_key")
 
-    def __call__(self, payload, parameters):
+    def __call__(self, payload):
         # Called from BZ webhook
         # Call Jira SDK with project key etc.
         print(payload)
-        print(parameters)
+        print(self.parameters)
diff --git a/src/templates/powered_by_template.html b/src/templates/powered_by_template.html
@@ -5,7 +5,7 @@
     </head>
     <body>
         <h1>{{title}}</h1>
-        <p>{{num_configs}} collections.</p>
+        <p>{{num_configs}} actions.</p>
         <div id="collections">
             <table>
                 <thead>
@@ -20,14 +20,14 @@ <h1>{{title}}</h1>
                 </thead>
                 <tbody class="list">
                     {% for key, value in data.items() %}
-                        {% if enable_query is none or value.get("enabled") is enable_query %}
+                        {% if enable_query is none or value.enabled is enable_query %}
                         <tr>
                             <td class="identifier">{{key}}</td>
-                            <td class="action">{{value.get("action")}}</td>
-                            <td class="contact">{{value.get("contact")}}</td>
-                            <td class="description">{{value.get("description")}}</td>
-                            <td class="enabled">{{value.get("enabled")}}</td>
-                            <td class="parameters">{% for key, value in value["parameters"].items() %}{{key ~ ": " ~ value}}{{ ", " if not loop.last else "" }}{% endfor %}
+                            <td class="action">{{value.action}}</td>
+                            <td class="contact">{{value.contact}}</td>
+                            <td class="description">{{value.description}}</td>
+                            <td class="enabled">{{value.enabled}}</td>
+                            <td class="parameters">{% for key, value in value.parameters.items() %}{{key ~ ": " ~ value}}{{ ", " if not loop.last else "" }}{% endfor %}
                             </td>
                         </tr>
                         {% endif %}
