feat: Add Export and Template for FSE

backend/lcfs/conftest.py

@@ -1,6 +1,7 @@
-import structlog
 import warnings
 
+import structlog
+
 # Suppress the PendingDeprecationWarning for multipart
 warnings.filterwarnings(
     "ignore",
@@ -13,13 +14,11 @@
 
 import pytest
 from fakeredis import FakeServer, aioredis
-from fakeredis.aioredis import FakeConnection
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi_cache import FastAPICache
 from fastapi_cache.backends.redis import RedisBackend
 from httpx import AsyncClient
-from redis.asyncio import ConnectionPool
 from sqlalchemy.ext.asyncio import (
     AsyncEngine,
     AsyncSession,

backend/lcfs/tests/final_supply_equipment/test_final_supply_equipment_export.py

@@ -0,0 +1,112 @@
+from datetime import datetime
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from docutils.nodes import description
+from starlette.responses import StreamingResponse
+
+from lcfs.db.models import Organization
+from lcfs.db.models.user.Role import RoleEnum
+from lcfs.utils.constants import FILE_MEDIA_TYPE
+from lcfs.web.api.final_supply_equipment.export import FinalSupplyEquipmentExporter
+from lcfs.web.exception.exceptions import DataNotFoundException
+
+
+@pytest.fixture
+def exporter(repo_mock, compliance_report_services_mock):
+    return FinalSupplyEquipmentExporter(
+        repo=repo_mock, compliance_report_services=compliance_report_services_mock
+    )
+
+
+@pytest.fixture
+def repo_mock():
+    with patch(
+        "lcfs.web.api.final_supply_equipment.export.FinalSupplyEquipmentRepository"
+    ) as mock:
+        mock_instance = mock.return_value
+        mock_instance.get_fse_options = AsyncMock(
+            return_value=[
+                [],
+                [],
+                [],
+                ["Port1", "Port2"],
+                ["Org1", "Org2"],
+            ]
+        )
+        mock_instance.get_fse_paginated = AsyncMock(return_value=([],))
+        return mock_instance
+
+
+@pytest.fixture
+def compliance_report_services_mock():
+    with patch(
+        "lcfs.web.api.final_supply_equipment.export.ComplianceReportServices"
+    ) as mock:
+        mock_instance = mock.return_value
+        mock_instance.get_compliance_report_by_id = AsyncMock(
+            return_value=AsyncMock(
+                compliance_period=AsyncMock(
+                    description="2023",
+                    effective_date=datetime(2023, 1, 1),
+                    expiration_date=datetime(2023, 12, 31),
+                )
+            )
+        )
+        return mock_instance
+
+
+@pytest.mark.anyio
+async def test_export_success(
+    exporter, fastapi_app, client, set_mock_user, compliance_report_services_mock
+):
+    set_mock_user(fastapi_app, [RoleEnum.SUPPLIER])
+    response = await exporter.export(
+        compliance_report_id=1,
+        organization=Organization(name="TestOrg"),
+        include_data=True,
+    )
+    assert isinstance(response, StreamingResponse)
+    assert response.status_code == 200
+    assert (
+        response.headers["Content-Disposition"]
+        == 'attachment; filename="FSE_TestOrg-2023.xlsx"'
+    )
+    assert response.media_type == FILE_MEDIA_TYPE["XLSX"].value
+
+
+@pytest.mark.anyio
+async def test_export_no_data(
+    exporter, fastapi_app, client, set_mock_user, compliance_report_services_mock
+):
+    exporter.repo.get_fse_paginated = AsyncMock(return_value=([],))
+    set_mock_user(fastapi_app, [RoleEnum.SUPPLIER])
+    response = await exporter.export(
+        compliance_report_id=1,
+        organization=Organization(name="TestOrg"),
+        include_data=False,
+    )
+    assert isinstance(response, StreamingResponse)
+    assert response.status_code == 200
+    assert (
+        response.headers["Content-Disposition"]
+        == 'attachment; filename="FSE_TestOrg-2023.xlsx"'
+    )
+    assert response.media_type == FILE_MEDIA_TYPE["XLSX"].value
+
+
+@pytest.mark.anyio
+async def test_export_invalid_compliance_report_id(
+    exporter, fastapi_app, client, set_mock_user
+):
+    set_mock_user(fastapi_app, [RoleEnum.SUPPLIER])
+    exporter.compliance_report_services.get_compliance_report_by_id = AsyncMock(
+        side_effect=DataNotFoundException("Report not found")
+    )
+    with pytest.raises(DataNotFoundException) as exc_info:
+        await exporter.export(
+            compliance_report_id=999,
+            organization=Organization(name="TestOrg"),
+            include_data=True,
+        )
+    assert str(exc_info.value) == "Report not found"