# Copyright (C) 2005-2012 Aaron Bentley <abentley@panoramicfeedback.com>
# Chris Ball <cjb@laptop.org>
# Gianluca Montecchi <gian@grys.it>
# Marien Zwart <marien.zwart@gmail.com>
# Thomas Gerigk <tgerigk@gmx.de>
# W. Trevor King <wking@tremily.us>
#
# This file is part of Bugs Everywhere.
#
# Bugs Everywhere is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 2 of the License, or (at your option) any
# later version.
#
# Bugs Everywhere is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# Bugs Everywhere. If not, see <http://www.gnu.org/licenses/>.
import libbe
import libbe.command
import libbe.command.util
import libbe.command.depend
import libbe.util.id
class Target (libbe.command.Command):
"""Assorted bug target manipulations and queries
>>> import os, StringIO, sys
>>> import libbe.bugdir
>>> bd = libbe.bugdir.SimpleBugDir(memory=False)
>>> io = libbe.command.StringInputOutput()
>>> io.stdout = sys.stdout
>>> ui = libbe.command.UserInterface(io=io)
>>> ui.storage_callbacks.set_storage(bd.storage)
>>> cmd = Target(ui=ui)
>>> ret = ui.run(cmd, args=['/a'])
No target assigned.
>>> ret = ui.run(cmd, args=['/a', 'tomorrow'])
>>> ret = ui.run(cmd, args=['/a'])
tomorrow
>>> ui.io.stdout = StringIO.StringIO()
>>> ret = ui.run(cmd, {'resolve':True}, ['tomorrow'])
>>> output = ui.io.get_stdout().strip()
>>> bd.flush_reload()
>>> target = bd.bug_from_uuid(output)
>>> print target.summary
tomorrow
>>> print target.severity
target
>>> ui.io.stdout = sys.stdout
>>> ret = ui.run(cmd, args=['/a', 'none'])
>>> ret = ui.run(cmd, args=['/a'])
No target assigned.
>>> ui.cleanup()
>>> bd.cleanup()
"""
name = 'target'
def __init__(self, *args, **kwargs):
libbe.command.Command.__init__(self, *args, **kwargs)
self.options.extend([
libbe.command.Option(name='resolve', short_name='r',
help="Print the UUID for the target bug whose summary "
"matches TARGET. If TARGET is not given, print the UUID "
"of the current bugdir target."),
libbe.command.Option(name='bugdir', short_name='b',
help='Short bugdir UUID for the target resolution. You '
'only need to set this if you have multiple bugdirs in '
'your repository.',
arg=libbe.command.Argument(
name='bugdir', metavar='ID', default=None,
completion_callback=libbe.command.util.complete_bugdir_id)),
])
self.args.extend([
libbe.command.Argument(
name='id', metavar='BUG-ID', optional=True,
completion_callback=libbe.command.util.complete_bug_id),
libbe.command.Argument(
name='target', metavar='TARGET', optional=True,
completion_callback=complete_target),
])
def _run(self, **params):
if params['resolve'] == False:
if params['id'] == None:
raise libbe.command.UserError('Please specify a bug id.')
else:
if params['target'] != None:
raise libbe.command.UserError('Too many arguments')
params['target'] = params.pop('id')
bugdirs = self._get_bugdirs()
if params['resolve'] == True:
if params['bugdir']:
bugdir = bugdirs[params['bugdir']]
elif len(bugdirs) == 1:
bugdir = list(bugdirs.values())[0]
else:
raise libbe.command.UserError(
'Ambiguous bugdir {}'.format(sorted(bugdirs.values())))
bug = bug_from_target_summary(bugdirs, bugdir, params['target'])
if bug == None:
print('No target assigned.', file=self.stdout)
else:
print(bug.id.long_user(), file=self.stdout)
return 0
bugdir,bug,comment = (
libbe.command.util.bugdir_bug_comment_from_user_id(
bugdirs, params['id']))
if params['target'] == None:
target = bug_target(bugdirs, bug)
if target == None:
print('No target assigned.', file=self.stdout)
else:
print(target.summary, file=self.stdout)
else:
if params['target'] == 'none':
target = remove_target(bugdirs, bug)
else:
target = add_target(bugdirs, bugdir, bug, params['target'])
return 0
def usage(self):
return 'usage: be %(name)s BUG-ID [TARGET]\nor: be %(name)s --resolve [TARGET]' \
% vars(self.__class__)
def _long_help(self):
return """
Assorted bug target manipulations and queries.
If no target is specified, the bug's current target is printed. If
TARGET is specified, it will be assigned to the bug, creating a new
target bug if necessary.
Targets are free-form; any text may be specified. They will generally
be milestone names or release numbers. The value "none" can be used
to unset the target.
In the alternative `be target --resolve TARGET` form, print the UUID
of the target-bug with summary TARGET. If target is not given, return
use the bugdir's current target (see `be set`).
If you want to list all bugs blocking the current target, try
$ be depend --status -closed,fixed,wontfix --severity -target \
$(be target --resolve)
If you want to set the current bugdir target by summary (rather than
by UUID), try
$ be set target $(be target --resolve SUMMARY)
"""
def bug_from_target_summary(bugdirs, bugdir, summary=None):
if summary == None:
if bugdir.target == None:
return None
else:
return bugdir.bug_from_uuid(bugdir.target)
matched = []
for uuid in bugdir.uuids():
bug = bugdir.bug_from_uuid(uuid)
if bug.severity == 'target' and bug.summary == summary:
matched.append(bug)
if len(matched) == 0:
return None
if len(matched) > 1:
raise Exception('Several targets with same summary: %s'
% '\n '.join([bug.uuid for bug in matched]))
return matched[0]
def bug_target(bugdirs, bug):
if bug.severity == 'target':
return bug
matched = []
for blocked in libbe.command.depend.get_blocks(bugdirs, bug):
if blocked.severity == 'target':
matched.append(blocked)
if len(matched) == 0:
return None
if len(matched) > 1:
raise Exception('This bug (%s) blocks several targets: %s'
% (bug.uuid,
'\n '.join([b.uuid for b in matched])))
return matched[0]
def remove_target(bugdirs, bug):
target = bug_target(bugdirs, bug)
libbe.command.depend.remove_block(target, bug)
return target
def add_target(bugdirs, bugdir, bug, summary):
target = bug_from_target_summary(bugdirs, bugdir, summary)
if target == None:
target = bugdir.new_bug(summary=summary)
target.severity = 'target'
libbe.command.depend.add_block(target, bug)
return target
def targets(bugdirs):
"""Generate all possible target bug summaries."""
for bugdir in list(bugdirs.values()):
bugdir.load_all_bugs()
for bug in bugdir:
if bug.severity == 'target':
yield bug.summary
def target_dict(bugdirs):
"""
Return a dict with bug UUID keys and bug summary values for all
target bugs.
"""
ret = {}
for bug in targets(bugdirs):
ret[bug.uuid] = bug
return ret
def complete_target(command, argument, fragment=None):
"""List possible command completions for fragment."""
return targets(command._get_bugdirs())
