Added tests

Author: adamspd

appointment/tests/test_tasks.py

@@ -0,0 +1,38 @@
+from django.test import TestCase
+from unittest.mock import patch
+from appointment.tasks import send_email_reminder
+from appointment.tests.base.base_test import BaseTest
+from django.utils.translation import gettext as _
+
+
+class SendEmailReminderTest(BaseTest):
+
+    @patch('appointment.tasks.send_email')
+    @patch('appointment.tasks.notify_admin')
+    def test_send_email_reminder(self, mock_notify_admin, mock_send_email):
+        # Use BaseTest setup to create an appointment
+        appointment_request = self.create_appt_request_for_sm1()
+        appointment = self.create_appointment_for_user1(appointment_request=appointment_request)
+
+        # Extract necessary data for the test
+        to_email = appointment.client.email
+        first_name = appointment.client.first_name
+        appointment_id = appointment.id
+
+        # Call the function under test
+        send_email_reminder(to_email, first_name, appointment_id)
+
+        # Verify send_email was called with correct parameters
+        mock_send_email.assert_called_once_with(
+            recipient_list=[to_email],
+            subject=_("Reminder: Upcoming Appointment"),
+            template_url='email_sender/reminder_email.html',
+            context={'first_name': first_name, 'appointment': appointment}
+        )
+
+        # Verify notify_admin was called with correct parameters
+        mock_notify_admin.assert_called_once_with(
+            subject=_("Admin Reminder: Upcoming Appointment"),
+            template_url='email_sender/reminder_email.html',
+            context={'first_name': first_name, 'appointment': appointment}
+        )

appointment/tests/test_utils.py

@@ -6,13 +6,15 @@
 from django.conf import settings
 from django.http import HttpRequest
 from django.test import TestCase
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
 from appointment.models import Appointment, AppointmentRequest, Config, Service, StaffMember
 from appointment.services import get_available_slots, get_finish_button_text
 from appointment.settings import APPOINTMENT_BUFFER_TIME, APPOINTMENT_FINISH_TIME, APPOINTMENT_LEAD_TIME, \
     APPOINTMENT_SLOT_DURATION, APPOINTMENT_WEBSITE_NAME
-from appointment.utils.date_time import convert_str_to_date, get_current_year, get_timestamp, get_timezone
+from appointment.utils.date_time import combine_date_and_time, convert_str_to_date, get_current_year, get_timestamp, \
+    get_timezone
 from appointment.utils.db_helpers import get_appointment_buffer_time, get_appointment_finish_time, \
     get_appointment_lead_time, get_appointment_slot_duration, get_user_model, get_website_name
 from appointment.utils.view_helpers import generate_random_id, get_locale, is_ajax
@@ -204,3 +206,43 @@ def test_get_finish_button_text_paid_service(self):
     def test_get_client_model(self):
         client_model = get_user_model()
         self.assertEqual(client_model, apps.get_model(settings.AUTH_USER_MODEL))
+
+
+class UtilityDateTimeTestCase(TestCase):
+    def test_combine_date_and_time_success(self):
+        """
+        Test combining a date and time into a datetime object successfully.
+        """
+        date = datetime.date(2024, 2, 5)
+        time = datetime.time(14, 30)
+        expected_datetime = datetime.datetime(2024, 2, 5, 14, 30)
+        combined_datetime = combine_date_and_time(date, time)
+        self.assertEqual(combined_datetime, expected_datetime)
+
+    def test_combine_date_and_time_with_timezone(self):
+        """
+        Test combining a date and time into a timezone-aware datetime object.
+        """
+        date = datetime.date(2024, 2, 5)
+        time = datetime.time(14, 30, tzinfo=timezone.utc)
+        combined_datetime = combine_date_and_time(date, time)
+        self.assertTrue(timezone.is_aware(combined_datetime), "The datetime object is not timezone-aware.")
+        self.assertEqual(combined_datetime.tzinfo, timezone.utc)
+
+    def test_combine_date_and_time_with_invalid_date(self):
+        """
+        Test handling of invalid date input.
+        """
+        date = "2024-02-05"  # Incorrect type. It should be datetime.date
+        time = datetime.time(14, 30)
+        with self.assertRaises(TypeError, msg="Expected TypeError when combining with invalid date type"):
+            combine_date_and_time(date, time)
+
+    def test_combine_date_and_time_with_invalid_time(self):
+        """
+        Test handling of invalid time input.
+        """
+        date = datetime.date(2024, 2, 5)
+        time = "14:30"  # Incorrect type. It should be datetime.time
+        with self.assertRaises(TypeError, msg="Expected TypeError when combining with invalid time type"):
+            combine_date_and_time(date, time)

appointment/tests/utils/test_db_helpers.py

