feat: Add new gcloud commands, API clients, and third-party libraries across various services.

gcloud auth application-default login/google-cloud-sdk/lib/surface/services/policies/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2023 Google Inc. 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.
+"""Package for the policies CLI subcommands."""
+
+from googlecloudsdk.calliope import base
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class Policies(base.Group):
+  """Get/update consumer policies and get the effective policy."""

gcloud auth application-default login/google-cloud-sdk/lib/surface/services/policies/get.py

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2023 Google Inc. 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 get command."""
+
+import json
+
+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
+from googlecloudsdk.core import yaml
+from googlecloudsdk.core.util import files
+
+_PROJECT_RESOURCE = 'projects/{}'
+_FOLDER_RESOURCE = 'folders/{}'
+_ORGANIZATION_RESOURCE = 'organizations/{}'
+_CONSUMER_POLICY_DEFAULT = '/consumerPolicies/{}'
+_INVALID_TIMESTAMP = (
+    # Invalid timestamp as the consumer policy is not created previously.
+    '1970-01-01T00:00:00Z'
+)
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class Get(base.Command):
+  """Get consumer policy for a project, folder or organization.
+
+  Get consumer policy for a project, folder or
+  organization.
+
+  ## EXAMPLES
+
+   Get consumer policy for default policy on current project:
+
+   $ {command}
+      OR
+   $ {command} --policy-name=default
+
+   Get consumer policy for default policy on current project and save the
+   content in an output file:
+
+   $ {command} --output-file=/path/to/the/file.yaml
+       OR
+   $ {command} --output-file=/path/to/the/file.json
+  """
+
+  @staticmethod
+  def Args(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)
+
+    parser.add_argument(
+        '--output-file',
+        help=(
+            'Path to the file to write policy contents to. Supported format:'
+            '.yaml or .json.'
+        ),
+    )
+
+  def Run(self, args):
+    """Run command.
+
+    Args:
+      args: an argparse namespace. All the arguments that were provided to this
+        command invocation.
+
+    Returns:
+      Resource name and its parent name.
+    """
+    if args.IsSpecified('folder'):
+      resource_name = _FOLDER_RESOURCE.format(args.folder)
+    elif args.IsSpecified('organization'):
+      resource_name = _ORGANIZATION_RESOURCE.format(args.organization)
+    elif args.IsSpecified('project'):
+      resource_name = _PROJECT_RESOURCE.format(args.project)
+    else:
+      project = properties.VALUES.core.project.Get(required=True)
+      resource_name = _PROJECT_RESOURCE.format(project)
+
+    policy = serviceusage.GetConsumerPolicyV2Beta(
+        resource_name + _CONSUMER_POLICY_DEFAULT.format(args.policy_name),
+    )
+
+    if args.IsSpecified('output_file'):
+      if not (
+          args.output_file.endswith('.json')
+          or args.output_file.endswith('.yaml')
+      ):
+        log.error(
+            'Invalid output-file format. Please provide path to a yaml or json'
+            ' file.'
+        )
+      else:
+        if args.output_file.endswith('.json'):
+          data = json.dumps(_ConvertToDict(policy), sort_keys=False)
+        else:
+          data = yaml.dump(_ConvertToDict(policy), round_trip=True)
+        files.WriteFileContents(args.output_file, data)
+
+        log.status.Print(
+            'Policy written to the output file %s ' % args.output_file
+        )
+    elif args.IsSpecified('format'):
+      return policy
+    else:
+      result = _ConvertToDict(policy)
+      for k, v in result.items():
+        if k != 'enableRules' and v:
+          log.status.Print(k + ': ' + v)
+        elif k == 'enableRules':
+          log.status.Print(k + ':')
+          for enable_rule in v:
+            _PrintRules(enable_rule)
+      return
+
+
+def _ConvertToDict(policy):
+  """ConvertToDict command.
+
+  Args:
+    policy: consumerPolicy to be convert to orderedDict.
+
+  Returns:
+    orderedDict.
+  """
+
+  output = {
+      'name': policy.name,
+      'enableRules': [],
+      'updateTime': policy.updateTime,
+      'createTime': policy.createTime,
+      'etag': policy.etag,
+  }
+
+  for enable_rule in policy.enableRules:
+    if enable_rule.services:
+      output['enableRules'].append({'services': list(enable_rule.services)})
+
+  if not policy.enableRules:
+    del output['enableRules']
+
+  if policy.updateTime == _INVALID_TIMESTAMP:
+    del output['updateTime']
+  if policy.createTime == _INVALID_TIMESTAMP:
+    del output['createTime']
+
+  return output
+
+
+def _PrintRules(rule):
+  keys = ['services']
+  for key in keys:
+    if key in rule.keys():
+      log.status.Print(' ' + key + ':')
+      for value in rule[key]:
+        log.status.Print('  - ' + value)

gcloud auth application-default login/google-cloud-sdk/lib/surface/services/policies/get_effective.py

@@ -0,0 +1,115 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2023 Google Inc. 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.
+
+# TODO: b/300099033 - Capitalize and turn into a sentence.
+"""services policies get-effective-policy command."""
+
+import collections
+
+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/{}'
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class GetEffectivePolicy(base.Command):
+  """Get effective policy for a project, folder or organization.
+
+  Get effective policy for a project, folder or organization.
+
+  ## EXAMPLES
+
+   Get effective policy for the current project:
+
+   $ {command}
+
+   Get effective policy for project `my-project`:
+
+   $ {command} --project=my-project
+  """
+
+  @staticmethod
+  def Args(parser):
+    parser.add_argument(
+        '--view',
+        help=(
+            'The view of the effective policy. BASIC includes basic metadata'
+            ' about the effective policy. FULL includes every information'
+            ' related to effective policy.'
+        ),
+        default='BASIC',
+        choices=['BASIC', 'FULL'],
+    )
+    common_flags.add_resource_args(parser)
+
+    parser.display_info.AddFormat("""
+          table(
+            EnabledService:label=EnabledService:sort=1,
+            EnabledPolicies:label=EnabledPolicies
+          )
+        """)
+
+  def Run(self, args):
+    """Run command.
+
+    Args:
+      args: an argparse namespace. All the arguments that were provided to this
+        command invocation.
+
+    Returns:
+      Effective Policy.
+    """
+    if args.IsSpecified('folder'):
+      resource_name = _FOLDER_RESOURCE.format(args.folder)
+    elif args.IsSpecified('organization'):
+      resource_name = _ORGANIZATION_RESOURCE.format(args.organization)
+    elif args.IsSpecified('project'):
+      resource_name = _PROJECT_RESOURCE.format(args.project)
+    else:
+      project = properties.VALUES.core.project.Get(required=True)
+      resource_name = _PROJECT_RESOURCE.format(project)
+
+    response = serviceusage.GetEffectivePolicyV2Beta(
+        resource_name + '/effectivePolicy', args.view
+    )
+
+    if args.IsSpecified('format'):
+      return response
+    else:
+      log.status.Print('EnabledRules:')
+      for enable_rule in response.enableRules:
+        log.status.Print(' Services:')
+        for service in enable_rule.services:
+          log.status.Print('  - %s' % service)
+
+      if args.view == 'FULL':
+        log.status.Print('\nMetadata of effective policy:')
+        result = []
+
+        resources = collections.namedtuple(
+            'serviceSources', ['EnabledService', 'EnabledPolicies']
+        )
+
+        for metadata in response.enableRuleMetadata:
+          for values in metadata.serviceSources.additionalProperties:
+            result.append(resources(values.key, values.value.policies))
+        return result

gcloud auth application-default login/google-cloud-sdk/lib/surface/services/policies/test_enabled.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2023 Google Inc. 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 test-enabled command."""
+from googlecloudsdk.api_lib.services import serviceusage
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.services import common_flags
+from googlecloudsdk.core import properties
+
+_PROJECT_RESOURCE = 'projects/%s'
+_FOLDER_RESOURCE = 'folders/%s'
+_ORGANIZATION_RESOURCE = 'organizations/%s'
+_SERVICE = 'services/%s'
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class TestEnabled(base.Command):
+  """Test a value against the result of merging consumer policies in the resource hierarchy.
+
+  Test a value against the result of merging consumer policies in the resource
+  hierarchy.
+
+  ## EXAMPLES
+
+  Test for service my-service for current project:
+
+    $ {command} my-service
+
+  Test for service my-service for project `my-project`:
+
+    $ {command} my-service --project=my-project
+  """
+
+  @staticmethod
+  def Args(parser):
+    common_flags.add_resource_args(parser)
+    parser.add_argument('service', help='Name of the service.')
+
+  def Run(self, args):
+    """Run command.
+
+    Args:
+      args: an argparse namespace. All the arguments that were provided to this
+        command invocation.
+
+    Returns:
+      The enablement of the given service.
+    """
+    if args.IsSpecified('folder'):
+      resource_name = _FOLDER_RESOURCE % args.folder
+    elif args.IsSpecified('organization'):
+      resource_name = _ORGANIZATION_RESOURCE % args.organization
+    elif args.IsSpecified('project'):
+      resource_name = _PROJECT_RESOURCE % args.project
+    else:
+      project = properties.VALUES.core.project.Get(required=True)
+      resource_name = _PROJECT_RESOURCE % project
+
+    response = serviceusage.TestEnabled(resource_name, _SERVICE % args.service)
+
+    # If enableRules is empty that means service is not enabled.
+    if response.enableRules:
+      return f'Service {args.service} is ENABLED for resource {resource_name}.'
+    else:
+      return (
+          f'Service {args.service} is NOT ENABLED for resource {resource_name}.'
+      )

