class Stamp(Command):
"""Add the review request URL to the commit message.
Stamps the review request URL onto the commit message of the revision
specified. The revisions argument behaves like it does in rbt post, where
it is required for some SCMs (e.g. Perforce) and unnecessary/ignored for
others (e.g. Git).
Normally, this command will guess the review request (based on the revision
number if provided, and the commit summary and description otherwise).
However, if a review request ID is specified by the user, it stamps the URL
of that review request instead of guessing.
"""
name = 'stamp'
author = 'The Review Board Project'
description = 'Adds the review request URL to the commit message.'
args = '[revisions]'
option_list = [
OptionGroup(
name='Stamp Options',
description='Controls the behavior of a stamp, including what '
'review request URL gets stamped.',
option_list=[
Option('-r', '--review-request-id',
dest='rid',
metavar='ID',
default=None,
help='Specifies the existing review request ID to '
'be stamped.'),
]
),
Command.server_options,
Command.repository_options,
Command.diff_options,
Command.branch_options,
Command.perforce_options,
]
def no_commit_error(self):
raise CommandError('No existing commit to stamp on.')
def _ask_review_request_match(self, review_request):
question = ('Stamp with Review Request #%s: "%s"? '
% (review_request.id,
get_draft_or_current_value(
'summary', review_request)))
return confirm(question)
def determine_review_request(self, api_client, api_root, repository_info,
repository_name, revisions):
"""Determine the correct review request for a commit.
A tuple (review request ID, review request absolute URL) is returned.
If no review request ID is found by any of the strategies,
(None, None) is returned.
"""
# First, try to match the changeset to a review request directly.
if repository_info.supports_changesets:
review_request = find_review_request_by_change_id(
api_client, api_root, repository_info, repository_name,
revisions)
if review_request and review_request.id:
return review_request.id, review_request.absolute_url
# Fall back on guessing based on the description. This may return None
# if no suitable review request is found.
logging.debug('Attempting to guess review request based on '
'summary and description')
try:
review_request = guess_existing_review_request(
repository_info, repository_name, api_root, api_client,
self.tool, revisions, guess_summary=False,
guess_description=False,
is_fuzzy_match_func=self._ask_review_request_match,
no_commit_error=self.no_commit_error)
except ValueError as e:
raise CommandError(six.text_type(e))
if review_request:
logging.debug('Found review request ID %d', review_request.id)
return review_request.id, review_request.absolute_url
else:
logging.debug('Could not find a matching review request')
return None, None
def main(self, *args):
"""Add the review request URL to a commit message."""
self.cmd_args = list(args)
repository_info, self.tool = self.initialize_scm_tool(
client_name=self.options.repository_type)
server_url = self.get_server_url(repository_info, self.tool)
api_client, api_root = self.get_api(server_url)
self.setup_tool(self.tool, api_root=api_root)
if not self.tool.can_amend_commit:
raise NotImplementedError('rbt stamp is not supported with %s.'
% self.tool.name)
try:
if self.tool.has_pending_changes():
raise CommandError('Working directory is not clean.')
except NotImplementedError:
pass
revisions = get_revisions(self.tool, self.cmd_args)
# Use the ID from the command line options if present.
if self.options.rid:
review_request_id = self.options.rid
try:
review_request = api_root.get_review_request(
review_request_id=review_request_id)
except APIError as e:
raise CommandError('Error getting review request %s: %s'
% (review_request_id, e))
review_request_url = review_request.absolute_url
else:
review_request_id, review_request_url = \
self. determine_review_request(
api_client, api_root, repository_info,
self.options.repository_name, revisions)
if not review_request_url:
raise CommandError('Could not determine the existing review '
'request URL to stamp with.')
stamp_commit_with_review_url(revisions, review_request_url, self.tool)
print('Successfully stamped change with the URL:')
print(review_request_url)
class Post(Command):
"""Create and update review requests."""
name = 'post'
author = 'The Review Board Project'
description = 'Uploads diffs to create and update review requests.'
args = '[revisions]'
GUESS_AUTO = 'auto'
GUESS_YES = 'yes'
GUESS_NO = 'no'
GUESS_YES_INPUT_VALUES = (True, 'yes', 1, '1')
GUESS_NO_INPUT_VALUES = (False, 'no', 0, '0')
GUESS_CHOICES = (GUESS_AUTO, GUESS_YES, GUESS_NO)
option_list = [
OptionGroup(
name='Posting Options',
description='Controls the behavior of a post, including what '
'review request gets posted and how, and what '
'happens after it is posted.',
option_list=[
Option('-u',
'--update',
dest='update',
action='store_true',
default=False,
help='Automatically determines the existing review '
'request to update.',
added_in='0.5.3'),
Option('-r',
'--review-request-id',
dest='rid',
metavar='ID',
default=None,
help='Specifies the existing review request ID to '
'update.'),
Option('-p',
'--publish',
dest='publish',
action='store_true',
default=False,
config_key='PUBLISH',
help='Publishes the review request immediately after '
'posting.'
'\n'
'All required fields must already be filled in '
'on the review request or must be provided when '
'posting.'),
Option('-t',
'--trivial-publish',
dest='trivial_publish',
action='store_true',
default=False,
help='Publish the review request immediately after '
'posting, but without sending an e-mail '
'notification.',
added_in='0.8.0'),
Option('-o',
'--open',
dest='open_browser',
action='store_true',
config_key='OPEN_BROWSER',
default=False,
help='Opens a web browser to the review request '
'after posting.'),
Option('-s',
'--stamp',
dest='stamp_when_posting',
action='store_true',
config_key='STAMP_WHEN_POSTING',
default=False,
help='Stamps the commit message with the review '
'request URL while posting the review.',
added_in='0.7.3'),
Option('--submit-as',
dest='submit_as',
metavar='USERNAME',
config_key='SUBMIT_AS',
default=None,
help='The username to use as the author of the '
'review request, instead of the logged in user.',
extended_help=(
"This is useful when used in a repository's "
"post-commit script to update or create review "
"requests. See :ref:`automating-rbt-post` for "
"more information on this use case.")),
Option('--change-only',
dest='change_only',
action='store_true',
default=False,
help='Updates fields from the change description, '
'but does not upload a new diff '
'(Perforce/Plastic only).'),
Option('--diff-only',
dest='diff_only',
action='store_true',
default=False,
help='Uploads a new diff, but does not update '
'fields from the change description '
'(Perforce/Plastic only).'),
]),
Command.server_options,
Command.repository_options,
OptionGroup(
name='Review Request Field Options',
description='Options for setting the contents of fields in the '
'review request.',
option_list=[
Option('-g',
'--guess-fields',
dest='guess_fields',
action='store',
config_key='GUESS_FIELDS',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Equivalent to setting both --guess-summary '
'and --guess-description.',
extended_help=(
'This can optionally take a value to control the '
'guessing behavior. See :ref:`guessing-behavior` '
'for more information.')),
Option('--guess-summary',
dest='guess_summary',
action='store',
config_key='GUESS_SUMMARY',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Generates the Summary field based on the '
'commit messages (Bazaar/Git/Mercurial only).',
extended_help=(
'This can optionally take a value to control the '
'guessing behavior. See :ref:`guessing-behavior` '
'for more information.')),
Option('--guess-description',
dest='guess_description',
action='store',
config_key='GUESS_DESCRIPTION',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Generates the Description field based on the '
'commit messages (Bazaar/Git/Mercurial only).',
extended_help=(
'This can optionally take a value to control the '
'guessing behavior. See :ref:`guessing-behavior` '
'for more information.')),
Option('-m',
'--change-description',
dest='change_description',
default=None,
metavar='TEXT',
help='A description of what changed in this update '
'of the review request. This is ignored for new '
'review requests.'),
Option('--summary',
dest='summary',
metavar='TEXT',
default=None,
help='The new contents for the Summary field.'),
Option('--description',
dest='description',
metavar='TEXT',
default=None,
help='The new contents for the Description field.'),
Option('--description-file',
dest='description_file',
default=None,
metavar='FILENAME',
help='A text file containing the new contents for the '
'Description field.'),
Option('--testing-done',
dest='testing_done',
metavar='TEXT',
default=None,
help='The new contents for the Testing Done field.'),
Option('--testing-done-file',
dest='testing_file',
default=None,
metavar='FILENAME',
help='A text file containing the new contents for the '
'Testing Done field.'),
Option('--branch',
dest='branch',
config_key='BRANCH',
metavar='BRANCH',
default=None,
help='The branch the change will be committed on or '
'affects. This is a free-form field and does not '
'control any behavior.'),
Option('--bugs-closed',
dest='bugs_closed',
metavar='BUG_ID[,...]',
default=None,
help='The comma-separated list of bug IDs closed.'),
Option('--target-groups',
dest='target_groups',
config_key='TARGET_GROUPS',
metavar='NAME[,...]',
default=None,
help='The names of the groups that should perform the '
'review.'),
Option('--target-people',
dest='target_people',
metavar='USERNAME[,...]',
config_key='TARGET_PEOPLE',
default=None,
help='The usernames of the people who should perform '
'the review.'),
Option('--depends-on',
dest='depends_on',
config_key='DEPENDS_ON',
metavar='ID[,...]',
default=None,
help='A comma-separated list of review request IDs '
'that this review request will depend on.',
added_in='0.6.1'),
Option('--markdown',
dest='markdown',
action='store_true',
config_key='MARKDOWN',
default=False,
help='Specifies if the summary, description, and '
'change description should should be interpreted '
'as Markdown-formatted text.'
'\n'
'This is only supported in Review Board 2.0+.',
added_in='0.6'),
]),
Command.diff_options,
Command.perforce_options,
Command.subversion_options,
Command.tfs_options,
]
def post_process_options(self):
super(Post, self).post_process_options()
# -g implies --guess-summary and --guess-description
if self.options.guess_fields:
self.options.guess_fields = self.normalize_guess_value(
self.options.guess_fields, '--guess-fields')
self.options.guess_summary = self.options.guess_fields
self.options.guess_description = self.options.guess_fields
if self.options.revision_range:
raise CommandError(
'The --revision-range argument has been removed. To post a '
'diff for one or more specific revisions, pass those '
'revisions as arguments. For more information, see the '
'RBTools 0.6 Release Notes.')
if self.options.svn_changelist:
raise CommandError(
'The --svn-changelist argument has been removed. To use a '
'Subversion changelist, pass the changelist name as an '
'additional argument after the command.')
# Only one of --description and --description-file can be used
if self.options.description and self.options.description_file:
raise CommandError('The --description and --description-file '
'options are mutually exclusive.')
# If --description-file is used, read that file
if self.options.description_file:
if os.path.exists(self.options.description_file):
with open(self.options.description_file, 'r') as fp:
self.options.description = fp.read()
else:
raise CommandError('The description file %s does not exist.' %
self.options.description_file)
# Only one of --testing-done and --testing-done-file can be used
if self.options.testing_done and self.options.testing_file:
raise CommandError('The --testing-done and --testing-done-file '
'options are mutually exclusive.')
# If --testing-done-file is used, read that file
if self.options.testing_file:
if os.path.exists(self.options.testing_file):
with open(self.options.testing_file, 'r') as fp:
self.options.testing_done = fp.read()
else:
raise CommandError('The testing file %s does not exist.' %
self.options.testing_file)
# If we have an explicitly specified summary, override
# --guess-summary
if self.options.summary:
self.options.guess_summary = self.GUESS_NO
else:
self.options.guess_summary = self.normalize_guess_value(
self.options.guess_summary, '--guess-summary')
# If we have an explicitly specified description, override
# --guess-description
if self.options.description:
self.options.guess_description = self.GUESS_NO
else:
self.options.guess_description = self.normalize_guess_value(
self.options.guess_description, '--guess-description')
# If the --diff-filename argument is used, we can't do automatic
# updating.
if self.options.diff_filename and self.options.update:
raise CommandError('The --update option cannot be used when '
'using --diff-filename.')
# If we have an explicitly specified review request ID, override
# --update
if self.options.rid and self.options.update:
self.options.update = False
if self.options.trivial_publish:
self.options.publish = True
def normalize_guess_value(self, guess, arg_name):
if guess in self.GUESS_YES_INPUT_VALUES:
return self.GUESS_YES
elif guess in self.GUESS_NO_INPUT_VALUES:
return self.GUESS_NO
elif guess == self.GUESS_AUTO:
return guess
else:
raise CommandError('Invalid value "%s" for argument "%s"' %
(guess, arg_name))
def get_repository_path(self, repository_info, api_root):
"""Get the repository path from the server.
This will compare the paths returned by the SCM client
with those one the server, and return the first match.
"""
if isinstance(repository_info.path, list):
repositories = api_root.get_repositories(only_fields='path',
only_links='')
for repo in repositories.all_items:
if repo['path'] in repository_info.path:
repository_info.path = repo['path']
break
if isinstance(repository_info.path, list):
error_str = [
'There was an error creating this review request.\n',
'\n',
'There was no matching repository path found on the server.\n',
'Unknown repository paths found:\n',
]
for foundpath in repository_info.path:
error_str.append('\t%s\n' % foundpath)
error_str += [
'Ask the administrator to add one of these repositories\n',
'to the Review Board server.\n',
]
raise CommandError(''.join(error_str))
return repository_info.path
def post_request(self,
repository_info,
repository,
server_url,
api_root,
review_request_id=None,
changenum=None,
diff_content=None,
parent_diff_content=None,
commit_id=None,
base_commit_id=None,
submit_as=None,
retries=3,
base_dir=None):
"""Creates or updates a review request, and uploads a diff.
On success the review request id and url are returned.
"""
supports_posting_commit_ids = \
self.tool.capabilities.has_capability('review_requests',
'commit_ids')
if review_request_id:
review_request = get_review_request(
review_request_id,
api_root,
only_fields='absolute_url,bugs_closed,id,status,public',
only_links='diffs,draft')
if review_request.status == 'submitted':
raise CommandError(
'Review request %s is marked as %s. In order to update '
'it, please reopen the review request and try again.' %
(review_request_id, review_request.status))
else:
# No review_request_id, so we will create a new review request.
try:
# Until we are Python 2.7+ only, the keys in request_data have
# to be bytes. See bug 3753 for details.
request_data = {b'repository': repository}
if changenum:
request_data[b'changenum'] = changenum
elif commit_id and supports_posting_commit_ids:
request_data[b'commit_id'] = commit_id
if submit_as:
request_data[b'submit_as'] = submit_as
if self.tool.can_bookmark:
bookmark = self.tool.get_current_bookmark()
request_data[b'extra_data__local_bookmark'] = bookmark
elif self.tool.can_branch:
branch = self.tool.get_current_branch()
request_data[b'extra_data__local_branch'] = branch
review_requests = api_root.get_review_requests(
only_fields='', only_links='create')
review_request = review_requests.create(**request_data)
except APIError as e:
if e.error_code == 204 and changenum:
# The change number is already in use. Get the review
# request for that change and update it instead.
rid = e.rsp['review_request']['id']
review_request = api_root.get_review_request(
review_request_id=rid,
only_fields='absolute_url,bugs_closed,id,status',
only_links='diffs,draft')
else:
raise CommandError('Error creating review request: %s' % e)
if (not repository_info.supports_changesets
or not self.options.change_only):
try:
diff_kwargs = {
'parent_diff': parent_diff_content,
'base_dir': base_dir,
}
if (base_commit_id and self.tool.capabilities.has_capability(
'diffs', 'base_commit_ids')):
# Both the Review Board server and SCMClient support
# base commit IDs, so pass that along when creating
# the diff.
diff_kwargs['base_commit_id'] = base_commit_id
review_request.get_diffs(only_fields='').upload_diff(
diff_content, **diff_kwargs)
except APIError as e:
error_msg = [
u'Error uploading diff\n\n',
]
if e.error_code == 101 and e.http_status == 403:
error_msg.append(u'You do not have permissions to modify '
u'this review request\n')
elif e.error_code == 219:
error_msg.append(
u'The generated diff file was empty. This '
u'usually means no files were\n'
u'modified in this change.\n')
else:
error_msg.append(str(e).decode('utf-8') + u'\n')
error_msg.append(
u'Your review request still exists, but the diff is '
u'not attached.\n')
error_msg.append(u'%s\n' % review_request.absolute_url)
raise CommandError(u'\n'.join(error_msg))
try:
draft = review_request.get_draft(only_fields='commit_id')
except APIError as e:
raise CommandError('Error retrieving review request draft: %s' % e)
# Stamp the commit message with the review request URL before posting
# the review, so that we can use the stamped commit message when
# guessing the description. This enables the stamped message to be
# present on the review if the user has chosen to publish immediately
# upon posting.
if self.options.stamp_when_posting:
if not self.tool.can_amend_commit:
print('Cannot stamp review URL onto the commit message; '
'stamping is not supported with %s.' % self.tool.name)
else:
try:
stamp_commit_with_review_url(self.revisions,
review_request.absolute_url,
self.tool)
print('Stamped review URL onto the commit message.')
except AlreadyStampedError:
print('Commit message has already been stamped')
except Exception as e:
logging.debug(
'Caught exception while stamping the '
'commit message. Proceeding to post '
'without stamping.',
exc_info=True)
print('Could not stamp review URL onto the commit '
'message.')
# If the user has requested to guess the summary or description,
# get the commit message and override the summary and description
# options. The guessing takes place after stamping so that the
# guessed description matches the commit when rbt exits.
if not self.options.diff_filename:
self.check_guess_fields()
# Update the review request draft fields based on options set
# by the user, or configuration.
update_fields = {}
if self.options.target_groups:
update_fields['target_groups'] = self.options.target_groups
if self.options.target_people:
update_fields['target_people'] = self.options.target_people
if self.options.depends_on:
update_fields['depends_on'] = self.options.depends_on
if self.options.summary:
update_fields['summary'] = self.options.summary
if self.options.branch:
update_fields['branch'] = self.options.branch
if self.options.bugs_closed:
# Append to the existing list of bugs.
self.options.bugs_closed = self.options.bugs_closed.strip(', ')
bug_set = (set(re.split('[, ]+', self.options.bugs_closed))
| set(review_request.bugs_closed))
self.options.bugs_closed = ','.join(bug_set)
update_fields['bugs_closed'] = self.options.bugs_closed
if self.options.description:
update_fields['description'] = self.options.description
if self.options.testing_done:
update_fields['testing_done'] = self.options.testing_done
if ((self.options.description or self.options.testing_done)
and self.options.markdown
and self.tool.capabilities.has_capability('text', 'markdown')):
# The user specified that their Description/Testing Done are
# valid Markdown, so tell the server so it won't escape the text.
update_fields['text_type'] = 'markdown'
if self.options.publish:
update_fields['public'] = True
if (self.options.trivial_publish
and self.tool.capabilities.has_capability(
'review_requests', 'trivial_publish')):
update_fields['trivial'] = True
if self.options.change_description is not None:
if review_request.public:
update_fields['changedescription'] = \
self.options.change_description
if (self.options.markdown
and self.tool.capabilities.has_capability(
'text', 'markdown')):
update_fields['changedescription_text_type'] = 'markdown'
else:
update_fields['changedescription_text_type'] = 'plain'
else:
logging.error(
'The change description field can only be set when '
'publishing an update. Use --description instead.')
if supports_posting_commit_ids and commit_id != draft.commit_id:
update_fields['commit_id'] = commit_id or ''
if update_fields:
try:
draft = draft.update(**update_fields)
except APIError as e:
raise CommandError(
'Error updating review request draft: %s\n\n'
'Your review request still exists, but the diff is not '
'attached.\n\n'
'%s\n' % (e, review_request.absolute_url))
return review_request.id, review_request.absolute_url
def check_guess_fields(self):
"""Checks and handles field guesses for the review request.
This will attempt to guess the values for the summary and
description fields, based on the contents of the commit message
at the provided revisions, if requested by the caller.
If the backend doesn't support guessing, or if guessing isn't
requested, or if explicit values were set in the options, nothing
will be set for the fields.
"""
is_new_review_request = (not self.options.rid
and not self.options.update)
guess_summary = (self.options.guess_summary == self.GUESS_YES
or (self.options.guess_summary == self.GUESS_AUTO
and is_new_review_request))
guess_description = (self.options.guess_description == self.GUESS_YES
or
(self.options.guess_description == self.GUESS_AUTO
and is_new_review_request))
if self.revisions and (guess_summary or guess_description):
try:
commit_message = self.tool.get_commit_message(self.revisions)
if commit_message:
guessed_summary = commit_message['summary']
guessed_description = commit_message['description']
if guess_summary and guess_description:
self.options.summary = guessed_summary
self.options.description = guessed_description
elif guess_summary:
self.options.summary = guessed_summary
elif guess_description:
# If we're guessing the description but not the summary
# (for example, if --summary was included), we probably
# don't want to strip off the summary line of the
# commit message.
if guessed_description.startswith(guessed_summary):
self.options.description = guessed_description
else:
self.options.description = \
guessed_summary + '\n\n' + guessed_description
except NotImplementedError:
# The SCMClient doesn't support getting commit messages,
# so we can't provide the guessed versions.
pass
def _ask_review_request_match(self, review_request):
question = ("Update Review Request #%s: '%s'? " %
(review_request.id,
get_draft_or_current_value('summary', review_request)))
return confirm(question)
def main(self, *args):
"""Create and update review requests."""
# The 'args' tuple must be made into a list for some of the
# SCM Clients code. The way arguments were structured in
# post-review meant this was a list, and certain parts of
# the code base try and concatenate args to the end of
# other lists. Until the client code is restructured and
# cleaned up we will satisfy the assumption here.
self.cmd_args = list(args)
self.post_process_options()
origcwd = os.path.abspath(os.getcwd())
repository_info, self.tool = self.initialize_scm_tool(
client_name=self.options.repository_type)
server_url = self.get_server_url(repository_info, self.tool)
api_client, api_root = self.get_api(server_url)
self.setup_tool(self.tool, api_root=api_root)
if (self.options.exclude_patterns
and not self.tool.supports_diff_exclude_patterns):
raise CommandError(
'The %s backend does not support excluding files via the '
'-X/--exclude commandline options or the EXCLUDE_PATTERNS '
'.reviewboardrc option.' % self.tool.name)
# Check if repository info on reviewboard server match local ones.
repository_info = repository_info.find_server_repository_info(api_root)
if self.options.diff_filename:
self.revisions = None
parent_diff = None
base_commit_id = None
commit_id = None
if self.options.diff_filename == '-':
if hasattr(sys.stdin, 'buffer'):
# Make sure we get bytes on Python 3.x
diff = sys.stdin.buffer.read()
else:
diff = sys.stdin.read()
else:
try:
diff_path = os.path.join(origcwd,
self.options.diff_filename)
with open(diff_path, 'rb') as fp:
diff = fp.read()
except IOError as e:
raise CommandError('Unable to open diff filename: %s' % e)
else:
self.revisions = get_revisions(self.tool, self.cmd_args)
if self.revisions:
extra_args = None
else:
extra_args = self.cmd_args
# Generate a diff against the revisions or arguments, filtering
# by the requested files if provided.
diff_info = self.tool.diff(
revisions=self.revisions,
include_files=self.options.include_files or [],
exclude_patterns=self.options.exclude_patterns or [],
extra_args=extra_args)
diff = diff_info['diff']
parent_diff = diff_info.get('parent_diff')
base_commit_id = diff_info.get('base_commit_id')
commit_id = diff_info.get('commit_id')
repository = (self.options.repository_name
or self.options.repository_url
or self.get_repository_path(repository_info, api_root))
base_dir = self.options.basedir or repository_info.base_path
if repository is None:
raise CommandError('Could not find the repository on the Review '
'Board server.')
if len(diff) == 0:
raise CommandError("There don't seem to be any diffs!")
# Validate the diffs to ensure that they can be parsed and that
# all referenced files can be found.
#
# Review Board 2.0.14+ (with the diffs.validation.base_commit_ids
# capability) is required to successfully validate against hosting
# services that need a base_commit_id. This is basically due to
# the limitations of a couple Git-specific hosting services
# (Beanstalk, Bitbucket, and Unfuddle).
#
# In order to validate, we need to either not be dealing with a
# base commit ID (--diff-filename), or be on a new enough version
# of Review Board, or be using a non-Git repository.
can_validate_base_commit_ids = \
self.tool.capabilities.has_capability('diffs', 'validation',
'base_commit_ids')
if (not base_commit_id or can_validate_base_commit_ids
or self.tool.name != 'Git'):
# We can safely validate this diff before posting it, but we
# need to ensure we only pass base_commit_id if the capability
# is set.
validate_kwargs = {}
if can_validate_base_commit_ids:
validate_kwargs['base_commit_id'] = base_commit_id
try:
diff_validator = api_root.get_diff_validation()
diff_validator.validate_diff(repository,
diff,
parent_diff=parent_diff,
base_dir=base_dir,
**validate_kwargs)
except APIError as e:
msg_prefix = ''
if e.error_code == 207:
msg_prefix = '%s: ' % e.rsp['file']
raise CommandError('Error validating diff\n\n%s%s' %
(msg_prefix, e))
except AttributeError:
# The server doesn't have a diff validation resource. Post as
# normal.
pass
if (repository_info.supports_changesets
and not self.options.diff_filename
and 'changenum' in diff_info):
changenum = diff_info['changenum']
else:
changenum = self.tool.get_changenum(self.revisions)
# Not all scm clients support get_changenum, so if get_changenum
# returns None (the default for clients that don't have changenums),
# we'll prefer the existing commit_id.
commit_id = changenum or commit_id
if self.options.update and self.revisions:
review_request = guess_existing_review_request(
repository_info,
self.options.repository_name,
api_root,
api_client,
self.tool,
self.revisions,
guess_summary=False,
guess_description=False,
is_fuzzy_match_func=self._ask_review_request_match,
submit_as=self.options.submit_as)
if not review_request or not review_request.id:
raise CommandError('Could not determine the existing review '
'request to update.')
self.options.rid = review_request.id
# If only certain files within a commit are being submitted for review,
# do not include the commit id. This prevents conflicts if multiple
# files from the same commit are posted for review separately.
if self.options.include_files or self.options.exclude_patterns:
commit_id = None
request_id, review_url = self.post_request(
repository_info,
repository,
server_url,
api_root,
self.options.rid,
changenum=changenum,
diff_content=diff,
parent_diff_content=parent_diff,
commit_id=commit_id,
base_commit_id=base_commit_id,
submit_as=self.options.submit_as,
base_dir=base_dir)
diff_review_url = review_url + 'diff/'
print('Review request #%s posted.' % request_id)
print()
print(review_url)
print(diff_review_url)
# Load the review up in the browser if requested to.
if self.options.open_browser:
try:
import webbrowser
if 'open_new_tab' in dir(webbrowser):
# open_new_tab is only in python 2.5+
webbrowser.open_new_tab(review_url)
elif 'open_new' in dir(webbrowser):
webbrowser.open_new(review_url)
else:
os.system('start %s' % review_url)
except:
logging.error('Error opening review URL: %s' % review_url)
class Post(Command):
"""Create and update review requests."""
name = "post"
author = "The Review Board Project"
description = "Uploads diffs to create and update review requests."
args = "[revisions]"
GUESS_AUTO = 'auto'
GUESS_YES = 'yes'
GUESS_NO = 'no'
GUESS_YES_INPUT_VALUES = (True, 'yes', 1, '1')
GUESS_NO_INPUT_VALUES = (False, 'no', 0, '0')
GUESS_CHOICES = (GUESS_AUTO, GUESS_YES, GUESS_NO)
option_list = [
OptionGroup(
name='Posting Options',
description='Controls the behavior of a post, including what '
'review request gets posted and how, and what '
'happens after it is posted.',
option_list=[
Option('-r', '--review-request-id',
dest='rid',
metavar='ID',
default=None,
help='Specifies the existing review request ID to '
'update.'),
Option('-u', '--update',
dest='update',
action='store_true',
default=False,
help='Automatically determines the existing review '
'request to update.'),
Option('-p', '--publish',
dest='publish',
action='store_true',
default=False,
config_key='PUBLISH',
help='Immediately publishes the review request after '
'posting.'),
Option('-o', '--open',
dest='open_browser',
action='store_true',
config_key='OPEN_BROWSER',
default=False,
help='Opens a web browser to the review request '
'after posting.'),
Option('--submit-as',
dest='submit_as',
metavar='USERNAME',
config_key='SUBMIT_AS',
default=None,
help='The user name to use as the author of the '
'review request, instead of the logged in user.'),
Option('--change-only',
dest='change_only',
action='store_true',
default=False,
help='Updates fields from the change description, '
'but does not upload a new diff '
'(Perforce/Plastic only).'),
Option('--diff-only',
dest='diff_only',
action='store_true',
default=False,
help='Uploads a new diff, but does not update '
'fields from the change description '
'(Perforce/Plastic only).'),
]
),
Command.server_options,
Command.repository_options,
OptionGroup(
name='Review Request Field Options',
description='Options for setting the contents of fields in the '
'review request.',
option_list=[
Option('-g', '--guess-fields',
dest='guess_fields',
action='store',
config_key='GUESS_FIELDS',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Short-hand for --guess-summary '
'--guess-description.'),
Option('--guess-summary',
dest='guess_summary',
action='store',
config_key='GUESS_SUMMARY',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Generates the Summary field based on the '
'commit messages (Bazaar/Git/Mercurial only).'),
Option('--guess-description',
dest='guess_description',
action='store',
config_key='GUESS_DESCRIPTION',
nargs='?',
default=GUESS_AUTO,
const=GUESS_YES,
choices=GUESS_CHOICES,
help='Generates the Description field based on the '
'commit messages (Bazaar/Git/Mercurial only).'),
Option('--change-description',
default=None,
help='A description of what changed in this update '
'of the review request. This is ignored for new '
'review requests.'),
Option('--summary',
dest='summary',
default=None,
help='The new contents for the Summary field.'),
Option('--description',
dest='description',
default=None,
help='The new contents for the Description field.'),
Option('--description-file',
dest='description_file',
default=None,
metavar='FILENAME',
help='A text file containing the new contents for the '
'Description field.'),
Option('--testing-done',
dest='testing_done',
default=None,
help='The new contents for the Testing Done field.'),
Option('--testing-done-file',
dest='testing_file',
default=None,
metavar='FILENAME',
help='A text file containing the new contents for the '
'Testing Done field.'),
Option('--branch',
dest='branch',
config_key='BRANCH',
default=None,
help='The branch the change will be committed on.'),
Option('--bugs-closed',
dest='bugs_closed',
default=None,
help='The comma-separated list of bug IDs closed.'),
Option('--target-groups',
dest='target_groups',
config_key='TARGET_GROUPS',
default=None,
help='The names of the groups that should perform the '
'review.'),
Option('--target-people',
dest='target_people',
config_key='TARGET_PEOPLE',
default=None,
help='The usernames of the people who should perform '
'the review.'),
Option('--depends-on',
dest='depends_on',
config_key='DEPENDS_ON',
default=None,
help='The new contents for the Depends On field.'),
Option('--markdown',
dest='markdown',
action='store_true',
config_key='MARKDOWN',
default=False,
help='Specifies if the summary and description should '
'be interpreted as Markdown-formatted text '
'(Review Board 2.0+ only).'),
]
),
Command.diff_options,
Command.perforce_options,
Command.subversion_options,
]
def post_process_options(self):
# -g implies --guess-summary and --guess-description
if self.options.guess_fields:
self.options.guess_fields = self.normalize_guess_value(
self.options.guess_fields, '--guess-fields')
self.options.guess_summary = self.options.guess_fields
self.options.guess_description = self.options.guess_fields
if self.options.revision_range:
raise CommandError(
'The --revision-range argument has been removed. To post a '
'diff for one or more specific revisions, pass those '
'revisions as arguments. For more information, see the '
'RBTools 0.6 Release Notes.')
if self.options.svn_changelist:
raise CommandError(
'The --svn-changelist argument has been removed. To use a '
'Subversion changelist, pass the changelist name as an '
'additional argument after the command.')
# Only one of --description and --description-file can be used
if self.options.description and self.options.description_file:
raise CommandError("The --description and --description-file "
"options are mutually exclusive.\n")
# If --description-file is used, read that file
if self.options.description_file:
if os.path.exists(self.options.description_file):
fp = open(self.options.description_file, "r")
self.options.description = fp.read()
fp.close()
else:
raise CommandError(
"The description file %s does not exist.\n" %
self.options.description_file)
# Only one of --testing-done and --testing-done-file can be used
if self.options.testing_done and self.options.testing_file:
raise CommandError("The --testing-done and --testing-done-file "
"options are mutually exclusive.\n")
# If --testing-done-file is used, read that file
if self.options.testing_file:
if os.path.exists(self.options.testing_file):
fp = open(self.options.testing_file, "r")
self.options.testing_done = fp.read()
fp.close()
else:
raise CommandError("The testing file %s does not exist.\n" %
self.options.testing_file)
# If we have an explicitly specified summary, override
# --guess-summary
if self.options.summary:
self.options.guess_summary = self.GUESS_NO
else:
self.options.guess_summary = self.normalize_guess_value(
self.options.guess_summary, '--guess-summary')
# If we have an explicitly specified description, override
# --guess-description
if self.options.description:
self.options.guess_description = self.GUESS_NO
else:
self.options.guess_description = self.normalize_guess_value(
self.options.guess_description, '--guess-description')
# If we have an explicitly specified review request ID, override
# --update
if self.options.rid and self.options.update:
self.options.update = False
def normalize_guess_value(self, guess, arg_name):
if guess in self.GUESS_YES_INPUT_VALUES:
return self.GUESS_YES
elif guess in self.GUESS_NO_INPUT_VALUES:
return self.GUESS_NO
elif guess == self.GUESS_AUTO:
return guess
else:
raise CommandError('Invalid value "%s" for argument "%s"'
% (guess, arg_name))
def get_repository_path(self, repository_info, api_root):
"""Get the repository path from the server.
This will compare the paths returned by the SCM client
with those one the server, and return the first match.
"""
if isinstance(repository_info.path, list):
repositories = api_root.get_repositories()
try:
while True:
for repo in repositories:
if repo['path'] in repository_info.path:
repository_info.path = repo['path']
raise StopIteration()
repositories = repositories.get_next()
except StopIteration:
pass
if isinstance(repository_info.path, list):
error_str = [
'There was an error creating this review request.\n',
'\n',
'There was no matching repository path found on the server.\n',
'Unknown repository paths found:\n',
]
for foundpath in repository_info.path:
error_str.append('\t%s\n' % foundpath)
error_str += [
'Ask the administrator to add one of these repositories\n',
'to the Review Board server.\n',
]
raise CommandError(''.join(error_str))
return repository_info.path
def get_draft_or_current_value(self, field_name, review_request):
"""Returns the draft or current field value from a review request.
If a draft exists for the supplied review request, return the draft's
field value for the supplied field name, otherwise return the review
request's field value for the supplied field name.
"""
if review_request.draft:
fields = review_request.draft[0]
else:
fields = review_request
return fields[field_name]
def get_possible_matches(self, review_requests, summary, description,
limit=5):
"""Returns a sorted list of tuples of score and review request.
Each review request is given a score based on the summary and
description provided. The result is a sorted list of tuples containing
the score and the corresponding review request, sorted by the highest
scoring review request first.
"""
candidates = []
# Get all potential matches.
try:
while True:
for review_request in review_requests:
summary_pair = (
self.get_draft_or_current_value(
'summary', review_request),
summary)
description_pair = (
self.get_draft_or_current_value(
'description', review_request),
description)
score = Score.get_match(summary_pair, description_pair)
candidates.append((score, review_request))
review_requests = review_requests.get_next()
except StopIteration:
pass
# Sort by summary and description on descending rank.
sorted_candidates = sorted(
candidates,
key=lambda m: (m[0].summary_score, m[0].description_score),
reverse=True
)
return sorted_candidates[:limit]
def num_exact_matches(self, possible_matches):
"""Returns the number of exact matches in the possible match list."""
count = 0
for score, request in possible_matches:
if score.is_exact_match():
count += 1
return count
def guess_existing_review_request_id(self, repository_info, api_root,
api_client):
"""Try to guess the existing review request ID if it is available.
The existing review request is guessed by comparing the existing
summary and description to the current post's summary and description,
respectively. The current post's summary and description are guessed if
they are not provided.
If the summary and description exactly match those of an existing
review request, the ID for which is immediately returned. Otherwise,
the user is prompted to select from a list of potential matches,
sorted by the highest ranked match first.
"""
user = get_user(api_client, api_root, auth_required=True)
repository_id = get_repository_id(
repository_info, api_root, self.options.repository_name)
try:
# Get only pending requests by the current user for this
# repository.
review_requests = api_root.get_review_requests(
repository=repository_id, from_user=user.username,
status='pending', expand='draft')
if not review_requests:
raise CommandError('No existing review requests to update for '
'user %s.'
% user.username)
except APIError, e:
raise CommandError('Error getting review requests for user '
'%s: %s' % (user.username, e))
summary = self.options.summary
description = self.options.description
if not summary or not description:
try:
commit_message = self.get_commit_message()
if commit_message:
if not summary:
summary = commit_message['summary']
if not description:
description = commit_message['description']
except NotImplementedError:
raise CommandError('--summary and --description are required.')
possible_matches = self.get_possible_matches(review_requests, summary,
description)
exact_match_count = self.num_exact_matches(possible_matches)
for score, review_request in possible_matches:
# If the score is the only exact match, return the review request
# ID without confirmation, otherwise prompt.
if score.is_exact_match() and exact_match_count == 1:
return review_request.id
else:
question = ("Update Review Request #%s: '%s'? "
% (review_request.id,
self.get_draft_or_current_value(
'summary', review_request)))
if confirm(question):
return review_request.id
return None
class StatusUpdate(Command):
"""Interact with review request status updates on Review Board.
This command allows setting, getting and deleting status updates for review
requests.
A status update is a way for a third-party service or extension to mark
some kind of status on a review request.
"""
name = 'status-update'
author = 'The Review Board Project'
description = ('Interact with review request status updates on Review '
'Board.')
args = '<action>'
option_list = [
OptionGroup(
name='Status Update Options',
description='Controls the behavior of a status-update, including '
'what review request the status update is attached '
'to.',
option_list=[
Option('-r',
'--review-request-id',
dest='rid',
metavar='ID',
type=int,
required=True,
help='Specifies which review request.'),
Option('-s',
'--status-update-id',
dest='sid',
metavar='ID',
type=int,
help='Specifies which status update from the review '
'request.'),
Option('-j',
'--json',
action='store_true',
dest='json',
default=False,
help='Format command output in JSON.'),
Option('--review',
dest='review',
metavar='FILE_PATH',
default=None,
help='JSON formatted file defining details of '
'review(s) to add to status update.'),
Option('--change-id',
dest='change_id',
metavar='ID',
type=int,
help='The change to a review request which this status '
'update applies to. When not specified, the '
'status update is for the review request as '
'initially published.'),
Option('--description',
dest='description',
metavar='TEXT',
default=None,
help='A user-visible description of the status '
'update.'),
Option('--service-id',
dest='service_id',
metavar='SERVICE_ID',
default=None,
help='A unique identifier for the service providing '
'the status update.'),
Option('--state',
dest='state',
metavar='STATE',
default=None,
help='The current state of the status update.'),
Option('--summary',
dest='summary',
metavar='TEXT',
default=None,
help='A user-visible short summary of the status '
'update.'),
Option('--timeout',
dest='timeout',
metavar='TIMEOUT',
type=int,
help='Timeout for pending status updates, measured in '
'seconds.'),
Option('--url',
dest='url',
metavar='URL',
default=None,
help='URL to link to for more details about the status '
'update.'),
Option('--url-text',
dest='url_text',
metavar='URL_TEXT',
default=None,
help='The text to use for the --url link.'),
]),
Command.server_options,
]
def _print_status_update(self, status_update):
"""Print status update in a human readable format.
Args:
status_update (rbtools.api.transport.Transport):
Representation of status-update API for a review request.
"""
if status_update.get('description'):
description = ': %s' % status_update.get('description')
else:
description = ''
print(' %d\t%s: <%s> %s%s' %
(status_update.get('id'), status_update.get('service_id'),
status_update.get('state'), status_update.get('summary'),
description))
def _dict_status_update(self, status_update):
"""Create a dict for status update.
Args:
status_update (rbtools.api.transport.Transport):
Representation of status-update API for a review request.
Returns:
dict:
Description of status_update that was passed in.
"""
keys = [
'change', 'description', 'extra_data', 'id', 'review',
'service_id', 'state', 'summary', 'timeout', 'url', 'url_text'
]
return {
key: status_update.get(key)
for key in keys if status_update.get(key)
}
def print(self, response):
"""Print output in format specified by user.
Args:
response (list, dict):
Response from API with list of status-updates or a single
status-update.
"""
if self.options.json:
if isinstance(response, list):
output = [
self._dict_status_update(status_update)
for status_update in response
]
else:
output = self._dict_status_update(response)
print(json.dumps(output, indent=2, sort_keys=True))
else:
if isinstance(response, list):
for status_update in response:
self._print_status_update(status_update)
else:
self._print_status_update(response)
def add_review(self, api_root):
"""Handle adding a review to a review request from a json file.
Args:
api_root (rbtools.api.transport.Transport):
Representation of the root level of the Review Board API for
doing further requests to the Review Board API.
Raises:
rbtools.commands.CommandError:
Error with the execution of the command.
Looks for ``reviews``, ``diff_comments``, and ``general_comments`` keys
in the json file contents and populates the review accordingly.
To find appropriate inputs for each key:
``reviews``:
Look at Web API documentation for POST on the Review List resource
for available fields.
``diff_comments``:
Look at Web API documentation for POST on the Review Diff Comment
List resource for available fields. All diff comments require
``first_line``, ``filediff_id``, ``num_lines``, and ``text`` field
to be specified.
``general_comments``:
Look at Web API documentation for POST on the Review General
Comment List resource for available fields. All general comments
require ``text`` field to be specified.
Example file contents:
```
{
"review": {
"body_top": "Header comment"
},
"diff_comment": [
{
"filediff_id": 10,
"first_line": 729,
"issue_opened": true,
"num_lines": 1,
"text": "Adding a comment on a diff line",
"text_type": "markdown"
}
],
"general_comments": [
{
"text": "Adding a general comment",
"text_type": "markdown"
}
]
}
```
"""
with open(self.options.review) as f:
file_contents = json.loads(f.read())
review_draft = api_root.get_reviews(review_request_id=self.options.rid)
if ('reviews' not in file_contents
and 'diff_comments' not in file_contents
and 'general_comments' not in file_contents):
raise CommandError('No information in review file, this will '
'create an empty review.')
if 'reviews' in file_contents:
# Make sure public is false so that comments can be added.
file_contents['reviews']['public'] = False
new_review_draft = review_draft.create(**file_contents['reviews'])
else:
new_review_draft = review_draft.create()
if 'diff_comments' in file_contents:
diff_comments = new_review_draft.get_diff_comments()
for comment in file_contents['diff_comments']:
try:
diff_comments.create(**comment)
except APIError as e:
logging.warning(
'Failed to create diff comment: %s\n'
'APIError: %s', json.dumps(comment), e)
if 'general_comments' in file_contents:
general_comments = new_review_draft.get_general_comments()
for comment in file_contents['general_comments']:
try:
general_comments.create(**comment)
except APIError as e:
logging.warning(
'Failed to create general comment: %s\n'
'APIError: %s', json.dumps(comment), e)
return new_review_draft
def get_status_update(self, api_root):
"""Handle getting status update information from Review Board.
Args:
api_root (rbtools.api.transport.Transport):
Representation of the root level of the Review Board API for
doing further requests to the Review Board API.
Raises:
rbtools.commands.CommandError:
Error with the execution of the command.
rbtools.commands.CommandExit:
Stop executing and return an exit status.
"""
try:
if self.options.sid:
self.print(
api_root.get_status_update(
review_request_id=self.options.rid,
status_update_id=self.options.sid).rsp.get(
'status_update'))
else:
self.print(
api_root.get_status_updates(review_request_id=self.options.
rid).rsp.get('status_updates'))
except APIError as e:
if e.rsp:
print(json.dumps(e.rsp, indent=2))
raise CommandExit(1)
else:
raise CommandError('Could not retrieve the requested '
'resource: %s' % e)
def set_status_update(self, api_root):
"""Handle setting status update information on Review Board.
Args:
api_root (rbtools.api.transport.Transport):
Representation of the root level of the Review Board API for
doing further requests to the Review Board API.
Raises:
rbtools.commands.CommandError:
Error with the execution of the command.
rbtools.commands.CommandExit:
Stop executing and return an exit status.
"""
# If a review file is specified, create review.
new_review_draft = None
review_draft_id = None
if self.options.review:
new_review_draft = self.add_review(api_root)
review_draft_id = new_review_draft.id
# Validate state option.
allowed_state = ['pending', 'done-failure', 'done-success', 'error']
if self.options.state and self.options.state not in allowed_state:
raise CommandError('--state must be one of: %s' %
(', '.join(allowed_state)))
# Build query args.
request_parameters = [
'change_id', 'description', 'service_id', 'state', 'summary',
'timeout', 'url', 'url_text'
]
options = vars(self.options)
query_args = {
parameter: options.get(parameter)
for parameter in iter(request_parameters) if options.get(parameter)
}
# Attach review to status-update.
if review_draft_id:
query_args['review_id'] = review_draft_id
try:
if self.options.sid:
status_update = api_root.get_status_update(
review_request_id=self.options.rid,
status_update_id=self.options.sid)
status_update = status_update.update(**query_args)
else:
if not self.options.service_id or not self.options.summary:
raise CommandError('--service-id and --summary are '
'required input for creating a new '
'status update')
status_update = api_root.get_status_updates(
review_request_id=self.options.rid)
status_update = status_update.create(**query_args)
# Make review public.
if new_review_draft:
new_review_draft.update(public=True)
self.print(status_update.rsp.get('status_update'))
except APIError as e:
if e.rsp:
print(json.dumps(e.rsp, indent=2))
raise CommandExit(1)
else:
raise CommandError('Could not set the requested '
'resource: %s' % e)
def delete_status_update(self, api_root):
"""Handle deleting status updates on Review Board.
Args:
api_root (rbtools.api.transport.Transport):
Representation of the root level of the Review Board API for
doing further requests to the Review Board API.
Raises:
rbtools.commands.CommandError:
Error with the execution of the command.
"""
try:
if not self.options.sid:
raise CommandError('Status update ID is required for '
'deleting a status update.')
status_update = api_root.get_status_update(
review_request_id=self.options.rid,
status_update_id=self.options.sid)
status_update.delete()
except APIError as e:
raise CommandError('Could not delete the requested resource: '
'%s' % e)
def main(self, action):
"""Call API for status-update.
Args:
action (unicode):
Sub command argument input for specifying which action to do
(can be ``get``, ``set``, or ``delete``).
Raises:
rbtools.command.CommandError:
Error with the execution of the command.
"""
if self.options.server:
server_url = self.options.server
else:
repository_info, tool = self.initialize_scm_tool()
server_url = self.get_server_url(repository_info, tool)
api_client, api_root = self.get_api(server_url)
if action == 'get':
self.get_status_update(api_root)
elif action == 'set':
self.set_status_update(api_root)
elif action == 'delete':
self.delete_status_update(api_root)
else:
raise CommandError('Action "%s" not recognized.' % action)
class Stamp(Command):
"""Add the review request URL to the last commit message.
Guesses the existing review request ID and stamp the review request URL
to the last commit message. If a review request ID is specified by the
user, use the specified review request URL instead of guessing.
"""
name = 'stamp'
author = 'The Review Board Project'
option_list = [
OptionGroup(
name='Stamp Options',
description='Controls the behavior of a stamp, including what '
'review request URL gets stamped.',
option_list=[
Option('-r',
'--review-request-id',
dest='rid',
metavar='ID',
default=None,
help='Specifies the existing review request ID to '
'be stamped.'),
]),
Command.server_options,
Command.repository_options,
Command.diff_options,
]
def no_commit_error(self):
raise CommandError('No existing commit to stamp on.')
def _ask_review_request_match(self, review_request):
question = ("Stamp last commit with Review Request #%s: '%s'? " %
(review_request.id,
get_draft_or_current_value('summary', review_request)))
return confirm(question)
def main(self, *args):
"""Stamp the latest commit with corresponding review request URL"""
self.cmd_args = list(args)
repository_info, self.tool = self.initialize_scm_tool(
client_name=self.options.repository_type)
server_url = self.get_server_url(repository_info, self.tool)
api_client, api_root = self.get_api(server_url)
self.setup_tool(self.tool, api_root=api_root)
if not self.tool.can_amend_commit:
raise NotImplementedError('rbt stamp is not supported with %s.' %
self.tool.name)
try:
if self.tool.has_pending_changes():
raise CommandError('Working directory is not clean.')
except NotImplementedError:
pass
revisions = get_revisions(self.tool, self.cmd_args)
commit_message = self.tool.get_raw_commit_message(revisions)
if '\nReviewed at http' in commit_message:
raise CommandError('This commit is already stamped.')
if not self.options.rid:
self.options.rid = guess_existing_review_request_id(
repository_info,
self.options.repository_name,
api_root,
api_client,
self.tool,
revisions,
guess_summary=False,
guess_description=False,
is_fuzzy_match_func=self._ask_review_request_match,
no_commit_error=self.no_commit_error)
if not self.options.rid:
raise CommandError('Could not determine the existing review '
'request URL to stamp with.')
review_request = get_review_request(self.options.rid, api_root)
stamp_url = review_request.absolute_url
commit_message += '\n\nReviewed at %s' % stamp_url
self.tool.amend_commit(commit_message)
print('Changes committed to current branch.')
