feat: API for deleting a course run and/or catalog course

Author: bradenmacdonald

src/openedx_catalog/api_impl.py

@@ -17,9 +17,11 @@
 __all__ = [
     "get_catalog_course",
     "update_catalog_course",
+    "delete_catalog_course",
     "get_course_run",
     "sync_course_run_details",
     "create_course_run_for_modulestore_course_with",
+    "delete_course_run",
 ]
 
 
@@ -84,6 +86,20 @@ def update_catalog_course(
         cc.save(update_fields=update_fields)
 
 
+def delete_catalog_course(catalog_course: CatalogCourse | int) -> None:
+    """
+    Delete a `CatalogCourse`. This will fail with a `ProtectedError` if any runs exist.
+
+    ⚠️ Does not check permissions.
+    ⚠️ Does not emit any course lifecycle events.
+    """
+    if isinstance(catalog_course, CatalogCourse):
+        cc = catalog_course
+    else:
+        cc = CatalogCourse.objects.get(pk=catalog_course)
+    cc.delete()
+
+
 def get_course_run(course_id: CourseKey) -> CourseRun:
     """
     Get a single course run.
@@ -117,6 +133,7 @@ def sync_course_run_details(
     `update_course_run` API that will become the main way to rename a course.
 
     ⚠️ Does not check permissions.
+    ⚠️ Does not emit any course lifecycle events.
     """
     run = CourseRun.objects.get(course_id=course_id)
     if display_name:
@@ -143,6 +160,7 @@ def create_course_run_for_modulestore_course_with(
     not meant for historical data (use a data migration).
 
     ⚠️ Does not check permissions.
+    ⚠️ Does not emit any course lifecycle events.
     """
     # Note: this code shares a lot with the code in
     # openedx-platform/openedx/core/djangoapps/content/course_overviews/migrations/0030_backfill_...
@@ -202,3 +220,16 @@ def create_course_run_for_modulestore_course_with(
         log.warning('Expected to create CourseRun for "%s" but it already existed.', str(course_id))
 
     return new_run
+
+
+def delete_course_run(course_id: CourseKey) -> None:
+    """
+    Delete a `CourseRun`.
+
+    This may fail with a `ProtectedError` or other `IntegrityError` subclass if
+    there are still active references to the course run.
+
+    ⚠️ Does not check permissions.
+    ⚠️ Does not emit any course lifecycle events.
+    """
+    CourseRun.objects.get(course_id=course_id).delete()

tests/openedx_catalog/test_api.py

@@ -7,6 +7,7 @@
 
 import pytest
 from django.db import connection
+from django.db.models import ProtectedError
 from django.test import override_settings
 from freezegun import freeze_time
 from opaque_keys.edx.keys import CourseKey
@@ -141,6 +142,22 @@ def test_update_ignore_other_fields(python100: CatalogCourse) -> None:
     assert python100.display_name == "New Name"
 
 
+# delete_catalog_course
+
+
+def test_delete_catalog_course(python100: CatalogCourse, python100_summer26: CourseRun) -> None:
+    """Test that we can delete a CatalogCourse but only if no runs exist"""
+    # At first, deletion will fail because of the Summer2026 run:
+    with pytest.raises(ProtectedError):
+        api.delete_catalog_course(python100)
+    python100.refresh_from_db()  # Make sure it's not deleted.
+    # Now delete the run, unblocking deletion of the catalog course:
+    python100_summer26.delete()  # FIXME: use an API method for this.
+    api.delete_catalog_course(python100)
+    with pytest.raises(CatalogCourse.DoesNotExist):
+        python100.refresh_from_db()  # Make sure it's gone
+
+
 # get_course_run
 
 
@@ -340,3 +357,20 @@ def test_create_course_run_for_modulestore_course_run_that_exists(caplog: pytest
     assert new_run.display_name == "Original Name"
     assert new_run.catalog_course.display_name == "Original Name"
     assert new_run.run == run_code
+
+
+# delete_course_run
+
+
+def test_delete_course_run(
+    python100: CatalogCourse,
+    python100_summer26: CourseRun,
+    python100_winter26: CourseRun,
+) -> None:
+    """Test that we can delete a CourseRun, passing in the object"""
+    api.delete_course_run(python100_summer26.course_id)
+    with pytest.raises(CourseRun.DoesNotExist):
+        python100_summer26.refresh_from_db()  # Make sure it's gone
+    # The catalog course and other run is unaffected:
+    python100.refresh_from_db()
+    python100_winter26.refresh_from_db()