File: //lib/google-cloud-sdk/lib/surface/debug/snapshots/delete.py
# -*- coding: utf-8 -*- #
# Copyright 2016 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.
"""Delete command for gcloud debug snapshots command group."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
import io
from googlecloudsdk.api_lib.debug import debug
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.debug import flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core.console import console_io
from googlecloudsdk.core.resource import resource_printer
DETAILED_HELP = {
'brief':
"""\
Delete debug snapshots for a Cloud Debugger debug target (debuggee).
""",
'DESCRIPTION':
"""\
*{command}* is used to delete snapshots from a Cloud Debugger debug
target (debuggee). It will ask for confirmation before deleting any
snapshots. To suppress confirmation, use the global --quiet option.
""",
'EXAMPLES':
"""\
To delete all active snapshots created by the current user of the debug
target (debuggee), without being prompted for confirmation, run:
$ {command} --target=<debuggee_id> --quiet
To delete all active and inactive snapshots created by all users of the
debug target (debuggee), run:
$ {command} --target=<debuggee_id> --all-users --include-inactive
To delete the debug snapshots with IDs 'ID1' and 'ID2' (where ID1 and
ID2 were each created by different users) of the debug target
(debuggee), run:
$ {command} ID1 ID2 --target=<debuggee_id> --all-users
"""
}
class Delete(base.DeleteCommand):
"""Delete debug snapshots."""
detailed_help = DETAILED_HELP
@staticmethod
def Args(parser):
flags.AddIdOptions(parser, 'snapshot', 'snapshots', 'deleted')
parser.add_argument(
'--all-users', action='store_true', default=False,
help="""\
If set, matching snapshots from all users will be deleted, rather
than only snapshots created by the current user.
""")
parser.add_argument(
'--include-inactive', action='store_true', default=False,
help="""\
If set, also delete snapshots which have been completed. By default,
only pending snapshots will be deleted.
""")
def Run(self, args):
"""Run the delete command."""
project_id = properties.VALUES.core.project.Get(required=True)
debugger = debug.Debugger(project_id)
debuggee = debugger.FindDebuggee(args.target)
snapshots = debuggee.ListBreakpoints(
args.location, resource_ids=args.ids,
include_all_users=args.all_users,
include_inactive=args.include_inactive,
restrict_to_type=debugger.SNAPSHOT_TYPE)
if snapshots:
snapshot_list = io.StringIO()
resource_printer.Print(
snapshots, 'table(location, condition, id)', snapshot_list)
console_io.PromptContinue(
message=(
'This command will delete the following snapshots:'
'\n\n{0}\n'.format(snapshot_list.getvalue())),
cancel_on_no=True)
for s in snapshots:
debuggee.DeleteBreakpoint(s.id)
# Guaranteed we have at least one snapshot, since ListMatchingBreakpoints
# would raise an exception otherwise.
if len(snapshots) == 1:
log.status.write('Deleted 1 snapshot.\n')
else:
log.status.write('Deleted {0} snapshots.\n'.format(len(snapshots)))
return snapshots