chore: add vitests

chore: cleanup

chore: cleanup

chore: cleanup

chore: cleanup

chore: cleanup

Author: shon-button

bc_obps/registration/tests/endpoints/_operations/test_reportable.py

@@ -2,6 +2,7 @@
 from registration.models import Operation
 from registration.tests.utils.helpers import CommonTestSetup, TestUtils
 from registration.utils import custom_reverse_lazy
+from model_bakery.baker import make_recipe
 
 
 class TestOperationsPreviousReportableEndpoint(CommonTestSetup):
@@ -10,27 +11,40 @@ def test_list_previous_reportable_operations(
         self,
         mock_list_previous_reportable_operations,
     ):
-        # Arrange: Mock service data
+        approved_user_operator = make_recipe(
+            "registration.tests.utils.approved_user_operator",
+            user=self.user,
+        )
+
+        operation = make_recipe(
+            "registration.tests.utils.operation",
+            operator=approved_user_operator.operator,
+        )
+
         mock_list_previous_reportable_operations.return_value = [
             {
-                "operation_id": "123",
-                "operation_name": "Test Operation",
+                "operation_id": operation.id,
+                "operation_name": operation.name,
                 "reporting_year": 2023,
                 "registration_purposes": [
                     Operation.Purposes.REPORTING_OPERATION,
                 ],
             }
         ]
 
-        # Act: Authorize user and perform GET request
         response = TestUtils.mock_get_with_auth_role(
             self,
             "industry_user",
             custom_reverse_lazy("list_previous_reportable_operations"),
         )
 
-        # Assert: Verify the response status
         assert response.status_code == 200
+        assert len(response.json()) == 1
+        assert response.json()[0].get("operation_name") == operation.name
+        assert response.json()[0].get("operation_id") == str(operation.id)
+        assert response.json()[0].get("reporting_year") == 2023
+        assert response.json()[0].get("registration_purposes") == [
+            Operation.Purposes.REPORTING_OPERATION,
+        ]
 
-        # Assert: Verify the service was called
         mock_list_previous_reportable_operations.assert_called_once()

bc_obps/service/operation_service.py

@@ -54,13 +54,17 @@
 from reporting.models.reporting_year import ReportingYear
 from service.reporting_year_service import ReportingYearService
 from django.conf import settings
-from service.operation_designated_operator_timeline_service import OperationDesignatedOperatorTimelineService
+from service.operation_designated_operator_timeline_service import (
+    OperationDesignatedOperatorTimelinePlus,
+    OperationDesignatedOperatorTimelineService,
+)
 from reporting.models.report import Report
 
 
 class OperationService:
 
     OPERATION_DEFAULT_START_DATE = datetime(2024, 1, 1, tzinfo=ZoneInfo("America/Vancouver"))
