Merge lp:~jelmer/brz/line-endings into lp:brz

[Jelmer Vernooij]

Improve error message if line endings in format file were corrupted.

[Martin Packman (gz)]

Seems reasonable, could alternatively only raise this if `klass.formats.get(first_line.replace('\r'))` returns something.

review: Approve

=== modified file 'breezy/bzr/__init__.py'
--- breezy/bzr/__init__.py	2018-06-27 20:57:41 +0000
+++ breezy/bzr/__init__.py	2018-09-21 02:15:40 +0000
@@ -44,7 +44,10 @@
         try:
             cls = klass.formats.get(first_line)
         except KeyError:
-            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
+            if first_line.endswith(b"\r\n"):
+                raise errors.LineEndingError(file=".bzr/branch-format")
+            else:
+                raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
         return cls.from_string(format_string)
 
     @classmethod

=== modified file 'breezy/errors.py'
--- breezy/errors.py	2018-08-14 21:37:46 +0000
+++ breezy/errors.py	2018-09-21 02:15:40 +0000
@@ -592,6 +592,15 @@
         self.format = format
 
 
+class LineEndingError(BzrError):
+
+    _fmt = ("Line ending corrupted for file: %(file)s; "
+            "Maybe your files got corrupted in transport?")
+
+    def __init__(self, file):
+        self.file = file
+
+
 class IncompatibleFormat(BzrError):
 
     _fmt = "Format %(format)s is not compatible with .bzr version %(controldir)s."

=== modified file 'breezy/tests/test_bzrdir.py'
--- breezy/tests/test_bzrdir.py	2018-08-07 20:43:32 +0000
+++ breezy/tests/test_bzrdir.py	2018-09-21 02:15:40 +0000
@@ -312,6 +312,14 @@
                           bzrdir.BzrDirFormat.find_format,
                           _mod_transport.get_transport_from_path('.'))
 
+    def test_find_format_line_endings(self):
+        t = self.get_transport()
+        t.mkdir('.bzr')
+        t.put_bytes('.bzr/branch-format', b'Corrupt line endings\r\n')
+        self.assertRaises(errors.LineEndingError,
+                          bzrdir.BzrDirFormat.find_format,
+                          _mod_transport.get_transport_from_path('.'))
+
     def test_register_unregister_format(self):
         format = SampleBzrDirFormat()
         url = self.get_url()