Merge lp:~jelmer/brz/related-bugs into lp:brz

[Jelmer Vernooij]

Support --bugs= argument to commit to link related bugs (not necessarily ones that were fixed).

Support --bugs= argument to commit to link related bugs (not necessarily ones that were fixed).

[Martin Packman (gz)]

Hm, seems most useful for general issue trackers rather than bugs specifically, so maybe the name is poor, but the idea makes sense. Could link story from each commit related for instance.

review: Approve

=== modified file 'breezy/bugtracker.py'
--- breezy/bugtracker.py	2018-05-14 19:59:18 +0000
+++ breezy/bugtracker.py	2018-11-13 02:02:02 +0000
@@ -406,16 +406,17 @@
 
 
 FIXED = 'fixed'
+RELATED = 'related'
 
-ALLOWED_BUG_STATUSES = {FIXED}
+ALLOWED_BUG_STATUSES = {FIXED, RELATED}
 
 
 def encode_fixes_bug_urls(bug_urls):
     """Get the revision property value for a commit that fixes bugs.
 
-    :param bug_urls: An iterable of escaped URLs to bugs. These normally
+    :param bug_urls: An iterable of (escaped URL, tag) tuples. These normally
         come from `get_bug_url`.
     :return: A string that will be set as the 'bugs' property of a revision
         as part of a commit.
     """
-    return '\n'.join(('%s %s' % (url, FIXED)) for url in bug_urls)
+    return '\n'.join(('%s %s' % (url, tag)) for (url, tag) in bug_urls)

=== modified file 'breezy/builtins.py'
--- breezy/builtins.py	2018-11-04 15:48:54 +0000
+++ breezy/builtins.py	2018-11-13 02:02:02 +0000
@@ -3518,6 +3518,8 @@
              Option('commit-time', type=text_type,
                     help="Manually set a commit time using commit date "
                     "format, e.g. '2009-10-10 08:00:00 +0100'."),
+             ListOption('bugs', type=text_type,
+                    help="Link to a related bug. (see \"brz help bugs\")."),
              ListOption('fixes', type=text_type,
                     help="Mark a bug as being fixed by this revision "
                          "(see \"brz help bugs\")."),
@@ -3540,11 +3542,11 @@
              ]
     aliases = ['ci', 'checkin']
 
-    def _iter_bug_fix_urls(self, fixes, branch):
+    def _iter_bug_urls(self, bugs, branch, status):
         default_bugtracker  = None
         # Configure the properties for bug fixing attributes.
-        for fixed_bug in fixes:
-            tokens = fixed_bug.split(':')
+        for bug in bugs:
+            tokens = bug.split(':')
             if len(tokens) == 1:
                 if default_bugtracker is None:
                     branch_config = branch.get_config_stack()
@@ -3556,29 +3558,30 @@
                         "'tracker:id' or specify a default bug tracker "
                         "using the `bugtracker` option.\nSee "
                         "\"brz help bugs\" for more information on this "
-                        "feature. Commit refused.") % fixed_bug)
+                        "feature. Commit refused.") % bug)
                 tag = default_bugtracker
                 bug_id = tokens[0]
             elif len(tokens) != 2:
                 raise errors.BzrCommandError(gettext(
                     "Invalid bug %s. Must be in the form of 'tracker:id'. "
                     "See \"brz help bugs\" for more information on this "
-                    "feature.\nCommit refused.") % fixed_bug)
+                    "feature.\nCommit refused.") % bug)
             else:
                 tag, bug_id = tokens
             try:
-                yield bugtracker.get_bug_url(tag, branch, bug_id)
+                yield bugtracker.get_bug_url(tag, branch, bug_id), status
             except bugtracker.UnknownBugTrackerAbbreviation:
                 raise errors.BzrCommandError(gettext(
-                    'Unrecognized bug %s. Commit refused.') % fixed_bug)
+                    'Unrecognized bug %s. Commit refused.') % bug)
             except bugtracker.MalformedBugIdentifier as e:
                 raise errors.BzrCommandError(gettext(
                     u"%s\nCommit refused.") % (e,))
 
     def run(self, message=None, file=None, verbose=False, selected_list=None,
-            unchanged=False, strict=False, local=False, fixes=None,
+            unchanged=False, strict=False, local=False, fixes=None, bugs=None,
             author=None, show_diff=False, exclude=None, commit_time=None,
             lossy=False):
+        import itertools
         from .commit import (
             PointlessCommit,
             )
@@ -3612,8 +3615,12 @@
 
         if fixes is None:
             fixes = []
+        if bugs is None:
+            bugs = []
         bug_property = bugtracker.encode_fixes_bug_urls(
-            self._iter_bug_fix_urls(fixes, tree.branch))
+            itertools.chain(
+                self._iter_bug_urls(bugs, tree.branch, bugtracker.RELATED),
+                self._iter_bug_urls(fixes, tree.branch, bugtracker.FIXED)))
         if bug_property:
             properties[u'bugs'] = bug_property
 

=== modified file 'breezy/log.py'
--- breezy/log.py	2018-08-15 18:44:16 +0000
+++ breezy/log.py	2018-11-13 02:02:02 +0000
@@ -2140,16 +2140,21 @@
 
 # Use the properties handlers to print out bug information if available
 def _bugs_properties_handler(revision):
+    ret = {}
     if 'bugs' in revision.properties:
         bug_lines = revision.properties['bugs'].split('\n')
         bug_rows = [line.split(' ', 1) for line in bug_lines]
         fixed_bug_urls = [row[0] for row in bug_rows if
                           len(row) > 1 and row[1] == 'fixed']
-
+        related_bug_urls = [row[0] for row in bug_rows if
+                            len(row) > 1 and row[1] == 'related']
         if fixed_bug_urls:
