more project api refactoring, fix test role init (#638)

bihealth · Mar 13, 2023 · 65bb633 · 65bb633
1 parent 4b3c0a6
commit 65bb633
Show file tree

Hide file tree

Showing 21 changed files with 375 additions and 262 deletions.
diff --git a/docs/source/major_changes.rst b/docs/source/major_changes.rst
@@ -52,6 +52,8 @@ effected code accordingly.
   ``RoleAssignment`` model queries.
 - ``Project.get_all_roles()`` has been removed. ``Project.get_roles()`` should
   be used in its place.
+- ``Project.get_delegates()`` returns a ``list`` instead of a ``QuerySet``. The
+  method signature has also been changed.
 
 Base Classes for Tests Updated
 ------------------------------

diff --git a/filesfolders/tests/test_plugins.py b/filesfolders/tests/test_plugins.py
@@ -6,9 +6,13 @@
 from test_plus.test import TestCase
 
 # Projectroles dependency
-from projectroles.models import Role, SODAR_CONSTANTS
+from projectroles.models import SODAR_CONSTANTS
 from projectroles.plugins import ProjectAppPluginPoint
-from projectroles.tests.test_models import ProjectMixin, RoleAssignmentMixin
+from projectroles.tests.test_models import (
+    ProjectMixin,
+    RoleMixin,
+    RoleAssignmentMixin,
+)
 
 from filesfolders.urls import urlpatterns
 from filesfolders.tests.test_models import (
@@ -36,6 +40,7 @@
 
 class TestPlugins(
     ProjectMixin,
+    RoleMixin,
     FolderMixin,
     FileMixin,
     HyperLinkMixin,
@@ -51,7 +56,7 @@ def setUp(self):
         self.user.is_superuser = True
         self.user.save()
         # Init roles
-        self.role_owner = Role.objects.get_or_create(name=PROJECT_ROLE_OWNER)[0]
+        self.init_roles()
         # Init project and owner role
         self.project = self.make_project(
             'TestProject', PROJECT_TYPE_PROJECT, None

diff --git a/filesfolders/tests/test_views.py b/filesfolders/tests/test_views.py
@@ -9,8 +9,12 @@
 from test_plus.test import TestCase
 
 # Projectroles dependency
-from projectroles.models import Role, SODAR_CONSTANTS
-from projectroles.tests.test_models import ProjectMixin, RoleAssignmentMixin
+from projectroles.models import SODAR_CONSTANTS
+from projectroles.tests.test_models import (
+    ProjectMixin,
+    RoleMixin,
+    RoleAssignmentMixin,
+)
 from projectroles.app_settings import AppSettingAPI
 
 from filesfolders.models import File, Folder, HyperLink
@@ -43,19 +47,17 @@
 
 
 class TestViewsBaseMixin(
-    ProjectMixin, RoleAssignmentMixin, FileMixin, FolderMixin, HyperLinkMixin
+    ProjectMixin,
+    RoleMixin,
+    RoleAssignmentMixin,
+    FileMixin,
+    FolderMixin,
+    HyperLinkMixin,
 ):
     def setUp(self):
         self.req_factory = RequestFactory()
         # Init roles
-        self.role_owner = Role.objects.get_or_create(name=PROJECT_ROLE_OWNER)[0]
-        self.role_delegate = Role.objects.get_or_create(
-            name=PROJECT_ROLE_DELEGATE
-        )[0]
-        self.role_contributor = Role.objects.get_or_create(
-            name=PROJECT_ROLE_CONTRIBUTOR
-        )[0]
-        self.role_guest = Role.objects.get_or_create(name=PROJECT_ROLE_GUEST)[0]
+        self.init_roles()
         # Init superuser
         self.user = self.make_user('superuser')
         self.user.is_staff = True

diff --git a/projectroles/forms.py b/projectroles/forms.py
@@ -784,7 +784,7 @@ def clean(self):
             # Ensure delegate limit is not exceeded
             if (
                 del_limit != 0
-                and self.project.get_delegates(exclude_inherited=True).count()
+                and len(self.project.get_delegates(inherited=False))
                 >= del_limit
             ):
                 self.add_error(
@@ -887,7 +887,7 @@ def clean_old_owner_role(self):
                 del_limit != 0
                 and new_owner_role
                 and new_owner_role.role.name != PROJECT_ROLE_DELEGATE
-                and self.project.get_delegates(exclude_inherited=True).count()
+                and len(self.project.get_delegates(inherited=False))
                 >= del_limit
             ):
                 raise forms.ValidationError(
@@ -1026,7 +1026,7 @@ def clean(self):
             # Ensure delegate limit is not exceeded
             if (
                 del_limit != 0
-                and self.project.get_delegates(exclude_inherited=True).count()
+                and len(self.project.get_delegates(inherited=False))
                 >= del_limit
             ):
                 self.add_error(

diff --git a/projectroles/management/commands/batchupdateroles.py b/projectroles/management/commands/batchupdateroles.py
@@ -67,6 +67,7 @@ def _update_role(self, project, user, role):
         logger.info(
             'Updating role of user {} to {}..'.format(user.username, role.name)
         )
+        # TODO: Update to handle other inherited users
         if user in [a.user for a in project.get_owners(inherited_only=True)]:
             logger.info('Skipping as user has inherited ownership')
             return
@@ -145,8 +146,7 @@ def _handle_list_row(self, project, role_name, email):
         if (
             role == self.del_role
             and del_limit != 0
-            and project.get_delegates(exclude_inherited=True).count()
-            >= del_limit
+            and len(project.get_delegates(inherited=False)) >= del_limit
         ):
             raise Exception(
                 'Delegate limit of {} has been reached'.format(del_limit)