feat: more usernames support for MR approvals

jarodwilson · JohnVillalovos · commit 12d195a35a1b · 2024-05-14T08:24:30.000-07:00
I don't think commit a2b8c8c went far enough to enable usernames support. We create and edit a lot of approval rules based on an external service (similar to CODE_OWNERS), but only have the usernames available, and currently, have to look up each user to get their user ID to populate user_ids for .set_approvers() calls. Would very much like to skip the lookup and just send the usernames, which this change should allow. See: https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule Signed-off-by: Jarod Wilson <jarod@redhat.com>
diff --git a/gitlab/v4/objects/merge_request_approvals.py b/gitlab/v4/objects/merge_request_approvals.py
@@ -89,6 +89,8 @@ def set_approvers(
         approver_ids: Optional[List[int]] = None,
         approver_group_ids: Optional[List[int]] = None,
         approval_rule_name: str = "name",
+        *,
+        approver_usernames: Optional[List[str]] = None,
         **kwargs: Any,
     ) -> RESTObject:
         """Change MR-level allowed approvers and approver groups.
@@ -104,13 +106,15 @@ def set_approvers(
         """
         approver_ids = approver_ids or []
         approver_group_ids = approver_group_ids or []
+        approver_usernames = approver_usernames or []
 
         data = {
             "name": approval_rule_name,
             "approvals_required": approvals_required,
             "rule_type": "regular",
             "user_ids": approver_ids,
             "group_ids": approver_group_ids,
+            "usernames": approver_usernames,
         }
         if TYPE_CHECKING:
             assert self._parent is not None
@@ -124,6 +128,7 @@ def set_approvers(
                 ar.user_ids = data["user_ids"]
                 ar.approvals_required = data["approvals_required"]
                 ar.group_ids = data["group_ids"]
+                ar.usernames = data["usernames"]
                 ar.save()
                 return ar
         # if there was no rule matching the rule name, create a new one
@@ -145,14 +150,14 @@ class ProjectMergeRequestApprovalRuleManager(CRUDMixin, RESTManager):
             "name",
             "approvals_required",
         ),
-        optional=("user_ids", "group_ids"),
+        optional=("user_ids", "group_ids", "usernames"),
     )
     # Important: When approval_project_rule_id is set, the name, users and
     # groups of project-level rule will be copied. The approvals_required
     # specified will be used.
     _create_attrs = RequiredOptional(
         required=("name", "approvals_required"),
-        optional=("approval_project_rule_id", "user_ids", "group_ids"),
+        optional=("approval_project_rule_id", "user_ids", "group_ids", "usernames"),
     )
 
     def get(
