Merge lp:~billy-olsen/charms/trusty/swift-proxy/public-endpoint-host into lp:~openstack-charmers-archive/charms/trusty/swift-proxy/next

[Billy Olsen]

Provides a config option which allows the user to specify the public hostname used to advertise to keystone when creating endpoints.

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #5043 swift-proxy-next for billy-olsen mp261005
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/5043/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #4723 swift-proxy-next for billy-olsen mp261005
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/4723/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #4449 swift-proxy-next for billy-olsen mp261005
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/4449/

[lp:~billy-olsen/charms/trusty/swift-proxy/public-endpoint-host]

99. By Billy Olsen on 2015-06-04

c-h sync

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #5074 swift-proxy-next for billy-olsen mp261005
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/5074/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #4753 swift-proxy-next for billy-olsen mp261005
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/4753/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #4481 swift-proxy-next for billy-olsen mp261005
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/4481/

[Corey Bryant (corey.bryant)]

Looks good! Mind adding a unit test?

[lp:~billy-olsen/charms/trusty/swift-proxy/public-endpoint-host]

100. By Billy Olsen on 2015-06-11

Add unit test for public hostname.

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #5344 swift-proxy-next for billy-olsen mp261005
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/5344/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #4976 swift-proxy-next for billy-olsen mp261005
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/4976/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #4585 swift-proxy-next for billy-olsen mp261005
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/4585/

[Corey Bryant (corey.bryant)]

review: Approve

=== modified file 'config.yaml'
--- config.yaml	2015-04-20 11:19:04 +0000
+++ config.yaml	2015-06-11 23:23:30 +0000
@@ -207,6 +207,18 @@
       192.168.0.0/24)
       .
       This network will be used for public endpoints.
+  os-public-hostname:
+    type: string
+    default:
+    description: |
+      The hostname or address of the public endpoints created for swift-proxy
+      in the keystone identity provider.
+      .
+      This value will be used for public endpoints. For example, an
+      os-public-hostname set to 'files.example.com' with will create
+      the following public endpoint for the swift-proxy:
+      .
+      https://files.example.com:80/swift/v1
   prefer-ipv6:
     type: boolean
     default: False

=== modified file 'hooks/charmhelpers/contrib/hahelpers/cluster.py'
=== modified file 'hooks/charmhelpers/contrib/openstack/ip.py'
--- hooks/charmhelpers/contrib/openstack/ip.py	2015-03-13 13:02:08 +0000
+++ hooks/charmhelpers/contrib/openstack/ip.py	2015-06-11 23:23:30 +0000
@@ -17,6 +17,7 @@
 from charmhelpers.core.hookenv import (
     config,
     unit_get,
+    service_name,
 )
 from charmhelpers.contrib.network.ip import (
     get_address_in_network,
@@ -26,8 +27,6 @@
 )
 from charmhelpers.contrib.hahelpers.cluster import is_clustered
 
-from functools import partial
-
 PUBLIC = 'public'
 INTERNAL = 'int'
 ADMIN = 'admin'
@@ -35,15 +34,18 @@
 ADDRESS_MAP = {
     PUBLIC: {
         'config': 'os-public-network',
-        'fallback': 'public-address'
+        'fallback': 'public-address',
+        'override': 'os-public-hostname',
     },
     INTERNAL: {
         'config': 'os-internal-network',
-        'fallback': 'private-address'
+        'fallback': 'private-address',
+        'override': 'os-internal-hostname',
     },
     ADMIN: {
         'config': 'os-admin-network',
-        'fallback': 'private-address'
+        'fallback': 'private-address',
+        'override': 'os-admin-hostname',
     }
 }
 
