fixup! feat: add support for optional Canvas due date syncing

Author: xitij2000

src/ol_openedx_canvas_integration/ol_openedx_canvas_integration/cms_tasks.py

@@ -187,10 +187,33 @@ def sync_course_assignments_with_canvas(course_id):
 
 @shared_task
 def sync_canvas_due_dates(course_id: str):
+    """
+    Synchronizes due dates for a specified course with the Canvas platform.
+
+    This task is a wrapper around the `_sync_canvas_due_dates` function, which performs the actual
+    synchronization of assignment due dates from Canvas to the platform.
+
+    Parameters:
+        course_id (str): The unique identifier of the course whose due
+        dates need to be synchronized.
+    """
     _sync_canvas_due_dates(course_id)
 
 
 def _sync_canvas_due_dates(course_id: str):
+    """
+    Synchronize assignment due dates from Canvas to a specific course in the platform.
+
+    This function retrieves assignment due dates from Canvas associated with a given course
+    and updates the platform's course content accordingly. The function skips synchronization
+    if the course has no Canvas ID or if using Canvas due dates is disabled for the course.
+
+    Arguments:
+        course_id (str): The unique identifier of the course whose due dates are to be synchronized.
+
+    Raises:
+        Various exceptions during retrieval or update operations are logged but not raised.
+    """
     course_key = CourseKey.from_string(course_id)
     course = get_course_by_id(course_key)
     canvas_course_id = get_canvas_course_id(course)

src/ol_openedx_canvas_integration/tests/test_cms_tasks.py

@@ -154,15 +154,17 @@ def create_course(self, other_course_settings:dict|None=None):
     )
     def test_sync_canvas_due_dates_no_canvas_id(self, other_course_settings):
         course, _ = self.create_course(other_course_settings)
+        canvas_client_mock = MagicMock()
+
         with (
-            patch("ol_openedx_canvas_integration.cms_tasks.TASK_LOG") as mocked_log,
+            patch(
+                "ol_openedx_canvas_integration.cms_tasks.CanvasClient",
+                return_value=canvas_client_mock,
+            ),
         ):
             _sync_canvas_due_dates(str(course.id))
 
-            mocked_log.info.assert_called_with(
-                "Due Date Sync: No canvas ID. Skipped for course %s",
-                str(course.id),
-            )
+            canvas_client_mock.get_canvas_assignments.assert_not_called()
 
     @ddt.data(
         {},
@@ -173,15 +175,17 @@ def test_sync_canvas_due_dates_due_dates_disabled(self, other_course_settings):
             "canvas_id": 11,
             **other_course_settings,
         })
+        canvas_client_mock = MagicMock()
+
         with (
-            patch("ol_openedx_canvas_integration.cms_tasks.TASK_LOG") as mocked_log,
+            patch(
+                "ol_openedx_canvas_integration.cms_tasks.CanvasClient",
+                return_value=canvas_client_mock,
+            ),
         ):
             _sync_canvas_due_dates(str(course.id))
 
-            mocked_log.info.assert_called_with(
-                "Due Date Sync: Disabled. Skipped for course %s",
-                str(course.id),
-            )
+            canvas_client_mock.get_canvas_assignments.assert_not_called()
 
 
     def test_sync_canvas_due_dates_updates_due_dates(self):