Increase test coverage (#39)

* Add .github/CODEOWNERS

* Remove locales from coverage report

* Increase test coverage of the package

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @jonaspiterek @ericof @sneridagh @tisto
+/.github @ericof

.meta.toml

@@ -12,6 +12,12 @@ dependencies_ignores = "['plone.volto', 'zestreleaser.towncrier', 'zest.releaser
 dependencies_mappings = [
     "Plone = ['Products.CMFPlone', 'Products.CMFCore', 'Products.GenericSetup', 'Products.ZCatalog', 'z3c.form']",
     ]
+extra_lines = """
+[tool.coverage.run]
+omit = [
+  "src/collective/blog/locales/*",
+]
+"""
 
 [tox]
 use_mxdev = true

news/38.internal

@@ -0,0 +1 @@
+Increase test coverage of the package [@ericof]

pyproject.toml

@@ -153,6 +153,10 @@ ignore = [
 #  """
 ##
 
+[tool.coverage.run]
+omit = [
+  "src/collective/blog/locales/*",
+]
 
 ##
 # Add extra configuration options in .meta.toml:

src/collective/blog/indexers/__init__.py

@@ -9,9 +9,6 @@ def _find_blog_uid(obj: DexterityContent) -> str:
     """Find a blog."""
     if IBlogInfo.providedBy(obj):
         return api.content.get_uuid(obj)
-    elif IPloneSiteRoot.providedBy(obj):
-        # No blog was found
-        return "No blog was found."
     else:
-        # Up one level (get parent)
-        return _find_blog_uid(aq_parent(obj))
+        # Up one level (get parent) if not reached the root of the site
+        return "" if IPloneSiteRoot.providedBy(obj) else _find_blog_uid(aq_parent(obj))

src/collective/blog/profiles.zcml

@@ -6,20 +6,26 @@
 
   <genericsetup:registerProfile
       name="default"
-      title="Blog: Install"
+      title="Blog Support for Plone"
       description="Package to configure Blog content types"
       provides="Products.GenericSetup.interfaces.EXTENSION"
       directory="profiles/default"
       />
 
   <genericsetup:registerProfile
       name="uninstall"
-      title="Blog: Uninstall"
+      title="Blog Support for Plone: Uninstall"
       description="Uninstall Blog setup."
       provides="Products.GenericSetup.interfaces.EXTENSION"
       directory="profiles/uninstall"
       />
 
   <include package=".upgrades" />
 
+  <!-- Hide Uninstall Profile-->
+  <utility
+      factory=".setuphandlers.HiddenProfiles"
+      name="collective.blog"
+      />
+
 </configure>

src/collective/blog/services/authors/get.py

@@ -40,14 +40,18 @@ def __call__(self, expand=True):
                     "fullname": brain.Title,
                 }
             )
