Catch export DB error + other fixes

rh-pre-commit.version: 2.3.2
rh-pre-commit.check-secrets: ENABLED

api/host_query_db.py

@@ -10,6 +10,7 @@
 from sqlalchemy import func
 from sqlalchemy import select
 from sqlalchemy.exc import MultipleResultsFound
+from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.orm import Query
 from sqlalchemy.orm import load_only
 from sqlalchemy.sql.expression import ColumnElement
@@ -629,7 +630,10 @@ def get_hosts_to_export(
     num_hosts = db.session.scalar(num_hosts_query)
     logger.debug(f"Number of hosts to be exported: {num_hosts}")
 
-    for host in db.session.scalars(export_host_query):
-        yield serialize_host_for_export_svc(host, staleness_timestamps=st_timestamps, staleness=staleness)
+    try:
+        for host in db.session.scalars(export_host_query):
+            yield serialize_host_for_export_svc(host, staleness_timestamps=st_timestamps, staleness=staleness)
+    except SQLAlchemyError as e:  # Most likely ObjectDeletedError, but catching all DB errors
+        raise InventoryException(title="DB Error", detail=str(e)) from e
 
     db.session.close()

app/exceptions.py

@@ -1,11 +1,21 @@
+# mypy: disallow-untyped-defs
+
+from __future__ import annotations
+
+
 class InventoryException(Exception):
-    def __init__(self, status=400, title=None, detail=None, type="about:blank"):
+    def __init__(
+        self, status: int = 400, title: str | None = None, detail: str | None = None, type: str = "about:blank"
+    ):
         self.status = status
         self.title = title
         self.detail = detail
         self.type = type
 
-    def to_json(self):
+    def __str__(self) -> str:
+        return str(self.to_json())
+
+    def to_json(self) -> dict[str, str | int | None]:
         return {
             "detail": self.detail,
             "status": self.status,
@@ -15,10 +25,10 @@ def to_json(self):
 
 
 class InputFormatException(InventoryException):
-    def __init__(self, detail):
+    def __init__(self, detail: str):
         InventoryException.__init__(self, title="Bad Request", detail=detail)
 
 
 class ValidationException(InventoryException):
-    def __init__(self, detail):
+    def __init__(self, detail: str):
         InventoryException.__init__(self, title="Validation Error", detail=detail)

app/queue/export_service.py

@@ -180,15 +180,15 @@ def _handle_export_error(
     response = session.post(
         url=request_url,
         headers=request_headers,
-        data=json.dumps({"message": str(error_message), "error": status_code}),
+        data=json.dumps({"message": error_message, "error": status_code}),
     )
     _handle_export_response(response, exportUUID, exportFormat)
 
 
 # This function is used by create_export, needs improvement
 def _handle_export_response(response: Response, exportUUID: UUID, exportFormat: str):
     if response.status_code != HTTPStatus.ACCEPTED:
-        raise InventoryException(response.text)
+        raise InventoryException(detail=response.text)
     elif response.text != "":
         logger.info(f"{response.text} for export ID {str(exportUUID)} in {exportFormat.upper()} format")
 

tests/test_export_service.py

@@ -6,6 +6,7 @@
 
 import pytest
 from marshmallow.exceptions import ValidationError
+from sqlalchemy.orm.exc import ObjectDeletedError
 
 from api.staleness_query import get_sys_default_staleness
 from app.auth.identity import Identity
@@ -221,3 +222,15 @@ def test_export_one_host(flask_app, db_create_host, inventory_config):
         host_list = get_host_list(identity=identity, rbac_filter=None, inventory_config=inventory_config)
 
         assert len(host_list) == 1
+
+
+@mock.patch("api.host_query_db.db.session.scalars", side_effect=ObjectDeletedError(None))
+def test_export_catches_db_error(flask_app, inventory_config, mocker):
+    with flask_app.app.app_context():
+        handle_export_error_mock = mocker.patch("app.queue.export_service._handle_export_error")
+
+        validated_msg = parse_export_service_message(es_utils.create_export_message_mock())
+        base64_x_rh_identity = validated_msg["data"]["resource_request"]["x_rh_identity"]
+
+        create_export(validated_msg, base64_x_rh_identity, inventory_config)
+        handle_export_error_mock.assert_called_once()

tests/test_host_mq_service.py

@@ -552,10 +552,10 @@ def test_add_host_with_wrong_owner(mocker, mq_create_or_update_host):
     )
 
     with pytest.raises(ValidationException) as ve:
-        key, event, headers = mq_create_or_update_host(
+        mq_create_or_update_host(
             host, return_all_data=True, notification_event_producer=mock_notification_event_producer
         )
-    assert str(ve.value) == "The owner in host does not match the owner in identity"
+    assert ve.value.detail == "The owner in host does not match the owner in identity"
     mock_notification_event_producer.write_event.assert_called_once()
 
 
@@ -1618,7 +1618,7 @@ def test_owner_id_different_from_cn(mocker):
 
     with pytest.raises(ValidationException) as ve:
         handle_message(json.dumps(message), mock_notification_event_producer)
-    assert str(ve.value) == "The owner in host does not match the owner in identity"
+    assert ve.value.detail == "The owner in host does not match the owner in identity"
     mock_notification_event_producer.write_event.assert_called_once()