feat: add a 'url_slug' property to CatalogCourse

Author: bradenmacdonald

src/openedx_catalog/admin.py

@@ -27,7 +27,15 @@ class CatalogCourseAdmin(admin.ModelAdmin):
     """
 
     list_filter = ["org__short_name", "language"]
-    list_display = ["display_name", "org_display", "course_code", "runs_summary", "created_date", "language"]
+    list_display = [
+        "display_name",
+        "org_display",
+        "course_code",
+        "runs_summary",
+        "url_slug",
+        "created_date",
+        "language",
+    ]
 
     def get_readonly_fields(self, request, obj: CatalogCourse | None = None) -> tuple[str, ...]:
         if obj:  # editing an existing object

src/openedx_catalog/models/catalog_course.py

@@ -178,6 +178,18 @@ def org_code(self, org_code: str) -> None:
         # not possible on MySQL, using the default collation used by the Organizations app.
         # So we do not worry about that possibility here.
 
+    @property
+    def url_slug(self):  # Do we need this? Would an opaque key be better?
+        """
+        An ID that can be used to identify this catalog course in URLs or APIs.
+        In the future, this may be an editable SlugField, so don't assume that
+        it never changes.
+        """
+        # '+' is a bad separator because it can mean " " in URLs.
+        # '-', '.', and '_' cannot be used since they're allowed in the org code
+        # So for now we use ':', and in the future we may make the whole slug customizable.
+        return f"{self.org_code}:{self.course_code}"
+
     def clean(self):
         """Validate/normalize fields when edited via Django admin"""
         # Set a default value for display_name:

tests/openedx_catalog/test_models.py

@@ -74,6 +74,12 @@ def test_course_code_required(self) -> None:
             # Using .update() will bypass all checks and defaults in save()/clean(), to see if the DB enforces this:
             CatalogCourse.objects.filter(pk=cc.pk).update(course_code="")
 
+    # url_slug field tests:
+    def test_url_slug(self) -> None:
+        """Test that url_slug is generated automatically"""
+        cc = CatalogCourse.objects.create(org_code="Org1", course_code="Python100")
+        assert cc.url_slug == "Org1:Python100"
+
     # display_name field tests:
 
     def test_display_name_default(self) -> None: