global: clean test infrastructure

.github/workflows/tests.yml

@@ -2,6 +2,7 @@
 #
 # This file is part of Invenio.
 # Copyright (C) 2016-2021 CERN.
+# Copyright (C) 2022 Graz University of Technology.
 #
 # Invenio is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -30,10 +31,10 @@ jobs:
       matrix:
           python-version: [3.7, 3.8, 3.9]
           requirements-level: [pypi]
-          db-service: [postgresql12]
+          db-service: [postgresql13]
           search-service: [elasticsearch7]
           include:
-          - db-service: postgresql12
+          - db-service: postgresql13
             DB_EXTRAS: "postgresql"
     env:
       DB: ${{ matrix.db-service }}

invenio_communities/alembic/5b478fe7ef7f_create_featured_communities_table.py

@@ -5,7 +5,7 @@
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Create featured communities table"""
+"""Create featured communities table."""
 
 import sqlalchemy as sa
 from alembic import op

invenio_communities/alembic/a3f5a8635cbb_remove_version_table.py

@@ -5,7 +5,7 @@
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Remove version table"""
+"""Remove version table."""
 
 import sqlalchemy as sa
 import sqlalchemy_utils

invenio_communities/alembic/fbe746957cfc_create_member_tables.py

@@ -5,7 +5,7 @@
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
-"""Create member tables"""
+"""Create member tables."""
 
 import sqlalchemy as sa
 from alembic import op

invenio_communities/cli.py

@@ -40,6 +40,7 @@ def demo():
 @communities.command("rebuild-index")
 @with_appcontext
 def rebuild_index():
+    """Rebuild index."""
     click.secho("Reindexing communities...", fg="green")
 
     communities_service = current_communities.service

invenio_communities/communities/dumpers/featured.py

@@ -7,6 +7,7 @@
 # under the terms of the MIT License; see LICENSE file for more details.
 
 """Featured timestamp dumper.
+
 Dumper used to dump/load the featured times of a record to/from an
 ElasticSearch body.
 """
@@ -27,7 +28,6 @@ def __init__(self, key="featured"):
 
     def dump(self, record, data):
         """Dump featured entries."""
-
         now_ = datetime.utcnow()
         future_entries = (
             CommunityFeatured.query.filter(

invenio_communities/communities/records/__init__.py

@@ -5,3 +5,5 @@
 #
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
+
+"""Init."""

invenio_communities/communities/records/systemfields/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2016-2021 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Init."""

invenio_communities/communities/records/systemfields/pidslug.py

@@ -17,7 +17,10 @@
 
 
 class PIDSlugFieldContext(SystemFieldContext):
+    """PID Slug Field Context."""
+
     def parse_pid(self, value):
+        """Parse pid."""
         if isinstance(value, UUID):
             return value
         try:

invenio_communities/communities/resources/resource.py

@@ -194,6 +194,7 @@ def delete_logo(self):
     @request_search_args
     @response_handler(many=True)
     def featured_communities_search(self):
+        """Features communities search."""
         hits = self.service.featured_search(
             identity=g.identity,
             params=resource_requestctx.args,

invenio_communities/communities/schema.py

@@ -32,7 +32,7 @@ def _not_blank(**kwargs):
 
 
 def is_not_uuid(value):
-    """Make sure value is not a UUID"""
+    """Make sure value is not a UUID."""
     try:
         UUID(value)
         raise ValidationError(
@@ -43,6 +43,7 @@ def is_not_uuid(value):
 
 
 class CommunityAccessSchema(Schema):
+    """Community Access Schema."""
 
     visibility = fields.Str(
         validate=validate.OneOf(
@@ -83,6 +84,7 @@ class VocabularySchema(Schema):
     @pre_load
     def clean(self, data, **kwargs):
         """Removes dump_only fields.
+
         Why: We want to allow the output of a Schema dump, to be a valid input
              to a Schema load without causing strange issues.
         """
@@ -137,5 +139,7 @@ def lowercase(self, in_data, **kwargs):
 
 
 class CommunityFeaturedSchema(Schema):
+    """Community Featured Schema."""
+
     id = fields.Int(metadata={"read_only": True})
     start_date = fields.DateTime(required=True)

invenio_communities/communities/services/components.py

@@ -8,6 +8,8 @@
 # Invenio is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
+"""Components."""
+
 from flask_babelex import lazy_gettext as _
 from invenio_access.permissions import system_identity, system_process
 from invenio_db import db
@@ -24,6 +26,7 @@ class PIDComponent(ServiceComponent):
     """Service component for Community PIDs."""
 
     def set_slug(self, record, slug):
+        """Set slug."""
         error = ValidationError(
             _("A community with this identifier already exists."), field_name="slug"
         )
@@ -107,6 +110,7 @@ class FeaturedCommunityComponent(ServiceComponent):
     """Service component for featured community integration."""
 
     def featured_create(self, identity, data=None, record=None, **kwargs):
+        """Featured create."""
         if record.access.visibility != "public":
             raise ValidationError(
                 _("The community is not public"), field_name="community_id"
@@ -183,7 +187,7 @@ def update(self, identity, data=None, record=None, **kwargs):
         db.session.add(community_set)
 
     def rename(self, identity, record=None, data=None, old_slug=None, **kwargs):
-        """Delete old set and create new set on ID change"""
+        """Delete old set and create new set on ID change."""
         if record.access.visibility != "public":
             return
 

invenio_communities/errors.py

@@ -5,10 +5,10 @@
 # Invenio-Communities is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
-from flask_babelex import gettext as _
-
 """Community base error."""
 
+from flask_babelex import gettext as _
+
 
 class CommunityError(Exception):
     """Base exception for community errors."""

invenio_communities/generators.py

@@ -149,6 +149,7 @@ def roles(self, **kwargs):
         raise NotImplementedError
 
     def communities(self, identity):
+        """Communities."""
         raise NotImplementedError
 
     def needs(self, record=None, community_id=None, **kwargs):
@@ -175,30 +176,35 @@ class CommunityMembers(CommunityRoles):
     """Roles representing all members of a community."""
 
     def roles(self, **kwargs):
+        """Roles."""
         return [r.name for r in current_roles]
 
     def communities(self, identity):
+        """Communities."""
         return [n.value for n in identity.provides if n.method == "community"]
 
 
 class CommunityCurators(CommunityRoles):
     """Roles representing all curators of a community."""
 
     def roles(self, **kwargs):
+        """Roles."""
         return [r.name for r in current_roles.can("curate")]
 
 
 class CommunityManagers(CommunityRoles):
     """Roles representing all managers of a community."""
 
     def roles(self, **kwargs):
+        """Roles."""
         return [r.name for r in current_roles.can("manage")]
 
 
 class CommunityManagersForRole(CommunityRoles):
     """Roles representing all managers of a community for a role update."""
 
     def roles(self, role=None, member=None, **kwargs):
+        """Roles."""
         allowed_roles = []
         if role is not None and member is not None:
             # Update from an old role to a new role. The most restrictive set
@@ -223,9 +229,11 @@ class CommunityOwners(CommunityRoles):
     """Roles representing the owners of a community."""
 
     def roles(self, **kwargs):
+        """Roles."""
         return [current_roles.owner_role.name]
 
     def communities(self, identity):
+        """Communities."""
         return [
             n.value
             for n in identity.provides

invenio_communities/members/records/api.py

@@ -6,7 +6,7 @@
 # Invenio-Communities is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
-"Members data layer API."
+"""Members data layer API."""
 
 from invenio_accounts.models import Role
 from invenio_db import db

invenio_communities/members/services/config.py

@@ -27,6 +27,8 @@
 
 
 class PublicSearchOptions(SearchOptions):
+    """Public Search Options."""
+
     sort_default = "bestmatch"
     sort_default_no_query = "name"
     sort_options = {
@@ -62,6 +64,8 @@ class PublicSearchOptions(SearchOptions):
 
 
 class InvitationsSearchOptions(SearchOptions):
+    """Invitations Search Options."""
+
     # TODO: should restrict fields that's being searched on.
     # query_parser_cls = QueryParser
     sort_default = "bestmatch"

invenio_communities/members/services/request.py

@@ -16,6 +16,7 @@
 
 
 def service():
+    """Service."""
     return current_communities.service.members
 
 

invenio_communities/members/services/schemas.py

@@ -36,6 +36,8 @@ class MemberEntitySchema(Schema):
 
 
 class MembersSchema(Schema):
+    """Members Schema."""
+
     members = fields.List(
         fields.Nested(MemberEntitySchema),
         # max is on purpose to limit the max number of additions/changes/
@@ -46,6 +48,8 @@ class MembersSchema(Schema):
 
 
 class RequestSchema(Schema):
+    """Request Schema."""
+
     id = fields.String()
     status = fields.String()
     is_open = fields.Boolean()
@@ -94,19 +98,20 @@ class DeleteBulkSchema(MembersSchema):
 
 
 class PublicDumpSchema(Schema):
+    """Public Dump Schema."""
+
     id = fields.String(required=True)
     member = fields.Method("get_member")
 
     def get_member(self, obj):
-        """Get a member"""
+        """Get a member."""
         if obj.user_id:
             return self.get_user_member(obj["user"])
         elif obj.group_id:
             return self.get_group_member(obj["group"])
 
     def get_user_member(self, user):
         """Get a user member."""
-
         profile = user.get("profile", {})
         name = profile.get("full_name") or user.get("username") or _("Untitled")
         description = profile.get("affiliations") or ""
@@ -147,7 +152,7 @@ class MemberDumpSchema(PublicDumpSchema):
     revision_id = fields.Integer()
 
     def is_self(self, obj):
-        """Get permission"""
+        """Get permission."""
         if "is_self" not in self.context:
             current_identity = self.context["identity"]
             self.context["is_self"] = (
@@ -158,11 +163,11 @@ def is_self(self, obj):
         return self.context["is_self"]
 
     def get_current_user(self, obj):
-        """Get permission"""
+        """Get permission."""
         return self.is_self(obj)
 
     def get_permissions(self, obj):
-        """Get permission"""
+        """Get permission."""
         permission_check = self.context["field_permission_check"]
 
         # Does not take CommunitySelfMember into account because no "member" is
@@ -191,7 +196,7 @@ class InvitationDumpSchema(MemberDumpSchema):
     permissions = fields.Method("get_permissions")
 
     def get_permissions(self, obj):
-        """Get permission"""
+        """Get permission."""
         # Only owners and managers can list invitations, and thus only the
         # request status is necessary to determine if the identity can cancel.
         is_open = obj["request"]["status"] == "submitted"

invenio_communities/members/services/service.py

@@ -304,6 +304,7 @@ def _invite_factory(self, identity, community, role, visible, member, message, u
             )
 
     def search(self, identity, community_id, params=None, es_preference=None, **kwargs):
+        """Search."""
         return self._members_search(
             identity,
             community_id,

invenio_communities/records/__init__.py

@@ -5,3 +5,5 @@
 # Invenio-Communities is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
 # details.
+
+"""Init."""

invenio_communities/records/records/__init__.py

@@ -5,3 +5,5 @@
 # Invenio-Communities is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
 # details.
+
+"""Init."""

invenio_communities/records/records/systemfields/__init__.py

@@ -6,6 +6,8 @@
 # modify it under the terms of the MIT License; see LICENSE file for more
 # details.
 
+"""Init."""
+
 from .communities.field import CommunitiesField
 
 __all__ = ("CommunitiesField",)

invenio_communities/records/records/systemfields/communities/__init__.py

@@ -5,3 +5,5 @@
 # Invenio-Communities is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
 # details.
+
+"""Init."""

invenio_communities/records/records/systemfields/communities/field.py

@@ -20,6 +20,7 @@ class CommunitiesField(SystemField):
     def __init__(
         self, m2m_model_cls, key="communities", context_cls=None, manager_cls=None
     ):
+        """Constructor."""
         self._m2m_model_cls = m2m_model_cls
         self._context_cls = context_cls or CommunitiesFieldContext
         self._manager_cls = manager_cls or CommunitiesRelationManager