Introduce public_url, internal_url and admin_url

This change deprecates the following parameters:
- port (replaced by public/internal/admin_url)
- public_protocol (replaced by public_url)
- public_address (replaced by public_url)
- internal_protocol (replaced by internal_url)
- internal_address (replaced by internal_url)
- admin_protocol (replaced by admin_url)
- admin_address (replaced by admin_url)

Add deprecation warnings if any of those values are provided
while maintaining full backward compatibility.

Closes-bug: #1274979
Change-Id: Iac152347534874f8763d8df4f81d1568d3c5e222

manifests/keystone/auth.pp

@@ -30,17 +30,8 @@
 # [*service_type*]
 #    Type of service. Optional. Defaults to 'image'.
 #
-# [*public_address*]
+# [*service_description*]
-#    Public address for endpoint. Optional. Defaults to '127.0.0.1'.
+#    Description for keystone service. Optional. Defaults to 'OpenStack Image Service'.
-#
-# [*admin_address*]
-#    Admin address for endpoint. Optional. Defaults to '127.0.0.1'.
-#
-# [*internal_address*]
-#    Internal address for endpoint. Optional. Defaults to '127.0.0.1'.
-#
-# [*port*]
-#    Port for endpoint. Optional. Defaults to '9292'.
 #
 # [*region*]
 #    Region for endpoint. Optional. Defaults to 'RegionOne'.
@@ -48,17 +39,65 @@
 # [*tenant*]
 #    Tenant for glance user. Optional. Defaults to 'services'.
 #
+# [*public_url*]
+#   (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:9292')
+#   This url should *not* contain any trailing '/'.
+#
+# [*admin_url*]
+#   (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:9292')
+#   This url should *not* contain any trailing '/'.
+#
+# [*internal_url*]
+#   (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:9292')
+#   This url should *not* contain any trailing '/'.
+#
+# [*port*]
+#   (optional) DEPRECATED: Use public_url, internal_url and admin_url instead.
+#   Default port for endpoints. (Defaults to 9292)
+#   Setting this parameter overrides public_url, internal_url and admin_url parameters.
+#
 # [*public_protocol*]
-#    Protocol for public endpoint. Optional. Defaults to 'http'.
+#   (optional) DEPRECATED: Use public_url instead.
+#   Protocol for public endpoint. (Defaults to 'http')
+#   Setting this parameter overrides public_url parameter.
+#
+# [*public_address*]
+#   (optional) DEPRECATED: Use public_url instead.
+#   Public address for endpoint. (Defaults to '127.0.0.1')
+#   Setting this parameter overrides public_url parameter.
 #
 # [*internal_protocol*]
-#    Protocol for internal endpoint. Optional. Defaults to 'http'.
+#   (optional) DEPRECATED: Use internal_url instead.
+#   Protocol for internal endpoint. (Defaults to 'http')
+#   Setting this parameter overrides internal_url parameter.
+#
+# [*internal_address*]
+#   (optional) DEPRECATED: Use internal_url instead.
+#   Internal address for endpoint. (Defaults to '127.0.0.1')
+#   Setting this parameter overrides internal_url parameter.
 #
 # [*admin_protocol*]
-#    Protocol for admin endpoint. Optional. Defaults to 'http'.
+#   (optional) DEPRECATED: Use admin_url instead.
+#   Protocol for admin endpoint. (Defaults to 'http')
+#   Setting this parameter overrides admin_url parameter.
 #
