Merge pull request #15 from mozilla/iss-7

PR to handle Issue #7 and #12

Author: bsieber-mozilla

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
         name: pylint
         entry: poetry run pylint
         language: system
-        exclude: ^migrations/
+        exclude: ^tests/
         types: [python]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.1.0
@@ -20,6 +20,7 @@ repos:
           '--indent', '4',
           '--no-sort-keys',
         ]
+        exclude: "infra/k8s/secret.json"
       - id: trailing-whitespace
   - repo: local
     hooks:

infra/Dockerfile

@@ -87,7 +87,7 @@ RUN bandit -lll --recursive src --exclude "src/poetry.lock,src/.venv,src/.mypy,s
 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 pylint src tests
 RUN yamllint -d "{extends: default, rules: {key-duplicates: enable, key-ordering: enable}}" ./config
 CMD ./infra/detect_secrets_helper.sh
 

infra/gunicorn_conf.py

@@ -73,5 +73,5 @@
 }
 
 
-def child_exit(server, worker):
+def child_exit(server, worker):  # pylint: disable=missing-function-docstring
     multiprocess.mark_process_dead(worker.pid)

pyproject.toml

@@ -45,9 +45,6 @@ testpaths = [
 [tool.pylint]
     [tool.pylint.'MESSAGES CONTROL']
     disable = [
-#        "C0114", #missing-module-docstring
-        "C0115", #missing-class-docstring
-        "C0116", #missing-function-docstring
         "C0301", #line-too-long
         "R0903", #too-few-public-methods
         "W0613", #unused-argument
@@ -57,7 +54,7 @@ testpaths = [
     [tool.pylint.MASTER]
     load-plugins='pylint_pytest'
     ignore='third_party'
-
+    ignore-patterns = "tests/*"
 
 [tool.isort]
 profile = "black"

src/app/api.py

@@ -30,16 +30,13 @@
 
 @app.get("/", include_in_schema=False)
 def root(request: Request):
-    """GET via root redirects to /docs.
-    - Args:
-    - Returns:
-        - **redirect**: Redirects call to ./docs
-    """
+    """GET via root redirects to /docs."""
     return RedirectResponse(url="./docs")
 
 
 @app.middleware("http")
 async def request_summary(request: Request, call_next):
+    """Middleware to log request info"""
     summary_logger = logging.getLogger("request.summary")
     previous_time = time.time()
 
@@ -66,6 +63,7 @@ async def request_summary(request: Request, call_next):
 
 @app.on_event("startup")
 def startup_event():
+    """On app startup perform these setup operations"""
     configure_logging()
 
 

src/app/environment.py

@@ -2,13 +2,15 @@
 Module dedicated to interacting with the environment (variables, version.json)
 """
 import json
-import os
 from functools import lru_cache
+from pathlib import Path
 
 from pydantic import BaseSettings
 
 
 class Settings(BaseSettings):
+    """The Settings object extracts environment variables for convenience."""
+
     host: str = "0.0.0.0"
     port: str = "80"
     app_reload: bool = True
@@ -29,19 +31,15 @@ class Settings(BaseSettings):
 
 @lru_cache()
 def get_settings() -> Settings:
+    """Return the Settings object; use cache"""
     return Settings()
 
 
 @lru_cache()
 def get_version():
-    """
-    Return contents of version.json.
-    This has generic data in repo, but gets the build details in CI.
-    """
-    _root = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
-    version_path = os.path.join(_root, "version.json")
+    """Return contents of version.json. This has generic data in repo, but gets the build details in CI."""
     info = {}
-    if os.path.exists(version_path):
-        with open(version_path, "r", encoding="utf8") as version_file:
-            info = json.load(version_file)
+    version_path = Path(__file__).parents[2] / "version.json"
+    if version_path.exists():
+        info = json.loads(version_path.read_text(encoding="utf8"))
     return info

src/app/log.py

@@ -11,6 +11,7 @@
 
 
 def configure_logging():
+    """Configure logging; mozlog format for Dockerflow"""
     logging_config = {
         "version": 1,
         "formatters": {

src/app/monitor.py

@@ -28,6 +28,7 @@ def get_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """Dockerflow API for heartbeat: GET"""
     return heartbeat(request, settings)
 
 
@@ -36,6 +37,7 @@ def head_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """Dockerflow API for heartbeat: HEAD"""
     return heartbeat(request, settings)
 
 
@@ -46,11 +48,13 @@ def lbheartbeat(request: Request):
 
 @api_router.get("/__lbheartbeat__")
 def get_lbheartbeat(request: Request):
+    """Dockerflow API for lbheartbeat: GET"""
     return lbheartbeat(request)
 
 
 @api_router.head("/__lbheartbeat__")
 def head_lbheartbeat(request: Request):
+    """Dockerflow API for lbheartbeat: HEAD"""
     return lbheartbeat(request)
 
 

src/jbi/configuration.py

@@ -1,6 +1,4 @@
-"""
-Parsing and validating the YAML configuration occurs within this module
-"""
+"""Parsing and validating the YAML configuration occurs within this module"""
 import importlib
 import logging
 from inspect import signature
@@ -17,16 +15,17 @@
 
 
 class ConfigError(Exception):
-    pass
+    """Errors used to determine when the Configuration is invalid"""
 
 
 class ProcessError(Exception):
-    pass
+    """Error when an exception occurs during processing"""
 
 
 def get_yaml_configurations(
     jbi_config_file: str = f"config/config.{settings.env}.yaml",
 ) -> Dict[str, Dict]:
+    """Convert and validate YAML configuration to python dict"""
 
     with open(jbi_config_file, encoding="utf-8") as file:
         try:
@@ -42,6 +41,7 @@ def get_yaml_configurations(
 
 
 def process_actions(action_configuration) -> Dict[str, Dict]:
+    """Validate `actions` section of the YAML config"""
     requested_actions = {}
     for yaml_action_key, inner_action_dict in action_configuration.items():
         inner_action_dict.setdefault("action", "src.jbi.whiteboard_actions.default")
@@ -56,7 +56,7 @@ 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
+    """Validate yaml_action_key == parameters.whiteboard_tag"""
     wb_tag = action_dict["parameters"].get("whiteboard_tag")
     if yaml_action_key != wb_tag:
         raise ConfigError(
@@ -66,7 +66,7 @@ def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
 
 
 def validate_action_yaml_module(action_dict: Dict[str, Any]):
-    # Validate action: exists, has init function, and has expected params
+    """Validate action: exists, has init function, and has expected params"""
     try:
         action: str = action_dict.get("action")  # type: ignore
         action_parameters: Optional[Dict[str, Any]] = action_dict.get("parameters")

src/jbi/router.py

@@ -19,24 +19,23 @@
 
 
 def execute_request(request, settings):
-    # Is request valid?
-    # Is whiteboard known?
-    # Execute desired action -- based on whiteboard config
-    pass
+    """Execute action"""
 
 
 @api_router.post("/bugzilla_webhook")
 def bugzilla_webhook(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """API endpoint that Bugzilla Webhook Events request"""
     return execute_request(request, settings)
 
 
 @api_router.get("/whiteboard_tags/")
 def get_whiteboard_tag(
     whiteboard_tag: Optional[str] = None,
 ):
+    """API for viewing whiteboard_tags"""
     data = configuration.get_yaml_configurations()
     if whiteboard_tag:
         wb_val = data.get(whiteboard_tag)
@@ -47,6 +46,7 @@ def get_whiteboard_tag(
 
 @api_router.get("/actions/")
 def get_actions_by_type(action_type: Optional[str] = None):
+    """API for viewing actions"""
     configured_actions = configuration.get_yaml_configurations()
     if action_type:
         data = [
@@ -61,6 +61,7 @@ def get_actions_by_type(action_type: Optional[str] = None):
 
 @api_router.get("/powered_by_jbi", response_class=HTMLResponse)
 def powered_by_jbi(request: Request, enabled: Optional[bool] = None):
+    """API for `Powered By` endpoint"""
     data = configuration.get_yaml_configurations()
     context = {
         "request": request,