File: //snap/google-cloud-cli/current/lib/surface/services/policies/add_enable_rules.py
# -*- 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.
"""services policies add-enable-rule command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.services import services_util
from googlecloudsdk.api_lib.services import serviceusage
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.services import common_flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
_PROJECT_RESOURCE = 'projects/{}'
_FOLDER_RESOURCE = 'folders/{}'
_ORGANIZATION_RESOURCE = 'organizations/{}'
_CONSUMER_POLICY_DEFAULT = '/consumerPolicies/{}'
_OP_BASE_CMD = 'gcloud beta services operations '
_OP_WAIT_CMD = _OP_BASE_CMD + 'wait {0}'
_DETAILED_HELP = {
'DESCRIPTION': """\
Add service(s) to a consumer policy for a project, folder or organization.
""",
'EXAMPLES': """\
To add enable rule for a service called `my-consumed-service` on default consumer policy on the current
project, run:
$ {command} my-consumed-service
OR
$ {command} my-consumed-service --policy_name=default
To add enable rule for a service called `my-consumed-service` on default consumer policy on the
project `my-project` , run:
$ {command} my-consumed-service --project=my-project
OR
$ {command} my-consumed-service --policy_name=default --project=my-project
To run the same command asynchronously (non-blocking), run:
$ {command} my-consumed-service --async
To enable services called `service1`, `service2`, and `service3` on the
current project default policy , run:
$ {command} service1 service2 service3
""",
}
# TODO(b/321801975) make command public after preview.
@base.UniverseCompatible
@base.Hidden
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
class AddEnableRules(base.SilentCommand):
"""Add service(s) to a consumer policy for a project, folder or organization."""
@staticmethod
def Args(parser):
"""Args is called by calliope to gather arguments for this command.
Args:
parser: An argparse parser that you can use to add arguments that go on
the command line after this command. Positional arguments are allowed.
"""
common_flags.available_service_flag(
suffix='to add enable rule for'
).AddToParser(parser)
parser.add_argument(
'--policy-name',
help=(
'Name of the consumer policy. Currently only "default" is'
' supported.'
),
default='default',
)
common_flags.add_resource_args(parser)
common_flags.validate_only_args(parser, suffix='add enable rule')
base.ASYNC_FLAG.AddToParser(parser)
def Run(self, args):
"""Run services policies add-enable-rule.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The services in the consumer policy.
"""
project = (
args.project
if args.IsSpecified('project')
else properties.VALUES.core.project.Get(required=True)
)
folder = args.folder if args.IsSpecified('folder') else None
organization = (
args.organization if args.IsSpecified('organization') else None
)
op, _ = serviceusage.AddEnableRule(
args.service,
project,
args.policy_name,
folder,
organization,
args.validate_only,
)
if args.async_:
cmd = _OP_WAIT_CMD.format(op.name)
log.status.Print(
'Asynchronous operation is in progress... '
'Use the following command to wait for its '
f'completion:\n {cmd}'
)
return
op = services_util.WaitOperation(op.name, serviceusage.GetOperationV2Alpha)
if args.validate_only:
services_util.PrintOperation(op)
else:
services_util.PrintOperationWithResponse(op)
AddEnableRules.detailed_help = _DETAILED_HELP