-# [*service_description*]
+# [*admin_address*]
-#    Description for keystone service. Optional. Defaults to 'OpenStack Image Service''.
+#   (optional) DEPRECATED: Use admin_url instead.
+#   Admin address for endpoint. (Defaults to '127.0.0.1')
+#   Setting this parameter overrides admin_url parameter.
+#
+# === Deprecation notes
+#
+# If any value is provided for public_protocol, public_address or port parameters,
+# public_url will be completely ignored. The same applies for internal and admin parameters.
+#
+# === Examples
+#
+#  class { 'glance::keystone::auth':
+#    public_url   => 'https://10.0.0.10:9292',
+#    internal_url => 'https://10.0.0.11:9292',
+#    admin_url    => 'https://10.0.0.11:9292',
+#  }
 #
 class glance::keystone::auth(
   $password,
@@ -69,24 +108,79 @@ class glance::keystone::auth(
   $configure_user_role = true,
   $service_name        = undef,
   $service_type        = 'image',
-  $public_address      = '127.0.0.1',
-  $admin_address       = '127.0.0.1',
-  $internal_address    = '127.0.0.1',
-  $port                = '9292',
   $region              = 'RegionOne',
   $tenant              = 'services',
-  $public_protocol     = 'http',
-  $admin_protocol      = 'http',
-  $internal_protocol   = 'http',
   $service_description = 'OpenStack Image Service',
+  $public_url          = 'http://127.0.0.1:9292',
+  $admin_url           = 'http://127.0.0.1:9292',
+  $internal_url        = 'http://127.0.0.1:9292',
+  # DEPRECATED PARAMETERS
+  $port                = undef,
+  $public_protocol     = undef,
+  $public_address      = undef,
+  $internal_protocol   = undef,
+  $internal_address    = undef,
+  $admin_protocol      = undef,
+  $admin_address       = undef,
 ) {
 
-  if $service_name == undef {
+  if $port {
-    $real_service_name = $auth_name
+    warning('The port parameter is deprecated, use public_url, internal_url and admin_url instead.')
-  } else {
-    $real_service_name = $service_name
   }
 
+  if $public_protocol {
+    warning('The public_protocol parameter is deprecated, use public_url instead.')
+  }
+
+  if $internal_protocol {
+    warning('The internal_protocol parameter is deprecated, use internal_url instead.')
+  }
+
+  if $admin_protocol {
+    warning('The admin_protocol parameter is deprecated, use admin_url instead.')
+  }
+
+  if $public_address {
+    warning('The public_address parameter is deprecated, use public_url instead.')
+  }
+
+  if $internal_address {
+    warning('The internal_address parameter is deprecated, use internal_url instead.')
+  }
+
+  if $admin_address {
+    warning('The admin_address parameter is deprecated, use admin_url instead.')
+  }
+
+  if ($public_protocol or $public_address or $port) {
+    $public_url_real = sprintf('%s://%s:%s',
+      pick($public_protocol, 'http'),
+      pick($public_address, '127.0.0.1'),
+      pick($port, '9292'))
+  } else {
+    $public_url_real = $public_url
+  }
+
+  if ($admin_protocol or $admin_address or $port) {
+    $admin_url_real = sprintf('%s://%s:%s',
+      pick($admin_protocol, 'http'),
+      pick($admin_address, '127.0.0.1'),
+      pick($port, '9292'))
+  } else {
+    $admin_url_real = $admin_url
+  }
+
+  if ($internal_protocol or $internal_address or $port) {
+    $internal_url_real = sprintf('%s://%s:%s',
+      pick($internal_protocol, 'http'),
+      pick($internal_address, '127.0.0.1'),
+      pick($port, '9292'))
+  } else {
+    $internal_url_real = $internal_url
+  }
+
+  $real_service_name = pick($service_name, $auth_name)
+
   if $configure_endpoint {
     Keystone_endpoint["${region}/${real_service_name}"]  ~> Service <| name == 'glance-api' |>
   }
@@ -102,9 +196,9 @@ class glance::keystone::auth(
     password            => $password,
     email               => $email,
     tenant              => $tenant,
-    public_url          => "${public_protocol}://${public_address}:${port}",
+    public_url          => $public_url_real,
-    admin_url           => "${admin_protocol}://${admin_address}:${port}",
+    admin_url           => $admin_url_real,
-    internal_url        => "${internal_protocol}://${internal_address}:${port}",
+    internal_url        => $internal_url_real,
   }
 
   if $configure_user_role {

spec/classes/glance_keystone_auth_spec.rb

@@ -61,7 +61,24 @@ describe 'glance::keystone::auth' do
 
   end
 
-  describe 'when address, region, port and protocoll are overridden' do
+  describe 'when overriding endpoint URLs' do
+    let :params do
+      { :password         => 'passw0rd',
+        :region            => 'RegionTwo',
+        :public_url       => 'https://10.10.10.10:81/v2',
+        :internal_url     => 'https://10.10.10.11:81/v2',
+        :admin_url        => 'https://10.10.10.12:81/v2' }
+    end
+
+    it { is_expected.to contain_keystone_endpoint('RegionTwo/glance').with(
+      :ensure       => 'present',
+      :public_url   => 'https://10.10.10.10:81/v2',
+      :internal_url => 'https://10.10.10.11:81/v2',
+      :admin_url    => 'https://10.10.10.12:81/v2'
+    ) }
+  end
+
+  describe 'with deprecated endpoints parameters' do
 
     let :params do
       {