learning-paths-plugin 0.2.3__tar.gz → 0.3.0__tar.gz

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 *
 
+0.3.0 - 2025-04-03
+******************
+
+Changed
+=======
+
+* Replaced Learning Path UUID with LearningPathKey.
+
 0.2.3 - 2025-03-31
 ******************
 
@@ -38,7 +46,7 @@ Added
 Added
 =====
 
-* Pathway progress API
+* Progress API
 
 0.2.0 - 2024-01-23
 ******************

{learning_paths_plugin-0.2.3/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.2.3
+Version: 0.3.0
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -120,6 +120,14 @@ Unreleased
 
 *
 
+0.3.0 - 2025-04-03
+******************
+
+Changed
+=======
+
+* Replaced Learning Path UUID with LearningPathKey.
+
 0.2.3 - 2025-03-31
 ******************
 
@@ -142,7 +150,7 @@ Added
 Added
 =====
 
-* Pathway progress API
+* Progress API
 
 0.2.0 - 2024-01-23
 ******************

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.2.3"
+__version__ = "0.3.0"

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/admin.py

@@ -104,14 +104,16 @@ class LearningPathAdmin(admin.ModelAdmin):
     search_fields = [
         "slug",
         "display_name",
+        "key",
     ]
     list_display = (
-        "uuid",
+        "key",
         "slug",
         "display_name",
         "level",
         "duration_in_days",
     )
+    readonly_fields = ("key",)
 
     inlines = [
         LearningPathStepInline,
@@ -120,6 +122,12 @@ class LearningPathAdmin(admin.ModelAdmin):
         LearningPathGradingCriteriaInline,
     ]
 
+    def get_readonly_fields(self, request, obj=None):
+        """Make key read-only only for existing objects."""
+        if obj:  # Editing an existing object.
+            return self.readonly_fields
+        return ()  # Allow all fields during creation.
+
     def save_related(self, request, form, formsets, change):
         """Save related objects and enroll users in the learning path."""
         super().save_related(request, form, formsets, change)
@@ -144,7 +152,7 @@ class EnrolledUsersAdmin(admin.ModelAdmin):
     search_fields = [
         "id",
         "user__username",
-        "learning_path__uuid",
+        "learning_path__key",
         "learning_path__slug",
         "learning_path__display_name",
     ]

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/api/v1/serializers.py

@@ -72,7 +72,7 @@ class LearningPathAsProgramSerializer(serializers.ModelSerializer):
 
 # pylint: disable=abstract-method
 class LearningPathProgressSerializer(serializers.Serializer):
-    learning_path_id = serializers.UUIDField()
+    learning_path_key = serializers.CharField()
     progress = serializers.FloatField()
     required_completion = serializers.FloatField()
 
@@ -82,7 +82,7 @@ class LearningPathGradeSerializer(serializers.Serializer):
     Serializer for learning path grade.
     """
 
-    learning_path_id = serializers.UUIDField()
+    learning_path_key = serializers.CharField()
     grade = serializers.FloatField()
     required_grade = serializers.FloatField()
 

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/api/v1/urls.py

@@ -1,6 +1,6 @@
 """API v1 URLs."""
 
-from django.urls import path
+from django.urls import path, re_path
 from rest_framework import routers
 
 from learning_paths.api.v1.views import (
@@ -11,6 +11,7 @@ from learning_paths.api.v1.views import (
     LearningPathUserProgressView,
     ListEnrollmentsView,
 )
+from learning_paths.keys import LEARNING_PATH_URL_PATTERN
 
 router = routers.SimpleRouter()
 router.register(
@@ -18,18 +19,18 @@ router.register(
 )
 
 urlpatterns = router.urls + [
-    path(
-        "<uuid:learning_path_uuid>/progress/",
+    re_path(
+        rf"{LEARNING_PATH_URL_PATTERN}/progress/",
         LearningPathUserProgressView.as_view(),
         name="learning-path-progress",
     ),
-    path(
-        "<uuid:learning_path_uuid>/grade/",
+    re_path(
+        rf"{LEARNING_PATH_URL_PATTERN}/grade/",
         LearningPathUserGradeView.as_view(),
         name="learning-path-grade",
     ),
-    path(
-        "<uuid:learning_path_id>/enrollments/",
+    re_path(
+        rf"{LEARNING_PATH_URL_PATTERN}/enrollments/",
         LearningPathEnrollmentView.as_view(),
         name="learning-path-enrollments",
     ),

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/api/v1/views.py

@@ -4,13 +4,13 @@ Views for LearningPath.
 
 import logging
 from datetime import datetime, timezone
-from uuid import UUID
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist, PermissionDenied, ValidationError
 from django.core.validators import validate_email
 from django.shortcuts import get_object_or_404
+from opaque_keys import InvalidKeyError
 from rest_framework import generics, status, viewsets
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import IsAdminUser, IsAuthenticated
@@ -23,6 +23,7 @@ from learning_paths.api.v1.serializers import (
     LearningPathGradeSerializer,
     LearningPathProgressSerializer,
 )
+from learning_paths.keys import LearningPathKey
 from learning_paths.models import (
     LearningPath,
     LearningPathEnrollment,
@@ -60,11 +61,12 @@ class LearningPathUserProgressView(APIView):
 
     permission_classes = (IsAuthenticated,)
 
-    def get(self, request, learning_path_uuid):
+    def get(self, request, learning_path_key_str: str):
         """
         Fetch the learning path progress
         """
-        learning_path = get_object_or_404(LearningPath, uuid=learning_path_uuid)
+        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
+        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
 
         progress = get_aggregate_progress(request.user, learning_path)
         required_completion = None
@@ -75,7 +77,7 @@ class LearningPathUserProgressView(APIView):
             pass
 
         data = {
-            "learning_path_id": learning_path.uuid,
+            "learning_path_key": str(learning_path_key),
             "progress": progress,
             "required_completion": required_completion,
         }
@@ -93,12 +95,13 @@ class LearningPathUserGradeView(APIView):
 
     permission_classes = (IsAuthenticated,)
 
-    def get(self, request, learning_path_uuid):
+    def get(self, request, learning_path_key_str: str):
         """
         Fetch learning path grade
         """
 
-        learning_path = get_object_or_404(LearningPath, uuid=learning_path_uuid)
+        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
+        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
 
         try:
             grading_criteria = learning_path.grading_criteria
@@ -111,7 +114,7 @@ class LearningPathUserGradeView(APIView):
         grade = grading_criteria.calculate_grade(request.user)
 
         data = {
-            "learning_path_id": learning_path_uuid,
+            "learning_path_key": str(learning_path_key),
             "grade": grade,
             "required_grade": grading_criteria.required_grade,
         }
@@ -129,7 +132,7 @@ class LearningPathEnrollmentView(APIView):
 
     permission_classes = [IsAuthenticated, IsAdminOrSelf]
 
-    def get(self, request, learning_path_id):
+    def get(self, request, learning_path_key_str: str):
         """Get the learning path of users.
 
         Staff/Admin can get all the active enrollments of the learning path.
@@ -139,7 +142,8 @@ class LearningPathEnrollmentView(APIView):
             username (optional): When provided it returns the enrollment for
                 the specified user.
         """
-        learning_path = get_object_or_404(LearningPath, uuid=learning_path_id)
+        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
+        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
 
         enrollments = LearningPathEnrollment.objects.filter(
             learning_path=learning_path, is_active=True
@@ -154,7 +158,7 @@ class LearningPathEnrollmentView(APIView):
         serializer = LearningPathEnrollmentSerializer(enrollments.all(), many=True)
         return Response(serializer.data)
 
-    def post(self, request, learning_path_id):
+    def post(self, request, learning_path_key_str: str):
         """Enroll learners in Learning Paths.
 
         Staff/Admin can enroll anyone with the username query param.
@@ -167,7 +171,8 @@ class LearningPathEnrollmentView(APIView):
             }
 
         """
-        learning_path = get_object_or_404(LearningPath, uuid=learning_path_id)
+        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
+        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
         username = request.data.get("username")
         user = get_object_or_404(User, username=username) if username else request.user
 
@@ -189,7 +194,7 @@ class LearningPathEnrollmentView(APIView):
         enrollment.save()
         return Response(LearningPathEnrollmentSerializer(enrollment).data)
 
-    def delete(self, request, learning_path_id):
+    def delete(self, request, learning_path_key_str: str):
         """
         Unenroll a learner from a learning path.
 