@@ -57,15 +59,50 @@
     :param endpoint_type: str endpoint type to resolve.
     :param returns: str base URL for services on the current service unit.
     """
-    scheme = 'http'
-    if 'https' in configs.complete_contexts():
-        scheme = 'https'
+    scheme = _get_scheme(configs)
+
     address = resolve_address(endpoint_type)
     if is_ipv6(address):
         address = "[{}]".format(address)
+
     return '%s://%s' % (scheme, address)
 
 
+def _get_scheme(configs):
+    """Returns the scheme to use for the url (either http or https)
+    depending upon whether https is in the configs value.
+
+    :param configs: OSTemplateRenderer config templating object to inspect
+                    for a complete https context.
+    :returns: either 'http' or 'https' depending on whether https is
+              configured within the configs context.
+    """
+    scheme = 'http'
+    if configs and 'https' in configs.complete_contexts():
+        scheme = 'https'
+    return scheme
+
+
+def _get_address_override(endpoint_type=PUBLIC):
+    """Returns any address overrides that the user has defined based on the
+    endpoint type.
+
+    Note: this function allows for the service name to be inserted into the
+    address if the user specifies {service_name}.somehost.org.
+
+    :param endpoint_type: the type of endpoint to retrieve the override
+                          value for.
+    :returns: any endpoint address or hostname that the user has overridden
+              or None if an override is not present.
+    """
+    override_key = ADDRESS_MAP[endpoint_type]['override']
+    addr_override = config(override_key)
+    if not addr_override:
+        return None
+    else:
+        return addr_override.format(service_name=service_name())
+
+
 def resolve_address(endpoint_type=PUBLIC):
     """Return unit address depending on net config.
 
