133 lines
4.7 KiB
Python
133 lines
4.7 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2022 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.
|
|
"""Base command class for Hub gcloud commands."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
from apitools.base.py import encoding
|
|
from googlecloudsdk.api_lib.container.fleet import client
|
|
from googlecloudsdk.api_lib.container.fleet import util
|
|
from googlecloudsdk.api_lib.util import waiter
|
|
from googlecloudsdk.command_lib.projects import util as project_util
|
|
from googlecloudsdk.core import log
|
|
from googlecloudsdk.core import properties
|
|
|
|
|
|
class HubCommand(object):
|
|
"""HubCommand is a mixin adding common utils to Hub commands."""
|
|
|
|
@property
|
|
def hubclient(self):
|
|
"""The HubClient for the current release track."""
|
|
# Build the client lazily, but only once.
|
|
if not hasattr(self, '_client'):
|
|
self._client = client.HubClient(self.ReleaseTrack())
|
|
return self._client
|
|
|
|
@property
|
|
def hubclient_v2(self):
|
|
"""The HubClient for the current release track."""
|
|
# Build the client lazily, but only once.
|
|
if not hasattr(self, '_client_v2'):
|
|
self._client_v2 = client.HubV2Client(self.ReleaseTrack())
|
|
return self._client_v2
|
|
|
|
@property
|
|
def messages(self):
|
|
"""Convenience property for hubclient.messages."""
|
|
return self.hubclient.messages
|
|
|
|
@property
|
|
def messages_v2(self):
|
|
"""Convenience property for hubclient_v2.messages."""
|
|
return self.hubclient_v2.messages
|
|
|
|
@staticmethod
|
|
def Project(number=False):
|
|
"""Simple helper for getting the current project.
|
|
|
|
Args:
|
|
number: Boolean, whether to return the project number instead of the ID.
|
|
|
|
Returns:
|
|
The project ID or project number, as a string.
|
|
"""
|
|
project = properties.VALUES.core.project.GetOrFail()
|
|
if number:
|
|
return project_util.GetProjectNumber(project)
|
|
return project
|
|
|
|
@staticmethod
|
|
def LocationResourceName(location='global', use_number=False):
|
|
return util.LocationResourceName(
|
|
HubCommand.Project(use_number), location=location)
|
|
|
|
@staticmethod
|
|
def FeatureResourceName(name,
|
|
project=None,
|
|
location='global',
|
|
use_number=False):
|
|
"""Builds the full resource name, using the core project property if no project is specified.."""
|
|
project = project or HubCommand.Project(use_number)
|
|
return util.FeatureResourceName(project, name, location=location)
|
|
|
|
@staticmethod
|
|
def MembershipResourceName(name, location='global', use_number=False):
|
|
"""Builds a full Membership name, using the core project property."""
|
|
return util.MembershipResourceName(
|
|
HubCommand.Project(use_number), name, location=location)
|
|
|
|
@staticmethod
|
|
def MembershipFeatureResourceName(
|
|
membership_name,
|
|
feature_name,
|
|
project=None,
|
|
location='global',
|
|
use_number=False,
|
|
):
|
|
"""Builds the full MembershipFeature name, using the core project property if no project is specified.."""
|
|
project = project or HubCommand.Project(use_number)
|
|
return util.MembershipFeatureResourceName(
|
|
project,
|
|
membership_name,
|
|
feature_name,
|
|
location=location,
|
|
)
|
|
|
|
@staticmethod
|
|
def WorkspaceResourceName(name, location='global', use_number=False):
|
|
"""Builds a full Workspace name, using the core project property."""
|
|
return util.WorkspaceResourceName(
|
|
HubCommand.Project(use_number), name, location=location)
|
|
|
|
@staticmethod
|
|
def ScopeResourceName(name, location='global', use_number=False):
|
|
"""Builds a full Scope name, using the core project property."""
|
|
return util.ScopeResourceName(
|
|
HubCommand.Project(use_number), name, location=location)
|
|
|
|
def WaitForHubOp(self, poller, op, message=None, warnings=True, **kwargs):
|
|
"""Helper wrapping waiter.WaitFor() with additional warning handling."""
|
|
op_ref = self.hubclient.OperationRef(op)
|
|
result = waiter.WaitFor(poller, op_ref, message=message, **kwargs)
|
|
if warnings:
|
|
final_op = poller.Poll(op_ref)
|
|
metadata_dict = encoding.MessageToPyValue(final_op.metadata)
|
|
if 'statusDetail' in metadata_dict:
|
|
log.warning(metadata_dict['statusDetail'])
|
|
return result
|