Terms and conditions
\n" - "Here are the terms and conditions of the current site.
" - ), - ) - - # It should use the provided language if it exists - self.assertEqual( - site_config.get_terms_and_conditions_in_html("fr"), - ( - "Conditions générales de ventes
\n" - "Voici les conditions générales de ventes du site.
" - ), - ) + with self.assertRaises(DeprecationWarning) as deprecation_warning: + site_config.get_terms_and_conditions_in_html() - # It should fallback to the default language if the provided language does not exist self.assertEqual( - site_config.get_terms_and_conditions_in_html("de"), - ( - "Terms and conditions
\n" - "Here are the terms and conditions of the current site.
" - ), + str(deprecation_warning.exception), + "Terms and conditions are managed through contract definition body.", ) diff --git a/src/backend/joanie/tests/core/test_templatetags_extra_tags.py b/src/backend/joanie/tests/core/test_templatetags_extra_tags.py index 9ee64bfd3..567f400a6 100644 --- a/src/backend/joanie/tests/core/test_templatetags_extra_tags.py +++ b/src/backend/joanie/tests/core/test_templatetags_extra_tags.py @@ -4,10 +4,13 @@ import random -from django.test import TestCase +from django.test import TestCase, override_settings + +from stockholm import Money from joanie.core.templatetags.extra_tags import ( base64_static, + format_currency_with_symbol, iso8601_to_date, iso8601_to_duration, join_and, @@ -165,3 +168,25 @@ def test_templatetags_extra_tags_iso8601_to_date(self): result = iso8601_to_date(date_string, "SHORT_DATETIME_FORMAT") self.assertEqual(result, "02/29/2024 1:37 p.m.") + + def test_templatetags_extra_tags_format_currency_with_symbol(self): + """ + The template tag `format_currency_with_symbol` should return the formatted amount + with the currency symbol according to the `settings.DEFAULT_CURRENCY` + and the way it should format according with `setting.JOANIE_FORMAT_LOCAL_CURRENCY` value. + """ + amount = Money("200.00") + with override_settings(LANGUAGE_CODE="en_us", DEFAULT_CURRENCY="EUR"): + formatted_amount_with_currency_1 = format_currency_with_symbol(amount) + + self.assertEqual(formatted_amount_with_currency_1, "€200.00") + + with override_settings(LANGUAGE_CODE="en_us", DEFAULT_CURRENCY="USD"): + formatted_amount_with_currency_2 = format_currency_with_symbol(amount) + + self.assertEqual(formatted_amount_with_currency_2, "$200.00") + + with override_settings(LANGUAGE_CODE="fr-fr", DEFAULT_CURRENCY="EUR"): + formatted_amount_with_currency_3 = format_currency_with_symbol(amount) + # '\xa0' represents a non-breaking space in Unicode. + self.assertEqual(formatted_amount_with_currency_3, "200,00\xa0€") diff --git a/src/backend/joanie/tests/core/test_utils_course_product_relation.py b/src/backend/joanie/tests/core/test_utils_course_product_relation.py index 7ac685ed8..f4147e13e 100644 --- a/src/backend/joanie/tests/core/test_utils_course_product_relation.py +++ b/src/backend/joanie/tests/core/test_utils_course_product_relation.py @@ -50,7 +50,7 @@ def test_utils_course_product_relation_get_orders_made(self): course=course_product_relation.course, ) for order in orders: - order.submit() + order.init_flow() result = get_orders(course_product_relation=course_product_relation) @@ -96,7 +96,7 @@ def test_utils_course_product_relation_get_generated_certificates(self): course=course_product_relation.course, ) for order in orders: - order.submit() + order.init_flow() factories.OrderCertificateFactory(order=order) generated_certificates_queryset = get_generated_certificates( diff --git a/src/backend/joanie/tests/core/test_utils_payment_schedule.py b/src/backend/joanie/tests/core/test_utils_payment_schedule.py index fe039f62e..406bdacc0 100644 --- a/src/backend/joanie/tests/core/test_utils_payment_schedule.py +++ b/src/backend/joanie/tests/core/test_utils_payment_schedule.py @@ -3,21 +3,30 @@ """ import uuid -from datetime import date, datetime +from datetime import date, datetime, timedelta +from decimal import Decimal as D from unittest import mock from zoneinfo import ZoneInfo from django.conf import settings +from django.core import mail from django.test import TestCase from django.test.utils import override_settings +from django.utils import timezone from stockholm import Money -from joanie.core.enums import PAYMENT_STATE_PENDING +from joanie.core import factories +from joanie.core.enums import ( + ORDER_STATE_PENDING_PAYMENT, + PAYMENT_STATE_PAID, + PAYMENT_STATE_PENDING, +) +from joanie.core.exceptions import InvalidConversionError from joanie.core.utils import payment_schedule from joanie.tests.base import BaseLogMixinTestCase -# pylint: disable=protected-access +# pylint: disable=protected-access, too-many-public-methods @override_settings( @@ -28,6 +37,7 @@ 100: (20, 30, 30, 20), }, DEFAULT_CURRENCY="EUR", + JOANIE_INSTALLMENT_REMINDER_PERIOD_DAYS=2, ) class PaymentScheduleUtilsTestCase(TestCase, BaseLogMixinTestCase): """ @@ -181,7 +191,7 @@ def test_utils_payment_schedule_calculate_due_dates_withdrawal_date_close_to_cou self, ): """ - calculate due dates event with withdrawal date corresponding to the signed contract date + Calculate due dates event with withdrawal date corresponding to the signed contract date """ withdrawal_date = date(2024, 1, 1) course_start_date = date(2024, 1, 10) @@ -201,6 +211,30 @@ def test_utils_payment_schedule_calculate_due_dates_withdrawal_date_close_to_cou ], ) + def test_utils_payment_schedule_calculate_due_dates_start_date_before_withdrawal( + self, + ): + """ + Check that the due dates are correctly calculated when the course start date is before + the withdrawal date + """ + withdrawal_date = date(2024, 1, 1) + course_start_date = date(2023, 2, 1) + course_end_date = date(2024, 3, 20) + percentages_count = 2 + + due_dates = payment_schedule._calculate_due_dates( + withdrawal_date, course_start_date, course_end_date, percentages_count + ) + + self.assertEqual( + due_dates, + [ + date(2024, 1, 1), + date(2024, 2, 1), + ], + ) + def test_utils_payment_schedule_calculate_installments(self): """ Check that the installments are correctly calculated @@ -237,11 +271,12 @@ def test_utils_payment_schedule_calculate_installments(self): ], ) - def test_utils_payment_schedule_generate_2_parts_withdrawal_date_higher_than_course_date_date( + def test_utils_payment_schedule_generate_2_parts_withdrawal_date_higher_than_course_start_date( self, ): """ - Check that order's schedule is correctly set for 1 part + Check that order's schedule is correctly set for 2 part when the withdrawal date is + higher than the course start date """ total = 3 signed_contract_date = datetime(2024, 1, 1, 14, tzinfo=ZoneInfo("UTC")) @@ -305,7 +340,7 @@ def test_utils_payment_schedule_generate_1_part(self): def test_utils_payment_schedule_generate_2_parts(self): """ - Check that order's schedule is correctly set for 1 part + Check that order's schedule is correctly set for 2 part """ total = 3 signed_contract_date = datetime(2024, 1, 1, 14, tzinfo=ZoneInfo("UTC")) @@ -569,3 +604,353 @@ def test_utils_payment_schedule_generate_4_parts_tricky_amount(self): }, ], ) + + def test_utils_is_installment_to_debit_today(self): + """ + Check that the installment is to debit if the due date is today. + """ + installment = { + "state": PAYMENT_STATE_PENDING, + "due_date": date(2024, 1, 17), + } + + mocked_now = date(2024, 1, 17) + with mock.patch("django.utils.timezone.localdate", return_value=mocked_now): + self.assertEqual( + payment_schedule.is_installment_to_debit(installment), True + ) + + def test_utils_is_installment_to_debit_past(self): + """ + Check that the installment is to debit if the due date is reached. + """ + installment = { + "state": PAYMENT_STATE_PENDING, + "due_date": date(2024, 1, 13), + } + + mocked_now = date(2024, 1, 17) + with mock.patch("django.utils.timezone.localdate", return_value=mocked_now): + self.assertEqual( + payment_schedule.is_installment_to_debit(installment), True + ) + + def test_utils_is_installment_to_debit_paid_today(self): + """ + Check that the installment is not to debit if the due date is today but its + state is paid + """ + installment = { + "state": PAYMENT_STATE_PAID, + "due_date": date(2024, 1, 17), + } + + mocked_now = date(2024, 1, 17) + with mock.patch("django.utils.timezone.localdate", return_value=mocked_now): + self.assertEqual( + payment_schedule.is_installment_to_debit(installment), False + ) + + def test_utils_has_installments_to_debit_true(self): + """ + Check that the order has installments to debit if at least one is to debit. + """ + order = factories.OrderFactory( + state=ORDER_STATE_PENDING_PAYMENT, + payment_schedule=[ + { + "id": "d9356dd7-19a6-4695-b18e-ad93af41424a", + "amount": "200.00", + "due_date": "2023-01-17", + "state": PAYMENT_STATE_PAID, + }, + { + "id": "1932fbc5-d971-48aa-8fee-6d637c3154a5", + "amount": "300.50", + "due_date": "2024-01-17", + "state": PAYMENT_STATE_PENDING, + }, + ], + ) + order.refresh_from_db() + + mocked_now = date(2024, 1, 17) + with mock.patch("django.utils.timezone.localdate", return_value=mocked_now): + self.assertEqual(payment_schedule.has_installments_to_debit(order), True) + + def test_utils_has_installments_to_debit_false(self): + """ + Check that the order has not installments to debit if no installment are pending + or due date is not reached. + """ + order = factories.OrderFactory( + state=ORDER_STATE_PENDING_PAYMENT, + payment_schedule=[ + { + "id": "d9356dd7-19a6-4695-b18e-ad93af41424a", + "amount": "200.00", + "due_date": "2023-01-17", + "state": PAYMENT_STATE_PAID, + }, + { + "id": "1932fbc5-d971-48aa-8fee-6d637c3154a5", + "amount": "300.50", + "due_date": "2024-02-17", + "state": PAYMENT_STATE_PENDING, + }, + ], + ) + order.refresh_from_db() + + mocked_now = date(2024, 1, 17) + with mock.patch("django.utils.timezone.localdate", return_value=mocked_now): + self.assertEqual(payment_schedule.has_installments_to_debit(order), False) + + def test_utils_payment_schedule_convert_date_str_to_date_object(self): + """ + Check that the method `convert_date_str_to_date_object` converts an isoformat string + of a date into a date object + """ + date_str = "2024-04-26" + + date_object = payment_schedule.convert_date_str_to_date_object(date_str) + + self.assertEqual(date_object, date(2024, 4, 26)) + + def test_utils_payment_schedule_convert_date_str_to_date_object_raises_invalid_conversion( + self, + ): + """ + Check that the method `convert_date_str_to_date_object` raises the exception + `InvalidConversionError` when a string with an incorrect ISO date format is passed as + the `due_date` value. + """ + date_str_1 = "abc-04-26" + date_str_2 = "2024-08-30T14:41:08.504233" + + with self.assertRaises(InvalidConversionError) as context: + payment_schedule.convert_date_str_to_date_object(date_str_1) + + self.assertEqual( + str(context.exception), + "Invalid date format for date_str: Invalid isoformat string: 'abc-04-26'.", + ) + + with self.assertRaises(InvalidConversionError) as context: + payment_schedule.convert_date_str_to_date_object(date_str_2) + + self.assertEqual( + str(context.exception), + "Invalid date format for date_str: Invalid isoformat " + "string: '2024-08-30T14:41:08.504233'.", + ) + + def test_utils_payment_schedule_convert_amount_str_to_money_object(self): + """ + Check that the method `convert_amount_str_to_money_object` converts a string value + representing an amount into a money object. + """ + item = "22.00" + + amount = payment_schedule.convert_amount_str_to_money_object(item) + + self.assertEqual(amount, Money("22.00")) + + def test_utils_payment_schedule_convert_amount_str_to_money_object_raises_invalid_conversion( + self, + ): + """ + Check that the method `convert_amount_str_to_money_object` raises the exception + `InvalidConversionError` when a string with an incorrect format for an amount is passed. + """ + amount_1 = "abc" + amount_2 = "124,00" + + with self.assertRaises(InvalidConversionError) as context: + payment_schedule.convert_amount_str_to_money_object(amount_1) + + self.assertEqual( + str(context.exception), + "Invalid format for amount: Input value cannot be used as monetary amount : 'abc'.", + ) + + with self.assertRaises(InvalidConversionError) as context: + payment_schedule.convert_amount_str_to_money_object(amount_2) + + self.assertEqual( + str(context.exception), + "Invalid format for amount: Input value cannot be used as monetary amount : '124,00'.", + ) + + def test_utils_is_next_installment_to_debit_in_payment_schedule(self): + """ + The method `is_next_installment_to_debit` should return a boolean + whether the installment due date is equal to the passed parameter `due_date` + value set in the settings named `JOANIE_INSTALLMENT_REMINDER_PERIOD_DAYS`. + """ + order = factories.OrderGeneratorFactory( + state=ORDER_STATE_PENDING_PAYMENT, + product__price=D("100"), + ) + order.payment_schedule[0]["state"] = PAYMENT_STATE_PAID + order.payment_schedule[0]["due_date"] = date(2024, 1, 17) + order.payment_schedule[1]["due_date"] = date(2024, 2, 17) + order.payment_schedule[2]["due_date"] = date(2024, 3, 17) + order.payment_schedule[3]["due_date"] = date(2024, 4, 17) + order.save() + + with mock.patch( + "django.utils.timezone.localdate", return_value=date(2024, 2, 15) + ): + due_date = timezone.localdate() + timedelta( + days=settings.JOANIE_INSTALLMENT_REMINDER_PERIOD_DAYS + ) + # Should return False for the 1st installment + self.assertEqual( + payment_schedule.is_next_installment_to_debit( + installment=order.payment_schedule[0], + due_date=due_date, + ), + False, + ) + # Should return True for the 2nd installment + self.assertEqual( + payment_schedule.is_next_installment_to_debit( + installment=order.payment_schedule[1], + due_date=due_date, + ), + True, + ) + # Should return False for the 3rd installment + self.assertEqual( + payment_schedule.is_next_installment_to_debit( + installment=order.payment_schedule[2], + due_date=due_date, + ), + False, + ) + # Should return False for the 4th installment + self.assertEqual( + payment_schedule.is_next_installment_to_debit( + installment=order.payment_schedule[3], + due_date=due_date, + ), + False, + ) + + def test_utils_send_mail_reminder_for_installment_debit(self): + """ + The method `send_mail_reminder_for_installment_debit` should send an email with + the informations about the upcoming installment. We should find the number of days + until the debit according to the setting `JOANIE_INSTALLMENT_REMINDER_PERIOD_DAYS`, + which is 2 days for this test. + """ + order = factories.OrderGeneratorFactory( + owner=factories.UserFactory( + first_name="John", + last_name="Doe", + email="sam@fun-test.fr", + language="en-us", + ), + state=ORDER_STATE_PENDING_PAYMENT, + product__price=D("100"), + product__title="Product 1", + ) + order.payment_schedule[0]["due_date"] = date(2024, 1, 17) + order.payment_schedule[0]["state"] = PAYMENT_STATE_PAID + order.payment_schedule[1]["due_date"] = date(2024, 2, 17) + order.payment_schedule[1]["due_date"] = PAYMENT_STATE_PENDING + order.save() + + payment_schedule.send_mail_reminder_for_installment_debit( + order, order.payment_schedule[1] + ) + + self.assertEqual(mail.outbox[0].to[0], "sam@fun-test.fr") + self.assertIn("will be debited in", mail.outbox[0].subject) + + # Check body + email_content = " ".join(mail.outbox[0].body.split()) + fullname = order.owner.get_full_name() + self.assertIn(f"Hello {fullname}", email_content) + self.assertIn("installment will be withdrawn on 2 days", email_content) + self.assertIn("We will try to debit an amount of", email_content) + self.assertIn("30.00", email_content) + self.assertIn("Product 1", email_content) + + def test_utils_send_mail_reminder_for_installment_debit_in_french_language(self): + """ + The method `send_mail_reminder_for_installment_debit` should send an email with + the informations about the upcoming installment in the current language of the user + when the translation exists in french language. + """ + owner = factories.UserFactory( + first_name="John", + last_name="Doe", + email="sam@fun-test.fr", + language="fr-fr", + ) + product = factories.ProductFactory(price=D("100.00"), title="Product 1") + product.translations.create(language_code="fr-fr", title="Produit 1") + order = factories.OrderGeneratorFactory( + product=product, + owner=owner, + state=ORDER_STATE_PENDING_PAYMENT, + ) + order.payment_schedule[0]["due_date"] = date(2024, 1, 17) + order.payment_schedule[0]["state"] = PAYMENT_STATE_PAID + order.payment_schedule[1]["due_date"] = date(2024, 2, 17) + order.payment_schedule[1]["due_date"] = PAYMENT_STATE_PENDING + order.save() + + payment_schedule.send_mail_reminder_for_installment_debit( + order, order.payment_schedule[1] + ) + + self.assertEqual(mail.outbox[0].to[0], "sam@fun-test.fr") + email_content = " ".join(mail.outbox[0].body.split()) + self.assertIn("Produit 1", email_content) + self.assertIn("30,00", email_content) + + @override_settings( + LANGUAGES=( + ("en-us", ("English")), + ("fr-fr", ("French")), + ("de-de", ("German")), + ) + ) + def test_utils_send_mail_reminder_for_installment_debit_should_use_fallback_language( + self, + ): + """ + The method `send_mail_reminder_for_installment_debit` should send an email with + the informations about the upcoming installment in the fallback language if the + translation does not exist in the current language of the user. + """ + owner = factories.UserFactory( + first_name="John", + last_name="Doe", + email="sam@fun-test.de", + language="de-de", + ) + product = factories.ProductFactory(price=D("100.00"), title="Product 1") + product.translations.create(language_code="fr-fr", title="Produit 1") + order = factories.OrderGeneratorFactory( + product=product, + owner=owner, + state=ORDER_STATE_PENDING_PAYMENT, + ) + order.payment_schedule[0]["due_date"] = date(2024, 1, 17) + order.payment_schedule[0]["state"] = PAYMENT_STATE_PAID + order.payment_schedule[1]["due_date"] = date(2024, 2, 17) + order.payment_schedule[1]["due_date"] = PAYMENT_STATE_PENDING + order.save() + + payment_schedule.send_mail_reminder_for_installment_debit( + order, order.payment_schedule[1] + ) + + self.assertEqual(mail.outbox[0].to[0], "sam@fun-test.de") + email_content = " ".join(mail.outbox[0].body.split()) + self.assertIn("Product 1", email_content) + self.assertIn("30.00", email_content) diff --git a/src/backend/joanie/tests/core/utils/test_contract.py b/src/backend/joanie/tests/core/utils/test_contract.py index e90200827..d0ad551b1 100644 --- a/src/backend/joanie/tests/core/utils/test_contract.py +++ b/src/backend/joanie/tests/core/utils/test_contract.py @@ -23,6 +23,51 @@ class UtilsContractTestCase(TestCase): """Test suite to generate a ZIP archive of signed contract PDF files in bytes utility""" + def test_utils_contract_get_signature_backend_references_states( + self, + ): + """ + From a Course Product Relation product object, we should be able to find the + contract's signature backend references that are attached to the validated + orders only for a specific course and product. It should return an iterator with + signature backend references. + All orders but the canceled ones should be returned. + """ + for state, _ in enums.ORDER_STATE_CHOICES: + with self.subTest(state=state): + relation = factories.CourseProductRelationFactory( + product__contract_definition=factories.ContractDefinitionFactory() + ) + contract = factories.ContractFactory( + # order__owner=users[index], + order__product=relation.product, + order__course=relation.course, + order__state=state, + definition_checksum="1234", + context={"foo": "bar"}, + student_signed_on=timezone.now(), + organization_signed_on=timezone.now(), + ) + + signature_backend_references_generator = ( + contract_utility.get_signature_backend_references( + course_product_relation=relation, organization=None + ) + ) + signature_backend_references_list = list( + signature_backend_references_generator + ) + + if state == enums.ORDER_STATE_CANCELED: + self.assertEqual(len(signature_backend_references_list), 0) + self.assertEqual(signature_backend_references_list, []) + else: + self.assertEqual(len(signature_backend_references_list), 1) + self.assertEqual( + signature_backend_references_list, + [contract.signature_backend_reference], + ) + def test_utils_contract_get_signature_backend_references_with_no_signed_contracts_yet( self, ): @@ -51,8 +96,7 @@ def test_utils_contract_get_signature_backend_references_with_no_signed_contract enums.ORDER_STATE_CANCELED, enums.ORDER_STATE_DRAFT, enums.ORDER_STATE_PENDING, - enums.ORDER_STATE_SUBMITTED, - enums.ORDER_STATE_VALIDATED, + enums.ORDER_STATE_COMPLETED, ] ), signature_backend_reference=signature_reference, @@ -94,7 +138,7 @@ def test_utils_contract_get_signature_backend_references_with_many_signed_contra order__owner=users[index], order__product=relation.product, order__course=relation.course, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -142,8 +186,7 @@ def test_utils_contract_get_signature_backend_references_no_signed_contracts_fro enums.ORDER_STATE_CANCELED, enums.ORDER_STATE_DRAFT, enums.ORDER_STATE_PENDING, - enums.ORDER_STATE_SUBMITTED, - enums.ORDER_STATE_VALIDATED, + enums.ORDER_STATE_COMPLETED, ] ), signature_backend_reference=signature_reference, @@ -185,7 +228,7 @@ def test_utils_contract_get_signature_backend_references_signed_contracts_from_o order__owner=users[index], order__product=relation.product, order__course=relation.course, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -241,8 +284,7 @@ def test_utils_contract_get_signature_backend_references_no_signed_contracts_fro enums.ORDER_STATE_CANCELED, enums.ORDER_STATE_DRAFT, enums.ORDER_STATE_PENDING, - enums.ORDER_STATE_SUBMITTED, - enums.ORDER_STATE_VALIDATED, + enums.ORDER_STATE_COMPLETED, ] ), signature_backend_reference=signature_reference, @@ -291,7 +333,7 @@ def test_utils_contract_get_signature_backend_references_signed_contracts_from_e order__product=relation.product, order__course=None, order__enrollment=enrollment, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -349,7 +391,7 @@ def test_utils_contract_get_signature_backend_reference_extra_filters_org_access order__product=relation.product, order__course=None, order__enrollment=enrollment, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -409,7 +451,7 @@ def test_utils_contract_get_signature_backend_reference_extra_filters_without_us order__product=relation.product, order__course=None, order__enrollment=enrollment, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -541,7 +583,7 @@ def test_utils_contract_generate_zip_archive_success(self): owner=users[index], product=relation.product, course=relation.course, - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, main_invoice=InvoiceFactory( recipient_address__address="1 Rue de L'Exemple", recipient_address__postcode=75000, @@ -623,7 +665,7 @@ def test_utils_contract_get_signature_backend_references_with_course_product_rel order__owner=learners[index], order__product=relation.product, order__course=relation.course, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, signature_backend_reference=signature_reference, definition_checksum="1234", context={"foo": "bar"}, @@ -656,7 +698,7 @@ def test_utils_contract_organization_has_owner_without_owners_returns_false( order = factories.OrderFactory( owner=user, product__contract_definition=factories.ContractDefinitionFactory(), - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, ) factories.ContractFactory( order=order, definition=order.product.contract_definition @@ -675,7 +717,7 @@ def test_utils_contract_organization_has_owner_returns_true( order = factories.OrderFactory( owner=user, product__contract_definition=factories.ContractDefinitionFactory(), - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, ) factories.ContractFactory( order=order, definition=order.product.contract_definition @@ -692,55 +734,67 @@ def test_utils_contract_get_signature_references_student_has_signed(self): """ Should return the signature backend references of orders that are owned by an organization and where it still awaits the organization's signature. - """ - user = factories.UserFactory() - order = factories.OrderFactory( - owner=user, - product__contract_definition=factories.ContractDefinitionFactory(), - state=enums.ORDER_STATE_VALIDATED, - ) - factories.ContractFactory( - order=order, - definition=order.product.contract_definition, - signature_backend_reference="wfl_fake_dummy_id", - definition_checksum="1234", - context="context", - submitted_for_signature_on=timezone.now(), - student_signed_on=timezone.now(), - organization_signed_on=None, - ) - order_found = contract_utility.get_signature_references( - organization_id=order.organization.id, student_has_not_signed=False - ) - - self.assertEqual(list(order_found), ["wfl_fake_dummy_id"]) + Contracts with a cancelled order should not be returned. + """ + for state, _ in enums.ORDER_STATE_CHOICES: + with self.subTest(state=state): + user = factories.UserFactory() + order = factories.OrderFactory( + owner=user, + product__contract_definition=factories.ContractDefinitionFactory(), + state=state, + ) + factories.ContractFactory( + order=order, + definition=order.product.contract_definition, + signature_backend_reference="wfl_fake_dummy_id", + definition_checksum="1234", + context="context", + submitted_for_signature_on=timezone.now(), + student_signed_on=timezone.now(), + organization_signed_on=None, + ) + order_found = contract_utility.get_signature_references( + organization_id=order.organization.id, student_has_not_signed=False + ) + + if state == enums.ORDER_STATE_CANCELED: + self.assertEqual(list(order_found), []) + else: + self.assertEqual(list(order_found), ["wfl_fake_dummy_id"]) def test_utils_contract_get_signature_references_student_has_not_signed(self): """ Should return the signature backend references that are owned by an organization and where there is no signature yet but has been submitted for signature. - """ - user = factories.UserFactory() - order = factories.OrderFactory( - owner=user, - product__contract_definition=factories.ContractDefinitionFactory(), - state=enums.ORDER_STATE_VALIDATED, - ) - factories.ContractFactory( - order=order, - definition=order.product.contract_definition, - signature_backend_reference="wfl_fake_dummy_id", - definition_checksum="1234", - context="context", - submitted_for_signature_on=timezone.now(), - student_signed_on=None, - organization_signed_on=None, - ) - order_found = contract_utility.get_signature_references( - organization_id=order.organization.id, student_has_not_signed=True - ) - - self.assertEqual(list(order_found), ["wfl_fake_dummy_id"]) + Contracts with a cancelled order should not be returned. + """ + for state, _ in enums.ORDER_STATE_CHOICES: + with self.subTest(state=state): + user = factories.UserFactory() + order = factories.OrderFactory( + owner=user, + product__contract_definition=factories.ContractDefinitionFactory(), + state=state, + ) + factories.ContractFactory( + order=order, + definition=order.product.contract_definition, + signature_backend_reference="wfl_fake_dummy_id", + definition_checksum="1234", + context="context", + submitted_for_signature_on=timezone.now(), + student_signed_on=None, + organization_signed_on=None, + ) + order_found = contract_utility.get_signature_references( + organization_id=order.organization.id, student_has_not_signed=True + ) + + if state == enums.ORDER_STATE_CANCELED: + self.assertEqual(list(order_found), []) + else: + self.assertEqual(list(order_found), ["wfl_fake_dummy_id"]) def test_utils_contract_get_signature_references_should_not_find_order(self): """ @@ -751,7 +805,7 @@ def test_utils_contract_get_signature_references_should_not_find_order(self): order = factories.OrderFactory( owner=user, product__contract_definition=factories.ContractDefinitionFactory(), - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, ) contract = factories.ContractFactory( order=order, @@ -799,7 +853,7 @@ def test_utils_contract_update_signatories_for_contracts_but_no_awaiting_contrac order = factories.OrderFactory( product=relation.product, course=relation.course, - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, organization=organization, ) factories.ContractFactory( @@ -820,7 +874,7 @@ def test_utils_contract_update_signatories_for_contracts_but_no_awaiting_contrac self.assertEqual( models.Contract.objects.filter( submitted_for_signature_on__isnull=False, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, order__organization_id=organization.id, organization_signed_on__isnull=False, student_signed_on__isnull=False, @@ -845,7 +899,7 @@ def test_utils_contract_update_signatories_for_contracts(self): owner=learners[index], product=relation.product, course=relation.course, - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, organization=organization, ) factories.ContractFactory( @@ -861,7 +915,7 @@ def test_utils_contract_update_signatories_for_contracts(self): owner=learners[2], product=relation.product, course=relation.course, - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, organization=organization, ) # This contract will need a full update for student and organization @@ -901,7 +955,7 @@ def test_utils_contract_update_signatories_for_contracts(self): self.assertEqual( models.Contract.objects.filter( submitted_for_signature_on__isnull=False, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, order__organization_id=organization.id, organization_signed_on__isnull=True, student_signed_on__isnull=True, @@ -911,7 +965,7 @@ def test_utils_contract_update_signatories_for_contracts(self): self.assertEqual( models.Contract.objects.filter( submitted_for_signature_on__isnull=False, - order__state=enums.ORDER_STATE_VALIDATED, + order__state=enums.ORDER_STATE_COMPLETED, order__organization_id=organization.id, organization_signed_on__isnull=True, student_signed_on__isnull=False, diff --git a/src/backend/joanie/tests/core/utils/test_contract_definition_generate_document_context.py b/src/backend/joanie/tests/core/utils/test_contract_definition_generate_document_context.py index df8697d73..92eaa2196 100644 --- a/src/backend/joanie/tests/core/utils/test_contract_definition_generate_document_context.py +++ b/src/backend/joanie/tests/core/utils/test_contract_definition_generate_document_context.py @@ -2,16 +2,22 @@ from datetime import datetime, timedelta, timezone from decimal import Decimal +from io import BytesIO from unittest import mock -from django.contrib.sites.models import Site from django.test import TestCase, override_settings from django.utils import timezone as django_timezone +from pdfminer.high_level import extract_text as pdf_extract_text + from joanie.core import enums, factories -from joanie.core.utils import contract_definition, image_to_base64 +from joanie.core.models import DocumentImage +from joanie.core.utils import contract_definition, image_to_base64, issuers +from joanie.core.utils.contract_definition import ORGANIZATION_FALLBACK_LOGO from joanie.payment.factories import InvoiceFactory +PROCESSOR_PATH = "joanie.tests.core.utils.test_contract_definition_generate_document_context._processor_for_test_suite" # pylint: disable=line-too-long + def _processor_for_test_suite(context): """A processor for the test of the document context generation.""" @@ -44,10 +50,6 @@ def test_utils_contract_definition_generate_document_context_with_order(self): last_name="", phone_number="0123456789", ) - factories.SiteConfigFactory( - site=Site.objects.get_current(), - terms_and_conditions="## Terms and conditions", - ) user_address = factories.UserAddressFactory( owner=user, first_name="John", @@ -109,16 +111,24 @@ def test_utils_contract_definition_generate_document_context_with_order(self): owner=user, product=relation.product, course=relation.course, - state=enums.ORDER_STATE_VALIDATED, + state=enums.ORDER_STATE_COMPLETED, main_invoice=InvoiceFactory(recipient_address=user_address), ) factories.OrderTargetCourseRelationFactory( course=relation.course, order=order, position=1 ) + + context = contract_definition.generate_document_context( + contract_definition=order.product.contract_definition, + user=user, + order=order, + ) + + organization_logo = DocumentImage.objects.get() + expected_context = { "contract": { "body": "Articles de la convention
", - "terms_and_conditions": "Terms and conditions
", "description": "Contract definition description", "title": "CONTRACT DEFINITION 1", "language": "en-us", @@ -160,7 +170,7 @@ def test_utils_contract_definition_generate_document_context_with_order(self): "title": address_organization.title, "is_main": address_organization.is_main, }, - "logo": image_to_base64(order.organization.logo), + "logo_id": str(organization_logo.id), "name": organization.title, "representative": organization.representative, "representative_profession": organization.representative_profession, @@ -176,12 +186,6 @@ def test_utils_contract_definition_generate_document_context_with_order(self): }, } - context = contract_definition.generate_document_context( - contract_definition=order.product.contract_definition, - user=user, - order=order, - ) - self.assertEqual(context, expected_context) def test_utils_contract_definition_generate_document_context_without_order(self): @@ -197,10 +201,6 @@ def test_utils_contract_definition_generate_document_context_without_order(self) `organization.contact_email` `organization.dpo_email`, `organization.representative_profession`. """ - organization_fallback_logo = ( - "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR" - "42mO8cPX6fwAIdgN9pHTGJwAAAABJRU5ErkJggg==" - ) user = factories.UserFactory( email="student@example.fr", first_name="John Doe", @@ -216,7 +216,6 @@ def test_utils_contract_definition_generate_document_context_without_order(self) expected_context = { "contract": { "body": "Articles de la convention
", - "terms_and_conditions": "", "description": "Contract definition description", "title": "CONTRACT DEFINITION 2", "language": "fr-fr", @@ -256,7 +255,7 @@ def test_utils_contract_definition_generate_document_context_without_order(self) "title": "Articles de la convention
", - "terms_and_conditions": "", "description": "Contract definition description", "title": "CONTRACT DEFINITION 3", "language": "fr-fr", @@ -337,7 +331,7 @@ def test_utils_contract_definition_generate_document_context_default_placeholder "title": "
+ );
+ }
+
+ return + {% endblocktranslate %} +
+ Currently, it remains {{ remaining_balance_to_pay }} to be paid. + The next installment will be debited on {{ date_next_installment_to_pay }}. + {% endblocktranslate %} + {% endwith %} +
+ We have tried to debit an amount of {{ installment_amount }} + on the credit card •••• •••• •••• {{ credit_card_last_numbers }}. + {% endblocktranslate %} +
+ We will try to debit an amount of {{ installment_amount }} on the credit card + •••• •••• •••• {{ credit_card_last_numbers }}. + {% endblocktranslate %} +
+ {% endblocktranslate %} + {% endwith %} +
+
+
+
+
+ Total
+ {{ product_price|format_currency_with_symbol }}
+
+ + {% blocktranslate with name=fullname%} + Hello {{ name }}, + {% endblocktranslate %} +
+ {% else %} + {% trans "Hello," %} + {% endif %}+