Update tests to have the same content available in portal, add doc strings

Author: jnptk

tests/services/blocktypes/test_blocktypes_get.py

@@ -9,9 +9,29 @@ def portal(portal_class):
     yield portal_class
 
 
+@pytest.fixture(scope="class")
+def contents(portal):
+    with api.env.adopt_roles(["Manager"]):
+        doc = api.content.create(portal, type="Document", id="lorem-ipsum")
+        doc.blocks = {
+            "1": {"@type": "title"},
+            "2": {"@type": "teaser"},
+            "3": {
+                "@type": "gridBlock",
+                "blocks": {
+                    "1": {"@type": "teaser"},
+                    "2": {"@type": "teaser"},
+                    "3": {"@type": "teaser"},
+                },
+            },
+        }
+        doc.reindexObject(idxs=["block_types"])
+        transaction.commit()
+
+
 class TestBlockTypesGet:
     @pytest.fixture(autouse=True)
-    def _setup(self, portal, api_manager_request):
+    def _setup(self, contents, portal, api_manager_request):
         self.portal = portal
         self.api_session = api_manager_request
 
@@ -26,28 +46,11 @@ def test_response_type_with_id(self):
         assert isinstance(data, list)
 
     def test_filtered(self):
-        with api.env.adopt_roles(["Manager"]):
-            doc = api.content.create(self.portal, type="Document", id="lorem-ipsum")
-            doc.blocks = {
-                "1": {"@type": "title"},
-                "2": {"@type": "teaser"},
-                "3": {
-                    "@type": "gridBlock",
-                    "blocks": {
-                        "1": {"@type": "teaser"},
-                        "2": {"@type": "teaser"},
-                        "3": {"@type": "teaser"},
-                    },
-                },
-            }
-            doc.reindexObject(idxs=["block_types"])
-            transaction.commit()
-
         response = self.api_session.get("/@blocktypes?path=/plone/lorem-ipsum")
         data = response.json()
         assert len(data) == 3
 
     def test_filtered_with_id(self):
         response = self.api_session.get("/@blocktypes/teaser?path=/plone/lorem-ipsum")
         data = response.json()
-        assert len(data) == 4
+        assert len(data) == 1

tests/services/conftest.py

@@ -8,13 +8,13 @@
 
 @pytest.fixture()
 def portal(functional):
-    """"""
+    """Provide the Plone portal instance for functional tests."""
     yield functional["portal"]
 
 
 @pytest.fixture(scope="class")
 def portal_class(functional_class):
-    """"""
+    """Provide the Plone portal instance for class-scoped functional tests."""
     if hasattr(functional_class, "testSetUp"):
         functional_class.testSetUp()
     portal = functional_class["portal"]
@@ -26,7 +26,7 @@ def portal_class(functional_class):
 
 @pytest.fixture()
 def request_api_factory(portal):
-    """"""
+    """Provide a factory function for creating Plone REST API session objects."""
 
     def factory():
         url = portal.absolute_url()
@@ -38,14 +38,14 @@ def factory():
 
 @pytest.fixture()
 def api_anon_request(request_api_factory):
-    """"""
+    """Provide an unauthenticated REST API session for anonymous requests."""
     request = request_api_factory()
     yield request
 
 
 @pytest.fixture()
 def api_manager_request(request_api_factory):
-    """"""
+    """Provide an authenticated REST API session with manager privileges."""
     request = request_api_factory()
     request.auth = (SITE_OWNER_NAME, SITE_OWNER_PASSWORD)
     yield request