Merge lp:~jelmer/brz/backslash-support into lp:brz

[Jelmer Vernooij]

Support adding files with filenames that are just a backslash on
platforms where it is not the path separator.

Support adding files with filenames that are just a backslash on
platforms where it is not the path separator.

[Martin Packman (gz)]

Okay, this still terrifies me, but I guess all we're really doing is giving *nix users one more in a long list of footguns.

[The Breezy Bot (the-breezy-bot)]

Voting criteria not met
https://ci.breezy-vcs.org/job/land-brz/504/

[Jelmer Vernooij (jelmer)]

I think the main consequence of this is that it's possible to create branches that can not be checked out on Windows. However, this is already possible - there is a separate bug open about warning in cases like this: bug 1743186

[Martin Packman (gz)]

Okay, lets do it.

review: Approve

=== modified file 'breezy/osutils.py'
--- breezy/osutils.py	2018-11-12 01:41:38 +0000
+++ breezy/osutils.py	2018-11-17 18:51:40 +0000
@@ -1035,12 +1035,18 @@
 
 def splitpath(p):
     """Turn string into list of parts."""
-    # split on either delimiter because people might use either on
-    # Windows
-    if isinstance(p, bytes):
-        ps = re.split(b'[\\\\/]', p)
+    if os.path.sep == '\\':
+        # split on either delimiter because people might use either on
+        # Windows
+        if isinstance(p, bytes):
+            ps = re.split(b'[\\\\/]', p)
+        else:
+            ps = re.split(r'[\\/]', p)
     else:
-        ps = re.split(r'[\\/]', p)
+        if isinstance(p, bytes):
+            ps = p.split(b'/')
+        else:
+            ps = p.split('/')
 
     rps = []
     for f in ps:
 
=== modified file 'breezy/tests/blackbox/test_add.py'
--- breezy/tests/blackbox/test_add.py	2018-11-11 04:08:32 +0000
+++ breezy/tests/blackbox/test_add.py	2018-11-17 18:51:40 +0000
@@ -265,3 +265,16 @@
         out = self.run_bzr('add')[0]
         results = sorted(out.rstrip('\n').split('\n'))
         self.assertEqual(['adding big.txt'], results)
+
+    def test_add_backslash(self):
+        # pad.lv/165151
+        if os.path.sep == '\\':
+            # TODO(jelmer): Test that backslashes are appropriately
+            # ignored?
+            raise tests.TestNotApplicable(
+                'unable to add filenames with backslashes where '
+                ' it is the path separator')
+        tree = self.make_branch_and_tree('.')
+        self.build_tree(['\\'])
+        self.assertEqual('adding \\\n', self.run_bzr('add \\\\')[0])
+        self.assertEqual('\\\n', self.run_bzr('ls --versioned')[0])
 
=== modified file 'breezy/tests/blackbox/test_remove.py'
--- breezy/tests/blackbox/test_remove.py	2018-11-11 04:08:32 +0000
+++ breezy/tests/blackbox/test_remove.py	2018-11-17 18:51:40 +0000
@@ -274,3 +274,16 @@
                      error_regexes=["removed a", "removed b", "removed b/c"])
         tree = WorkingTree.open('.')
         self.assertFilesUnversioned(files)
+
+    def test_remove_backslash(self):
+        # pad.lv/176263
+        if os.path.sep == '\\':
+            raise tests.TestNotApplicable(
+                'unable to add filenames with backslashes where '
+                ' it is the path separator')
+        tree = self.make_branch_and_tree('.')
+        self.build_tree(['\\'])
+        self.assertEqual('adding \\\n', self.run_bzr('add \\\\')[0])
+        self.assertEqual('\\\n', self.run_bzr('ls --versioned')[0])
+        self.assertEqual('', self.run_bzr('rm \\\\')[0])
+        self.assertEqual('', self.run_bzr('ls --versioned')[0])
 
=== modified file 'breezy/tests/test_osutils.py'
--- breezy/tests/test_osutils.py	2018-11-12 01:41:38 +0000
+++ breezy/tests/test_osutils.py	2018-11-17 18:51:40 +0000
@@ -1058,7 +1058,10 @@
         check(['a', 'b'], 'a/b')
         check(['a', 'b'], 'a/./b')
         check(['a', '.b'], 'a/.b')
-        check(['a', '.b'], 'a\\.b')
+        if os.path.sep == '\\':
+            check(['a', '.b'], 'a\\.b')
+        else:
+            check(['a\\.b'], 'a\\.b')
 
         self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
 
 
=== modified file 'doc/en/release-notes/brz-3.0.txt'
--- doc/en/release-notes/brz-3.0.txt	2018-11-16 07:18:33 +0000
+++ doc/en/release-notes/brz-3.0.txt	2018-11-17 18:51:40 +0000
@@ -67,6 +67,11 @@
    has been renamed to ``transform.orphan_policy``.
    (Jelmer Vernooij)
 
+ * Backslash (\) is no longer accepted as a path separator
+   on platforms where it is not the default path separator,
+   e.g. POSIX systems. This is so that filenames with backslashes
+   in their name can be added explicitly. (#176263, #165151)
+
  * One-letter shortcuts for Ubuntu releases are no
    longer supported after 'ubuntu:'. Bazaar's mapping for
    one-letter distroseries had not been updated since natty.
@@ -176,6 +181,10 @@
 
 * Support '0' markers in fastimport plugin. (Jelmer Vernooij, #1744615)
 
+* Support adding/removing filenames that consist of just
+  backslashes in where backslash is not the path separator.
+  (Jelmer Vernooij, #176263, #165151)
+
 * Report correct path in output of ``brz add``.
   (Brian de Alwis, Jelmer Vernooij, #1799482)