@@ -11,11 +11,14 @@
 from django.core.exceptions import FieldDoesNotExist
 from django.test import TestCase
 from django.urls import reverse
+from django.utils import timezone
+from django_q.models import Schedule
 
 from appointment.models import DayOff, PaymentInfo
 from appointment.tests.base.base_test import BaseTest
 from appointment.utils.date_time import get_current_year
-from appointment.utils.db_helpers import (calculate_slots, check_day_off_for_staff, create_and_save_appointment,
+from appointment.utils.db_helpers import (calculate_slots, cancel_existing_reminder, check_day_off_for_staff,
+                                          create_and_save_appointment,
                                           create_payment_info_and_get_url, exclude_booked_slots,
                                           day_off_exists_for_date_range, get_all_staff_members,
                                           get_all_appointments, Config, get_appointment_buffer_time,
@@ -28,7 +31,9 @@
                                           get_staff_member_end_time, get_staff_member_buffer_time,
                                           get_staff_member_slot_duration, get_user_by_email, get_user_model,
                                           get_staff_member_from_user_id_or_logged_in,
-                                          get_staff_member_by_user_id, working_hours_exist, is_working_day,
+                                          get_staff_member_by_user_id, schedule_email_reminder,
+                                          update_appointment_reminder, working_hours_exist,
+                                          is_working_day,
                                           get_working_hours_for_staff_and_day,
                                           get_working_hours_by_id, get_website_name, get_times_from_config,
                                           create_new_user, generate_unique_username_from_email, parse_name,
@@ -149,6 +154,59 @@ def get_mock_reverse(url_name, **kwargs):
     return reverse(url_name, **kwargs)
 
 
+class ScheduleEmailReminderTest(BaseTest):
+    def test_schedule_email_reminder_cluster_running(self):
+        appointment = self.create_appointment_for_user1()
+        with patch('appointment.settings.check_q_cluster', return_value=True), \
+                patch('appointment.utils.db_helpers.schedule') as mock_schedule:
+            schedule_email_reminder(appointment)
+            mock_schedule.assert_called_once()
+            # Further assertions can be made here based on the arguments passed to schedule
+
+    def test_schedule_email_reminder_cluster_not_running(self):
+        appointment = self.create_appointment_for_user2()
+        with patch('appointment.settings.check_q_cluster', return_value=False), \
+                patch('appointment.utils.db_helpers.logger') as mock_logger:
+            schedule_email_reminder(appointment)
+            mock_logger.warning.assert_called_with(
+                "Django-Q cluster is not running. Email reminder will not be scheduled.")
+
+
+class UpdateAppointmentReminderTest(BaseTest):
+    def test_update_appointment_reminder_date_time_changed(self):
+        appointment = self.create_appointment_for_user1()
+        new_date = timezone.now().date() + timezone.timedelta(days=10)
+        new_start_time = timezone.now().time()
+
+        with patch('appointment.utils.db_helpers.schedule_email_reminder') as mock_schedule_email_reminder, \
+                patch('appointment.utils.db_helpers.cancel_existing_reminder') as mock_cancel_existing_reminder:
+            update_appointment_reminder(appointment, new_date, new_start_time, True)
+            mock_cancel_existing_reminder.assert_called_once_with(appointment.id_request)
+            mock_schedule_email_reminder.assert_called_once()
+
+    def test_update_appointment_reminder_no_change(self):
+        appointment = self.create_appointment_for_user2()
+        # Use existing date and time
+        new_date = appointment.appointment_request.date
+        new_start_time = appointment.appointment_request.start_time
+
+        with patch('appointment.utils.db_helpers.schedule_email_reminder') as mock_schedule_email_reminder, \
+                patch('appointment.utils.db_helpers.cancel_existing_reminder') as mock_cancel_existing_reminder:
+            update_appointment_reminder(appointment, new_date, new_start_time, appointment.want_reminder)
+            mock_cancel_existing_reminder.assert_not_called()
+            mock_schedule_email_reminder.assert_not_called()
+
+
+class CancelExistingReminderTest(BaseTest):
+    def test_cancel_existing_reminder(self):
+        appointment = self.create_appointment_for_user1()
+        Schedule.objects.create(func='appointment.tasks.send_email_reminder', name=f"reminder_{appointment.id_request}")
+
+        self.assertEqual(Schedule.objects.count(), 1)
+        cancel_existing_reminder(appointment.id_request)
+        self.assertEqual(Schedule.objects.filter(name=f"reminder_{appointment.id_request}").count(), 0)
+
+
 class TestCreatePaymentInfoAndGetUrl(BaseTest):
 
     def setUp(self):
@@ -786,4 +844,3 @@ def test_create_new_user_check_password(self):
         user = create_new_user(client_data)
         password = f"{get_website_name()}{get_current_year()}"
         self.assertTrue(user.check_password(password))
-