import datetime import pytz from decimal import Decimal from django.core.exceptions import ValidationError from registrasion.models import commerce from registrasion.models import conditions from registrasion.models import inventory from controller_helpers import TestingCartController from controller_helpers import TestingCreditNoteController from controller_helpers import TestingInvoiceController from test_cart import RegistrationCartTestCase UTC = pytz.timezone('UTC') class InvoiceTestCase(RegistrationCartTestCase): def _invoice_containing_prod_1(self, qty=1): cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, qty) return TestingInvoiceController.for_cart(self.reget(cart.cart)) def _credit_note_for_invoice(self, invoice): note = commerce.CreditNote.objects.get(invoice=invoice) return TestingCreditNoteController(note) def test_create_invoice(self): current_cart = TestingCartController.for_user(self.USER_1) # Should be able to create an invoice after the product is added current_cart.add_to_cart(self.PROD_1, 1) invoice_1 = TestingInvoiceController.for_cart(current_cart.cart) # That invoice should have a single line item line_items = commerce.LineItem.objects.filter( invoice=invoice_1.invoice, ) self.assertEqual(1, len(line_items)) # That invoice should have a value equal to cost of PROD_1 self.assertEqual(self.PROD_1.price, invoice_1.invoice.value) # Adding item to cart should produce a new invoice current_cart.add_to_cart(self.PROD_2, 1) invoice_2 = TestingInvoiceController.for_cart(current_cart.cart) self.assertNotEqual(invoice_1.invoice, invoice_2.invoice) # The old invoice should automatically be voided invoice_1_new = commerce.Invoice.objects.get(pk=invoice_1.invoice.id) invoice_2_new = commerce.Invoice.objects.get(pk=invoice_2.invoice.id) self.assertTrue(invoice_1_new.is_void) self.assertFalse(invoice_2_new.is_void) # Invoice should have two line items line_items = commerce.LineItem.objects.filter( invoice=invoice_2.invoice, ) self.assertEqual(2, len(line_items)) # Invoice should have a value equal to cost of PROD_1 and PROD_2 self.assertEqual( self.PROD_1.price + self.PROD_2.price, invoice_2.invoice.value) def test_invoice_controller_for_id_works(self): invoice = self._invoice_containing_prod_1(1) id_ = invoice.invoice.id invoice1 = TestingInvoiceController.for_id(id_) invoice2 = TestingInvoiceController.for_id(str(id_)) self.assertEqual(invoice.invoice, invoice1.invoice) self.assertEqual(invoice.invoice, invoice2.invoice) def test_create_invoice_fails_if_cart_invalid(self): self.make_ceiling("Limit ceiling", limit=1) self.set_time(datetime.datetime(2015, 01, 01, tzinfo=UTC)) current_cart = TestingCartController.for_user(self.USER_1) current_cart.add_to_cart(self.PROD_1, 1) self.add_timedelta(self.RESERVATION * 2) cart_2 = TestingCartController.for_user(self.USER_2) cart_2.add_to_cart(self.PROD_1, 1) # Now try to invoice the first user with self.assertRaises(ValidationError): TestingInvoiceController.for_cart(current_cart.cart) def test_paying_invoice_makes_new_cart(self): invoice = self._invoice_containing_prod_1(1) invoice.pay("A payment!", invoice.invoice.value) # This payment is for the correct amount invoice should be paid. self.assertTrue(invoice.invoice.is_paid) # Cart should not be active self.assertNotEqual( commerce.Cart.STATUS_ACTIVE, invoice.invoice.cart.status, ) # Asking for a cart should generate a new one new_cart = TestingCartController.for_user(self.USER_1) self.assertNotEqual(invoice.invoice.cart, new_cart.cart) def test_invoice_includes_discounts(self): voucher = inventory.Voucher.objects.create( recipient="Voucher recipient", code="VOUCHER", limit=1 ) discount = conditions.VoucherDiscount.objects.create( description="VOUCHER RECIPIENT", voucher=voucher, ) conditions.DiscountForProduct.objects.create( discount=discount, product=self.PROD_1, percentage=Decimal(50), quantity=1 ) current_cart = TestingCartController.for_user(self.USER_1) current_cart.apply_voucher(voucher.code) # Should be able to create an invoice after the product is added current_cart.add_to_cart(self.PROD_1, 1) invoice_1 = TestingInvoiceController.for_cart(current_cart.cart) # That invoice should have two line items line_items = commerce.LineItem.objects.filter( invoice=invoice_1.invoice, ) self.assertEqual(2, len(line_items)) # That invoice should have a value equal to 50% of the cost of PROD_1 self.assertEqual( self.PROD_1.price * Decimal("0.5"), invoice_1.invoice.value) def test_zero_value_invoice_is_automatically_paid(self): voucher = inventory.Voucher.objects.create( recipient="Voucher recipient", code="VOUCHER", limit=1 ) discount = conditions.VoucherDiscount.objects.create( description="VOUCHER RECIPIENT", voucher=voucher, ) conditions.DiscountForProduct.objects.create( discount=discount, product=self.PROD_1, percentage=Decimal(100), quantity=1 ) current_cart = TestingCartController.for_user(self.USER_1) current_cart.apply_voucher(voucher.code) # Should be able to create an invoice after the product is added current_cart.add_to_cart(self.PROD_1, 1) invoice_1 = TestingInvoiceController.for_cart(current_cart.cart) self.assertTrue(invoice_1.invoice.is_paid) def test_invoice_voids_self_if_cart_is_invalid(self): current_cart = TestingCartController.for_user(self.USER_1) # Should be able to create an invoice after the product is added current_cart.add_to_cart(self.PROD_1, 1) invoice_1 = TestingInvoiceController.for_cart(current_cart.cart) self.assertFalse(invoice_1.invoice.is_void) # Adding item to cart should produce a new invoice current_cart.add_to_cart(self.PROD_2, 1) invoice_2 = TestingInvoiceController.for_cart(current_cart.cart) self.assertNotEqual(invoice_1.invoice, invoice_2.invoice) # Viewing invoice_1's invoice should show it as void invoice_1_new = TestingInvoiceController(invoice_1.invoice) self.assertTrue(invoice_1_new.invoice.is_void) # Viewing invoice_2's invoice should *not* show it as void invoice_2_new = TestingInvoiceController(invoice_2.invoice) self.assertFalse(invoice_2_new.invoice.is_void) def test_voiding_invoice_creates_new_invoice(self): invoice_1 = self._invoice_containing_prod_1(1) self.assertFalse(invoice_1.invoice.is_void) invoice_1.void() invoice_2 = TestingInvoiceController.for_cart(invoice_1.invoice.cart) self.assertNotEqual(invoice_1.invoice, invoice_2.invoice) def test_cannot_pay_void_invoice(self): invoice_1 = self._invoice_containing_prod_1(1) invoice_1.void() with self.assertRaises(ValidationError): invoice_1.validate_allowed_to_pay() def test_cannot_void_paid_invoice(self): invoice = self._invoice_containing_prod_1(1) invoice.pay("Reference", invoice.invoice.value) with self.assertRaises(ValidationError): invoice.void() def test_cannot_void_partially_paid_invoice(self): invoice = self._invoice_containing_prod_1(1) invoice.pay("Reference", invoice.invoice.value - 1) self.assertTrue(invoice.invoice.is_unpaid) with self.assertRaises(ValidationError): invoice.void() def test_cannot_generate_blank_invoice(self): current_cart = TestingCartController.for_user(self.USER_1) with self.assertRaises(ValidationError): TestingInvoiceController.for_cart(current_cart.cart) def test_cannot_pay_implicitly_void_invoice(self): cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice = TestingInvoiceController.for_cart(self.reget(cart.cart)) # Implicitly void the invoice cart.add_to_cart(self.PROD_1, 1) with self.assertRaises(ValidationError): invoice.validate_allowed_to_pay() def test_overpaid_invoice_results_in_credit_note(self): invoice = self._invoice_containing_prod_1(1) # Invoice is overpaid by 1 unit to_pay = invoice.invoice.value + 1 invoice.pay("Reference", to_pay) # The total paid should be equal to the value of the invoice only self.assertEqual(invoice.invoice.value, invoice.total_payments()) self.assertTrue(invoice.invoice.is_paid) # There should be a credit note generated out of the invoice. credit_notes = commerce.CreditNote.objects.filter( invoice=invoice.invoice, ) self.assertEqual(1, credit_notes.count()) self.assertEqual(to_pay - invoice.invoice.value, credit_notes[0].value) def test_full_paid_invoice_does_not_generate_credit_note(self): invoice = self._invoice_containing_prod_1(1) # Invoice is paid evenly invoice.pay("Reference", invoice.invoice.value) # The total paid should be equal to the value of the invoice only self.assertEqual(invoice.invoice.value, invoice.total_payments()) self.assertTrue(invoice.invoice.is_paid) # There should be no credit notes credit_notes = commerce.CreditNote.objects.filter( invoice=invoice.invoice, ) self.assertEqual(0, credit_notes.count()) def test_refund_partially_paid_invoice_generates_correct_credit_note(self): invoice = self._invoice_containing_prod_1(1) # Invoice is underpaid by 1 unit to_pay = invoice.invoice.value - 1 invoice.pay("Reference", to_pay) invoice.refund() # The total paid should be zero self.assertEqual(0, invoice.total_payments()) self.assertTrue(invoice.invoice.is_void) # There should be a credit note generated out of the invoice. credit_notes = commerce.CreditNote.objects.filter( invoice=invoice.invoice, ) self.assertEqual(1, credit_notes.count()) self.assertEqual(to_pay, credit_notes[0].value) def test_refund_fully_paid_invoice_generates_correct_credit_note(self): invoice = self._invoice_containing_prod_1(1) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() # The total paid should be zero self.assertEqual(0, invoice.total_payments()) self.assertTrue(invoice.invoice.is_refunded) # There should be a credit note generated out of the invoice. credit_notes = commerce.CreditNote.objects.filter( invoice=invoice.invoice, ) self.assertEqual(1, credit_notes.count()) self.assertEqual(to_pay, credit_notes[0].value) def test_apply_credit_note_pays_invoice(self): invoice = self._invoice_containing_prod_1(1) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() # There should be one credit note generated out of the invoice. cn = self._credit_note_for_invoice(invoice.invoice) # That credit note should be in the unclaimed pile self.assertEquals(1, commerce.CreditNote.unclaimed().count()) # Create a new (identical) cart with invoice cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice2 = TestingInvoiceController.for_cart(self.reget(cart.cart)) cn.apply_to_invoice(invoice2.invoice) self.assertTrue(invoice2.invoice.is_paid) # That invoice should not show up as unclaimed any more self.assertEquals(0, commerce.CreditNote.unclaimed().count()) def test_apply_credit_note_generates_new_credit_note_if_overpaying(self): invoice = self._invoice_containing_prod_1(2) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() # There should be one credit note generated out of the invoice. cn = self._credit_note_for_invoice(invoice.invoice) self.assertEquals(1, commerce.CreditNote.unclaimed().count()) # Create a new cart (of half value of inv 1) and get invoice cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice2 = TestingInvoiceController.for_cart(self.reget(cart.cart)) cn.apply_to_invoice(invoice2.invoice) self.assertTrue(invoice2.invoice.is_paid) # We generated a new credit note, and spent the old one, # unclaimed should still be 1. self.assertEquals(1, commerce.CreditNote.unclaimed().count()) credit_note2 = commerce.CreditNote.objects.get( invoice=invoice2.invoice, ) # The new credit note should be the residual of the cost of cart 1 # minus the cost of cart 2. self.assertEquals( invoice.invoice.value - invoice2.invoice.value, credit_note2.value, ) def test_cannot_apply_credit_note_on_invalid_invoices(self): invoice = self._invoice_containing_prod_1(1) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() # There should be one credit note generated out of the invoice. cn = self._credit_note_for_invoice(invoice.invoice) # Create a new cart with invoice, pay it invoice_2 = self._invoice_containing_prod_1(1) invoice_2.pay("LOL", invoice_2.invoice.value) # Cannot pay paid invoice with self.assertRaises(ValidationError): cn.apply_to_invoice(invoice_2.invoice) invoice_2.refund() # Cannot pay refunded invoice with self.assertRaises(ValidationError): cn.apply_to_invoice(invoice_2.invoice) # Create a new cart with invoice invoice_2 = self._invoice_containing_prod_1(1) invoice_2.void() # Cannot pay void invoice with self.assertRaises(ValidationError): cn.apply_to_invoice(invoice_2.invoice) def test_cannot_apply_a_refunded_credit_note(self): invoice = self._invoice_containing_prod_1(1) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() self.assertEquals(1, commerce.CreditNote.unclaimed().count()) cn = self._credit_note_for_invoice(invoice.invoice) cn.refund() # Refunding a credit note should mark it as claimed self.assertEquals(0, commerce.CreditNote.unclaimed().count()) # Create a new cart with invoice cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice_2 = TestingInvoiceController.for_cart(self.reget(cart.cart)) # Cannot pay with this credit note. with self.assertRaises(ValidationError): cn.apply_to_invoice(invoice_2.invoice) def test_cannot_refund_an_applied_credit_note(self): invoice = self._invoice_containing_prod_1(1) to_pay = invoice.invoice.value invoice.pay("Reference", to_pay) self.assertTrue(invoice.invoice.is_paid) invoice.refund() self.assertEquals(1, commerce.CreditNote.unclaimed().count()) cn = self._credit_note_for_invoice(invoice.invoice) # Create a new cart with invoice cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice_2 = TestingInvoiceController.for_cart(self.reget(cart.cart)) cn.apply_to_invoice(invoice_2.invoice) self.assertEquals(0, commerce.CreditNote.unclaimed().count()) # Cannot refund this credit note as it is already applied. with self.assertRaises(ValidationError): cn.refund() def test_money_into_void_invoice_generates_credit_note(self): invoice = self._invoice_containing_prod_1(1) invoice.void() val = invoice.invoice.value invoice.pay("Paying into the void.", val, pre_validate=False) cn = self._credit_note_for_invoice(invoice.invoice) self.assertEqual(val, cn.credit_note.value) def test_money_into_refunded_invoice_generates_credit_note(self): invoice = self._invoice_containing_prod_1(1) val = invoice.invoice.value invoice.pay("Paying the first time.", val) invoice.refund() cnval = val - 1 invoice.pay("Paying into the void.", cnval, pre_validate=False) notes = commerce.CreditNote.objects.filter(invoice=invoice.invoice) notes = sorted(notes, key=lambda note: note.value) self.assertEqual(cnval, notes[0].value) self.assertEqual(val, notes[1].value) def test_money_into_paid_invoice_generates_credit_note(self): invoice = self._invoice_containing_prod_1(1) val = invoice.invoice.value invoice.pay("Paying the first time.", val) invoice.pay("Paying into the void.", val, pre_validate=False) cn = self._credit_note_for_invoice(invoice.invoice) self.assertEqual(val, cn.credit_note.value) def test_required_category_constraints_prevent_invoicing(self): self.CAT_1.required = True self.CAT_1.save() cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_3, 1) # CAT_1 is required, we don't have CAT_1 yet with self.assertRaises(ValidationError): invoice = TestingInvoiceController.for_cart(cart.cart) # Now that we have CAT_1, we can check out the cart cart.add_to_cart(self.PROD_1, 1) invoice = TestingInvoiceController.for_cart(cart.cart) # Paying for the invoice should work fine invoice.pay("Boop", invoice.invoice.value) # We have an item in the first cart, so should be able to invoice # for the second cart, even without CAT_1 in it. cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_3, 1) invoice2 = TestingInvoiceController.for_cart(cart.cart) # Void invoice2, and release the first cart # now we don't have any CAT_1 invoice2.void() invoice.refund() # Now that we don't have CAT_1, we can't checkout this cart with self.assertRaises(ValidationError): invoice = TestingInvoiceController.for_cart(cart.cart) def test_invoice_with_credit_note_applied_is_refunded(self): ''' Invoices with partial payments should void when cart is updated. Test for issue #64 -- applying a credit note to an invoice means that invoice cannot be voided, and new invoices cannot be created. ''' cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 1) invoice = TestingInvoiceController.for_cart(cart.cart) # Now get a credit note invoice.pay("Lol", invoice.invoice.value) invoice.refund() cn = self._credit_note_for_invoice(invoice.invoice) # Create a cart of higher value than the credit note cart = TestingCartController.for_user(self.USER_1) cart.add_to_cart(self.PROD_1, 2) # Create a current invoice, and apply partial payments invoice = TestingInvoiceController.for_cart(cart.cart) cn.apply_to_invoice(invoice.invoice) # Adding to cart will mean that the old invoice for this cart # will be invalidated. A new invoice should be generated. cart.add_to_cart(self.PROD_1, 1) invoice = TestingInvoiceController.for_id(invoice.invoice.id) invoice2 = TestingInvoiceController.for_cart(cart.cart) cn2 = self._credit_note_for_invoice(invoice.invoice) invoice._refresh() # The first invoice should be refunded self.assertEquals( commerce.Invoice.STATUS_VOID, invoice.invoice.status, ) # Both credit notes should be for the same amount self.assertEquals( cn.credit_note.value, cn2.credit_note.value, ) def test_sends_email_on_invoice_creation(self): invoice = self._invoice_containing_prod_1(1) self.assertEquals(1, len(self.emails)) email = self.emails[0] self.assertEquals([self.USER_1.email], email["to"]) self.assertEquals("invoice_created", email["kind"]) self.assertEquals(invoice.invoice, email["context"]["invoice"]) def test_sends_first_change_email_on_invoice_fully_paid(self): invoice = self._invoice_containing_prod_1(1) self.assertEquals(1, len(self.emails)) invoice.pay("Partial", invoice.invoice.value - 1) # Should have an "invoice_created" email and nothing else. self.assertEquals(1, len(self.emails)) invoice.pay("Remainder", 1) self.assertEquals(2, len(self.emails)) email = self.emails[1] self.assertEquals([self.USER_1.email], email["to"]) self.assertEquals("invoice_updated", email["kind"]) self.assertEquals(invoice.invoice, email["context"]["invoice"]) def test_sends_email_when_invoice_refunded(self): invoice = self._invoice_containing_prod_1(1) self.assertEquals(1, len(self.emails)) invoice.pay("Payment", invoice.invoice.value) self.assertEquals(2, len(self.emails)) invoice.refund() self.assertEquals(3, len(self.emails)) email = self.emails[2] self.assertEquals([self.USER_1.email], email["to"]) self.assertEquals("invoice_updated", email["kind"]) self.assertEquals(invoice.invoice, email["context"]["invoice"])