Merge lp:~jelmer/brz/location into lp:brz

[Jelmer Vernooij]

Move location_to_url to its own module.

Move location_to_url to its own module.

[Martin Packman (gz)]

Yes, this makes sense, especially if we want to try using a fancier type here later.

review: Approve

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

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

=== modified file 'breezy/builtins.py'
--- breezy/builtins.py	2018-11-21 03:20:30 +0000
+++ breezy/builtins.py	2018-12-10 01:47:19 +0000
@@ -5625,12 +5625,12 @@
 
     def run(self, listen=None, port=None, inet=False, directory=None,
             allow_writes=False, protocol=None, client_timeout=None):
-        from . import transport
+        from . import location, transport
         if directory is None:
             directory = osutils.getcwd()
         if protocol is None:
             protocol = transport.transport_server_registry.get()
-        url = transport.location_to_url(directory)
+        url = location.location_to_url(directory)
         if not allow_writes:
             url = 'readonly+' + url
         t = transport.get_transport_from_url(url)

=== added file 'breezy/location.py'
--- breezy/location.py	1970-01-01 00:00:00 +0000
+++ breezy/location.py	2018-12-10 01:47:19 +0000
@@ -0,0 +1,64 @@
+# Copyright (C) 2006-2010 Canonical Ltd
+# Copyright (C) 2018 Breezy Developers
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""UI location string handling."""
+
+from __future__ import absolute_import
+
+from . import (
+    urlutils,
+    )
+from .sixish import (
+    PY3,
+    string_types,
+    )
+
+
+def location_to_url(location):
+    """Determine a fully qualified URL from a location string.
+
+    This will try to interpret location as both a URL and a directory path. It
+    will also lookup the location in directories.
+
+    :param location: Unicode or byte string object with a location
+    :raise InvalidURL: If the location is already a URL, but not valid.
+    :return: Byte string with resulting URL
+    """
+    if not isinstance(location, string_types):
+        raise AssertionError("location not a byte or unicode string")
+    from .directory_service import directories
+    location = directories.dereference(location)
+
+    # Catch any URLs which are passing Unicode rather than ASCII
+    try:
+        location = location.encode('ascii')
+    except UnicodeError:
+        if urlutils.is_url(location):
+            raise urlutils.InvalidURL(path=location,
+                                      extra='URLs must be properly escaped')
+        location = urlutils.local_path_to_url(location)
+    else:
+        if PY3:
+            location = location.decode('ascii')
+
+    if location.startswith("file:") and not location.startswith("file://"):
+        return urlutils.join(urlutils.local_path_to_url("."), location[5:])
+
+    if not urlutils.is_url(location):
+        return urlutils.local_path_to_url(location)
+
+    return location

=== modified file 'breezy/tests/__init__.py'
--- breezy/tests/__init__.py	2018-11-17 16:53:10 +0000
+++ breezy/tests/__init__.py	2018-12-10 01:47:19 +0000
@@ -4127,6 +4127,7 @@
         'breezy.tests.test_lazy_import',
         'breezy.tests.test_lazy_regex',
         'breezy.tests.test_library_state',
+        'breezy.tests.test_location',
         'breezy.tests.test_lock',
         'breezy.tests.test_lockable_files',
         'breezy.tests.test_lockdir',

=== added file 'breezy/tests/test_location.py'
--- breezy/tests/test_location.py	1970-01-01 00:00:00 +0000
+++ breezy/tests/test_location.py	2018-12-10 01:47:19 +0000
@@ -0,0 +1,75 @@
+# Copyright (C) 2005-2011, 2015, 2016 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""Tests for breezy.location."""
+
+from .. import (
+    osutils,
+    tests,
+    urlutils,
+    )
+from ..directory_service import directories
+from ..location import (
+    location_to_url,
+    )
+
+
+class SomeDirectory(object):
+
+    def look_up(self, name, url):
+        return "http://bar"
+
+
+class TestLocationToUrl(tests.TestCase):
+
+    def get_base_location(self):
+        path = osutils.abspath('/foo/bar')
+        if path.startswith('/'):
+            url = 'file://%s' % (path,)
+        else:
+            # On Windows, abspaths start with the drive letter, so we have to
+            # add in the extra '/'
+            url = 'file:///%s' % (path,)
+        return path, url
+
+    def test_regular_url(self):
+        self.assertEqual("file://foo", location_to_url("file://foo"))
+
+    def test_directory(self):
+        directories.register("bar:", SomeDirectory, "Dummy directory")
+        self.addCleanup(directories.remove, "bar:")
+        self.assertEqual("http://bar", location_to_url("bar:"))
+
+    def test_unicode_url(self):
+        self.assertRaises(urlutils.InvalidURL, location_to_url,
+                          b"http://fo/\xc3\xaf".decode("utf-8"))
+
+    def test_unicode_path(self):
+        path, url = self.get_base_location()
+        location = path + b"\xc3\xaf".decode("utf-8")
+        url += '%C3%AF'
+        self.assertEqual(url, location_to_url(location))
+
+    def test_path(self):
+        path, url = self.get_base_location()
+        self.assertEqual(url, location_to_url(path))
+
+    def test_relative_file_url(self):
+        self.assertEqual(urlutils.local_path_to_url(".") + "/bar",
+                         location_to_url("file:bar"))
+
+    def test_absolute_file_url(self):
+        self.assertEqual("file:///bar", location_to_url("file:/bar"))