+    MIN_REPORTING_YEAR = 2024
 
     @classmethod
     def get_if_authorized(
@@ -755,6 +759,7 @@ def handle_change_of_registration_purpose(
 
         return payload
 
+    # list previous reportable operations methods:
     @staticmethod
     def get_valid_operation_regulated_products(operation: Operation, reporting_year: int) -> QuerySet[RegulatedProduct]:
         """
@@ -772,19 +777,31 @@ def _is_reportable_operation_year(
     ) -> bool:
         return operation_year not in added_operation_years and operation_year not in existing_reports
 
+    @classmethod
+    def _is_designated_to_user_operator(
+        cls,
+        designated_operator_timeline: OperationDesignatedOperatorTimelinePlus | None,
+        user_operator: UserOperator,
+    ) -> bool:
+        return (
+            designated_operator_timeline is not None
+            and designated_operator_timeline.operator.id == user_operator.operator_id
+        )
+
     @classmethod
     def _get_previous_reporting_years(cls) -> QuerySet[ReportingYear]:
         """
         Returns reporting years that are eligible for the Start Past Report workflow
 
-        Only reporting years prior to the current reporting year are returned
+        Only reporting years from MIN_REPORTING_YEAR up to (but not including) the current
+        reporting year are returned.
         """
-
         current_reporting_year = ReportingYearService.get_current_reporting_year()
 
-        return ReportingYear.objects.filter(reporting_year__lt=current_reporting_year.reporting_year).order_by(
-            "-reporting_year"
-        )
+        return ReportingYear.objects.filter(
+            reporting_year__gte=cls.MIN_REPORTING_YEAR,
+            reporting_year__lt=current_reporting_year.reporting_year,
+        ).order_by("-reporting_year")
 
     @staticmethod
     def _get_registration_purposes_for_operation_type(
@@ -812,6 +829,29 @@ def _get_registration_purposes_for_operation_type(
 
         raise ValueError(f"Unsupported operation type: {operation_type}")
 
+    @classmethod
+    def _add_reportable_operation(
+        cls,
+        reportable_operations: list[dict],
+        added_operation_years: set[tuple[UUID, int]],
+        operation: Operation,
+        reporting_year: ReportingYear,
+        is_current_registered_fallback: bool,
+    ) -> None:
+        """
+        Adds a reportable operation/reporting year combination to the result set
+        and tracks it to prevent duplicates.
+        """
+        operation_year = (operation.id, reporting_year.reporting_year)
+
+        reportable_operations.append(
+            {
+                **cls._build_reportable_operation_row(operation, reporting_year),
+                "is_current_registered_fallback": is_current_registered_fallback,
+            }
+        )
+        added_operation_years.add(operation_year)
+
     @classmethod
     def _build_reportable_operation_row(
         cls,
@@ -897,6 +937,7 @@ def list_previous_reportable_operations(
                     reporting_year.reporting_year,
                 )
 
+                # Skip combinations that have already have a report
                 if not cls._is_reportable_operation_year(
                     operation_year,
                     added_operation_years,
@@ -906,46 +947,41 @@ def list_previous_reportable_operations(
 
                 designated_operator_timeline = designations_lookup.get(operation_year)
 
-                if (
-                    designated_operator_timeline
-                    and designated_operator_timeline.operator.id == user_operator.operator_id
+                # Include operations designated to the user's operator for the reporting year
+                if cls._is_designated_to_user_operator(
+                    designated_operator_timeline,
+                    user_operator,
                 ):
-                    reportable_operations.append(
-                        {
-                            **cls._build_reportable_operation_row(
-                                timeline.operation,
-                                reporting_year,
-                            ),
-                            "is_current_registered_fallback": False,
-                        }
+                    cls._add_reportable_operation(
+                        reportable_operations,
+                        added_operation_years,
+                        timeline.operation,
+                        reporting_year,
+                        False,
                     )
 
-                    added_operation_years.add(operation_year)
-
         for operation in current_registered_operations:
             for reporting_year in reporting_years:
                 operation_year = (
                     operation.id,
                     reporting_year.reporting_year,
                 )
 
+                # Skip combinations that have already have a report
                 if not cls._is_reportable_operation_year(
                     operation_year,
                     added_operation_years,
                     existing_reports,
                 ):
                     continue
 
-                reportable_operations.append(
-                    {
-                        **cls._build_reportable_operation_row(
-                            operation,
-                            reporting_year,
-                        ),
-                        "is_current_registered_fallback": True,
-                    }
+                # Fall back to the current registered operator when no historical designation applies
+                cls._add_reportable_operation(
+                    reportable_operations,
+                    added_operation_years,
+                    operation,
+                    reporting_year,
+                    True,
                 )
 
-                added_operation_years.add(operation_year)
-
         return reportable_operations

bc_obps/service/report_service.py

@@ -114,7 +114,11 @@ def create_report_for_reporting_year(
             # allow report creation only if the authenticated user's operator was
             # the designated operator for the selected reporting year
             if designated_operator_timeline.operator.id != user_operator.operator_id:
-                raise UserError("You are not authorized to create a report for this operation and reporting year.")
+                raise UserError(
+                    f"This operation was owned by another operation in {reporting_year}, "
+                    "you do not need to report on this operation. "
+                    "If you believe this is incorrect, please contact ghgregulator@gov.bc.ca."
+                )
 
             operator = designated_operator_timeline.operator
             use_transferred_operation_handling = designated_operator_timeline.has_been_transferred
@@ -124,7 +128,11 @@ def create_report_for_reporting_year(
             # no historical designation exists for the selected reporting year
             # allow creation only if the operation is currently registered to the authenticated user's operator
             if operation.operator_id != user_operator.operator_id:
-                raise UserError("You are not authorized to create a report for this operation and reporting year.")
+                raise UserError(
+                    f"This operation was owned by another operation in {reporting_year}, "
+                    "you do not need to report on this operation. "
+                    "If you believe this is incorrect, please contact ghgregulator@gov.bc.ca."
+                )
 
             if operation.status != Operation.Statuses.REGISTERED:
                 raise UserError(
@@ -148,7 +156,9 @@ def create_report_for_reporting_year(
         ]
 
         if requires_boro_id and operation.bc_obps_regulated_operation_id is None:
-            raise UserError("Regulated operations must have a BORO ID before a report can be created.")
+            raise UserError(
+                "This operation does not have a BORO ID, please wait for a BORO ID to be issued before starting this report."
+            )
 
         report = Report.objects.create(
             operation=operation,