-            return {ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls)):\
-                    ' '.join(fixed_bug_urls)}
-    return {}
+            ret[ngettext('fixes bug', 'fixes bugs', len(fixed_bug_urls))] = (
+                ' '.join(fixed_bug_urls))
+        if related_bug_urls:
+            ret[ngettext('related bug', 'related bugs', len(related_bug_urls))] = (
+                ' '.join(related_bug_urls))
+    return ret
 
 properties_handler_registry.register('bugs_properties_handler',
                                      _bugs_properties_handler)

=== modified file 'breezy/plugins/commitfromnews/committemplate.py'
--- breezy/plugins/commitfromnews/committemplate.py	2018-07-14 19:18:18 +0000
+++ breezy/plugins/commitfromnews/committemplate.py	2018-11-13 02:02:02 +0000
@@ -96,7 +96,8 @@
                     bugids.extend(_BUG_MATCH.findall(line))
                 self.commit.revprops['bugs'] = \
                     bugtracker.encode_fixes_bug_urls(
-                        [bt.get_bug_url(bugid) for bugid in bugids])
+                        [(bt.get_bug_url(bugid), bugtracker.FIXED)
+                         for bugid in bugids])
             return self.merge_message(''.join(new_lines))
 
     def merge_message(self, new_message):

=== modified file 'breezy/tests/blackbox/test_commit.py'
--- breezy/tests/blackbox/test_commit.py	2018-08-13 01:38:21 +0000
+++ breezy/tests/blackbox/test_commit.py	2018-11-13 02:02:02 +0000
@@ -568,6 +568,22 @@
         del properties['branch-nick']
         self.assertFalse('bugs' in properties)
 
+    def test_bugs_sets_property(self):
+        """commit --bugs=lp:234 sets the lp:234 revprop to 'related'."""
+        tree = self.make_branch_and_tree('tree')
+        self.build_tree(['tree/hello.txt'])
+        tree.add('hello.txt')
+        self.run_bzr('commit -m hello --bugs=lp:234 tree/hello.txt')
+
+        # Get the revision properties, ignoring the branch-nick property, which
+        # we don't care about for this test.
+        last_rev = tree.branch.repository.get_revision(tree.last_revision())
+        properties = dict(last_rev.properties)
+        del properties[u'branch-nick']
+
+        self.assertEqual({u'bugs': 'https://launchpad.net/bugs/234 related'},
+                         properties)
+
     def test_fixes_bug_sets_property(self):
         """commit --fixes=lp:234 sets the lp:234 revprop to 'fixed'."""
         tree = self.make_branch_and_tree('tree')

=== modified file 'breezy/tests/test_bugtracker.py'
--- breezy/tests/test_bugtracker.py	2018-05-14 19:59:18 +0000
+++ breezy/tests/test_bugtracker.py	2018-11-13 02:02:02 +0000
@@ -324,7 +324,8 @@
     def test_encoding_one(self):
         self.assertEqual(
             'http://example.com/bugs/1 fixed',
-            bugtracker.encode_fixes_bug_urls(['http://example.com/bugs/1']))
+            bugtracker.encode_fixes_bug_urls(
+                [('http://example.com/bugs/1', 'fixed')]))
 
     def test_encoding_zero(self):
         self.assertEqual('', bugtracker.encode_fixes_bug_urls([]))
@@ -332,6 +333,7 @@
     def test_encoding_two(self):
         self.assertEqual(
             'http://example.com/bugs/1 fixed\n'
-            'http://example.com/bugs/2 fixed',
+            'http://example.com/bugs/2 related',
             bugtracker.encode_fixes_bug_urls(
-                ['http://example.com/bugs/1', 'http://example.com/bugs/2']))
+                [('http://example.com/bugs/1', 'fixed'),
+                 ('http://example.com/bugs/2', 'related')]))

=== modified file 'breezy/tests/test_options.py'
--- breezy/tests/test_options.py	2018-08-05 20:13:41 +0000
+++ breezy/tests/test_options.py	2018-11-13 02:02:02 +0000
@@ -44,16 +44,16 @@
         # to cmd_commit, when they are meant to be about option parsing in
         # general.
         self.assertEqual(
-           ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True}),
+            ([], {'author': [], 'exclude': [], 'fixes': [], 'help': True, 'bugs': []}),
            parse_args(cmd_commit(), ['--help']))
         self.assertEqual(
-           ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter'}),
+            ([], {'author': [], 'exclude': [], 'fixes': [], 'message': 'biter', 'bugs': []}),
            parse_args(cmd_commit(), ['--message=biter']))
 
     def test_no_more_opts(self):
         """Terminated options"""
         self.assertEqual(
-            (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': []}),
+            (['-file-with-dashes'], {'author': [], 'exclude': [], 'fixes': [], 'bugs': []}),
             parse_args(cmd_commit(), ['--', '-file-with-dashes']))
 
     def test_option_help(self):

=== modified file 'breezy/tests/test_revision.py'
--- breezy/tests/test_revision.py	2018-07-07 19:27:38 +0000
+++ breezy/tests/test_revision.py	2018-11-13 02:02:02 +0000
@@ -230,8 +230,8 @@
         r = revision.Revision(
             '1', properties={
                 u'bugs': bugtracker.encode_fixes_bug_urls(
-                    ['http://example.com/bugs/1',
-                     'http://launchpad.net/bugs/1234'])})
+                    [('http://example.com/bugs/1', 'fixed'),
+                     ('http://launchpad.net/bugs/1234', 'fixed')])})
         self.assertEqual(
             [('http://example.com/bugs/1', bugtracker.FIXED),
              ('http://launchpad.net/bugs/1234', bugtracker.FIXED)],