140 validation metadata

src/sbl_filing_api/entities/models/dao.py

@@ -32,7 +32,7 @@ class SubmissionDAO(Base):
     accepter: Mapped[UserActionDAO] = relationship(lazy="selectin", foreign_keys=[accepter_id])
     state: Mapped[SubmissionState] = mapped_column(SAEnum(SubmissionState))
     validation_ruleset_version: Mapped[str] = mapped_column(nullable=True)
-    validation_json: Mapped[List[dict[str, Any]]] = mapped_column(JSON, nullable=True)
+    validation_json: Mapped[dict[str, Any]] = mapped_column(JSON, nullable=True)
     submission_time: Mapped[datetime] = mapped_column(server_default=func.now())
     filename: Mapped[str]
 

src/sbl_filing_api/entities/models/dto.py

@@ -19,7 +19,7 @@ class SubmissionDTO(BaseModel):
     id: int | None = None
     state: SubmissionState | None = None
     validation_ruleset_version: str | None = None
-    validation_json: List[Dict[str, Any]] | None = None
+    validation_json: Dict[str, Any] | None = None
     submission_time: datetime | None = None
     filename: str
     submitter: UserActionDTO

src/sbl_filing_api/services/submission_processor.py

@@ -3,7 +3,7 @@
 
 from io import BytesIO
 from fastapi import UploadFile
-from regtech_data_validator.create_schemas import validate_phases
+from regtech_data_validator.create_schemas import validate_phases, ValidationPhase
 from regtech_data_validator.data_formatters import df_to_json, df_to_download
 from regtech_data_validator.checks import Severity
 import pandas as pd
@@ -101,7 +101,7 @@ async def validate_and_update_submission(period_code: str, lei: str, submission:
             )
         else:
             submission.state = SubmissionState.VALIDATION_SUCCESSFUL
