Add CodeRabbit recommendations

Author: oto-macenauer-absa

.github/workflows/test.yml

@@ -87,9 +87,6 @@ jobs:
         run: |
           pip install -r requirements.txt
 
-      - name: Set PYTHONPATH environment variable
-        run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/release_notes_generator/release_notes_generator" >> $GITHUB_ENV
-
       - name: Check code coverage with Pytest
         run: pytest --cov=. -v tests/ --cov-fail-under=80
 

DEVELOPER.md

@@ -14,7 +14,7 @@ Clone the repository and navigate to the project directory:
 
 ```shell
 git clone https://github.com/AbsaOSS/EventGate.git
-cd event-gate
+cd EventGate
 ```
 
 ## Set Up Python Environment
@@ -75,23 +75,23 @@ All done! ✨ 🍰 ✨
 
 ## Run mypy Tool Locally
 
-This project uses the [my[py]](https://mypy.readthedocs.io/en/stable/) tool, a static type checker for Python.
+This project uses the [mypy](https://mypy.readthedocs.io/en/stable/) tool, a static type checker for Python.
 
 > Type checkers help ensure that you correctly use variables and functions in your code.
 > With mypy, add type hints (PEP 484) to your Python programs,
 > and mypy will warn you when you use those types incorrectly.
-my[py] configuration is in `pyproject.toml` file.
+mypy configuration is in `pyproject.toml` file.
 
-Follow these steps to format your code with my[py] locally:
+Follow these steps to type-check your code with mypy locally:
 
-### Run my[py]
+### Run mypy
 
-Run my[py] on all files in the project.
+Run mypy on all files in the project.
 ```shell
 mypy .
 ```
 
-To run my[py] check on a specific file, follow the pattern `mypy <path_to_file>/<name_of_file>.py --check-untyped-defs`.
+To run mypy on a specific file, follow the pattern `mypy <path_to_file>/<name_of_file>.py --check-untyped-defs`.
 
 Example:
 ```shell
@@ -124,4 +124,4 @@ See the coverage report on the path:
 open htmlcov/index.html
 ```
 
-## 
+##

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.black]
 line-length = 120
 target-version = ['py311']
-force-exclude = '''test'''
+# force-exclude = '''test'''
 
 [tool.coverage.run]
 omit = ["tests/*"]

requirements.txt

@@ -11,5 +11,5 @@ jsonschema==4.25.1
 PyJWT==2.10.1
 requests==2.32.5
 boto3==1.40.25
-confluent_kafka
+confluent-kafka==2.11.1
 psycopg2-binary==2.9.10

src/event_gate_lambda.py

@@ -50,9 +50,7 @@
 logger.debug("Initialized LOGGER")
 logger.debug(f"Using CONF_DIR={_CONF_DIR}")
 if _INVALID_CONF_ENV:
-    logger.warning(
-        f"CONF_DIR env var set to non-existent path: {_INVALID_CONF_ENV}; fell back to {_CONF_DIR}"
-    )
+    logger.warning(f"CONF_DIR env var set to non-existent path: {_INVALID_CONF_ENV}; fell back to {_CONF_DIR}")
 
 # Resolve project root (parent directory of this file's directory)
 _PROJECT_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
@@ -210,17 +208,38 @@ def post_topic_message(topic_name: str, topic_message: Dict[str, Any], token_enc
 
 
 def extract_token(event_headers: Dict[str, str]) -> str:
-    """Extract bearer token from headers.
+    """Extract bearer token from headers (case-insensitive).
 
-    Supports lowercase custom 'bearer' header or standard 'Authorization: Bearer <token>'.
-    Returns empty string if not present (caller handles auth error response).
+    Supports:
+      - Custom 'bearer' header (any casing) whose value is the raw token
+      - Standard 'Authorization: Bearer <token>' header (case-insensitive scheme & key)
+    Returns empty string if token not found or malformed.
     """
-    if "bearer" in event_headers:
-        return event_headers["bearer"]
-    auth_header = event_headers.get("Authorization", "")
-    if auth_header.startswith("Bearer "):
-        return auth_header[len("Bearer ") :]
-    return ""
+    if not event_headers:
+        return ""
+
+    # Normalize keys to lowercase for case-insensitive lookup
+    lowered = {str(k).lower(): v for k, v in event_headers.items()}
+
+    # Direct bearer header (raw token)
+    if "bearer" in lowered and isinstance(lowered["bearer"], str):
+        token_candidate = lowered["bearer"].strip()
+        if token_candidate:
+            return token_candidate
+
+    # Authorization header with Bearer scheme
+    auth_val = lowered.get("authorization", "")
+    if not isinstance(auth_val, str):  # defensive
+        return ""
+    auth_val = auth_val.strip()
+    if not auth_val:
+        return ""
+
+    # Case-insensitive match for 'Bearer ' prefix
+    if not auth_val.lower().startswith("bearer "):
+        return ""
+    token_part = auth_val[7:].strip()  # len('Bearer ')==7
+    return token_part
 
 
 def lambda_handler(event: Dict[str, Any], context: Any):  # pylint: disable=unused-argument,too-many-return-statements

src/writer_eventbridge.py

@@ -5,7 +5,7 @@
 
 import json
 import logging
-from typing import Any, Dict, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple, List
 
 import boto3
 from botocore.exceptions import BotoCoreError, ClientError
@@ -26,6 +26,12 @@ def init(logger: logging.Logger, config: Dict[str, Any]) -> None:
     STATE["logger"].debug("Initialized EVENTBRIDGE writer")
 
 
+def _format_failed_entries(entries: List[Dict[str, Any]]) -> str:
+    failed = [e for e in entries if "ErrorCode" in e or "ErrorMessage" in e]
+    # Keep message concise but informative
+    return json.dumps(failed) if failed else "[]"
+
+
 def write(topic_name: str, message: Dict[str, Any]) -> Tuple[bool, Optional[str]]:
     """Publish a message to EventBridge.
 
@@ -58,21 +64,16 @@ def write(topic_name: str, message: Dict[str, Any]) -> Tuple[bool, Optional[str]
                 }
             ]
         )
