Merge lp:~jelmer/brz/rcp-url into lp:brz

[Jelmer Vernooij]

Add support for rcp-style location string for SSH operations.

Add support for rcp-style location stringfor SSH operations.

For the moment, these are converted to ssh:// URLs. Breezy prints an error when
opening these, suggesting the user use either bzr+ssh or git+ssh. This is not
ideal, but better than giving a more confusing error.

Unfortunately this requires some heuristics, since it may be hard to tell apart
real "URLs" and RCP style location strings. E.g. "http:foo".

[Martin Packman (gz)]

Thanks, seem couple of comments inline.

review: Approve

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

Merging failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/257/

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

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/260/

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

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/262/

=== modified file 'breezy/directory_service.py'
--- breezy/directory_service.py	2019-02-09 03:23:20 +0000
+++ breezy/directory_service.py	2019-03-03 20:13:19 +0000
@@ -185,8 +185,8 @@
 
     def look_up(self, name, url, purpose=None):
         dir = _mod_controldir.ControlDir.open_containing('.')[0]
-        return urlutils.join_segment_parameters(dir.user_url,
-                                                {"branch": urlutils.escape(name)})
+        return urlutils.join_segment_parameters(
+            dir.user_url, {"branch": urlutils.escape(name)})
 
 
 directories.register('co:', ColocatedDirectory,
 
=== modified file 'breezy/location.py'
--- breezy/location.py	2019-02-09 03:23:20 +0000
+++ breezy/location.py	2019-03-03 20:13:19 +0000
@@ -19,6 +19,8 @@
 
 from __future__ import absolute_import
 
+import re
+
 from . import (
     urlutils,
     )
@@ -44,6 +46,28 @@
 hooks = LocationHooks()
 
 
+def rcp_location_to_url(location, scheme='ssh'):
+    """Convert a rcp-style location to a URL.
+
+    :param location: Location to convert, e.g. "foo:bar"
+    :param schenme: URL scheme to return, defaults to "ssh"
+    :return: A URL, e.g. "ssh://foo/bar"
+    :raises ValueError: if this is not a RCP-style URL
+    """
+    m = re.match('^(?P<user>[^@:/]+@)?(?P<host>[^/:]+):(?P<path>.*)$', location)
+    if not m:
+        raise ValueError("Not a RCP URL")
+    if m.group('path').startswith('//'):
+        raise ValueError("Not a RCP URL: already looks like a URL")
+    quoted_user = urlutils.quote(m.group('user')[:-1]) if m.group('user') else None
+    url = urlutils.URL(
+        scheme=scheme, quoted_user=quoted_user,
+        port=None, quoted_password=None,
+        quoted_host=urlutils.quote(m.group('host')),
+        quoted_path=urlutils.quote(m.group('path')))
+    return str(url)
+
+
 def location_to_url(location, purpose=None):
     """Determine a fully qualified URL from a location string.
 
@@ -65,8 +89,8 @@
         location = location.encode('ascii')
     except UnicodeError:
         if urlutils.is_url(location):
-            raise urlutils.InvalidURL(path=location,
-                                      extra='URLs must be properly escaped')
+            raise urlutils.InvalidURL(
+                path=location, extra='URLs must be properly escaped')
         location = urlutils.local_path_to_url(location)
     else:
         if PY3:
@@ -75,6 +99,13 @@
     if location.startswith("file:") and not location.startswith("file://"):
         return urlutils.join(urlutils.local_path_to_url("."), location[5:])
 
+    try:
+        url = rcp_location_to_url(location, scheme="ssh")
+    except ValueError:
+        pass
+    else:
+        return url
+
     if not urlutils.is_url(location):
         return urlutils.local_path_to_url(location)
 
 
=== modified file 'breezy/tests/test_location.py'
--- breezy/tests/test_location.py	2019-02-09 02:59:15 +0000
+++ breezy/tests/test_location.py	2019-03-03 20:13:19 +0000
@@ -25,6 +25,7 @@
 from ..location import (
     hooks as location_hooks,
     location_to_url,
+    rcp_location_to_url,
     )
 
 
@@ -75,6 +76,11 @@
     def test_absolute_file_url(self):
         self.assertEqual("file:///bar", location_to_url("file:/bar"))
 
+    def test_rcp_url(self):
+        self.assertEqual(
+            "ssh://example.com/srv/git/bar",
+            location_to_url("example.com:/srv/git/bar"))
+
     def test_rewrite_hook(self):
         self.assertEqual(
             'http://foo.example.com/blah', location_to_url('http://foo.example.com/blah'))
@@ -84,3 +90,23 @@
         location_hooks.install_named_hook('rewrite_url', rewrite_url, 'test')
         self.assertEqual(
             'http://bar.example.com/bar', location_to_url('http://foo.example.com/foo'))
+
+
+class RCPLocationTests(tests.TestCase):
+
+    def test_without_user(self):
+        self.assertEqual(
+            "git+ssh://example.com/srv/git/bar",
+            rcp_location_to_url("example.com:/srv/git/bar", scheme='git+ssh'))
+        self.assertEqual(
+            "ssh://example.com/srv/git/bar",
+            rcp_location_to_url("example.com:/srv/git/bar"))
+
+    def test_with_user(self):
+        self.assertEqual(
+            "git+ssh://[e-mail]/srv/git/bar",
+            rcp_location_to_url("[e-mail]:/srv/git/bar", scheme='git+ssh'))
+
+    def test_invalid(self):
+        self.assertRaises(ValueError, rcp_location_to_url, "http://srv/git/bar")
+        self.assertRaises(ValueError, rcp_location_to_url, "git/bar")
 
=== modified file 'breezy/tests/test_transport.py'
--- breezy/tests/test_transport.py	2018-11-23 23:51:34 +0000
+++ breezy/tests/test_transport.py	2019-03-03 20:13:19 +0000
@@ -119,11 +119,13 @@
         try:
             transport.get_transport_from_url('ssh://fooserver/foo')
         except errors.UnsupportedProtocol as e:
-            self.assertEqual('Unsupported protocol'
-                             ' for url "ssh://fooserver/foo":'
-                             ' bzr supports bzr+ssh to operate over ssh,'
-                             ' use "bzr+ssh://fooserver/foo".',
-                             str(e))
+            self.assertEqual(
+                'Unsupported protocol'
+                ' for url "ssh://fooserver/foo":'
+                ' Use bzr+ssh for Bazaar operations over SSH, '
+                'e.g. "bzr+ssh://fooserver/foo". Use git+ssh '
+                'for Git operations over SSH, e.g. "git+ssh://fooserver/foo".',
+                str(e))
         else:
             self.fail('Did not raise UnsupportedProtocol')
 
 
=== modified file 'breezy/transport/remote.py'
--- breezy/transport/remote.py	2018-11-11 04:08:32 +0000
+++ breezy/transport/remote.py	2019-03-03 20:13:19 +0000
@@ -602,11 +602,15 @@
 
 
 class HintingSSHTransport(transport.Transport):
-    """Simple transport that handles ssh:// and points out bzr+ssh://."""
+    """Simple transport that handles ssh:// and points out bzr+ssh:// and git+ssh://."""
+
+    # TODO(jelmer): Implement support for detecting whether the repository at the
+    # other end is a git or bzr repository.
 
     def __init__(self, url):
-        raise errors.UnsupportedProtocol(url,
-                                         'bzr supports bzr+ssh to operate over ssh, use "bzr+%s".' % url)
+        raise errors.UnsupportedProtocol(
+            url, 'Use bzr+ssh for Bazaar operations over SSH, e.g. "bzr+%s". '
+            'Use git+ssh for Git operations over SSH, e.g. "git+%s".' % (url, url))
 
 
 def get_test_permutations():
 
=== modified file 'doc/en/release-notes/brz-3.0.txt'
--- doc/en/release-notes/brz-3.0.txt	2019-02-14 06:21:45 +0000
+++ doc/en/release-notes/brz-3.0.txt	2019-03-03 20:13:19 +0000
@@ -137,6 +137,10 @@
  * Plugins can now be registered using the 'entrypoints' mechanism in
    setuptools. (Jelmer Vernooij, #1802647)
 
+ * The Breezy UI now handles RCP-style URLs and suggests the
+   user specify either ``git+ssh`` or ``bzr+ssh``.
+   (Jelmer Vernooij)
+
 Improvements
 ************