Merge lp:~jelmer/brz/supports-storing-branch-nick into lp:brz

[Jelmer Vernooij]

Add and use a ``RepositoryFormat.supports_storing_branch_nick`` property.

Add a ``RepositoryFormat.supports_storing_branch_nick`` property, that can be used to determine whether a revision records the nick of the branch it is on. This would be set to True for bzr, svn and mercurial branches, but e.g. to False for git.

[Martin Packman (gz)]

Looks good, thanks!

review: Approve

=== modified file 'breezy/repository.py'
--- breezy/repository.py	2017-11-14 01:20:51 +0000
+++ breezy/repository.py	2017-11-21 00:36:15 +0000
@@ -1295,6 +1295,9 @@
     # Is it possible for revisions to be present without being referenced
     # somewhere ?
     supports_unreferenced_revisions = None
+    # Does this format store the current Branch.nick in a revision when
+    # creating commits?
+    supports_storing_branch_nick = True
 
     def __repr__(self):
         return "%s()" % self.__class__.__name__

=== modified file 'breezy/tests/per_branch/test_branch.py'
--- breezy/tests/per_branch/test_branch.py	2017-11-12 17:53:35 +0000
+++ breezy/tests/per_branch/test_branch.py	2017-11-21 00:36:15 +0000
@@ -303,9 +303,11 @@
         branch.nick = "My happy branch"
         wt.commit('My commit respect da nick.')
         committed = branch.repository.get_revision(branch.last_revision())
-        # TODO(jelmer): Only set branch nick on bzr branches
-        self.assertEqual(committed.properties["branch-nick"],
-                         "My happy branch")
+        if branch.repository._format.supports_storing_branch_nick:
+            self.assertEqual(committed.properties["branch-nick"],
+                             "My happy branch")
+        else:
+            self.assertNotIn("branch-nick", committed.properties)
 
     def test_create_colocated(self):
         try:

=== modified file 'breezy/tests/per_branch/test_commit.py'
--- breezy/tests/per_branch/test_commit.py	2017-11-17 03:06:50 +0000
+++ breezy/tests/per_branch/test_commit.py	2017-11-21 00:36:15 +0000
@@ -36,8 +36,11 @@
         branch.nick = "My happy branch"
         wt.commit('My commit respect da nick.')
         committed = branch.repository.get_revision(branch.last_revision())
-        self.assertEqual(committed.properties["branch-nick"],
-                         "My happy branch")
+        if branch.repository._format.supports_storing_branch_nick:
+            self.assertEqual(committed.properties["branch-nick"],
+                             "My happy branch")
+        else:
+            self.assertNotIn("branch-nick", committed.properties)
 
 
 class TestCommitHook(per_branch.TestCaseWithBranch):

=== modified file 'breezy/tests/per_repository/test_repository.py'
--- breezy/tests/per_repository/test_repository.py	2017-11-19 19:01:00 +0000
+++ breezy/tests/per_repository/test_repository.py	2017-11-21 00:36:15 +0000
@@ -118,6 +118,10 @@
         self.assertFormatAttribute('supports_setting_revision_ids',
             (True, False))
 
+    def test_attribute_format_supports_storing_branch_nick(self):
+        self.assertFormatAttribute('supports_storing_branch_nick',
+            (True, False))
+
     def test_format_is_deprecated(self):
         repo = self.make_repository('repo')
         self.assertSubset([repo._format.is_deprecated()], (True, False))

=== modified file 'breezy/tests/per_repository/test_revision.py'
--- breezy/tests/per_repository/test_revision.py	2017-11-19 18:57:05 +0000
+++ breezy/tests/per_repository/test_revision.py	2017-11-21 00:36:15 +0000
@@ -37,12 +37,15 @@
         rev = b.repository.get_revision(rev1)
         self.assertTrue('flavor' in rev.properties)
         self.assertEqual(rev.properties['flavor'], 'choc-mint')
-        self.assertEqual([('branch-nick', 'Nicholas'),
-                           ('condiment', 'orange\n  mint\n\tcandy'),
-                           ('empty', ''),
-                           ('flavor', 'choc-mint'),
-                           ('non_ascii', u'\xb5'),
-                          ], sorted(rev.properties.items()))
+        expected_revprops = {
+            'condiment': 'orange\n  mint\n\tcandy',
+            'empty': '',
+            'flavor': 'choc-mint',
+            'non_ascii': u'\xb5',
+            }
+        if b.repository._format.supports_storing_branch_nick:
+            expected_revprops['branch-nick'] = 'Nicholas'
+        self.assertEqual(expected_revprops, rev.properties)
 
     def test_invalid_revprops(self):
         """Invalid revision properties"""