-        if response.get("FailedEntryCount", 0) > 0:
-            msg = str(response)
+        failed_count = response.get("FailedEntryCount", 0)
+        if failed_count > 0:
+            entries = response.get("Entries", [])
+            failed_repr = _format_failed_entries(entries)
+            msg = f"{failed_count} EventBridge entries failed: {failed_repr}"
             logger.error(msg)
             return False, msg
-    except (BotoCoreError, ClientError) as err:
-        err_msg = f"The EventBridge writer failed: {err}"  # specific AWS error
-        logger.error(err_msg)
-        return False, err_msg
-    except Exception as err:  # pragma: no cover - unexpected failure path
-        err_msg = (
-            f"The EventBridge writer failed with unknown error: {err}"
-            if not isinstance(err, (BotoCoreError, ClientError))
-            else str(err)
-        )
-        logger.error(err_msg)
-        return False, err_msg
+    except (BotoCoreError, ClientError) as err:  # explicit AWS client-related errors
+        logger.exception("EventBridge put_events call failed")
+        return False, str(err)
 
+    # Let any unexpected exception propagate for upstream handler (avoids broad except BLE001 / TRY400)
     return True, None

src/writer_kafka.py

@@ -15,6 +15,7 @@
 _logger: logging.Logger = logging.getLogger(__name__)
 kafka_producer: Optional[Producer] = None
 
