|
| 1 | +# Copyright 2026 Google LLC |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | +"""Helper for google groups management.""" |
| 15 | + |
| 16 | +import threading |
| 17 | +from urllib import parse |
| 18 | + |
| 19 | +from googleapiclient import discovery |
| 20 | +from googleapiclient import errors |
| 21 | + |
| 22 | +from clusterfuzz._internal.config import local_config |
| 23 | +from clusterfuzz._internal.google_cloud_utils import credentials |
| 24 | +from clusterfuzz._internal.metrics import logs |
| 25 | + |
| 26 | +# pylint: disable=no-member |
| 27 | + |
| 28 | +_FAIL_RETRIES = 3 |
| 29 | + |
| 30 | +_local = threading.local() |
| 31 | + |
| 32 | + |
| 33 | +def get_identity_api() -> discovery.Resource | None: |
| 34 | + """Return cloud identity api client.""" |
| 35 | + if not hasattr(_local, 'identity_service'): |
| 36 | + creds, _ = credentials.get_default() |
| 37 | + _local.identity_service = discovery.build( |
| 38 | + 'cloudidentity', 'v1', credentials=creds, cache_discovery=False) |
| 39 | + |
| 40 | + return _local.identity_service |
| 41 | + |
| 42 | + |
| 43 | +def get_group_id(group_name: str, exists_check: bool = False) -> str | None: |
| 44 | + """Retrive a google group ID.""" |
| 45 | + identity_service = get_identity_api() |
| 46 | + try: |
| 47 | + request = identity_service.groups().lookup(groupKey_id=group_name) |
| 48 | + response = request.execute() |
| 49 | + return response.get('name') |
| 50 | + except errors.HttpError: |
| 51 | + if not exists_check: |
| 52 | + logs.warning(f"Unable to look up group {group_name}.") |
| 53 | + return None |
| 54 | + |
| 55 | + |
| 56 | +def check_transitive_group_membership(group_id: str, member: str) -> bool: |
| 57 | + """Check if an user is a member of a google group.""" |
| 58 | + identity_service = get_identity_api() |
| 59 | + try: |
| 60 | + query_params = parse.urlencode({ |
| 61 | + "query": "member_key_id == '{}'".format(member) |
| 62 | + }) |
| 63 | + request = identity_service.groups().memberships().checkTransitiveMembership( |
| 64 | + parent=group_id) |
| 65 | + request.uri += "&" + query_params |
| 66 | + response = request.execute(num_retries=_FAIL_RETRIES) |
| 67 | + return response.get('hasMembership', False) |
| 68 | + except errors.HttpError: |
| 69 | + logs.warning( |
| 70 | + f'Unable to check group membership from {member} to {group_id}.') |
| 71 | + return False |
| 72 | + |
| 73 | + |
| 74 | +def create_google_group(group_name: str, |
| 75 | + group_display_name: str | None = None, |
| 76 | + group_description: str | None = None, |
| 77 | + customer_id: str | None = None) -> str | None: |
| 78 | + """Create a google group.""" |
| 79 | + identity_service = get_identity_api() |
| 80 | + |
| 81 | + customer_id = customer_id or str( |
| 82 | + local_config.ProjectConfig().get('groups_customer_id')) |
| 83 | + if not customer_id: |
| 84 | + logs.error('No customer ID set. Unable to create a new google group.') |
| 85 | + return None |
| 86 | + |
| 87 | + group_key = {"id": group_name} |
| 88 | + group = { |
| 89 | + "parent": "customers/" + customer_id, |
| 90 | + "description": group_description, |
| 91 | + "displayName": group_display_name, |
| 92 | + "groupKey": group_key, |
| 93 | + # Set the label to specify creation of a Google Group. |
| 94 | + "labels": { |
| 95 | + "cloudidentity.googleapis.com/groups.discussion_forum": "" |
| 96 | + } |
| 97 | + } |
| 98 | + try: |
| 99 | + request = identity_service.groups().create(body=group) |
| 100 | + request.uri += "&initialGroupConfig=WITH_INITIAL_OWNER" |
| 101 | + response = request.execute(num_retries=_FAIL_RETRIES) |
| 102 | + group_id = response.get('response').get('name') |
| 103 | + logs.info(f'Created google group {group_name}', request_response=response) |
| 104 | + return group_id |
| 105 | + except errors.HttpError: |
| 106 | + logs.error(f'Failed to create google group {group_name}') |
| 107 | + return None |
| 108 | + |
| 109 | + |
| 110 | +def get_google_group_memberships(group_id: str) -> dict[str, str] | None: |
| 111 | + """Get dict of membership name to members id from a google group.""" |
| 112 | + identity_service = get_identity_api() |
| 113 | + |
| 114 | + try: |
| 115 | + response = identity_service.groups().memberships().list( |
| 116 | + parent=group_id).execute() |
| 117 | + memberships = { |
| 118 | + member.get('preferredMemberKey').get('id'): member.get('name') |
| 119 | + for member in response.get('memberships', []) |
| 120 | + } |
| 121 | + return memberships |
| 122 | + except errors.HttpError: |
| 123 | + logs.error(f'Failed to get list of members from group {group_id}') |
| 124 | + return None |
| 125 | + |
| 126 | + |
| 127 | +def add_member_to_group(group_id: str, member: str) -> bool: |
| 128 | + """Add a new member to a google group.""" |
| 129 | + identity_service = get_identity_api() |
| 130 | + |
| 131 | + try: |
| 132 | + # Create a membership object with a role type MEMBER |
| 133 | + membership = { |
| 134 | + "preferredMemberKey": { |
| 135 | + "id": member |
| 136 | + }, |
| 137 | + "roles": { |
| 138 | + "name": "MEMBER", |
| 139 | + } |
| 140 | + } |
| 141 | + # Create a membership using the group ID and the membership object |
| 142 | + response = identity_service.groups().memberships().create( |
| 143 | + parent=group_id, body=membership).execute(num_retries=_FAIL_RETRIES) |
| 144 | + logs.info( |
| 145 | + f'Added {member} to google group {group_id}', request_response=response) |
| 146 | + return True |
| 147 | + except errors.HttpError: |
| 148 | + logs.error(f'Failed to add {member} to google group {group_id}') |
| 149 | + return False |
| 150 | + |
| 151 | + |
| 152 | +def delete_google_group_membership(group_id: str, |
| 153 | + member: str, |
| 154 | + membership_name: str | None = None) -> bool: |
| 155 | + """Delete a google group membership.""" |
| 156 | + identity_service = get_identity_api() |
| 157 | + |
| 158 | + try: |
| 159 | + if not membership_name: |
| 160 | + membership_lookup_request = identity_service.groups().memberships( |
| 161 | + ).lookup(parent=group_id) |
| 162 | + membership_lookup_request.uri += "&memberKey.id=" + member |
| 163 | + membership_lookup_response = membership_lookup_request.execute() |
| 164 | + membership_name = membership_lookup_response.get("name") |
| 165 | + |
| 166 | + response = identity_service.groups().memberships().delete( |
| 167 | + name=membership_name).execute(num_retries=_FAIL_RETRIES) |
| 168 | + logs.info( |
| 169 | + f'Removed {member} ({membership_name}) from google group {group_id}', |
| 170 | + request_response=response) |
| 171 | + return True |
| 172 | + except errors.HttpError: |
| 173 | + logs.error(f'Failed to remove {member} from google group {group_id}') |
| 174 | + return False |
0 commit comments