Merge lp:~jtv/maas/extract-compose_URL into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Extract provisioningserver.utils.compose_URL into its own sub-module, provisioningserver.utils.url, to make room for another URL-related helper that I'm about to add.

There are no substantial changes here, beyond moving code and changing some imports. The imports changes did affect some patch calls in tests, but nothing dramatic.

Jeroen

[Graham Binns (gmb)]

Easy karma indeed.

review: Approve

=== modified file 'src/maas/development.py'
--- src/maas/development.py	2014-10-08 11:01:44 +0000
+++ src/maas/development.py	2014-11-07 13:40:43 +0000
@@ -25,7 +25,7 @@
 from maas.customise_test_db import patch_db_creation
 from metadataserver.address import guess_server_host
 import provisioningserver.config
-from provisioningserver.utils import compose_URL
+from provisioningserver.utils.url import compose_URL
 from psycopg2.extensions import ISOLATION_LEVEL_READ_COMMITTED
 
 # We expect the following settings to be overridden. They are mentioned here

=== modified file 'src/maas/settings.py'
--- src/maas/settings.py	2014-10-30 18:24:50 +0000
+++ src/maas/settings.py	2014-11-07 13:40:43 +0000
@@ -25,7 +25,7 @@
     )
 from maas.monkey import patch_get_script_prefix
 from metadataserver.address import guess_server_host
-from provisioningserver.utils import compose_URL
+from provisioningserver.utils.url import compose_URL
 from psycopg2.extensions import ISOLATION_LEVEL_READ_COMMITTED
 
 

=== modified file 'src/maasserver/preseed.py'
--- src/maasserver/preseed.py	2014-10-02 05:07:20 +0000
+++ src/maasserver/preseed.py	2014-11-07 13:40:43 +0000
@@ -61,11 +61,9 @@
 from metadataserver.user_data.snippets import get_snippet_context
 from netaddr import IPAddress
 from provisioningserver.rpc.exceptions import NoConnectionsAvailable
-from provisioningserver.utils import (
-    compose_URL,
-    locate_config,
-    )
+from provisioningserver.utils import locate_config
 from provisioningserver.utils.fs import read_text_file
+from provisioningserver.utils.url import compose_URL
 import tempita
 import yaml
 

=== modified file 'src/maasserver/tests/test_dhcp.py'
--- src/maasserver/tests/test_dhcp.py	2014-09-19 03:12:47 +0000
+++ src/maasserver/tests/test_dhcp.py	2014-11-07 13:40:43 +0000
@@ -55,7 +55,7 @@
     ConfigureDHCPv6,
     )
 from provisioningserver.rpc.testing import always_succeed_with
