Merge lp:~jelmer/brz/setting-file-ids into lp:brz

[Jelmer Vernooij]

Add a ``WorkingTreeFormat.supports_setting_file_ids`` property, which can be set for svn/git working tree formats.

Add a ``WorkingTreeFormat.supports_setting_file_ids`` property, which can be set for svn/git working tree formats.

The idea is that tests can be skipped based on this property.

[Martin Packman (gz)]

Makes sense.

review: Approve

=== modified file 'breezy/tests/per_workingtree/test_workingtree.py'
--- breezy/tests/per_workingtree/test_workingtree.py	2017-06-11 18:41:26 +0000
+++ breezy/tests/per_workingtree/test_workingtree.py	2017-07-30 19:18:06 +0000
@@ -1232,3 +1232,8 @@
         self.assertSubset(
             [self.workingtree_format.supports_versioned_directories],
             (True, False))
+
+    def test_supports_setting_file_ids(self):
+        self.assertSubset(
+            [self.workingtree_format.supports_setting_file_ids],
+            (True, False))
 
=== modified file 'breezy/workingtree.py'
--- breezy/workingtree.py	2017-07-21 13:41:26 +0000
+++ breezy/workingtree.py	2017-07-30 19:18:06 +0000
@@ -76,6 +76,11 @@
 ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
 
+class SettingFileIdUnsupported(errors.BzrError):
+
+    _fmt = "This format does not support setting file ids."""
+
+
 class TreeEntry(object):
     """An entry that implements the minimum interface used by commands.
 
@@ -229,6 +234,9 @@
     def supports_views(self):
         return self.views.supports_views()
 
+    def supports_setting_file_ids(self):
+        return self._format.supports_setting_file_ids
+
     def get_config_stack(self):
         """Retrieve the config stack for this tree.
 
@@ -771,6 +779,8 @@
         """See MutableTree.mkdir()."""
         if file_id is None:
             file_id = generate_ids.gen_file_id(os.path.basename(path))
+        elif not self.supports_setting_file_ids():
+            raise SettingFileIdUnsupported()
         os.mkdir(self.abspath(path))
         self.add(path, file_id, 'directory')
         return file_id
@@ -1296,6 +1306,8 @@
     @needs_tree_write_lock
     def set_root_id(self, file_id):
         """Set the root id for this tree."""
+        if not self.supports_setting_file_ids():
+            raise SettingFileIdUnsupported()
         # for compatability
         if file_id is None:
             raise ValueError(
@@ -1732,6 +1744,9 @@
 
     supports_versioned_directories = None
 
+    supports_setting_file_ids = True
+    """If this format allows setting the file id."""
+
     def initialize(self, controldir, revision_id=None, from_branch=None,
                    accelerator_tree=None, hardlink=False):
         """Initialize a new working tree in controldir.
 
=== modified file 'doc/en/release-notes/brz-3.0.txt'
--- doc/en/release-notes/brz-3.0.txt	2017-07-23 22:06:41 +0000
+++ doc/en/release-notes/brz-3.0.txt	2017-07-30 19:18:06 +0000
@@ -172,6 +172,11 @@
  * A new ``Repository.iter_revisions`` method has been added.
    (Jelmer Vernooij)
 
+ * A new ``WorkingTreeFormat.supports_setting_file_ids`` property
+   has been added that can be set to False to indicate a working tree
+   doesn't support e.g. passing a file_id into ``WorkingTree.mkdir``.
+   (Jelmer Vernooij, #1707533)
+
 Internals
 *********