[MPT-16794] - Fix bug in calculating previous year. Add check for future billing month/year

Author: antoniodimariano

ffc/billing/process_billing.py

@@ -78,7 +78,7 @@ async def process_billing(
     """
     product_id = settings.MPT_PRODUCTS_IDS[0]
     mpt_client = MPTAsyncClient()
-
+    # print(f"Processing Date: {year}-{month}".format(year=year, month=month))
     if authorization_id:
         authorization = await mpt_client.fetch_authorization(authorization_id)
         processor = AuthorizationProcessor(year, month, authorization, dry_run)

ffc/management/commands/process_billing.py

@@ -11,48 +11,64 @@
 
 
 class Command(BaseCommand):
-    help = "Synchronize agreements on anniversary."
+    help = "Generate billing files for a given period."
 
     def add_arguments(self, parser):  # pragma no cover
+        previous_month = date.today() - relativedelta(months=1)
         parser.add_argument(
             "--dry-run",
             action="store_true",
             default=False,
-            help="Test generation of billing files without making changes",
+            help="Test generation of billing files without making changes.",
         )
 
         parser.add_argument(
             "--authorization",
-            help="Generate billing file for given authorization",
+            help="Generate billing file for given authorization.",
         )
         parser.add_argument(
             "--year",
             type=int,
-            default=date.today().year,
-            help="Year for billing period",
+            default=previous_month.year,
+            help=f"Year for billing period. Default to {previous_month.year}",
         )
         parser.add_argument(
             "--month",
             type=int,
-            default=(date.today() - relativedelta(months=1)).month,
-            help="Year for billing period",
+            default=previous_month.month,
+            help=f"Month for billing period. Default to {previous_month.month}.",
         )
         parser.add_argument(
             "--cutoff-day",
             type=int,
             default=5,
-            help="The cutoff day to run the process for.",
+            help="The cutoff day to run the process for. Default is the 5th",
         )
 
     def handle(self, *args, **options):
         cutoff_day = options["cutoff_day"]
-        if cutoff_day not in range(1, 29):
-            self.stderr.write(self.style.ERROR("cutoff-day must be between 1 and 28 (inclusive)"))
+        billing_month = options["month"]
+        billing_year = options["year"]
+        today = date.today()
+
+        if not (1 <= cutoff_day <= 28):
+            self.stderr.write(
+                self.style.ERROR("The cutoff-day must be between 1 and 28 (inclusive)")
+            )
+            sys.exit(1)
+
+        if not (1 <= billing_month <= 12):
+            self.stderr.write(
+                self.style.ERROR("The billing month must be between 1 and 12 (inclusive)")
+            )
+            sys.exit(1)
+        if (billing_year, billing_month) > (today.year, today.month):
+            self.stderr.write(self.style.ERROR("The billing period cannot be in the future"))
             sys.exit(1)
         asyncio.run(
             process_billing(
-                options["year"],
-                options["month"],
+                billing_year,
+                billing_month,
                 authorization_id=options.get("authorization"),
                 dry_run=options["dry_run"],
                 cutoff_day=cutoff_day,

tests/ffc/test_process_billing.py

@@ -1441,41 +1441,115 @@ def test_get_trial_days_full_month(billing_process_instance):
 # # -----------------------------------------------------------------------------------
 # # - Test command
 @pytest.mark.parametrize(
-    "opts",
+    ("opts", "not_allowed", "error_message"),
     [
-        {
-            "year": 2025,
-            "month": 8,
-            "dry_run": True,
-            "cutoff_day": 1,
-        },
-        {
-            "year": 2024,
-            "month": 12,
-            "dry_run": False,
-            "authorization": "AUTH123",
-            "cutoff_day": 1,
-        },
+        (
+            {"year": 2025, "month": 8, "dry_run": True, "cutoff_day": 1},
+            False,
+            None,
+        ),
+        (
+            {
+                "year": 2024,
+                "month": 12,
+                "dry_run": False,
+                "authorization": "AUTH123",
+                "cutoff_day": 1,
+            },
+            False,
+            None,
+        ),
+        (
+            {
+                "year": date.today().year + 1,
+                "month": 1,
+                "dry_run": True,
+                "cutoff_day": 5,
+            },
+            True,
+            "The billing period cannot be in the future",
+        ),
+        (
+            {
+                "dry_run": True,
+            },
+            False,
+            None,
+        ),
+        (
+            {
+                "year": date.today().year,
+                "dry_run": True,
+                "cutoff_day": 5,
+            },
+            True,
+            "The billing period cannot be in the future",
+        ),
+        (
+            {
+                "month": max(1, date.today().month - 1),
+                "dry_run": True,
+                "cutoff_day": 5,
+            },
+            False,
+            None,
+        ),
+        (
+            {
+                "month": 20,
+                "dry_run": True,
+            },
+            True,
+            "The billing month must be between 1 and 12 (inclusive)",
+        ),
+        (
+            {
+                "cutoff_day": 100,
+                "dry_run": True,
+            },
+            True,
+            "The cutoff-day must be between 1 and 28 (inclusive)",
+        ),
     ],
 )
-def test_handle_run_command(mocker, opts):
-    fake_coro_obj = object()
-    process_billing_mock = Mock(return_value=fake_coro_obj)
-    asyncio_run_mock = Mock()
-
-    mocker.patch("ffc.management.commands.process_billing.process_billing", process_billing_mock)
-    mocker.patch("ffc.management.commands.process_billing.asyncio.run", asyncio_run_mock)
-    call_command("process_billing", **opts)
-    expected_auth = opts.get("authorization")
-    process_billing_mock.assert_called_once_with(
-        opts["year"],
-        opts["month"],
-        authorization_id=expected_auth,
-        dry_run=opts["dry_run"],
-        cutoff_day=opts["cutoff_day"],
+def test_process_billing_command(mocker, opts, not_allowed, error_message, capsys):
+    fake_coro = object()
+    mock_process_billing = Mock(return_value=fake_coro)
+    mock_asyncio_run = Mock()
+
+    mocker.patch(
+        "ffc.management.commands.process_billing.process_billing",
+        mock_process_billing,
+    )
+    mocker.patch(
+        "ffc.management.commands.process_billing.asyncio.run",
+        mock_asyncio_run,
     )
 
-    asyncio_run_mock.assert_called_once_with(fake_coro_obj)
+    if not_allowed:
+        with pytest.raises(SystemExit) as excinfo:
+            call_command("process_billing", **opts)
+
+        assert excinfo.value.code == 1
+
+        captured = capsys.readouterr()
+        assert error_message in captured.err
+
+        mock_process_billing.assert_not_called()
+        mock_asyncio_run.assert_not_called()
+    else:
+        call_command("process_billing", **opts)
+        if "year" in opts and "month" in opts:
+            mock_process_billing.assert_called_once_with(
+                opts["year"],
+                opts["month"],
+                authorization_id=opts.get("authorization"),
+                dry_run=opts["dry_run"],
+                cutoff_day=opts["cutoff_day"],
+            )
+        else:
+            mock_process_billing.assert_called_once()
+        mock_asyncio_run.assert_called_once_with(fake_coro)
 
 
 # # -----------------------------------------------------------------------------------