Merge pull request #14 from mozilla/pr1-cleanup

Author: bsieber-mozilla

infra/gunicorn_conf.py

@@ -1,4 +1,7 @@
-# From: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/docker-images/gunicorn_conf.py
+"""
+Conf file extracted from:
+https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/docker-images/gunicorn_conf.py
+"""
 # pylint: disable=invalid-name
 
 import multiprocessing

poetry.lock

@@ -17,6 +17,7 @@ atlassian-python-api = "^3.20.1"
 dockerflow = "2022.1.0"
 PyYAML = "^6.0"
 types-PyYAML = "^6.0.4"
+Jinja2 = "^3.0.3"
 
 
 [tool.poetry.dev-dependencies]
@@ -44,7 +45,7 @@ testpaths = [
 [tool.pylint]
     [tool.pylint.'MESSAGES CONTROL']
     disable = [
-        "C0114", #missing-module-docstring
+#        "C0114", #missing-module-docstring
         "C0115", #missing-class-docstring
         "C0116", #missing-function-docstring
         "C0301", #line-too-long

pyproject.toml

@@ -1,10 +1,14 @@
+"""
+Core FastAPI app (setup, middleware)
+"""
 import logging
 import time
 from datetime import datetime
 
 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
@@ -21,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)

src/app/api.py

@@ -1,3 +1,6 @@
+"""
+Module dedicated to interacting with the environment (variables, version.json)
+"""
 import json
 import os
 from functools import lru_cache

src/app/environment.py

@@ -1,3 +1,6 @@
+"""
+Dedicated module for logging configuration and setup
+"""
 import logging
 import logging.config
 import sys

src/app/log.py

@@ -1,3 +1,6 @@
+"""
+Router dedicated to Dockerflow APIs
+"""
 from typing import Dict
 
 from fastapi import APIRouter, Depends, Request

src/app/monitor.py

@@ -1,3 +1,6 @@
+"""
+Parsing and validating the YAML configuration occurs within this module
+"""
 import importlib
 import logging
 from inspect import signature
@@ -43,6 +46,7 @@ def process_actions(action_configuration) -> Dict[str, Dict]:
     for yaml_action_key, inner_action_dict in action_configuration.items():
         inner_action_dict.setdefault("action", "src.jbi.whiteboard_actions.default")
         inner_action_dict.setdefault("enabled", False)
+        inner_action_dict.setdefault("parameters", {})
         validate_action_yaml_jbi_naming(
             yaml_action_key=yaml_action_key, action_dict=inner_action_dict
         )
@@ -53,24 +57,18 @@ def process_actions(action_configuration) -> Dict[str, Dict]:
 
 def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
     # Validate yaml_action_key == parameters.whiteboard_tag
-    try:
-        action_parameters = action_dict.get("parameters")
-        wb_tag = action_parameters.get("whiteboard_tag")
-        if yaml_action_key != wb_tag:
-            raise ConfigError(
-                f"Expected action key '{wb_tag}', found `{yaml_action_key}."
-                "(from the `parameters.whiteboard_tag` field)."
-            )
-    except (TypeError, AttributeError) as exception:
-        raise ConfigError("Action is not properly setup.") from exception
+    wb_tag = action_dict["parameters"].get("whiteboard_tag")
+    if yaml_action_key != wb_tag:
+        raise ConfigError(
+            f"Expected action key '{wb_tag}', found `{yaml_action_key}."
+            "(from the `parameters.whiteboard_tag` field)."
+        )
 
 
 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:

src/jbi/configuration.py

@@ -1,12 +1,18 @@
+"""
+Router dedicated to Jira Bugzilla Integration APIs
+"""
 import logging
-from typing import Dict, Optional
+from typing import Optional
 
 from fastapi import APIRouter, Depends, Request
 from fastapi.responses import HTMLResponse
+from fastapi.templating import Jinja2Templates
 
 from src.app import environment
 from src.jbi import configuration
 
+templates = Jinja2Templates(directory="src/templates")
+
 api_router = APIRouter(tags=["JBI"])
 
 jbi_logger = logging.getLogger("src.jbi")
@@ -54,110 +60,13 @@ def get_actions_by_type(action_type: Optional[str] = None):
 
 
 @api_router.get("/powered_by_jbi", response_class=HTMLResponse)
-def powered_by_jbi(enabled: Optional[bool] = None):
+def powered_by_jbi(request: Request, enabled: Optional[bool] = None):
     data = configuration.get_yaml_configurations()
-    num_configs = len(data)
-    html = f"""
-    <html>
-        <head>
-            <title>Powered by JBI</title>
-            <style>{get_css_style()}
-            </style>
-        </head>
-        <body>
-            <h1>Powered by JBI</h1>
-            <p>{num_configs} collections.</p>
-            <div id="collections"> {create_inner_html_table(data=data, enable_query=enabled)} </div>
-        </body>
-    </html>
-    """
-    return html
-
-
-def create_inner_html_table(data: Dict, enable_query: Optional[bool]):
-    agg_table = ""
-    header = """
-        <tr>
-            <th>Key</th>
-            <th>Action</th>
-            <th>Contact</th>
-            <th>Description </th>
-            <th>Enabled</th>
-            <th>Parameters</th>
-        </tr>
-    """
-    for key, value in data.items():
-        enabled = value.get("enabled")
-        if enable_query is None or enabled is enable_query:
-            parameters = ", ".join(
-                f"{k}={v}" for k, v in value.get("parameters").items()
-            )
-            per_row = f"""
-            <tr>
-                <td class="key">{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">{enabled}</td>
-                <td class="parameters">{parameters}</td>
-            </tr>"""
-            agg_table += per_row
-
-    html = f"""
-    <table>
-        <thead>{header}</thead>
-        <tbody class="list">{agg_table}</tbody>
-    </table>
-    """
-    return html
-
-
-def get_css_style():
-    return """body {
-      font-family: sans-serif;
-    }
-
-    table {
-      border-collapse: collapse;
-      margin: 25px 0;
-      font-size: 0.9em;
-      min-width: 400px;
-      box-shadow: 0 0 20px rgba(0, 0, 0, 0.15);
-    }
-
-    thead tr {
-      background-color: #009879;
-      color: #ffffff;
-      text-align: left;
-    }
-
-    th, td {
-      padding: 12px 15px;
-    }
-
-    tbody tr {
-      border-bottom: 1px solid #dddddd;
-    }
-
-    tbody tr:nth-of-type(even) {
-      background-color: #f3f3f3;
-    }
-
-    tbody tr:last-of-type {
-      border-bottom: 2px solid #009879;
-    }
-
-    .sort:after {
-      content: "▼▲";
-      padding-left: 10px;
-      opacity: 0.5;
-    }
-    .sort.desc:after {
-      content: "▲";
-      opacity: 1;
-    }
-    .sort.asc:after {
-      content: "▼";
-      opacity: 1;
+    context = {
+        "request": request,
+        "title": "Powered by JBI",
+        "num_configs": len(data),
+        "data": data,
+        "enable_query": enabled,
     }
-  """
+    return templates.TemplateResponse("powered_by_template.html", context)

src/jbi/router.py

@@ -1,3 +1,6 @@
+"""
+Services and functions that can be used to create custom actions
+"""
 import logging
 
 import bugzilla as rh_bugzilla  # type: ignore