+
 def init(logger: logging.Logger, config: Dict[str, Any]) -> None:
     """Initialize Kafka producer.
 
@@ -67,9 +68,7 @@ def write(topic_name: str, message: Dict[str, Any]) -> Tuple[bool, Optional[str]
             topic_name,
             key="",
             value=json.dumps(message).encode("utf-8"),
-            callback=lambda err, msg: (
-                errors.append(str(err)) if err is not None else None
-            ),
+            callback=lambda err, msg: (errors.append(str(err)) if err is not None else None),
         )
         kafka_producer.flush()
         if errors:

src/writer_postgres.py

@@ -35,12 +35,8 @@ def init(logger: logging.Logger) -> None:
     secret_region = os.environ.get("POSTGRES_SECRET_REGION", "")
 
     if secret_name and secret_region:
-        aws_secrets = boto3.Session().client(
-            service_name="secretsmanager", region_name=secret_region
-        )
-        postgres_secret = aws_secrets.get_secret_value(SecretId=secret_name)[
-            "SecretString"
-        ]
+        aws_secrets = boto3.Session().client(service_name="secretsmanager", region_name=secret_region)
+        postgres_secret = aws_secrets.get_secret_value(SecretId=secret_name)["SecretString"]
         POSTGRES = json.loads(postgres_secret)
     else:
         POSTGRES = {"database": ""}
@@ -100,16 +96,8 @@ def postgres_edla_write(cursor, table: str, message: Dict[str, Any]) -> None:
             message["operation"],
             message.get("location"),
             message["format"],
-            (
-                json.dumps(message.get("format_options"))
-                if "format_options" in message
-                else None
-            ),
-            (
-                json.dumps(message.get("additional_info"))
-                if "additional_info" in message
-                else None
-            ),
+            (json.dumps(message.get("format_options")) if "format_options" in message else None),
+            (json.dumps(message.get("additional_info")) if "additional_info" in message else None),
         ),
     )
 
@@ -190,11 +178,7 @@ def postgres_run_write(cursor, table_runs: str, table_jobs: str, message: Dict[s
                 job["timestamp_start"],
                 job["timestamp_end"],
                 job.get("message"),
-                (
-                    json.dumps(job.get("additional_info"))
-                    if "additional_info" in job
-                    else None
-                ),
+                (json.dumps(job.get("additional_info")) if "additional_info" in job else None),
             ),
         )
 
@@ -234,11 +218,7 @@ def postgres_test_write(cursor, table: str, message: Dict[str, Any]) -> None:
             message["source_app"],
             message["environment"],
             message["timestamp"],
-            (
-                json.dumps(message.get("additional_info"))
-                if "additional_info" in message
-                else None
-            ),
+            (json.dumps(message.get("additional_info")) if "additional_info" in message else None),
         ),
     )
 
@@ -271,9 +251,7 @@ def write(topic_name: str, message: Dict[str, Any]) -> Tuple[bool, Optional[str]
                 if topic_name == "public.cps.za.dlchange":
                     postgres_edla_write(cursor, "public_cps_za_dlchange", message)
                 elif topic_name == "public.cps.za.runs":
-                    postgres_run_write(
-                        cursor, "public_cps_za_runs", "public_cps_za_runs_jobs", message
-                    )
+                    postgres_run_write(cursor, "public_cps_za_runs", "public_cps_za_runs_jobs", message)
                 elif topic_name == "public.cps.za.test":
                     postgres_test_write(cursor, "public_cps_za_test", message)
                 else:

tests/conftest.py

@@ -14,7 +14,8 @@
 # limitations under the License.
 #
 import os, sys
+
 # Ensure project root is on sys.path so 'src' package is importable during tests
-PROJECT_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+PROJECT_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
 if PROJECT_ROOT not in sys.path:
     sys.path.insert(0, PROJECT_ROOT)

tests/test_conf_validation.py

@@ -1,4 +1,5 @@
 import os
+
 #
 # Copyright 2025 ABSA Group Limited
 #
@@ -28,25 +29,26 @@
     "event_bus_arn",
 }
 
+
 def load_json(path):
     with open(path, "r") as f:
         return json.load(f)
 
+
 @pytest.fixture(scope="module")
 def config_files():
-    files = [
-        f for f in glob(os.path.join(CONF_DIR, "config*.json"))
-        if os.path.basename(f) not in {"access.json"}
-    ]
+    files = [f for f in glob(os.path.join(CONF_DIR, "config*.json")) if os.path.basename(f) not in {"access.json"}]
     assert files, "No config files found matching pattern config*.json"
     return files
 
+
 @pytest.mark.parametrize("key", sorted(REQUIRED_CONFIG_KEYS))
 def test_config_files_have_required_keys(config_files, key):
     for path in config_files:
         data = load_json(path)
         assert key in data, f"Config {path} missing key: {key}"
 
+
 def test_access_json_structure():
     path = os.path.join(CONF_DIR, "access.json")
     data = load_json(path)
@@ -56,6 +58,7 @@ def test_access_json_structure():
         assert isinstance(users, list), f"Topic {topic} value must be a list of users"
         assert all(isinstance(u, str) for u in users), f"All users for topic {topic} must be strings"
 
+
 @pytest.mark.parametrize("topic_file", glob(os.path.join(CONF_DIR, "topic_*.json")))
 def test_topic_json_schemas_basic(topic_file):
     assert topic_file, "No topic_*.json files found"