gcloud auth application-default login/google-cloud-sdk/lib/surface/services/policies/update.py

@@ -0,0 +1,108 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2025 Google Inc. 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 update command."""
+
+from googlecloudsdk.api_lib.services import exceptions
+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 yaml
+
+
+@base.UniverseCompatible
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class Update(base.Command):
+  """Update consumer policy for a project, folder or organization.
+
+  Update consumer policy for a project, folder or organization.
+
+  ## EXAMPLES
+
+  Update consumer policy
+
+   $ {command} --consumer-policy-file=/path/to/the/file.yaml
+
+  Validate the update action on the policy:
+
+   $ {command} --consumer-policy-file=/path/to/the/file.yaml --validate-only
+
+  Update consumer policy and bypass dependency check:
+
+   $ {command} --consumer-policy-file=/path/to/the/file.yaml
+   --bypass-dependency-check
+
+  Update consumer policy and bypass api usage check:
+
+   $ {command} --consumer-policy-file=/path/to/the/file.yaml
+   --bypass-api-usage-check
+  """
+
+  @staticmethod
+  def Args(parser):
+    common_flags.consumer_policy_file_flag().AddToParser(parser)
+    common_flags.validate_only_args(parser, suffix='to update')
+    common_flags.bypass_api_usage_check().AddToParser(parser)
+    common_flags.bypass_dependency_check().AddToParser(parser)
+
+  def Run(self, args):
+    """Run command.
+
+    Args:
+      args: an argparse namespace. All the arguments that were provided to this
+        command invocation.
+
+    Returns:
+      Response from longrunning.operations from UpdateConsumerPolicy API call.
+    """
+
+    if not args.consumer_policy_file.endswith('.yaml'):
+      raise exceptions.ConfigError(
+          'Invalid consumer_policy_file format. Please provide path to a yaml'
+          ' file.'
+      )
+
+    policy = yaml.load_path(args.consumer_policy_file)
+
+    if not isinstance(policy, dict):
+      raise exceptions.ConfigError(
+          'Invalid consumer-policy-file. Please provide a valid policy.'
+      )
+
+    if 'name' not in policy:
+      raise exceptions.ConfigError(
+          'Invalid Consumer Policy. Please provide a name.'
+      )
+
+    op = serviceusage.UpdateConsumerPolicy(
+        policy,
+        validate_only=args.validate_only,
+        bypass_dependency_check=args.bypass_dependency_check,
+        force=args.bypass_api_usage_check,
+    )
+
+    # If there is no change in the consumer policy after applying the changes,
+    # the operation name is empty.
+    # temporary fix till the backend returns name for no-op operations.
+    if op.done and not op.name:
+      log.warning('No change required for the current consumer policy.')
+      return None
+
+    op = services_util.WaitOperation(op.name, serviceusage.GetOperationV2Beta)
+    if args.validate_only:
+      services_util.PrintOperation(op)
+    else:
+      services_util.PrintOperationWithResponseForUpdateConsumerPolicy(op)