Merge pull request #3891 from bcgov/366-decreased-credit-handler

feat: DecreasedCreditHandler can handle all statuses except approved

Author: BCerki

bc_obps/compliance/service/supplementary_version_service.py

@@ -500,7 +500,7 @@ def can_handle(new_summary: ReportComplianceSummary, previous_summary: ReportCom
         return (
             previous_summary.credited_emissions > ZERO_DECIMAL
             and new_summary.credited_emissions < previous_summary.credited_emissions
-            and original_earned_credit_record.issuance_status == ComplianceEarnedCredit.IssuanceStatus.DECLINED
+            and original_earned_credit_record.issuance_status != ComplianceEarnedCredit.IssuanceStatus.APPROVED
         )
 
     @staticmethod
@@ -525,9 +525,21 @@ def handle(
             is_supplementary=True,
             previous_version=previous_compliance_version,
         )
-        # Create new credits record
+        # Get the previous earned_credit record
+        previous_earned_credit = ComplianceEarnedCredit.objects.get(
+            compliance_report_version=previous_compliance_version
+        )
+
         ComplianceEarnedCreditsService.create_earned_credits_record(compliance_report_version)
 
+        # If previously requested, mark it as declined
+        if previous_earned_credit.issuance_status in (
+            ComplianceEarnedCredit.IssuanceStatus.ISSUANCE_REQUESTED,
+            ComplianceEarnedCredit.IssuanceStatus.CHANGES_REQUIRED,
+        ):
+            previous_earned_credit.issuance_status = ComplianceEarnedCredit.IssuanceStatus.DECLINED
+            previous_earned_credit.save()
+
         return compliance_report_version
 
 

bc_obps/compliance/tests/service/test_supplementary_version_service.py

@@ -1640,7 +1640,15 @@ def test_handle_increased_credits_success_when_credits_not_approved(self, issuan
 
 
 class TestDecreasedCreditHandler(BaseSupplementaryVersionServiceTest):
-    def test_can_handle_decreased_credits(self):
+    @pytest.mark.parametrize(
+        "issuance_status",
+        [
+            ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            ComplianceEarnedCredit.IssuanceStatus.ISSUANCE_REQUESTED,
+            ComplianceEarnedCredit.IssuanceStatus.CHANGES_REQUIRED,
+        ],
+    )
+    def test_can_handle_decreased_credits_no_previous_approval(self, issuance_status):
         # Arrange
         with pgtrigger.ignore('reporting.ReportComplianceSummary:immutable_report_version'):
             self.previous_summary = baker.make_recipe(
@@ -1667,7 +1675,7 @@ def test_can_handle_decreased_credits(self):
             'compliance.tests.utils.compliance_earned_credit',
             compliance_report_version=self.original_report_version,
             earned_credits_amount=500,
-            issuance_status=ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            issuance_status=issuance_status,
             bccr_trading_name='Test Trading Name',
             bccr_holding_account_id='123',
         )
@@ -1678,6 +1686,52 @@ def test_can_handle_decreased_credits(self):
         # Assert
         assert result is True
 
+    def test_cannot_handle_decreased_credits_already_approved(self):
+        # Arrange
+        with pgtrigger.ignore('reporting.ReportComplianceSummary:immutable_report_version'):
+            self.previous_summary = baker.make_recipe(
+                'reporting.tests.utils.report_compliance_summary',
+                excess_emissions=0,
+                credited_emissions=Decimal('600'),
+                report_version=self.report_version_1,
+            )
+            self.new_summary = baker.make_recipe(
+                'reporting.tests.utils.report_compliance_summary',
+                excess_emissions=0,
+                credited_emissions=Decimal('500'),
+                report_version=self.report_version_2,
+            )
+        self.compliance_report = baker.make_recipe(
+            'compliance.tests.utils.compliance_report', report=self.report, compliance_period_id=1
+        )
+        self.original_report_version = baker.make_recipe(
+            'compliance.tests.utils.compliance_report_version',
+            report_compliance_summary=self.previous_summary,
+            is_supplementary=False,
+        )
+        baker.make_recipe(
+            'compliance.tests.utils.compliance_earned_credit',
+            compliance_report_version=self.original_report_version,
+            earned_credits_amount=500,
+            issuance_status=ComplianceEarnedCredit.IssuanceStatus.APPROVED,
+            bccr_trading_name='Test Trading Name',
+            bccr_holding_account_id='123',
+        )
+
+        # Act
+        result = DecreasedCreditHandler.can_handle(self.new_summary, self.previous_summary)
+
+        # Assert
+        assert result is False
+
+    @pytest.mark.parametrize(
+        "issuance_status",
+        [
+            ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            ComplianceEarnedCredit.IssuanceStatus.ISSUANCE_REQUESTED,
+            ComplianceEarnedCredit.IssuanceStatus.CHANGES_REQUIRED,
+        ],
+    )
     @patch('compliance.service.supplementary_version_service.DecreasedCreditHandler.handle')
     @patch('compliance.service.supplementary_version_service.IncreasedCreditHandler.handle')
     @patch('compliance.service.supplementary_version_service.NoChangeHandler.handle')
@@ -1690,6 +1744,7 @@ def test_correctly_calls_decreased_credit_handler(
         mock_no_change_handler,
         mock_increased_credit_handler,
         mock_decreased_credit_handler,
+        issuance_status,
     ):
         # Arrange
         with pgtrigger.ignore('reporting.ReportComplianceSummary:immutable_report_version'):
@@ -1718,7 +1773,7 @@ def test_correctly_calls_decreased_credit_handler(
             'compliance.tests.utils.compliance_earned_credit',
             compliance_report_version=self.previous_compliance_report_version,
             earned_credits_amount=800,
-            issuance_status=ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            issuance_status=issuance_status,
             bccr_trading_name='Test Trading Name',
             bccr_holding_account_id='123',
         )
@@ -1743,7 +1798,15 @@ def test_correctly_calls_decreased_credit_handler(
         mock_no_change_handler.assert_not_called()
         mock_increased_credit_handler.assert_not_called()
 
-    def test_handle_decreased_credits_success(self):
+    @pytest.mark.parametrize(
+        "issuance_status",
+        [
+            ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            ComplianceEarnedCredit.IssuanceStatus.ISSUANCE_REQUESTED,
+            ComplianceEarnedCredit.IssuanceStatus.CHANGES_REQUIRED,
+        ],
+    )
+    def test_handle_decreased_credits_success(self, issuance_status):
         # Arrange
         with pgtrigger.ignore('reporting.ReportComplianceSummary:immutable_report_version'):
             self.previous_summary = baker.make_recipe(
@@ -1767,7 +1830,7 @@ def test_handle_decreased_credits_success(self):
             'compliance.tests.utils.compliance_earned_credit',
             compliance_report_version=self.original_report_version,
             earned_credits_amount=800,
-            issuance_status=ComplianceEarnedCredit.IssuanceStatus.DECLINED,
+            issuance_status=issuance_status,
             bccr_trading_name='Test Trading Name',
             bccr_holding_account_id='123',
         )
@@ -1787,8 +1850,10 @@ def test_handle_decreased_credits_success(self):
         assert new_compliance_version.is_supplementary is True
         assert new_compliance_version.previous_version == self.original_report_version
         assert original_credit_record.earned_credits_amount == Decimal('800')
+
         assert new_credit_record.earned_credits_amount == Decimal('500')
         assert new_credit_record.issuance_status == ComplianceEarnedCredit.IssuanceStatus.CREDITS_NOT_ISSUED
+        assert original_credit_record.issuance_status == ComplianceEarnedCredit.IssuanceStatus.DECLINED
 
 
 class TestSupercededHandler(BaseSupplementaryVersionServiceTest):