-from provisioningserver.utils import compose_URL
+from provisioningserver.utils.url import compose_URL
 from testtools.matchers import (
     AllMatch,
     ContainsAll,

=== modified file 'src/provisioningserver/drivers/hardware/seamicro.py'
--- src/provisioningserver/drivers/hardware/seamicro.py	2014-09-10 16:20:31 +0000
+++ src/provisioningserver/drivers/hardware/seamicro.py	2014-11-07 13:40:43 +0000
@@ -23,7 +23,8 @@
 import urlparse
 
 from provisioningserver.logger import get_maas_logger
-import provisioningserver.utils as utils
+from provisioningserver.utils import create_node
+from provisioningserver.utils.url import compose_URL
 from seamicroclient import exceptions as seamicro_exceptions
 from seamicroclient.v2 import client as seamicro_client
 
@@ -202,7 +203,7 @@
     :returns: api for version, None if version not supported
     """
     if version == 'v0.9':
-        api = SeaMicroAPIV09(utils.compose_URL('http:///v0.9/', ip))
+        api = SeaMicroAPIV09(compose_URL('http:///v0.9/', ip))
         try:
             api.login(username, password)
         except urllib2.URLError:
@@ -210,7 +211,7 @@
             return None
         return api
     elif version == 'v2.0':
-        url = utils.compose_URL('http:///v2.0', ip)
+        url = compose_URL('http:///v2.0', ip)
         try:
             api = seamicro_client.Client(
                 auth_url=url, username=username, password=password)
@@ -288,13 +289,13 @@
         maaslog.info(
             "Found seamicro15k node with macs %s; adding to MAAS with "
             "params : %s", macs, params)
-        utils.create_node(macs, 'amd64', 'sm15k', params)
+        create_node(macs, 'amd64', 'sm15k', params)
 
 
 def power_control_seamicro15k_v09(ip, username, password, server_id,
                                   power_change, retry_count=5, retry_wait=1):
     server_id = '%s/0' % server_id
-    api = SeaMicroAPIV09(utils.compose_URL('http:///v0.9/', ip))
+    api = SeaMicroAPIV09(compose_URL('http:///v0.9/', ip))
 
     while retry_count > 0:
         api.login(username, password)

=== modified file 'src/provisioningserver/drivers/hardware/tests/test_seamicro.py'
--- src/provisioningserver/drivers/hardware/tests/test_seamicro.py	2014-09-18 12:44:38 +0000
+++ src/provisioningserver/drivers/hardware/tests/test_seamicro.py	2014-11-07 13:40:43 +0000
@@ -41,7 +41,6 @@
     SeaMicroError,
     select_seamicro15k_api_version,
     )
-import provisioningserver.utils as utils
 
 
 class FakeResponse:
@@ -334,9 +333,7 @@
         self.patch(
             SeaMicroAPIV09, 'get',
             Mock(return_value=result))
-        mock_create_node = self.patch(
-            utils,
-            'create_node')
+        mock_create_node = self.patch(seamicro, 'create_node')
 
         probe_seamicro15k_and_enlist(
             ip, username, password, power_control='restapi')
@@ -418,9 +415,7 @@
             seamicro,
             'get_seamicro15k_api')
         mock_get_api.return_value = fake_client
-        mock_create_node = self.patch(
-            utils,
-            'create_node')
+        mock_create_node = self.patch(seamicro, 'create_node')
 
         probe_seamicro15k_and_enlist(
             ip, username, password, power_control='restapi2')

=== modified file 'src/provisioningserver/utils/__init__.py'
--- src/provisioningserver/utils/__init__.py	2014-09-16 11:43:25 +0000
+++ src/provisioningserver/utils/__init__.py	2014-11-07 13:40:43 +0000
@@ -13,7 +13,6 @@
 
 __metaclass__ = type
 __all__ = [
-    "compose_URL",
     "create_node",
     "filter_dict",
     "flatten",
@@ -36,11 +35,6 @@
 import re
 import sys
 from sys import _getframe as getframe
-import urllib
-from urlparse import (
-    urlparse,
-    urlunparse,
-    )
 from warnings import warn
 
 import bson
@@ -381,33 +375,6 @@
     return matched, other
 
 
-def compose_URL(base_url, host):
-    """Produce a URL on a given hostname or IP address.
-
-    This is straightforward if the IP address is a hostname or an IPv4
-    address; but if it's an IPv6 address, the URL must contain the IP address
-    in square brackets as per RFC 3986.
-
-    :param base_url: URL without the host part, e.g. `http:///path'.
-    :param host: Host name or IP address to insert in the host part of the URL.
-    :return: A URL string with the host part taken from `host`, and all others
-        from `base_url`.
-    """
-    if re.match('[:.0-9a-fA-F]+(?:%.+)?$', host) and host.count(':') > 0:
-        # IPv6 address, without the brackets.  Add square brackets.
-        # In case there's a zone index (introduced by a % sign), escape it.
-        netloc_host = '[%s]' % urllib.quote(host, safe=':')
-    else:
-        # IPv4 address, hostname, or IPv6 with brackets.  Keep as-is.
-        netloc_host = host
-    parsed_url = urlparse(base_url)
-    if parsed_url.port is None:
-        netloc = netloc_host
-    else:
-        netloc = '%s:%d' % (netloc_host, parsed_url.port)
-    return urlunparse(parsed_url._replace(netloc=netloc))
-
-
 def warn_deprecated(alternative=None):
     """Issue a `DeprecationWarning` for the calling function.
 

=== added file 'src/provisioningserver/utils/tests/test_url.py'
--- src/provisioningserver/utils/tests/test_url.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/tests/test_url.py	2014-11-07 13:40:43 +0000
@@ -0,0 +1,107 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Test utilities for URL handling."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = []
+
+from random import randint
+
+from maastesting.factory import factory
+from maastesting.testcase import MAASTestCase
+from provisioningserver.utils.url import compose_URL
+
+
+class TestComposeURL(MAASTestCase):
+
+    def make_path(self):
+        """Return an arbitrary URL path part."""
+        return '%s/%s' % (factory.make_name('root'), factory.make_name('sub'))
+
+    def make_network_interface(self):
+        return 'eth%d' % randint(0, 100)
+
+    def test__inserts_IPv4(self):
+        ip = factory.make_ipv4_address()
+        path = self.make_path()
+        self.assertEqual(
+            'http://%s/%s' % (ip, path),
+            compose_URL('http:///%s' % path, ip))
+
+    def test__inserts_IPv6_with_brackets(self):
+        ip = factory.make_ipv6_address()
+        path = self.make_path()
+        self.assertEqual(
+            'http://[%s]/%s' % (ip, path),
+            compose_URL('http:///%s' % path, ip))
+
+    def test__escapes_IPv6_zone_index(self):
+        ip = factory.make_ipv6_address()
+        zone = self.make_network_interface()
+        hostname = '%s%%%s' % (ip, zone)
+        path = self.make_path()
+        self.assertEqual(
+            'http://[%s%%25%s]/%s' % (ip, zone, path),
+            compose_URL('http:///%s' % path, hostname))
+
+    def test__inserts_bracketed_IPv6_unchanged(self):
+        ip = factory.make_ipv6_address()
+        hostname = '[%s]' % ip
+        path = self.make_path()
+        self.assertEqual(
+            'http://%s/%s' % (hostname, path),
+            compose_URL('http:///%s' % path, hostname))
+
+    def test__does_not_escape_bracketed_IPv6_zone_index(self):
+        ip = factory.make_ipv6_address()
+        zone = self.make_network_interface()
+        path = self.make_path()
+        hostname = '[%s%%25%s]' % (ip, zone)
+        self.assertEqual(
+            'http://%s/%s' % (hostname, path),
+            compose_URL('http:///%s' % path, hostname))
+
+    def test__inserts_hostname(self):
+        hostname = factory.make_name('host')
+        path = self.make_path()
+        self.assertEqual(
+            'http://%s/%s' % (hostname, path),
+            compose_URL('http:///%s' % path, hostname))
+
+    def test__preserves_query(self):
+        ip = factory.make_ipv4_address()
+        key = factory.make_name('key')
+        value = factory.make_name('value')
+        self.assertEqual(
+            'https://%s?%s=%s' % (ip, key, value),
+            compose_URL('https://?%s=%s' % (key, value), ip))
+
+    def test__preserves_port_with_IPv4(self):
+        ip = factory.make_ipv4_address()
+        port = factory.pick_port()
+        self.assertEqual(
+            'https://%s:%s/' % (ip, port),
+            compose_URL('https://:%s/' % port, ip))
+
+    def test__preserves_port_with_IPv6(self):
+        ip = factory.make_ipv6_address()
+        port = factory.pick_port()
+        self.assertEqual(
+            'https://[%s]:%s/' % (ip, port),
+            compose_URL('https://:%s/' % port, ip))
+
+    def test__preserves_port_with_hostname(self):
+        hostname = factory.make_name('host')
+        port = factory.pick_port()
+        self.assertEqual(
+            'https://%s:%s/' % (hostname, port),
+            compose_URL('https://:%s/' % port, hostname))

=== modified file 'src/provisioningserver/utils/tests/test_utils.py'
--- src/provisioningserver/utils/tests/test_utils.py	2014-09-18 12:44:38 +0000
+++ src/provisioningserver/utils/tests/test_utils.py	2014-11-07 13:40:43 +0000
@@ -18,10 +18,7 @@
 from cStringIO import StringIO
 import json
 import os
-from random import (
-    choice,
-    randint,
-    )
+from random import choice
 from textwrap import dedent
 
 from fixtures import EnvironmentVariableFixture
@@ -44,7 +41,6 @@
 import provisioningserver.utils
 from provisioningserver.utils import (
     classify,
-    compose_URL,
     create_node,
     escape_py_literal,
     filter_dict,
@@ -544,92 +540,6 @@
                 "exists.", macs))
 
 
-class TestComposeURL(MAASTestCase):
-
-    def make_path(self):
-        """Return an arbitrary URL path part."""
-        return '%s/%s' % (factory.make_name('root'), factory.make_name('sub'))
-
-    def make_network_interface(self):
-        return 'eth%d' % randint(0, 100)
-
-    def test__inserts_IPv4(self):
-        ip = factory.make_ipv4_address()
-        path = self.make_path()
-        self.assertEqual(
-            'http://%s/%s' % (ip, path),
-            compose_URL('http:///%s' % path, ip))
-
-    def test__inserts_IPv6_with_brackets(self):
-        ip = factory.make_ipv6_address()
-        path = self.make_path()
-        self.assertEqual(
-            'http://[%s]/%s' % (ip, path),
-            compose_URL('http:///%s' % path, ip))
-
-    def test__escapes_IPv6_zone_index(self):
-        ip = factory.make_ipv6_address()
-        zone = self.make_network_interface()
-        hostname = '%s%%%s' % (ip, zone)
-        path = self.make_path()
-        self.assertEqual(
-            'http://[%s%%25%s]/%s' % (ip, zone, path),
-            compose_URL('http:///%s' % path, hostname))
-
-    def test__inserts_bracketed_IPv6_unchanged(self):
-        ip = factory.make_ipv6_address()
-        hostname = '[%s]' % ip
-        path = self.make_path()
-        self.assertEqual(
-            'http://%s/%s' % (hostname, path),
-            compose_URL('http:///%s' % path, hostname))
-
-    def test__does_not_escape_bracketed_IPv6_zone_index(self):
-        ip = factory.make_ipv6_address()
-        zone = self.make_network_interface()
-        path = self.make_path()
-        hostname = '[%s%%25%s]' % (ip, zone)
-        self.assertEqual(
-            'http://%s/%s' % (hostname, path),
-            compose_URL('http:///%s' % path, hostname))
-
-    def test__inserts_hostname(self):
-        hostname = factory.make_name('host')
-        path = self.make_path()
-        self.assertEqual(
-            'http://%s/%s' % (hostname, path),
-            compose_URL('http:///%s' % path, hostname))
-
-    def test__preserves_query(self):
-        ip = factory.make_ipv4_address()
-        key = factory.make_name('key')
-        value = factory.make_name('value')
-        self.assertEqual(
-            'https://%s?%s=%s' % (ip, key, value),
-            compose_URL('https://?%s=%s' % (key, value), ip))
-
-    def test__preserves_port_with_IPv4(self):
-        ip = factory.make_ipv4_address()
-        port = factory.pick_port()
-        self.assertEqual(
-            'https://%s:%s/' % (ip, port),
-            compose_URL('https://:%s/' % port, ip))
-
-    def test__preserves_port_with_IPv6(self):
-        ip = factory.make_ipv6_address()
-        port = factory.pick_port()
-        self.assertEqual(
-            'https://[%s]:%s/' % (ip, port),
-            compose_URL('https://:%s/' % port, ip))
-
-    def test__preserves_port_with_hostname(self):
-        hostname = factory.make_name('host')
-        port = factory.pick_port()
-        self.assertEqual(
-            'https://%s:%s/' % (hostname, port),
-            compose_URL('https://:%s/' % port, hostname))
-
-
 class TestGetClusterConfig(MAASTestCase):
     scenarios = [
         ('Variable with quoted value', dict(

=== added file 'src/provisioningserver/utils/url.py'
--- src/provisioningserver/utils/url.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/url.py	2014-11-07 13:40:43 +0000
@@ -0,0 +1,51 @@
+# Copyright 2014 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Utilities for URL handling."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    'compose_URL',
+    ]
+
+import re
+import urllib
+from urlparse import (
+    urlparse,
+    urlunparse,
+    )
+
+
+def compose_URL(base_url, host):
+    """Produce a URL on a given hostname or IP address.
+
+    This is straightforward if the IP address is a hostname or an IPv4
+    address; but if it's an IPv6 address, the URL must contain the IP address
+    in square brackets as per RFC 3986.
+
+    :param base_url: URL without the host part, e.g. `http:///path'.
+    :param host: Host name or IP address to insert in the host part of the URL.
+    :return: A URL string with the host part taken from `host`, and all others
+        from `base_url`.
+    """
+    if re.match('[:.0-9a-fA-F]+(?:%.+)?$', host) and host.count(':') > 0:
+        # IPv6 address, without the brackets.  Add square brackets.
+        # In case there's a zone index (introduced by a % sign), escape it.
+        netloc_host = '[%s]' % urllib.quote(host, safe=':')
+    else:
+        # IPv4 address, hostname, or IPv6 with brackets.  Keep as-is.
+        netloc_host = host
+    parsed_url = urlparse(base_url)
+    if parsed_url.port is None:
+        netloc = netloc_host
+    else:
+        netloc = '%s:%d' % (netloc_host, parsed_url.port)
+    return urlunparse(parsed_url._replace(netloc=netloc))