Updates from review

Author: Bryan Sieber

.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
 

pyproject.toml

@@ -54,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,11 +30,7 @@
 
 @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")
 
 

src/app/environment.py

@@ -37,13 +37,9 @@ def get_settings() -> Settings:
 
 @lru_cache()
 def get_version():
-    """
-    Return contents of version.json.
-    This has generic data in repo, but gets the build details in CI.
-    """
+    """Return contents of version.json. This has generic data in repo, but gets the build details in CI."""
     info = {}
     version_path = Path(__file__).parents[2] / "version.json"
-    print(version_path)
     if version_path.exists():
         info = json.loads(version_path.read_text(encoding="utf8"))
     return info

src/app/log.py

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

src/app/monitor.py

@@ -28,9 +28,7 @@ def get_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
-    """
-    Dockerflow API for heartbeat: GET
-    """
+    """Dockerflow API for heartbeat: GET"""
     return heartbeat(request, settings)
 
 
@@ -39,9 +37,7 @@ def head_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
-    """
-    Dockerflow API for heartbeat: HEAD
-    """
+    """Dockerflow API for heartbeat: HEAD"""
     return heartbeat(request, settings)
 
 
@@ -52,17 +48,13 @@ def lbheartbeat(request: Request):
 
 @api_router.get("/__lbheartbeat__")
 def get_lbheartbeat(request: Request):
-    """
-    Dockerflow API for lbheartbeat: GET
-    """
+    """Dockerflow API for lbheartbeat: GET"""
     return lbheartbeat(request)
 
 
 @api_router.head("/__lbheartbeat__")
 def head_lbheartbeat(request: Request):
-    """
-    Dockerflow API for lbheartbeat: HEAD
-    """
+    """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,23 +15,17 @@
 
 
 class ConfigError(Exception):
-    """
-    Errors used to determine when the Configuration is invalid
-    """
+    """Errors used to determine when the Configuration is invalid"""
 
 
 class ProcessError(Exception):
-    """
-    Error when an exception occurs during processing
-    """
+    """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
-    """
+    """Convert and validate YAML configuration to python dict"""
 
     with open(jbi_config_file, encoding="utf-8") as file:
         try:
@@ -49,9 +41,7 @@ def get_yaml_configurations(
 
 
 def process_actions(action_configuration) -> Dict[str, Dict]:
-    """
-    Validate `actions` section of the YAML config
-    """
+    """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")

src/jbi/router.py

@@ -19,21 +19,15 @@
 
 
 def execute_request(request, settings):
-    """
-    Is request valid?
-    Is whiteboard known?
-    Execute desired action -- based on whiteboard config
-    """
+    """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
-    """
+    """API endpoint that Bugzilla Webhook Events request"""
     return execute_request(request, settings)
 
 

src/jbi/services.py

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