@@ -203,7 +208,8 @@ class LearningPathEnrollmentView(APIView):
             }
 
         """
-        learning_path = get_object_or_404(LearningPath, uuid=learning_path_id)
+        learning_path_key = LearningPathKey.from_string(learning_path_key_str)
+        learning_path = get_object_or_404(LearningPath, key=learning_path_key)
         username = request.data.get("username")
         user = get_object_or_404(User, username=username) if username else request.user
 
@@ -281,17 +287,14 @@ class BulkEnrollView(APIView):
         valid_learning_paths_keys = []
         for key in learning_paths_keys:
             try:
-                UUID(key)
-            except ValueError:
+                LearningPathKey.from_string(key)
+                valid_learning_paths_keys.append(key)
+            except InvalidKeyError:
                 logger.warning("BulkEnrollView: Invalid learning path key: %s", key)
-                continue
-            valid_learning_paths_keys.append(key)
 
-        learning_paths = LearningPath.objects.filter(
-            uuid__in=valid_learning_paths_keys
-        ).all()
+        learning_paths = LearningPath.objects.filter(key__in=valid_learning_paths_keys)
 
-        existing_users = User.objects.filter(email__in=emails).all()
+        existing_users = User.objects.filter(email__in=emails)
         non_existing_emails = set(emails) - set(u.email for u in existing_users)
 
         enrollments_created = []

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/apps.py

@@ -12,6 +12,7 @@ class LearningPathsConfig(AppConfig):
     """
 
     name = "learning_paths"
