WIP

Author: bradenmacdonald

src/openedx_content/applets/units/admin.py

@@ -2,6 +2,7 @@
 
 This module provides functions to manage units.
 """
+
 from dataclasses import dataclass
 from functools import partial
 
@@ -23,12 +24,14 @@
 create_unit = partial(publishing_api.create_container, container_type=Unit)
 create_unit_and_version = partial(publishing_api.create_container_and_version, container_type=Unit)
 
+
 @dataclass(frozen=True)
 class UnitListEntry:
     """
     [ 🛑 UNSTABLE ]
     Data about a single entity in a container, e.g. a component in a unit.
     """
+
     component_version: ComponentVersion
     pinned: bool = False
 

src/openedx_content/applets/units/api.py

@@ -26,10 +26,8 @@ class Unit(ContainerTypeImplementation):
     @classmethod
     def validate_entity(cls, entity: PublishableEntity) -> None:
         """Check if the given entity is allowed as a child of a Unit"""
-        try:
-            getattr(entity, "component")
-        except PublishableEntity.component.RelatedObjectDoesNotExist:
-            raise
+        # Units only allow Components as children, so the entity must be 1:1 with Component:
+        getattr(entity, "component")  # Could raise PublishableEntity.component.RelatedObjectDoesNotExist
 
     # validate settings
 

src/openedx_content/applets/units/models.py

@@ -1,6 +1,7 @@
 """
 Basic tests for the units API.
 """
+
 from unittest.mock import patch
 
 import ddt  # type: ignore[import]
@@ -18,7 +19,7 @@
 
 @ddt.ddt
 class UnitTestCase(ComponentTestCase):
-    """ Test cases for Units (containers of components) """
+    """Test cases for Units (containers of components)"""
 
     def setUp(self) -> None:
         super().setUp()
@@ -31,10 +32,10 @@ def setUp(self) -> None:
             title="Querying Counting Problem (2)",
         )
 
-    def create_component(self, *, title: str = "Test Component", key: str = "component:1") -> tuple[
-        authoring_models.Component, authoring_models.ComponentVersion
-    ]:
-        """ Helper method to quickly create a component """
+    def create_component(
+        self, *, title: str = "Test Component", key: str = "component:1"
+    ) -> tuple[authoring_models.Component, authoring_models.ComponentVersion]:
+        """Helper method to quickly create a component"""
         return content_api.create_component_and_version(
             self.learning_package.id,
             component_type=self.problem_type,
@@ -51,7 +52,7 @@ def create_unit_with_components(
         title="Unit",
         key="unit:key",
     ) -> authoring_models.Unit:
-        """ Helper method to quickly create a unit with some components """
+        """Helper method to quickly create a unit with some components"""
         unit, _unit_v1 = content_api.create_unit_and_version(
             learning_package_id=self.learning_package.id,
             key=key,
@@ -232,7 +233,10 @@ def test_add_corrupted_component(self):
         self.component_1_v1.publishable_entity_version.refresh_from_db()  # No error
         self.component_1_v1.publishable_entity_version.entity.refresh_from_db()  # No error
         # Now add this corrupted component, pinned to v1:
-        with pytest.raises(ValidationError, match='The entity "xblock.v1:problem:Query Counting" cannot be added to a "unit" container.'):
+        with pytest.raises(
+            ValidationError,
+            match='The entity "xblock.v1:problem:Query Counting" cannot be added to a "unit" container.',
+        ):
             self.create_unit_with_components([self.component_1_v1])
 
     def test_create_empty_unit_and_version(self):
@@ -524,10 +528,14 @@ def test_create_two_units_with_same_components(self):
 
         # Check that the contents are as expected:
         assert [row.component_version for row in content_api.get_components_in_unit(unit1, published=False)] == [
-            self.component_2_v1, self.component_2_v1, self.component_1_v1,
+            self.component_2_v1,
+            self.component_2_v1,
+            self.component_1_v1,
         ]
         assert [row.component_version for row in content_api.get_components_in_unit(unit2, published=False)] == [
-            self.component_1_v1, self.component_2_v1, self.component_1_v1,
+            self.component_1_v1,
+            self.component_2_v1,
+            self.component_1_v1,
         ]
 
         # Modify component 1
@@ -699,7 +707,7 @@ def test_cannot_add_soft_deleted_component(self, publish_first):
             self.create_unit_with_components([component])
 
     def test_removing_component(self):
-        """ Test removing a component from a unit (but not deleting it) """
+        """Test removing a component from a unit (but not deleting it)"""
         unit = self.create_unit_with_components([self.component_1, self.component_2])
         content_api.publish_all_drafts(self.learning_package.id)
 
@@ -739,7 +747,7 @@ def test_removing_component(self):
         ]
 
     def test_soft_deleting_component(self):
-        """ Test soft deleting a component that's in a unit (but not removing it) """
+        """Test soft deleting a component that's in a unit (but not removing it)"""
         unit = self.create_unit_with_components([self.component_1, self.component_2])
         content_api.publish_all_drafts(self.learning_package.id)
 