@@ -77,7 +114,10 @@
 
     :param endpoint_type: Network endpoing type
     """
-    resolved_address = None
+    resolved_address = _get_address_override(endpoint_type)
+    if resolved_address:
+        return resolved_address
+
     vips = config('vip')
     if vips:
         vips = vips.split()
@@ -109,38 +149,3 @@
                          "clustered=%s)" % (net_type, clustered))
 
     return resolved_address
-
-
-def endpoint_url(configs, url_template, port, endpoint_type=PUBLIC,
-                 override=None):
-    """Returns the correct endpoint URL to advertise to Keystone.
-
-    This method provides the correct endpoint URL which should be advertised to
-    the keystone charm for endpoint creation. This method allows for the url to
-    be overridden to force a keystone endpoint to have specific URL for any of
-    the defined scopes (admin, internal, public).
-
-    :param configs: OSTemplateRenderer config templating object to inspect
-                    for a complete https context.
-    :param url_template: str format string for creating the url template. Only
-                         two values will be passed - the scheme+hostname
-                        returned by the canonical_url and the port.
-    :param endpoint_type: str endpoint type to resolve.
-    :param override: str the name of the config option which overrides the
-                     endpoint URL defined by the charm itself. None will
-                     disable any overrides (default).
-    """
-    if override:
-        # Return any user-defined overrides for the keystone endpoint URL.
-        user_value = config(override)
-        if user_value:
-            return user_value.strip()
-
-    return url_template % (canonical_url(configs, endpoint_type), port)
-
-
-public_endpoint = partial(endpoint_url, endpoint_type=PUBLIC)
-
-internal_endpoint = partial(endpoint_url, endpoint_type=INTERNAL)
-
-admin_endpoint = partial(endpoint_url, endpoint_type=ADMIN)

=== modified file 'hooks/charmhelpers/contrib/peerstorage/__init__.py'
=== modified file 'unit_tests/test_swift_hooks.py'
--- unit_tests/test_swift_hooks.py	2014-12-05 13:21:52 +0000
+++ unit_tests/test_swift_hooks.py	2015-06-11 23:23:30 +0000
@@ -1,16 +1,16 @@
-import mock
+from mock import patch
 import unittest
 import uuid
 
 
-with mock.patch('charmhelpers.core.hookenv.log'):
+with patch('charmhelpers.core.hookenv.log'):
     import swift_hooks
 
 
 class SwiftHooksTestCase(unittest.TestCase):
 
-    @mock.patch("swift_hooks.relation_get")
-    @mock.patch("swift_hooks.local_unit")
+    @patch("swift_hooks.relation_get")
+    @patch("swift_hooks.local_unit")
     def test_all_peers_stopped(self, mock_local_unit, mock_relation_get):
         token1 = str(uuid.uuid4())
         token2 = str(uuid.uuid4())
@@ -37,3 +37,93 @@
         responses = [{'stop-proxy-service-ack': token1},
                      {'stop-proxy-service-ack': token1}]
         self.assertFalse(swift_hooks.all_peers_stopped(responses))
+
+    @patch.object(swift_hooks, 'config')
+    @patch('charmhelpers.contrib.openstack.ip.config')
+    @patch.object(swift_hooks, 'CONFIGS')
+    @patch('charmhelpers.core.hookenv.local_unit')
+    @patch('charmhelpers.core.hookenv.service_name')
+    @patch('charmhelpers.contrib.openstack.ip.unit_get')
+    @patch('charmhelpers.contrib.openstack.ip.is_clustered')
+    @patch.object(swift_hooks, 'relation_set')
+    def test_keystone_joined(self, _relation_set, _is_clustered, _unit_get,
+                             _service_name, _local_unit, _CONFIGS, _ip_config,
+                             _config):
+        config_dict = {
+            'bind-port': '1234',
+            'region': 'RegionOne',
+            'operator-roles': 'Operator,Monitor'
+        }
+
+        def foo(key=None):
+            if key is None:
+                return config_dict
+            else:
+                return config_dict.get(key)
+
+        _config.side_effect = foo
+        _ip_config.side_effect = foo
+        _unit_get.return_value = 'swift-proxy'
+        _local_unit.return_value = 'swift-proxy/0'
+        _service_name.return_value = 'swift-proxy'
+        _is_clustered.return_value = False
+
+        swift_hooks.keystone_joined()
+
+        _relation_set.assert_called_with(
+            service='swift',
+            region='RegionOne',
+            public_url='http://swift-proxy:1234/v1/AUTH_$(tenant_id)s',
+            internal_url='http://swift-proxy:1234/v1/AUTH_$(tenant_id)s',
+            admin_url='http://swift-proxy:1234',
+            requested_roles='Operator,Monitor',
+            relation_id=None
+        )
+
+    @patch.object(swift_hooks, 'config')
+    @patch('charmhelpers.contrib.openstack.ip.config')
+    @patch.object(swift_hooks, 'CONFIGS')
+    @patch('charmhelpers.core.hookenv.local_unit')
+    @patch('charmhelpers.core.hookenv.service_name')
+    @patch('charmhelpers.contrib.openstack.ip.unit_get')
+    @patch('charmhelpers.contrib.openstack.ip.is_clustered')
+    @patch.object(swift_hooks, 'relation_set')
+    def test_keystone_joined_public_hostname(self,
+                                             _relation_set,
+                                             _is_clustered,
+                                             _unit_get,
+                                             _service_name,
+                                             _local_unit,
+                                             _CONFIGS,
+                                             _ip_config,
+                                             _config):
+        config_dict = {
+            'bind-port': '1234',
+            'region': 'RegionOne',
+            'operator-roles': 'Operator,Monitor',
+            'os-public-hostname': 'public.example.com'
+        }
+
+        def foo(key=None):
+            if key is None:
+                return config_dict
+            else:
+                return config_dict.get(key)
+
+        _config.side_effect = _ip_config.side_effect = foo
+        _unit_get.return_value = _service_name.return_value = 'swift-proxy'
+        _local_unit.return_value = 'swift-proxy/0'
+        _is_clustered.return_value = False
+
+        swift_hooks.keystone_joined()
+
+        _relation_set.assert_called_with(
+            service='swift',
+            region='RegionOne',
+            public_url=('http://public.example.com:1234/'
+                        'v1/AUTH_$(tenant_id)s'),
+            internal_url='http://swift-proxy:1234/v1/AUTH_$(tenant_id)s',
+            admin_url='http://swift-proxy:1234',
+            requested_roles='Operator,Monitor',
+            relation_id=None
+        )