feat: add collections support for containers

Author: rpenido

openedx_learning/apps/authoring/publishing/api.py

@@ -74,6 +74,7 @@
     "get_container",
     "get_container_by_key",
     "get_containers",
+    "get_collection_containers",
     "ChildrenEntitiesAction",
     "ContainerEntityListEntry",
     "get_entities_in_container",
@@ -955,6 +956,21 @@ def get_containers(
     return container_cls.objects.filter(publishable_entity__learning_package=learning_package_id)
 
 
+def get_collection_containers(
+    learning_package_id: int,
+    collection_key: str,
+) -> QuerySet[Container]:
+    """
+    Returns a QuerySet of Containers relating to the PublishableEntities in a Collection.
+
+    Containers have a one-to-one relationship with PublishableEntity, but the reverse may not always be true.
+    """
+    return Container.objects.filter(
+        publishable_entity__learning_package_id=learning_package_id,
+        publishable_entity__collections__key=collection_key,
+    ).order_by('pk')
+
+
 @dataclass(frozen=True)
 class ContainerEntityListEntry:
     """

tests/openedx_learning/apps/authoring/collections/test_api.py

@@ -18,6 +18,7 @@
     LearningPackage,
     PublishableEntity,
 )
+from openedx_learning.apps.authoring.units.models import Unit
 from openedx_learning.lib.test_utils import TestCase
 
 User = get_user_model()
@@ -221,10 +222,11 @@ def test_create_collection_without_description(self):
 
 class CollectionEntitiesTestCase(CollectionsTestCase):
     """
-    Base class with collections that contain components.
+    Base class with collections that contain entities.
     """
     published_component: Component
     draft_component: Component
+    draft_unit: Unit
     user: UserType
     html_type: ComponentType
     problem_type: ComponentType
@@ -243,6 +245,13 @@ def setUpTestData(cls) -> None:
 
         cls.html_type = api.get_or_create_component_type("xblock.v1", "html")
         cls.problem_type = api.get_or_create_component_type("xblock.v1", "problem")
+        created_time = datetime(2025, 4, 1, tzinfo=timezone.utc)
+        cls.draft_unit = api.create_unit(
+            learning_package_id=cls.learning_package.id,
+            key="unit-1",
+            created=created_time,
+            created_by=cls.user.id,
+        )
 
         # Make and publish one Component
         cls.published_component, _ = api.create_component_and_version(
@@ -284,6 +293,7 @@ def setUpTestData(cls) -> None:
             entities_qset=PublishableEntity.objects.filter(id__in=[
                 cls.published_component.pk,
                 cls.draft_component.pk,
+                cls.draft_unit.pk,
             ]),
         )
         cls.disabled_collection = api.add_to_collection(
@@ -308,6 +318,7 @@ def test_create_collection_entities(self):
             self.published_component.publishable_entity,
         ]
         assert list(self.collection2.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -325,11 +336,13 @@ def test_add_to_collection(self):
                 self.collection1.key,
                 PublishableEntity.objects.filter(id__in=[
                     self.draft_component.pk,
+                    self.draft_unit.pk,
                 ]),
                 created_by=self.user.id,
             )
 
         assert list(self.collection1.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -352,6 +365,7 @@ def test_add_to_collection_again(self):
             )
 
         assert list(self.collection2.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -383,6 +397,7 @@ def test_remove_from_collection(self):
                 self.collection2.key,
                 PublishableEntity.objects.filter(id__in=[
                     self.published_component.pk,
+                    self.draft_unit.pk,
                 ]),
             )
 
@@ -422,6 +437,24 @@ def test_get_collection_components(self):
             self.another_library_collection.key,
         ))
 
+    def test_get_collection_containers(self):
+        assert not list(api.get_collection_containers(
+            self.learning_package.id,
+            self.collection1.key,
+        ))
+        assert list(api.get_collection_containers(
+            self.learning_package.id,
+            self.collection2.key,
+        )) == [self.draft_unit.container]
+        assert not list(api.get_collection_containers(
+            self.learning_package.id,
+            self.collection3.key,
+        ))
+        assert not list(api.get_collection_containers(
+            self.learning_package.id,
+            self.another_library_collection.key,
+        ))
+
 
 class UpdateCollectionTestCase(CollectionTestCase):
     """
@@ -533,6 +566,7 @@ def test_soft_delete(self):
         assert collection == api.get_collection(self.learning_package.id, collection.key)
         # ...and the collection's entities remain intact.
         assert list(collection.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -586,6 +620,7 @@ def test_restore(self):
         assert collection == api.get_collection(self.learning_package.id, collection.key)
         # ...and the collection's entities remain intact.
         assert list(collection.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -615,6 +650,7 @@ def test_set_collections(self):
             self.draft_component.publishable_entity,
         ]
         assert list(self.collection2.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]
@@ -651,6 +687,7 @@ def test_set_collections(self):
             self.published_component.publishable_entity,
         ]
         assert list(self.collection2.entities.all()) == [
+            self.draft_unit.publishable_entity,
             self.published_component.publishable_entity,
             self.draft_component.publishable_entity,
         ]