@@ -770,7 +778,7 @@ def test_soft_deleting_component(self):
         ]
 
     def test_soft_deleting_and_removing_component(self):
-        """ Test soft deleting a component that's in a unit AND removing it """
+        """Test soft deleting a component that's in a unit AND removing it"""
         unit = self.create_unit_with_components([self.component_1, self.component_2])
         content_api.publish_all_drafts(self.learning_package.id)
 
@@ -806,7 +814,7 @@ def test_soft_deleting_and_removing_component(self):
         ]
 
     def test_soft_deleting_pinned_component(self):
-        """ Test soft deleting a pinned 📌 component that's in a unit """
+        """Test soft deleting a pinned 📌 component that's in a unit"""
         unit = self.create_unit_with_components([self.component_1_v1, self.component_2_v1])
         content_api.publish_all_drafts(self.learning_package.id)
 
@@ -951,17 +959,28 @@ def test_units_containing(self):
         # Unit 3 doesn't contain it
         _unit3_no = self.create_unit_with_components([self.component_2], key="u3")
         # Unit 4 ✅ has component 1, unpinned
-        unit4_unpinned = self.create_unit_with_components([
-            self.component_1, self.component_2, self.component_2_v1,
-        ], key="u4")
+        unit4_unpinned = self.create_unit_with_components(
+            [
+                self.component_1,
+                self.component_2,
+                self.component_2_v1,
+            ],
+            key="u4",
+        )
         # Units 5/6 don't contain it
         _unit5_no = self.create_unit_with_components([self.component_2_v1, self.component_2], key="u5")
         _unit6_no = self.create_unit_with_components([], key="u6")
         # To test unique results, unit 7 ✅ contains several copies of component 1. Also tests matching against
         # components that aren't in the first position.
-        unit7_several = self.create_unit_with_components([
-            self.component_2, self.component_1, self.component_1_v1, self.component_1,
-        ], key="u7")
+        unit7_several = self.create_unit_with_components(
+            [
+                self.component_2,
+                self.component_1,
+                self.component_1_v1,
+                self.component_1,
+            ],
+            key="u7",
+        )
 
         # No need to publish anything as the get_containers_with_entity() API only considers drafts (for now).
 
@@ -986,11 +1005,13 @@ def test_get_components_in_unit_queries(self):
         Test the query count of get_components_in_unit()
         This also tests the generic method get_entities_in_container()
         """
-        unit = self.create_unit_with_components([
-            self.component_1,
-            self.component_2,
-            self.component_2_v1,
-        ])
+        unit = self.create_unit_with_components(
+            [
+                self.component_1,
+                self.component_2,
+                self.component_2_v1,
+            ]
+        )
         with self.assertNumQueries(3):
             result = content_api.get_components_in_unit(unit, published=False)
         assert result == [