-        if not data:
-            data = [
+        data = (
+            data
+            if data
+            else [
                 {
                     "@id": portal_url,
                     "fullname": DEFAULT_USER,
                 }
             ]
-        return {"authors": data}
+        )
+        result["authors"]["items"] = data
+        return result
 
 
 class AuthorsGet(Service):

tests/conftest.py

@@ -1,7 +1,11 @@
 from collective.blog.testing import ACCEPTANCE_TESTING
 from collective.blog.testing import FUNCTIONAL_TESTING
 from collective.blog.testing import INTEGRATION_TESTING
+from copy import deepcopy
 from plone import api
+from plone.app.testing import SITE_OWNER_NAME
+from plone.app.testing import SITE_OWNER_PASSWORD
+from plone.restapi.testing import RelativeSession
 from pytest_plone import fixtures_factory
 
 import pytest
@@ -22,54 +26,74 @@
 
 
 @pytest.fixture
-def blogs_payload() -> list:
-    """Payload to create two blogs items."""
+def filter_items():
+    def func(content: list, portal_type: str, only_public: bool = False) -> list:
+        response = []
+        for raw_item in content:
+            if raw_item["type"] != portal_type:
+                continue
+            if only_public:
+                item = {k: v for k, v in raw_item.items() if not k.startswith("_")}
+            else:
+                item = deepcopy(raw_item)
+            response.append(item)
+        return response
+
+    return func
+
+
+@pytest.fixture
+def all_content() -> list:
+    """Payload to create all content items."""
     return [
         {
+            "_container": "/",
+            "type": "Image",
+            "id": "an-image",
+            "title": "A Random Image",
+            "description": "With some details",
+            "_image": b"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAA1JREFUGFdjCDO+/R8ABKsCZD++CcMAAAAASUVORK5CYII=",  # noQA
+        },
+        {
+            "_container": "/",
             "type": "Blog",
             "id": "tech-blog",
             "title": "Awesome Tech Blog",
             "description": "My awesome technical blog",
         },
         {
+            "_container": "/",
             "type": "Blog",
             "id": "dumpster",
             "title": "General",
             "description": "Posts about life, universe and everything",
         },
-    ]
-
-
-@pytest.fixture
-def authors_payload() -> list:
-    """Payload to create two author items."""
-    return [
         {
+            "_container": "/tech-blog/authors",
             "type": "Author",
             "id": "douglas-adams",
             "title": "Douglas Adams",
             "description": "A very good writer",
         },
         {
+            "_container": "/tech-blog/authors",
+            "_preview_image_link": "/an-image",
             "type": "Author",
             "id": "marvin",
             "title": "Marvin",
             "description": "A very good nice robot",
         },
-    ]
-
-
-@pytest.fixture
-def posts_payload() -> list:
-    """Payload to create two posts items."""
-    return [
         {
+            "_container": "/tech-blog",
+            "_preview_image_link": "/an-image",
             "type": "Post",
             "id": "initial-commit",
             "title": "Initial Blog Post",
             "description": "Let's start my blog post with something cool",
         },
         {
+            "_container": "/tech-blog",
+            "_preview_image_link": "/an-image",
             "type": "Post",
             "id": "collective-blog",
             "title": "New package: collective.blog",
@@ -78,6 +102,24 @@ def posts_payload() -> list:
     ]
 
 
+@pytest.fixture
+def blogs_payload(all_content, filter_items) -> list:
+    """Payload to create two blogs items."""
+    return filter_items(all_content, "Blog", True)
+
+
+@pytest.fixture
+def authors_payload(all_content, filter_items) -> list:
+    """Payload to create two author items."""
+    return filter_items(all_content, "Author", True)
+
+
+@pytest.fixture
+def posts_payload(all_content, filter_items) -> list:
+    """Payload to create two posts items."""
+    return filter_items(all_content, "Post", True)
+
+
 @pytest.fixture
 def blogs(portal, blogs_payload) -> dict:
     """Create Blogs content items."""
@@ -117,3 +159,27 @@ def posts(portal, authors, blogs, posts_payload) -> dict:
             content = api.content.create(container=blog, **data)
             response[content.UID()] = content.title
     return response
+
+
+@pytest.fixture()
+def request_factory(portal):
+    def factory():
+        url = portal.absolute_url()
+        api_session = RelativeSession(url)
+        api_session.headers.update({"Accept": "application/json"})
+        return api_session
+
+    return factory
+
+
+@pytest.fixture()
+def anon_request(request_factory):
+    return request_factory()
+
+
+@pytest.fixture()
+def manager_request(request_factory):
+    request = request_factory()
+    request.auth = (SITE_OWNER_NAME, SITE_OWNER_PASSWORD)
+    yield request
+    request.auth = ()

tests/controlpanel/conftest.py

@@ -1,15 +1,6 @@
-from plone.app.testing import SITE_OWNER_NAME
-from plone.app.testing import SITE_OWNER_PASSWORD
-from plone.restapi.testing import RelativeSession
-
 import pytest
 
 
-@pytest.fixture()
-def app(functional):
-    return functional["app"]
-
-
 @pytest.fixture()
 def portal(functional):
     portal = functional["portal"]
@@ -19,27 +10,3 @@ def portal(functional):
 @pytest.fixture()
 def http_request(functional):
     return functional["request"]
-
-
-@pytest.fixture()
-def request_factory(portal):
-    def factory():
-        url = portal.absolute_url()
-        api_session = RelativeSession(url)
-        api_session.headers.update({"Accept": "application/json"})
-        return api_session
-
-    return factory
-
-
-@pytest.fixture()
-def anon_request(request_factory):
-    return request_factory()
-
-
-@pytest.fixture()
-def manager_request(request_factory):
-    request = request_factory()
-    request.auth = (SITE_OWNER_NAME, SITE_OWNER_PASSWORD)
-    yield request
-    request.auth = ()

tests/restapi/conftest.py

@@ -0,0 +1,59 @@
+from base64 import b64decode
+from copy import deepcopy
+from plone import api
+from plone.namedfile.file import NamedBlobImage
+
+import pytest
+import transaction
+
+
+@pytest.fixture()
+def create_content_tree(all_content):
+    def func():
+        contents = []
+        author_uid = ""
+        with api.env.adopt_roles(["Manager"]):
+            # Create image to be used as preview
+            for data in all_content:
+                item = deepcopy(data)
+                target_info = None
+                parent = item.pop("_container")
+                container = api.content.get(path=parent)
+                if "_image" in item:
+                    item["image"] = NamedBlobImage(b64decode(item.pop("_image")))
+                if "_preview_image_link" in item:
+                    target_info = (
+                        api.content.get(item.pop("_preview_image_link")),
+                        "preview_image_link",
+                    )
+                if item["type"] == "Post":
+                    item["creators"] = [author_uid]
+                content = api.content.create(container=container, **item)
+                if target_info:
+                    target, relationship = target_info
+                    api.relation.create(content, target, relationship)
+                content_uid = api.content.get_uuid(content)
+                if item["type"] == "Author" and not author_uid:
+                    author_uid = content_uid
+                contents.append(content_uid)
+        return contents
+
+    return func
+
+
+@pytest.fixture()
+def portal(functional, create_content_tree):
+    portal = functional["portal"]
+    with transaction.manager:
+        contents = create_content_tree()
+    yield portal
+    with transaction.manager:
+        for uid in contents[::-1]:
+            obj = api.content.get(UID=uid)
+            if obj:
+                api.content.delete(obj)
+
+
+@pytest.fixture()
+def http_request(functional):
+    return functional["request"]