update taskflow user name parameter naming (#1653)

bihealth · Sep 13, 2024 · 99252d2 · 99252d2
1 parent 3ee4e53
commit 99252d2
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -40,6 +40,7 @@ Changed
     - Send iRODS delete request emails to all addresses of user (#2000)
 - **Taskflowbackend**
     - Refactor task tests (#2002)
+    - Unify user name parameter naming in flows (#1653)
 
 Removed
 -------

diff --git a/taskflowbackend/flows/role_delete.py b/taskflowbackend/flows/role_delete.py
@@ -6,7 +6,7 @@ class Flow(BaseLinearFlow):
     """Flow for removing an user's role in project"""
 
     def validate(self):
-        self.required_fields = ['username']
+        self.required_fields = ['user_name']
         self.require_lock = False  # Project lock not required for this flow
         return super().validate()
 
@@ -19,7 +19,7 @@ def build(self, force_fail=False):
                 irods=self.irods,
                 inject={
                     'group_name': existing_group,
-                    'user_name': self.flow_data['username'],
+                    'user_name': self.flow_data['user_name'],
                 },
             )
         )
diff --git a/taskflowbackend/flows/role_update.py b/taskflowbackend/flows/role_update.py
@@ -6,7 +6,7 @@ class Flow(BaseLinearFlow):
     """Flow for updating an user's role in project"""
 
     def validate(self):
-        self.required_fields = ['username']
+        self.required_fields = ['user_name']
         self.require_lock = False  # Project lock not required for this flow
         return super().validate()
 
@@ -18,7 +18,7 @@ def build(self, force_fail=False):
                 name='Create user in irods',
                 irods=self.irods,
                 inject={
-                    'user_name': self.flow_data['username'],
+                    'user_name': self.flow_data['user_name'],
                     'user_type': 'rodsuser',
                 },
             )
@@ -29,7 +29,7 @@ def build(self, force_fail=False):
                 irods=self.irods,
                 inject={
                     'group_name': project_group,
-                    'user_name': self.flow_data['username'],
+                    'user_name': self.flow_data['user_name'],
                 },
             )
         )
diff --git a/taskflowbackend/flows/role_update_irods_batch.py b/taskflowbackend/flows/role_update_irods_batch.py
@@ -12,14 +12,14 @@ def validate(self):
 
     def build(self, force_fail=False):
         # Add roles
-        for username in set(
+        for user_name in set(
             [r['user_name'] for r in self.flow_data['roles_add']]
         ):
             self.add_task(
                 irods_tasks.CreateUserTask(
-                    name='Create user "{}" in irods'.format(username),
+                    name='Create user "{}" in irods'.format(user_name),
                     irods=self.irods,
-                    inject={'user_name': username, 'user_type': 'rodsuser'},
+                    inject={'user_name': user_name, 'user_type': 'rodsuser'},
                 )
             )
         for role_add in self.flow_data['roles_add']:

diff --git a/taskflowbackend/plugins.py b/taskflowbackend/plugins.py
@@ -271,7 +271,7 @@ def perform_role_modify(self, role_as, action, old_role=None, request=None):
         children = self._get_child_projects(project)
 
         if project.type == PROJECT_TYPE_PROJECT:
-            flow_data = {'username': user.username}
+            flow_data = {'user_name': user.username}
             taskflow.submit(
                 project=project, flow_name='role_update', flow_data=flow_data
             )

diff --git a/taskflowbackend/tests/test_flows.py b/taskflowbackend/tests/test_flows.py
@@ -1642,7 +1642,7 @@ def setUp(self):
     def test_delete(self):
         """Test role_delete for deleting a role assignment"""
         self.assert_group_member(self.project, self.user_new, True)
-        flow_data = {'username': self.user_new.username}
+        flow_data = {'user_name': self.user_new.username}
         flow = self.taskflow.get_flow(
             irods_backend=self.irods_backend,
             project=self.project,
@@ -1656,7 +1656,7 @@ def test_delete(self):
     def test_delete_locked(self):
         """Test role_delete with locked project"""
         self.assert_group_member(self.project, self.user_new, True)
-        flow_data = {'username': self.user_new.username}
+        flow_data = {'user_name': self.user_new.username}
         flow = self.taskflow.get_flow(
             irods_backend=self.irods_backend,
             project=self.project,
@@ -1683,7 +1683,7 @@ def test_update(self):
         user_new = self.make_user('user_new')
         self.make_assignment(self.project, user_new, self.role_contributor)
         self.assert_group_member(self.project, user_new, False)
-        flow_data = {'username': user_new.username}
+        flow_data = {'user_name': user_new.username}
         flow = self.taskflow.get_flow(
             irods_backend=self.irods_backend,
             project=self.project,
@@ -1699,7 +1699,7 @@ def test_update_locked(self):
         user_new = self.make_user('user_new')
         self.make_assignment(self.project, user_new, self.role_contributor)
         self.assert_group_member(self.project, user_new, False)
-        flow_data = {'username': user_new.username}
+        flow_data = {'user_name': user_new.username}
         flow = self.taskflow.get_flow(
             irods_backend=self.irods_backend,
             project=self.project,