Fix force_generate param and handle subs canceled before start_date

Author: bogdanpetrea

silver/documents_generator.py

@@ -56,7 +56,7 @@ def generate(self, subscription=None, billing_date=None, customers=None,
         :param customers: the customers for which one wants to generate the
             proformas/invoices.
         :param force_generate: if True, invoices are generated at the date
-            indicated by `billing_date` instead of the normal end of billing
+            indicated by `billing_date` instead of after the normal end of billing
             cycle.
 
         :note
@@ -114,7 +114,16 @@ def get_subscriptions_prepared_for_billing(self, customer, billing_date, force_g
         criteria = {'state__in': [Subscription.STATES.ACTIVE,
                                   Subscription.STATES.CANCELED]}
         for subscription in customer.subscriptions.filter(**criteria):
-            if subscription.should_be_billed(billing_date) or force_generate:
+            to_bill = subscription.should_be_billed(billing_date) or force_generate
+
+            if not to_bill and subscription.cancel_date:
+                billing_up_to_dates = subscription.billed_up_to_dates
+                to_bill = (
+                    subscription.cancel_date < billing_up_to_dates["metered_features_billed_up_to"] and
+                    subscription.cancel_date < billing_up_to_dates["plan_billed_up_to"]
+                )
+
+            if to_bill:
                 subs_to_bill.append(subscription)
 
         return subs_to_bill
@@ -135,7 +144,6 @@ def _bill_subscription_into_document(self, subscription, billing_date, document=
         })
 
         billing_log, entries_info = self.add_subscription_cycles_to_document(**kwargs)
-
         if subscription.state == Subscription.STATES.CANCELED:
             subscription.end()
             subscription.save()
@@ -382,6 +390,12 @@ def _generate_for_user_with_consolidated_billing(self, customer, billing_date, f
 
             self._create_discount_entries(**kwargs)
 
+            # TODO: Creating and then deleting the document in the DB is not ideal and this whole logic
+            #       should be refactored.
+            if not document.entries.exists():
+                document.delete()
+                continue
+
             if provider.default_document_state == Provider.DEFAULT_DOC_STATE.ISSUED:
                 document.issue()
 
@@ -405,6 +419,12 @@ def _generate_for_user_without_consolidated_billing(self, customer, billing_date
 
             self._create_discount_entries(**kwargs)
 
+            # TODO: Creating and then deleting the document in the DB is not ideal and this whole logic
+            #       should be refactored.
+            if not document.entries.exists():
+                document.delete()
+                continue
+
             if provider.default_document_state == Provider.DEFAULT_DOC_STATE.ISSUED:
                 document.issue()
 
@@ -419,14 +439,29 @@ def _generate_for_single_subscription(self, subscription=None, billing_date=None
 
         provider = subscription.provider
 
-        if not subscription.should_be_billed(billing_date) or force_generate:
+        to_bill = subscription.should_be_billed(billing_date) or force_generate
+
+        if not to_bill and subscription.cancel_date:
+            billing_up_to_dates = subscription.billed_up_to_dates
+            to_bill = (
+                subscription.cancel_date < billing_up_to_dates["metered_features_billed_up_to"] and
+                subscription.cancel_date < billing_up_to_dates["plan_billed_up_to"]
+            )
+
+        if not to_bill:
             return
 
         document, discount_amounts = self._bill_subscription_into_document(subscription, billing_date)
 
         kwargs = {'entries_info': discount_amounts,
                   provider.flow: document}
 
+        # TODO: Creating and then deleting the document in the DB is not ideal and this whole logic
+        #       should be refactored.
+        if not document.entries.exists():
+            document.delete()
+            return
+
         self._create_discount_entries(**kwargs)
 
         if provider.default_document_state == Provider.DEFAULT_DOC_STATE.ISSUED:

silver/management/commands/generate_docs.py

@@ -48,30 +48,35 @@ def add_arguments(self, parser):
         parser.add_argument('--date',
                             action='store', dest='billing_date', type=date,
                             help='The billing date (format YYYY-MM-DD).')
+        parser.add_argument('--force',
+                            action='store', dest='force_generate', type=bool,
+                            help='Bill subscriptions even in situations when they would be skipped.')
 
     def handle(self, *args, **options):
         translation.activate('en-us')
 
         billing_date = options['billing_date']
+        force_generate = options.get('force_generate', False)
 
         docs_generator = DocumentsGenerator()
         if options['subscription_id']:
             try:
                 subscription_id = options['subscription_id']
                 logger.info('Generating for subscription with id=%s; '
-                            'billing_date=%s.', subscription_id,
-                            billing_date)
+                            'billing_date=%s; force_generate=%s.', subscription_id,
+                            billing_date, force_generate)
 
                 subscription = Subscription.objects.get(id=subscription_id)
                 docs_generator.generate(subscription=subscription,
-                                        billing_date=billing_date)
+                                        billing_date=billing_date,
+                                        force_generate=force_generate)
                 self.stdout.write('Done. You can have a Club-Mate now. :)')
             except Subscription.DoesNotExist:
                 msg = 'The subscription with the provided id does not exist.'
                 self.stdout.write(msg)
         else:
             logger.info('Generating for all the available subscriptions; '
-                        'billing_date=%s.', billing_date)
+                        'billing_date=%s; force_generate=%s.', billing_date, force_generate)
 
-            docs_generator.generate(billing_date=billing_date)
+            docs_generator.generate(billing_date=billing_date, force_generate=force_generate)
             self.stdout.write('Done. You can have a Club-Mate now. :)')

silver/tests/commands/test_generate_docs.py

@@ -1726,6 +1726,47 @@ def test_gen_active_and_canceled_selection(self):
 
         assert Subscription.objects.filter(state='ended').count() == 3
 
+    def test_subscription_with_cancel_date_before_start_date(self):
+        """
+        Should not produce anything, just end the subscription.
+        """
+
+        subscription = SubscriptionFactory.create()
+        subscription.activate()
+        subscription.cancel(when=subscription.start_date - dt.timedelta(days=2))
+        subscription.save()
+
+        assert subscription.state == "canceled"
+
+        call_command('generate_docs',
+                     billing_date=subscription.start_date + dt.timedelta(days=9999),
+                     stdout=self.output)
+        assert Invoice.objects.all().count() == Proforma.objects.all().count() == 0
+
+        subscription.refresh_from_db()
+        assert subscription.state == "ended"
+
+    def test_subscription_with_cancel_date_before_start_date_and_with_specified_subscription_id(self):
+        """
+        Should not produce anything, just end the subscription.
+        """
+
+        subscription = SubscriptionFactory.create()
+        subscription.activate()
+        subscription.cancel(when=subscription.start_date - dt.timedelta(days=2))
+        subscription.save()
+
+        assert subscription.state == "canceled"
+
+        call_command('generate_docs',
+                     billing_date=subscription.start_date + dt.timedelta(days=9999),
+                     subscription=str(subscription.id),
+                     stdout=self.output)
+        assert Invoice.objects.all().count() == Proforma.objects.all().count() == 0
+
+        subscription.refresh_from_db()
+        assert subscription.state == "ended"
+
     def test_subscription_with_separate_cycles_during_trial(self):
         separate_cycles_during_trial = True
         prebill_plan = False