376 lines
12 KiB
Python
376 lines
12 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2023 Google LLC. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Apphub Applications API."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
from apitools.base.py import list_pager
|
|
from googlecloudsdk.api_lib.apphub import consts as api_lib_consts
|
|
from googlecloudsdk.api_lib.apphub import utils as api_lib_utils
|
|
from googlecloudsdk.api_lib.util import waiter
|
|
from googlecloudsdk.calliope import base
|
|
from googlecloudsdk.command_lib.iam import iam_util
|
|
|
|
|
|
class ApplicationsClient(object):
|
|
"""Client for Applications in apphub API."""
|
|
|
|
def __init__(self, release_track=base.ReleaseTrack.ALPHA):
|
|
self.client = api_lib_utils.GetClientInstance(release_track)
|
|
self.messages = api_lib_utils.GetMessagesModule(release_track)
|
|
self._app_client = self.client.projects_locations_applications
|
|
self._lookup_client = self.client.projects_locations
|
|
self._poller = waiter.CloudOperationPoller(
|
|
self._app_client,
|
|
self.client.projects_locations_operations,
|
|
)
|
|
self._delete_poller = waiter.CloudOperationPollerNoResources(
|
|
self.client.projects_locations_operations,
|
|
)
|
|
self._lookup_poller = waiter.CloudOperationPoller(
|
|
self._lookup_client,
|
|
self.client.projects_locations_operations,
|
|
)
|
|
|
|
def Describe(self, app_id):
|
|
"""Describe an application in the Project/location.
|
|
|
|
Args:
|
|
app_id: str, the application id.
|
|
|
|
Returns:
|
|
Described service project Resource.
|
|
"""
|
|
describe_req = self.messages.ApphubProjectsLocationsApplicationsGetRequest(
|
|
name=app_id
|
|
)
|
|
return self._app_client.Get(describe_req)
|
|
|
|
def List(
|
|
self,
|
|
parent,
|
|
limit=None,
|
|
page_size=100,
|
|
):
|
|
"""List applications in the Projects/Location.
|
|
|
|
Args:
|
|
parent: str, projects/{projectId}/locations/{location}
|
|
limit: int or None, the total number of results to return. Default value
|
|
is None
|
|
page_size: int, the number of entries in each batch (affects requests
|
|
made, but not the yielded results). Default value is 100.
|
|
|
|
Returns:
|
|
Generator of matching service projects.
|
|
"""
|
|
list_req = self.messages.ApphubProjectsLocationsApplicationsListRequest(
|
|
parent=parent
|
|
)
|
|
return list_pager.YieldFromList(
|
|
self._app_client,
|
|
list_req,
|
|
field='applications',
|
|
batch_size=page_size,
|
|
limit=limit,
|
|
batch_size_attribute='pageSize',
|
|
)
|
|
|
|
def Create(
|
|
self,
|
|
app_id,
|
|
scope_type,
|
|
display_name,
|
|
description,
|
|
attributes,
|
|
async_flag,
|
|
parent,
|
|
):
|
|
"""Creates an application in the Project/location.
|
|
|
|
Args:
|
|
app_id: str, Application ID
|
|
scope_type: str, Scope of the Application
|
|
display_name: str, Human-friendly display name
|
|
description: str, Description of the Application
|
|
attributes: Attributes, Attributes of the Application
|
|
async_flag: Boolean value for async operation. If true the operation will
|
|
be async
|
|
parent: parent for project resource
|
|
|
|
Returns:
|
|
Application or Operation based on async flag value.
|
|
"""
|
|
application = self.messages.Application(
|
|
description=description,
|
|
displayName=display_name,
|
|
scope=self.messages.Scope(
|
|
type=self.messages.Scope.TypeValueValuesEnum(scope_type)
|
|
),
|
|
attributes=attributes,
|
|
)
|
|
|
|
create_req = self.messages.ApphubProjectsLocationsApplicationsCreateRequest(
|
|
application=application, applicationId=app_id, parent=parent
|
|
)
|
|
operation = self._app_client.Create(create_req)
|
|
|
|
if async_flag:
|
|
return operation
|
|
|
|
create_response = api_lib_utils.WaitForOperation(
|
|
self._poller,
|
|
operation,
|
|
api_lib_consts.CreateApplication.WAIT_FOR_ADD_MESSAGE,
|
|
api_lib_consts.CreateApplication.ADD_TIMELIMIT_SEC,
|
|
)
|
|
|
|
return create_response
|
|
|
|
def Update(self, args, app_ref, release_track=base.ReleaseTrack.ALPHA):
|
|
"""Updates an Apphub application.
|
|
|
|
Args:
|
|
args: args, Arguments provided by the client
|
|
app_ref: Application reference
|
|
release_track: release_track provided by the client
|
|
|
|
Returns:
|
|
Application or Operation based on async flag value.
|
|
"""
|
|
|
|
update_mask = ''
|
|
|
|
attributes = api_lib_utils.GetMessagesModule(release_track).Attributes()
|
|
application = self.messages.Application(attributes=attributes)
|
|
|
|
if args.environment_type is not None:
|
|
attributes.environment = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Environment(
|
|
type=api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Environment.TypeValueValuesEnum(args.environment_type)
|
|
)
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_ENVIRONMENT_FIELD_NAME,
|
|
)
|
|
|
|
if args.criticality_type:
|
|
attributes.criticality = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Criticality(
|
|
type=api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Criticality.TypeValueValuesEnum(args.criticality_type)
|
|
)
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_CRITICALITY_FIELD_NAME,
|
|
)
|
|
|
|
for b_owner in args.business_owners or []:
|
|
business_owner = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).ContactInfo()
|
|
business_owner.email = b_owner.get('email', None)
|
|
if b_owner.get('display-name', None):
|
|
business_owner.displayName = b_owner.get('display-name', None)
|
|
if release_track == base.ReleaseTrack.ALPHA:
|
|
if b_owner.get('channel-uri', None):
|
|
business_owner.channel = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Channel(uri=b_owner.get('channel-uri'))
|
|
attributes.businessOwners.append(business_owner)
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_BUSINESS_OWNERS_FIELD_NAME,
|
|
)
|
|
|
|
for d_owner in args.developer_owners or []:
|
|
developer_owner = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).ContactInfo()
|
|
developer_owner.email = d_owner.get('email', None)
|
|
if d_owner.get('display-name', None):
|
|
developer_owner.displayName = d_owner.get('display-name', None)
|
|
if release_track == base.ReleaseTrack.ALPHA:
|
|
if d_owner.get('channel-uri', None):
|
|
developer_owner.channel = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Channel(uri=d_owner.get('channel-uri'))
|
|
attributes.developerOwners.append(developer_owner)
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_DEVELOPER_OWNERS_FIELD_NAME,
|
|
)
|
|
|
|
for o_owner in args.operator_owners or []:
|
|
operator_owner = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).ContactInfo()
|
|
operator_owner.email = o_owner.get('email', None)
|
|
if o_owner.get('display-name'):
|
|
operator_owner.displayName = o_owner.get('display-name')
|
|
if release_track == base.ReleaseTrack.ALPHA:
|
|
if o_owner.get('channel-uri'):
|
|
operator_owner.channel = api_lib_utils.GetMessagesModule(
|
|
release_track
|
|
).Channel(uri=o_owner.get('channel-uri'))
|
|
attributes.operatorOwners.append(operator_owner)
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_OPERATOR_OWNERS_FIELD_NAME,
|
|
)
|
|
|
|
if args.display_name is not None:
|
|
application.displayName = args.display_name
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_DISPLAY_NAME_FIELD_NAME,
|
|
)
|
|
|
|
if args.description is not None:
|
|
application.description = args.description
|
|
update_mask = api_lib_utils.AddToUpdateMask(
|
|
update_mask,
|
|
api_lib_consts.UpdateApplication.UPDATE_MASK_DESCRIPTION_FIELD_NAME,
|
|
)
|
|
|
|
patch_req = self.messages.ApphubProjectsLocationsApplicationsPatchRequest(
|
|
application=application,
|
|
name=app_ref.RelativeName(),
|
|
updateMask=update_mask,
|
|
)
|
|
|
|
operation = self._app_client.Patch(patch_req)
|
|
|
|
if args.async_:
|
|
return operation
|
|
|
|
patch_response = api_lib_utils.WaitForOperation(
|
|
self._poller,
|
|
operation,
|
|
api_lib_consts.UpdateApplication.WAIT_FOR_UPDATE_MESSAGE,
|
|
api_lib_consts.UpdateApplication.ADD_TIMELIMIT_SEC,
|
|
)
|
|
|
|
return patch_response
|
|
|
|
def Delete(self, app_id, async_flag):
|
|
"""Delete an application in the Project/location.
|
|
|
|
Args:
|
|
app_id: str, The name for the application being deleted
|
|
async_flag: Boolean value for async operation. If true the operation will
|
|
be async
|
|
|
|
Returns:
|
|
Empty Response Message or Operation based on async flag value.
|
|
"""
|
|
remove_req = self.messages.ApphubProjectsLocationsApplicationsDeleteRequest(
|
|
name=app_id
|
|
)
|
|
operation = self._app_client.Delete(remove_req)
|
|
|
|
if async_flag:
|
|
return operation
|
|
|
|
delete_response = api_lib_utils.WaitForOperation(
|
|
self._delete_poller,
|
|
operation,
|
|
api_lib_consts.DeleteApplication.WAIT_FOR_DELETE_MESSAGE,
|
|
api_lib_consts.DeleteApplication.REMOVE_TIMELIMIT_SEC,
|
|
)
|
|
|
|
return delete_response
|
|
|
|
def GetIamPolicy(self, app_id):
|
|
"""Fetch the IAM Policy attached to the sepcified application.
|
|
|
|
Args:
|
|
app_id: str, the application id.
|
|
|
|
Returns:
|
|
The application's IAM Policy.
|
|
"""
|
|
# version = iam_util.MAX_LIBRARY_IAM_SUPPORTED_VERSION
|
|
get_req = (
|
|
self.messages.ApphubProjectsLocationsApplicationsGetIamPolicyRequest(
|
|
resource=app_id,
|
|
)
|
|
)
|
|
return self._app_client.GetIamPolicy(get_req)
|
|
|
|
def SetIamPolicy(self, app_id, policy_file):
|
|
"""Sets an application's IamPolicy to the one provided.
|
|
|
|
If 'policy_file' has no etag specified, this will BLINDLY OVERWRITE the IAM
|
|
policy!
|
|
|
|
Args:
|
|
app_id: str, the application id..
|
|
policy_file: a policy file.
|
|
|
|
Returns:
|
|
The IAM Policy.
|
|
"""
|
|
policy = iam_util.ParsePolicyFile(policy_file, self.messages.Policy)
|
|
return self._SetIamPolicyHelper(app_id, policy)
|
|
|
|
def _SetIamPolicyHelper(self, app_id, policy):
|
|
set_req = (
|
|
self.messages.ApphubProjectsLocationsApplicationsSetIamPolicyRequest(
|
|
resource=app_id,
|
|
setIamPolicyRequest=self.messages.SetIamPolicyRequest(
|
|
policy=policy,),
|
|
))
|
|
return self._app_client.SetIamPolicy(set_req)
|
|
|
|
def AddIamPolicyBinding(self, app_id, member, role):
|
|
"""Does an atomic Read-Modify-Write, adding the member to the role.
|
|
|
|
Args:
|
|
app_id: str, the application id.
|
|
member: str, the principal to add the binding for.
|
|
role: predefined role, the role name to assign to the principal.
|
|
|
|
Returns:
|
|
The IAM Policy.
|
|
|
|
"""
|
|
policy = self.GetIamPolicy(app_id)
|
|
iam_util.AddBindingToIamPolicy(self.messages.Binding, policy, member, role)
|
|
return self._SetIamPolicyHelper(app_id, policy)
|
|
|
|
def RemoveIamPolicyBinding(self, app_id, member, role):
|
|
"""Does an atomic Read-Modify-Write, removing the member to the role.
|
|
|
|
Args:
|
|
app_id: str, the application id.
|
|
member: str, the principal to add the binding for.
|
|
role: predefined role, the role name to assign to the principal.
|
|
|
|
Returns:
|
|
The IAM Policy.
|
|
|
|
"""
|
|
policy = self.GetIamPolicy(app_id)
|
|
iam_util.RemoveBindingFromIamPolicy(policy, member, role)
|
|
return self._SetIamPolicyHelper(app_id, policy)
|