=== modified file 'breezy/tests/test_transport.py'
--- breezy/tests/test_transport.py	2018-11-12 01:41:38 +0000
+++ breezy/tests/test_transport.py	2018-12-10 01:47:19 +0000
@@ -28,7 +28,6 @@
     transport,
     urlutils,
     )
-from ..directory_service import directories
 from ..sixish import (
     BytesIO,
     )
@@ -37,7 +36,6 @@
     fakenfs,
     http,
     local,
-    location_to_url,
     memory,
     pathfilter,
     readonly,
@@ -1107,51 +1105,3 @@
         result = http.unhtml_roughly(fake_html)
         self.assertEqual(len(result), 1000)
         self.assertStartsWith(result, " something!")
-
-
-class SomeDirectory(object):
-
-    def look_up(self, name, url):
-        return "http://bar"
-
-
-class TestLocationToUrl(tests.TestCase):
-
-    def get_base_location(self):
-        path = osutils.abspath('/foo/bar')
-        if path.startswith('/'):
-            url = 'file://%s' % (path,)
-        else:
-            # On Windows, abspaths start with the drive letter, so we have to
-            # add in the extra '/'
-            url = 'file:///%s' % (path,)
-        return path, url
-
-    def test_regular_url(self):
-        self.assertEqual("file://foo", location_to_url("file://foo"))
-
-    def test_directory(self):
-        directories.register("bar:", SomeDirectory, "Dummy directory")
-        self.addCleanup(directories.remove, "bar:")
-        self.assertEqual("http://bar", location_to_url("bar:"))
-
-    def test_unicode_url(self):
-        self.assertRaises(urlutils.InvalidURL, location_to_url,
-                          b"http://fo/\xc3\xaf".decode("utf-8"))
-
-    def test_unicode_path(self):
-        path, url = self.get_base_location()
-        location = path + b"\xc3\xaf".decode("utf-8")
-        url += '%C3%AF'
-        self.assertEqual(url, location_to_url(location))
-
-    def test_path(self):
-        path, url = self.get_base_location()
-        self.assertEqual(url, location_to_url(path))
-
-    def test_relative_file_url(self):
-        self.assertEqual(urlutils.local_path_to_url(".") + "/bar",
-                         location_to_url("file:bar"))
-
-    def test_absolute_file_url(self):
-        self.assertEqual("file:///bar", location_to_url("file:/bar"))

=== modified file 'breezy/transport/__init__.py'
--- breezy/transport/__init__.py	2018-11-18 19:48:57 +0000
+++ breezy/transport/__init__.py	2018-12-10 01:47:19 +0000
@@ -37,6 +37,7 @@
 
 from breezy import (
     errors,
+    location as _mod_location,
     osutils,
     ui,
     urlutils,
@@ -1507,42 +1508,6 @@
         raise NotImplementedError(self.disconnect)
 
 
-def location_to_url(location):
-    """Determine a fully qualified URL from a location string.
-
-    This will try to interpret location as both a URL and a directory path. It
-    will also lookup the location in directories.
-
-    :param location: Unicode or byte string object with a location
-    :raise InvalidURL: If the location is already a URL, but not valid.
-    :return: Byte string with resulting URL
-    """
-    if not isinstance(location, string_types):
-        raise AssertionError("location not a byte or unicode string")
-    from breezy.directory_service import directories
-    location = directories.dereference(location)
-
-    # Catch any URLs which are passing Unicode rather than ASCII
-    try:
-        location = location.encode('ascii')
-    except UnicodeError:
-        if urlutils.is_url(location):
-            raise urlutils.InvalidURL(path=location,
-                                      extra='URLs must be properly escaped')
-        location = urlutils.local_path_to_url(location)
-    else:
-        if PY3:
-            location = location.decode('ascii')
-
-    if location.startswith("file:") and not location.startswith("file://"):
-        return urlutils.join(urlutils.local_path_to_url("."), location[5:])
-
-    if not urlutils.is_url(location):
-        return urlutils.local_path_to_url(location)
-
-    return location
-
-
 def get_transport_from_path(path, possible_transports=None):
     """Open a transport for a local path.
 
@@ -1601,7 +1566,8 @@
     """
     if base is None:
         base = '.'
-    return get_transport_from_url(location_to_url(base), possible_transports)
+    return get_transport_from_url(
+        _mod_location.location_to_url(base), possible_transports)
 
 
 def _try_transport_factories(base, factory_list):