-        submission.validation_json = json.loads(df_to_json(result[1]))
+        submission.validation_json = build_validation_results(result)
         submission_report = df_to_download(result[1])
         await upload_to_storage(
             period_code, lei, str(submission.id) + REPORT_QUALIFIER, submission_report.encode("utf-8")
@@ -112,7 +112,6 @@ async def validate_and_update_submission(period_code: str, lei: str, submission:
         log.error("The file is malformed", re, exc_info=True, stack_info=True)
         submission.state = SubmissionState.SUBMISSION_UPLOAD_MALFORMED
         await update_submission(submission)
-
     except Exception as e:
         log.error(
             f"Validation for submission {submission.id} did not complete due to an unexpected error.",
@@ -122,3 +121,27 @@ async def validate_and_update_submission(period_code: str, lei: str, submission:
         )
         submission.state = SubmissionState.VALIDATION_ERROR
         await update_submission(submission)
+
+
+def build_validation_results(result):
+    val_json = json.loads(df_to_json(result[1]))
+    val_res = {}
+
+    if result[2] == ValidationPhase.SYNTACTICAL.value:
+        val_res["syntax_errors"]["details"] = val_json
+        val_res["syntax_errors"]["count"] = len(val_res["syntax_errors"]["details"])
+    else:
+        val_res = {
+            "syntax_errors": {"count": 0, "details": []},
+            "logic_errors": {"count": 0, "details": []},
+            "logic_warnings": {"count": 0, "details": []},
+        }
+        for v in val_json:
+            if v["validation"]["severity"] == Severity.WARNING.value:
+                val_res["logic_warnings"]["details"].append(v)
+            elif v["validation"]["severity"] == Severity.ERROR.value:
+                val_res["logic_errors"]["details"].append(v)
+        val_res["logic_warnings"]["count"] = len(val_res["logic_warnings"]["details"])
+        val_res["logic_errors"]["count"] = len(val_res["logic_errors"]["details"])
+
+    return val_res

tests/services/conftest.py

@@ -47,9 +47,99 @@ def warning_submission_mock(mocker: MockerFixture, validate_submission_mock: Moc
 
 
 @pytest.fixture(scope="function")
-def df_to_json_mock(mocker: MockerFixture, validate_submission_mock: Mock):
-    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.df_to_json")
-    mock_json_formatting.return_value = "[{}]"
+def validation_success_mock(mocker: MockerFixture, validate_submission_mock: Mock):
+    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.build_validation_results")
+    mock_json_formatting.return_value = """
+        {
+        "syntax_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_warnings": {
+            "count": 0,
+            "details": []
+        }
+    }"""
+    return mock_json_formatting
+
+
+@pytest.fixture(scope="function")
+def validation_syntax_errors_mock(mocker: MockerFixture, validate_submission_mock: Mock):
+    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.build_validation_results")
+    mock_json_formatting.return_value = """
+        {
+        "syntax_errors": {
+            "count": 2,
+            "details": []
+        }
+    }"""
+    return mock_json_formatting
+
+
+@pytest.fixture(scope="function")
+def validation_logic_warnings_mock(mocker: MockerFixture, validate_submission_mock: Mock):
+    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.build_validation_results")
+    mock_json_formatting.return_value = """
+        {
+        "syntax_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_warnings": {
+            "count": 1,
+            "details": []
+        }
+    }"""
+    return mock_json_formatting
+
+
+@pytest.fixture(scope="function")
+def validation_logic_errors_mock(mocker: MockerFixture, validate_submission_mock: Mock):
+    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.build_validation_results")
+    mock_json_formatting.return_value = """
+        {
+        "syntax_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_errors": {
+            "count": 4,
+            "details": []
+        },
+        "logic_warnings": {
+            "count": 0,
+            "details": []
+        }
+    }"""
+    return mock_json_formatting
+
+
+@pytest.fixture(scope="function")
+def validation_logic_warnings_and_errors_mock(mocker: MockerFixture, validate_submission_mock: Mock):
+    mock_json_formatting = mocker.patch("sbl_filing_api.services.submission_processor.build_validation_results")
+    mock_json_formatting.return_value = """
+        {
+        "syntax_errors": {
+            "count": 0,
+            "details": []
+        },
+        "logic_errors": {
+            "count": 3,
+            "details": []
+        },
+        "logic_warnings": {
+            "count": 2,
+            "details": []
+        }
+    }"""
     return mock_json_formatting
 
 

tests/services/test_submission_processor.py

@@ -1,4 +1,6 @@
 import asyncio
+import json
+
 import pytest
 
 from http import HTTPStatus
@@ -107,7 +109,11 @@ def test_file_not_supported_file_size_too_large(self, mock_upload_file: Mock):
         assert e.value.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE
 
     async def test_validate_and_update_successful(
-        self, mocker: MockerFixture, successful_submission_mock: Mock, df_to_json_mock: Mock, df_to_download_mock: Mock
+        self,
+        mocker: MockerFixture,
+        successful_submission_mock: Mock,
+        validation_success_mock: Mock,
+        df_to_download_mock: Mock,
     ):
         mock_sub = SubmissionDAO(
             id=1,
@@ -126,12 +132,20 @@ async def test_validate_and_update_successful(
             "1" + submission_processor.REPORT_QUALIFIER,
             encoded_results,
         )
+        json_results = json.loads(successful_submission_mock.mock_calls[1].args[0].validation_json)
         assert successful_submission_mock.mock_calls[0].args[0].state == SubmissionState.VALIDATION_IN_PROGRESS
         assert successful_submission_mock.mock_calls[0].args[0].validation_ruleset_version == "0.1.0"
         assert successful_submission_mock.mock_calls[1].args[0].state == "VALIDATION_SUCCESSFUL"
+        assert json_results["syntax_errors"]["count"] == 0
+        assert json_results["logic_errors"]["count"] == 0
+        assert json_results["logic_warnings"]["count"] == 0
 
-    async def test_validate_and_update_warnings(
-        self, mocker: MockerFixture, warning_submission_mock: Mock, df_to_json_mock: Mock, df_to_download_mock: Mock
+    async def test_validate_and_update_logic_warnings(
+        self,
+        mocker: MockerFixture,
+        warning_submission_mock: Mock,
+        validation_logic_warnings_mock: Mock,
+        df_to_download_mock: Mock,
     ):
         mock_sub = SubmissionDAO(
             id=1,
@@ -149,12 +163,82 @@ async def test_validate_and_update_warnings(
             "1" + submission_processor.REPORT_QUALIFIER,
             encoded_results,
         )
+        json_results = json.loads(warning_submission_mock.mock_calls[1].args[0].validation_json)
         assert warning_submission_mock.mock_calls[0].args[0].state == SubmissionState.VALIDATION_IN_PROGRESS
         assert warning_submission_mock.mock_calls[0].args[0].validation_ruleset_version == "0.1.0"
         assert warning_submission_mock.mock_calls[1].args[0].state == "VALIDATION_WITH_WARNINGS"
+        assert json_results["syntax_errors"]["count"] == 0
+        assert json_results["logic_errors"]["count"] == 0
+        assert json_results["logic_warnings"]["count"] > 0
+
+    async def test_validate_and_update_syntax_errors(
+        self,
+        mocker: MockerFixture,
+        error_submission_mock: Mock,
+        validation_syntax_errors_mock: Mock,
+        df_to_download_mock: Mock,
+    ):
+        mock_sub = SubmissionDAO(
+            id=1,
+            filing=1,
+            state=SubmissionState.SUBMISSION_UPLOADED,
+            filename="submission.csv",
+        )
+
+        file_mock = mocker.patch("sbl_filing_api.services.submission_processor.upload_to_storage")
 
-    async def test_validate_and_update_errors(
-        self, mocker: MockerFixture, error_submission_mock: Mock, df_to_json_mock: Mock, df_to_download_mock: Mock
+        await submission_processor.validate_and_update_submission("2024", "123456790", mock_sub, None)
+        encoded_results = df_to_download_mock.return_value.encode("utf-8")
+        assert file_mock.mock_calls[0].args == (
+            "2024",
+            "123456790",
+            "1" + submission_processor.REPORT_QUALIFIER,
+            encoded_results,
+        )
+        json_results = json.loads(error_submission_mock.mock_calls[1].args[0].validation_json)
+        assert error_submission_mock.mock_calls[0].args[0].state == SubmissionState.VALIDATION_IN_PROGRESS
+        assert error_submission_mock.mock_calls[0].args[0].validation_ruleset_version == "0.1.0"
+        assert error_submission_mock.mock_calls[1].args[0].state == "VALIDATION_WITH_ERRORS"
+        assert json_results["syntax_errors"]["count"] > 0
+
+    async def test_validate_and_update_logic_errors(
+        self,
+        mocker: MockerFixture,
+        error_submission_mock: Mock,
+        validation_logic_errors_mock: Mock,
+        df_to_download_mock: Mock,
+    ):
+        mock_sub = SubmissionDAO(
+            id=1,
+            filing=1,
+            state=SubmissionState.SUBMISSION_UPLOADED,
+            filename="submission.csv",
+        )
+
+        file_mock = mocker.patch("sbl_filing_api.services.submission_processor.upload_to_storage")
+
+        await submission_processor.validate_and_update_submission("2024", "123456790", mock_sub, None)
+        encoded_results = df_to_download_mock.return_value.encode("utf-8")
+        assert file_mock.mock_calls[0].args == (
+            "2024",
+            "123456790",
+            "1" + submission_processor.REPORT_QUALIFIER,
+            encoded_results,
+        )
+        json_results = json.loads(error_submission_mock.mock_calls[1].args[0].validation_json)
+        assert error_submission_mock.mock_calls[0].args[0].state == SubmissionState.VALIDATION_IN_PROGRESS
+        assert error_submission_mock.mock_calls[0].args[0].validation_ruleset_version == "0.1.0"
+        assert error_submission_mock.mock_calls[1].args[0].state == "VALIDATION_WITH_ERRORS"
+        assert json_results["syntax_errors"]["count"] == 0
+        assert json_results["logic_errors"]["count"] > 0
+        assert json_results["logic_warnings"]["count"] == 0
+
+    async def test_validate_and_update_logic_warnings_and_errors(
+        self,
+        mocker: MockerFixture,
+        error_submission_mock: Mock,
+        validation_logic_warnings_and_errors_mock: Mock,
+        df_to_download_mock: Mock,
     ):
         mock_sub = SubmissionDAO(
             id=1,
@@ -173,9 +257,13 @@ async def test_validate_and_update_errors(
             "1" + submission_processor.REPORT_QUALIFIER,
             encoded_results,
         )
+        json_results = json.loads(error_submission_mock.mock_calls[1].args[0].validation_json)
         assert error_submission_mock.mock_calls[0].args[0].state == SubmissionState.VALIDATION_IN_PROGRESS
         assert error_submission_mock.mock_calls[0].args[0].validation_ruleset_version == "0.1.0"
         assert error_submission_mock.mock_calls[1].args[0].state == "VALIDATION_WITH_ERRORS"
+        assert json_results["syntax_errors"]["count"] == 0
+        assert json_results["logic_errors"]["count"] > 0
+        assert json_results["logic_warnings"]["count"] > 0
 
     async def test_validate_and_update_submission_malformed(
         self,