+    verbose_name = "Learning Paths"
 
     plugin_app = {
         # Configuration setting for Plugin URLs for this app.

learning_paths_plugin-0.3.0/learning_paths/keys.py

@@ -0,0 +1,77 @@
+"""
+Keys and fields used by learning-paths-plugin.
+"""
+
+import re
+from typing import Self
+
+from django.core.exceptions import ValidationError
+from opaque_keys import InvalidKeyError
+from opaque_keys.edx.django.models import LearningContextKeyField
+from opaque_keys.edx.keys import LearningContextKey
+
+LEARNING_PATH_NAMESPACE = "path-v1"
+LEARNING_PATH_PATTERN = r"([^+]+)\+([^+]+)\+([^+]+)\+([^+]+)"
+LEARNING_PATH_URL_PATTERN = (
+    rf"(?P<learning_path_key_str>{LEARNING_PATH_NAMESPACE}:{LEARNING_PATH_PATTERN})"
+)
+
+
+class LearningPathKey(LearningContextKey):
+    """
+    A key for a learning path.
+
+    Format: path-v1:{name}+{number}+{run}+{group}
+    """
+
+    CANONICAL_NAMESPACE = LEARNING_PATH_NAMESPACE
+    KEY_FIELDS = ("org", "number", "run", "group")
+    CHECKED_INIT = False
+
+    __slots__ = KEY_FIELDS
+
+    _learning_path_key_regex = re.compile(rf"^{LEARNING_PATH_PATTERN}$")
+
+    def __init__(self, org, number, run, group):
+        """Initialize a LearningPathKey instance."""
+        super().__init__(org=org, number=number, run=run, group=group)
+
+    @classmethod
+    def _from_string(cls, serialized: str) -> Self:
+        """Return an instance of this class constructed from the given string."""
+        match = cls._learning_path_key_regex.match(serialized)
+        if not match:
+            raise InvalidKeyError(cls, serialized)
+        return cls(*match.groups())
+
+    def _to_string(self) -> str:
+        """Return a string representing this key."""
+        return "+".join(
+            [self.org, self.number, self.run, self.group]  # pylint: disable=no-member
+        )
+
+
+class LearningPathKeyField(LearningContextKeyField):
+    """Field for storing LearningPathKey objects."""
+
+    description = "A LearningPathKey object"
+    KEY_CLASS = LearningPathKey
+    # Declare the field types for the django-stubs mypy type hint plugin:
+    _pyi_private_set_type: LearningPathKey | str | None
+    _pyi_private_get_type: LearningPathKey | None
+
+    def to_python(self, value):
+        """Convert the input value to a LearningPathKey object."""
+        # TODO: https://github.com/open-craft/learning-paths-plugin/issues/12
+        if not value:
+            return None
+
+        try:
+            if not value:
+                raise InvalidKeyError(self.KEY_CLASS, None)
+
+            return super().to_python(value)
+        except InvalidKeyError:
+            raise ValidationError(  # pylint: disable=raise-missing-from
+                "Invalid format. Use: 'path-v1:{org}+{number}+{run}+{group}'"
+            )

learning_paths_plugin-0.3.0/learning_paths/migrations/0007_replace_uuid_with_learningpathkey.py

@@ -0,0 +1,77 @@
+# Generated by Django 4.2.16 on 2025-03-12 13:08
+
+from django.db import migrations, models
+import learning_paths.keys
+import uuid
+
+
+def set_keys_from_uuids(apps, schema_editor):
+    """
+    Assign unique keys to existing learning paths based on their UUIDs.
+    """
+    LearningPath = apps.get_model("learning_paths", "LearningPath")
+
+    for learning_path in LearningPath.objects.all():
+        key_str = f"path-v1:test+test+test+{learning_path.uuid}"
+        learning_path.key = learning_paths.keys.LearningPathKey.from_string(key_str)
+        learning_path.save(update_fields=["key"])
+
+
+def reverse_migration(apps, schema_editor):
+    """
+    No reverse operation needed
+    """
+    pass
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("learning_paths", "0006_enrollment_models"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="learningpath",
+            name="key",
+            field=learning_paths.keys.LearningPathKeyField(
+                db_index=True,
+                help_text="Unique identifier for this Learning Path.<br/>It must follow the format: <i>path-v1:{org}+{number}+{run}+{group}</i>.",
+                max_length=255,
+                null=True,  # Temporarily allow nulls.
+                unique=False,  # Temporarily allow non-unique keys.
+            ),
+            preserve_default=False,
+        ),
+        migrations.RunPython(set_keys_from_uuids, reverse_migration),
+        migrations.AlterField(
+            model_name="learningpath",
+            name="key",
+            field=learning_paths.keys.LearningPathKeyField(
+                db_index=True,
+                help_text="Unique identifier for this Learning Path.<br/>It must follow the format: <i>path-v1:{org}+{number}+{run}+{group}</i>.",
+                max_length=255,
+                unique=True,
+            ),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="learningpath",
+            name="uuid",
+            field=models.UUIDField(
+                blank=True,
+                default=uuid.uuid4,
+                editable=False,
+                help_text="Legacy identifier for compatibility with Course Discovery.",
+                unique=True,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="learningpath",
+            name="sequential",
+            field=models.BooleanField(
+                default=False,
+                help_text="Whether the courses in this Learning Path are meant to be taken sequentially.",
+                verbose_name="Is sequential",
+            ),
+        ),
+    ]

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths/models.py

@@ -14,6 +14,7 @@ from opaque_keys.edx.django.models import CourseKeyField
 from simple_history.models import HistoricalRecords
 
 from .compat import get_user_course_grade
+from .keys import LearningPathKeyField
 
 User = auth.get_user_model()
 
@@ -31,9 +32,24 @@ class LearningPath(TimeStampedModel):
     .. no_pii:
     """
 
+    key = LearningPathKeyField(
+        max_length=255,
+        unique=True,
+        db_index=True,
+        help_text=_(
+            "Unique identifier for this Learning Path.<br/>"
+            "It must follow the format: <i>path-v1:{org}+{number}+{run}+{group}</i>."
+        ),
+    )
     # LearningPath is consumed as a course-discovery Program.
-    # Programs are identified by UUIDs and this why we must have this UUID field.
-    uuid = models.UUIDField(blank=True, default=uuid4, editable=False, unique=True)
+    # Programs are identified by UUIDs, which is why we must have this UUID field.
+    uuid = models.UUIDField(
+        blank=True,
+        default=uuid4,
+        editable=False,
+        unique=True,
+        help_text=_("Legacy identifier for compatibility with Course Discovery."),
+    )
     slug = models.SlugField(
         db_index=True,
         unique=True,
@@ -60,6 +76,7 @@ class LearningPath(TimeStampedModel):
         ),
     )
     sequential = models.BooleanField(
+        default=False,
         verbose_name=_("Is sequential"),
         help_text=_(
             "Whether the courses in this Learning Path are meant to be taken sequentially."

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0/learning_paths_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.2.3
+Version: 0.3.0
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -120,6 +120,14 @@ Unreleased
 
 *
 
+0.3.0 - 2025-04-03
+******************
+
+Changed
+=======
+
+* Replaced Learning Path UUID with LearningPathKey.
+
 0.2.3 - 2025-03-31
 ******************
 
@@ -142,7 +150,7 @@ Added
 Added
 =====
 
-* Pathway progress API
+* Progress API
 
 0.2.0 - 2024-01-23
 ******************

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths_plugin.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ learning_paths/__init__.py
 learning_paths/admin.py
 learning_paths/apps.py
 learning_paths/compat.py
+learning_paths/keys.py
 learning_paths/models.py
 learning_paths/receivers.py
 learning_paths/settings.py
@@ -28,6 +29,7 @@ learning_paths/migrations/0003_learningpath_subtitle.py
 learning_paths/migrations/0004_auto_20240207_1633.py
 learning_paths/migrations/0005_learningpathstep_weight_learningpathgradingcriteria.py
 learning_paths/migrations/0006_enrollment_models.py
+learning_paths/migrations/0007_replace_uuid_with_learningpathkey.py
 learning_paths/migrations/__init__.py
 learning_paths/templates/learning_paths/base.html
 learning_paths_plugin.egg-info/PKG-INFO
@@ -39,5 +41,6 @@ learning_paths_plugin.egg-info/requires.txt
 learning_paths_plugin.egg-info/top_level.txt
 requirements/base.in
 requirements/constraints.txt
+tests/test_keys.py
 tests/test_models.py
 tests/test_receivers.py

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/learning_paths_plugin.egg-info/entry_points.txt

@@ -1,2 +1,5 @@
+[context_key]
+path-v1 = learning_paths.keys:LearningPathKey
+
 [lms.djangoapp]
 learning_paths = learning_paths.apps:LearningPathsConfig

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/setup.py

@@ -162,6 +162,9 @@ setup(
         "lms.djangoapp": [
             "learning_paths = learning_paths.apps:LearningPathsConfig",
         ],
+        "context_key": [
+            "path-v1 = learning_paths.keys:LearningPathKey",
+        ],
     },
     include_package_data=True,
     install_requires=load_requirements("requirements/base.in"),

learning_paths_plugin-0.3.0/tests/test_keys.py

@@ -0,0 +1,110 @@
+"""
+Tests for the learning-paths-plugin keys module.
+"""
+
+import pytest
+from django.core.exceptions import ValidationError
+from opaque_keys import InvalidKeyError
+
+from learning_paths.keys import LearningPathKey, LearningPathKeyField
+
+
+class TestLearningPathKey:
+    """Tests for LearningPathKey class."""
+
+    # pylint: disable=no-member
+    def test_create_key(self):
+        """Test creation of a valid key."""
+        key = LearningPathKey("org", "number", "run", "group")
+        assert key.org == "org"
+        assert key.number == "number"
+        assert key.run == "run"
+        assert key.group == "group"
+        assert key.CANONICAL_NAMESPACE == "path-v1"
+
+    def test_key_from_string(self):
+        """Test creating a key from a string."""
+        key_str = "path-v1:org+number+run+group"
+        assert LearningPathKey.from_string(key_str) == LearningPathKey(
+            "org", "number", "run", "group"
+        )
+
+    def test_key_to_string(self):
+        """Test serializing a key to a string."""
+        key = LearningPathKey("org", "number", "run", "group")
+        assert str(key) == "path-v1:org+number+run+group"
+
+    @pytest.mark.parametrize(
+        "key_str",
+        [
+            "path-v1:invalid_key_format",
+            "path-v1:org+number+run+group+extra",  # Extra part
+            "path-v1:org+number+run",  # Missing group
+            "number+run+group",  # Missing namespace
+        ],
+    )
+    def test_invalid_key_string(self, key_str):
+        """Test that an invalid key string raises an error."""
+        with pytest.raises(InvalidKeyError):
+            LearningPathKey.from_string(key_str)
+
+    def test_key_equality(self):
+        """Test that equal keys compare as equal."""
+        key1 = LearningPathKey("org", "number", "run", "group")
+        key2 = LearningPathKey("org", "number", "run", "group")
+        key3 = LearningPathKey("org", "different", "run", "group")
+
+        assert key1 == key2
+        assert key1 != key3
+
+
+class TestLearningPathKeyField:
+    """Tests for LearningPathKeyField class."""
+
+    def test_to_python_with_none(self):
+        """Test that None is returned for empty values."""
+        field = LearningPathKeyField()
+        assert field.to_python(None) is None
+        assert field.to_python("") is None
+
+    def test_to_python_with_key_object(self):
+        """Test that a key object is returned as-is."""
+        field = LearningPathKeyField()
+        key = LearningPathKey("org", "number", "run", "group")
+        assert field.to_python(key) is key
+
+    def test_to_python_with_valid_string(self):
+        """Test conversion of a valid string to a key."""
+        field = LearningPathKeyField()
+        key_str = "path-v1:org+number+run+group"
+        key = field.to_python(key_str)
+
+        assert isinstance(key, LearningPathKey)
+        assert key == LearningPathKey.from_string(key_str)
+
+    @pytest.mark.parametrize(
+        "key_str",
+        [
+            "path-v1:invalid_key_format",
+            "path-v1:org+number+run+group+extra",  # Extra part
+            "path-v1:org+number+run",  # Missing group
+            "number+run+group",  # Missing namespace
+        ],
+    )
+    def test_to_python_with_invalid_string(self, key_str):
+        """Test that an invalid string raises a ValidationError."""
+        field = LearningPathKeyField()
+
+        with pytest.raises(ValidationError):
+            field.to_python(key_str)
+
+    def test_to_python_validation_error_message(self):
+        """Test that the validation error message is as expected."""
+        field = LearningPathKeyField()
+
+        with pytest.raises(ValidationError) as excinfo:
+            field.to_python("invalid_key_format")
+
+        assert "Invalid format. Use: 'path-v1:{org}+{number}+{run}+{group}'" in str(
+            excinfo.value
+        )

learning_paths_plugin-0.3.0/tests/test_models.py

@@ -0,0 +1,79 @@
+"""
+Tests for the learning_paths models.
+"""
+
+# pylint: disable=redefined-outer-name,unused-argument
+
+import pytest
+from django.core.exceptions import ValidationError
+from django.db import IntegrityError
+
+from learning_paths.keys import LearningPathKey
+from learning_paths.models import LearningPath
+
+
+@pytest.fixture
+def learning_path_key():
+    """Create a learning path key for testing."""
+    return LearningPathKey("org", "number", "run", "group")
+
+
+@pytest.fixture
+def learning_path(learning_path_key):
+    """Create a basic learning path for tests."""
+    return LearningPath.objects.create(
+        key=learning_path_key,
+        slug="test-path",
+        display_name="Test Learning Path",
+        subtitle="Test Subtitle",
+        description="Test description",
+        level="intermediate",
+        duration_in_days=30,
+        sequential=True,
+    )
+
+
+@pytest.mark.django_db
+class TestLearningPath:
+    """Tests for the LearningPath model."""
+
+    def test_creation(self, learning_path):
+        """Test creating a learning path."""
+        assert learning_path.display_name == "Test Learning Path"
+        assert learning_path.slug == "test-path"
+        assert learning_path.sequential is True
+
+    def test_string_representation(self, learning_path):
+        """Test the string representation."""
+        assert str(learning_path) == "Test Learning Path"
+
+    def test_uuid_auto_generation(self, learning_path_key):
+        """Test that the UUID is auto-generated."""
+        path = LearningPath.objects.create(key=learning_path_key)
+        assert path.uuid is not None
+
+    # TODO: https://github.com/open-craft/learning-paths-plugin/issues/12
+    @pytest.mark.skip(reason="UUID migration incomplete")
+    def test_key_required(self, learning_path_key):
+        """Test that key is required."""
+        with pytest.raises(ValidationError):
+            LearningPath.objects.create()
+
+    def test_unique_key(self, learning_path, learning_path_key):
+        """Test that key must be unique."""
+        with pytest.raises(
+            IntegrityError,
+            match="UNIQUE constraint failed: learning_paths_learningpath.key",
+        ):
+            LearningPath.objects.create(key=learning_path_key)
+
+    def test_unique_slug(self, learning_path, learning_path_key):
+        """Test that slug must be unique."""
+        with pytest.raises(
+            IntegrityError,
+            match="UNIQUE constraint failed: learning_paths_learningpath.slug",
+        ):
+            LearningPath.objects.create(
+                key=LearningPathKey("org2", "number2", "run2", "group2"),
+                slug=learning_path.slug,
+            )

{learning_paths_plugin-0.2.3 → learning_paths_plugin-0.3.0}/tests/test_receivers.py

@@ -3,7 +3,7 @@
 from django.contrib.auth import get_user_model
 from django.test import TestCase
 
-from learning_paths.api.v1.tests.factories import LearnerPathwayFactory
+from learning_paths.api.v1.tests.factories import LearningPathFactory
 from learning_paths.models import LearningPathEnrollment, LearningPathEnrollmentAllowed
 from learning_paths.receivers import process_pending_enrollments
 
@@ -17,8 +17,8 @@ class TestProcessPendingEnrollments(TestCase):
 
     def setUp(self):
         self.user_email = "test@example.com"
-        self.learning_path_1 = LearnerPathwayFactory()
-        self.learning_path_2 = LearnerPathwayFactory()
+        self.learning_path_1 = LearningPathFactory()
+        self.learning_path_2 = LearningPathFactory()
 
     def test_process_pending_enrollments_with_pending_enrollments(self):
         """

learning_paths_plugin-0.2.3/tests/test_models.py

@@ -1,15 +0,0 @@
-#!/usr/bin/env python
-"""
-Tests for the `learning-paths-plugin` models module.
-"""
-
-import pytest
-
-
-@pytest.mark.skip(
-    reason="Placeholder to allow pytest to succeed before real tests are in place."
-)
-def test_placeholder():
-    """
-    TODO: Delete this test once there are real tests.
-    """