From a33e4337be164829faac15932ab082b99028e1ed Mon Sep 17 00:00:00 2001 From: Iury Gregory Melo Ferreira Date: Fri, 5 Aug 2016 12:11:13 -0300 Subject: [PATCH] Add authtoken class Add authtoken class like we do in all other modules, to configure [keystone_authtoken] section. deprecations: - manila::api::keystone_user is deprecated in favor of manila::keystone::authtoken::username - manila::api::keystone_tenant is deprecated in favor of manila::keystone::authtoken::project_name - manila::api::keystone_password is deprecated in favor of manila::keystone::authtoken::password - manila::api::keystone_auth_uri is deprecated in favor of manila::keystone::authtoken::auth_uri - manila::api::keystone_auth_admin_prefix is deprecated and will be removed in a future release - manila::api::keystone_auth_host is deprecated and will be removed in a future release - manila::api::keystone_auth_port is deprecated and will be removed in a future release Change-Id: I3b124eb1d8c5d4e21811d0ec11c2e92f4088a90c Closes-Bug: #1604463 --- manifests/api.pp | 216 ++++++++------ manifests/keystone/authtoken.pp | 273 ++++++++++++++++++ .../notes/authtoken-4c9708f4e3b9605d.yaml | 24 ++ spec/acceptance/basic_manila_spec.rb | 5 +- spec/classes/manila_api_spec.rb | 62 ---- .../classes/manila_keystone_authtoken_spec.rb | 150 ++++++++++ 6 files changed, 572 insertions(+), 158 deletions(-) create mode 100644 manifests/keystone/authtoken.pp create mode 100644 releasenotes/notes/authtoken-4c9708f4e3b9605d.yaml create mode 100644 spec/classes/manila_keystone_authtoken_spec.rb diff --git a/manifests/api.pp b/manifests/api.pp index 3c45a756..5870ded8 100644 --- a/manifests/api.pp +++ b/manifests/api.pp @@ -4,32 +4,9 @@ # # === Parameters # -# [*keystone_password*] -# The password to use for authentication (keystone) -# -# [*keystone_enabled*] -# (optional) Use keystone for authentification -# Defaults to true -# -# [*keystone_tenant*] -# (optional) The tenant of the auth user -# Defaults to services -# -# [*keystone_user*] -# (optional) The name of the auth user -# Defaults to manila -# -# [*keystone_auth_host*] -# (optional) The keystone host -# Defaults to localhost -# -# [*keystone_auth_port*] -# (optional) The keystone auth port -# Defaults to 35357 -# -# [*keystone_auth_protocol*] -# (optional) The protocol used to access the auth host -# Defaults to http. +# [*auth_strategy*] +# (optional) Type of authentication to be used. +# Defaults to 'keystone' # # [*os_region_name*] # (optional) Some operations require manila to make API requests @@ -37,21 +14,6 @@ # requests. For example, boot-from-share. # Defaults to undef. # -# [*keystone_auth_admin_prefix*] -# (optional) The admin_prefix used to admin endpoint of the auth host -# This allow admin auth URIs like http://auth_host:35357/keystone. -# (where '/keystone' is the admin prefix) -# Defaults to false for empty. If defined, should be a string with a -# leading '/' and no trailing '/'. -# -# [*keystone_auth_uri*] -# (Optional) Public Identity API endpoint. -# Defaults to false. -# -# [*service_port*] -# (optional) The manila api port -# Defaults to 5000 -# # [*package_ensure*] # (optional) The state of the package # Defaults to present @@ -85,32 +47,119 @@ # HTTPProxyToWSGI middleware. # Defaults to $::os_service_default. # +# === DEPRECATED PARAMTERS +# +# [*keystone_enabled*] +# (optional) DEPRECATED. Use auth_strategy instead. +# Defaults to undef +# +# [*keystone_password*] +# (optional) DEPRECATED. The password to use for authentication (keystone) +# Defaults to undef +# +# [*keystone_tenant*] +# (optional) DEPRECATED. The tenant of the auth user +# Defaults to undef +# +# [*keystone_user*] +# (optional) DEPRECATED. The name of the auth user +# Defaults to undef +# +# [*keystone_auth_host*] +# (optional) DEPRECATED. The keystone host +# Defaults to undef +# +# [*keystone_auth_port*] +# (optional) DEPRECATED. The keystone auth port +# Defaults to undef +# +# [*keystone_auth_protocol*] +# (optional) DEPRECATED. The protocol used to access the auth host +# Defaults to undef +# +# [*keystone_auth_admin_prefix*] +# (optional) DEPRECATED. The admin_prefix used to admin endpoint of the auth host +# This allow admin auth URIs like http://auth_host:35357/keystone. +# (where '/keystone' is the admin prefix) +# Defaults to false for empty. If defined, should be a string with a +# leading '/' and no trailing '/'. +# Defaults to undef +# +# [*keystone_auth_uri*] +# (Optional) DEPRECATED. Public Identity API endpoint. +# Defaults to undef. +# +# [*service_port*] +# (optional) DEPRECATED. The manila api port +# Defaults to undef +# class manila::api ( - $keystone_password, - $keystone_enabled = true, - $keystone_tenant = 'services', - $keystone_user = 'manila', - $keystone_auth_host = 'localhost', - $keystone_auth_port = '35357', - $keystone_auth_protocol = 'http', - $keystone_auth_admin_prefix = false, - $keystone_auth_uri = false, - $os_region_name = undef, - $service_port = '5000', - $package_ensure = 'present', - $bind_host = '0.0.0.0', - $enabled = true, - $sync_db = true, - $manage_service = true, - $ratelimits = undef, - $ratelimits_factory = - 'manila.api.v1.limits:RateLimitingMiddleware.factory', - $enable_proxy_headers_parsing = $::os_service_default, + $auth_strategy = 'keystone', + $os_region_name = undef, + $package_ensure = 'present', + $bind_host = '0.0.0.0', + $enabled = true, + $sync_db = true, + $manage_service = true, + $ratelimits = undef, + $ratelimits_factory = 'manila.api.v1.limits:RateLimitingMiddleware.factory', + $enable_proxy_headers_parsing = $::os_service_default, + # Deprecated + $keystone_enabled = undef, + $keystone_user = undef, + $keystone_tenant = undef, + $keystone_auth_uri = undef, + $keystone_password = undef, + $keystone_auth_admin_prefix = undef, + $keystone_auth_host = undef, + $keystone_auth_port = undef, + $keystone_auth_protocol = undef, + $service_port = undef, ) { include ::manila::params require ::keystone::python + if $keystone_enabled { + warning('keystone_enabled is deprecated, use auth_strategy instead.') + } + + if $keystone_user { + warning('manila::api::keystone_user is deprecated, use manila::keystone::authtoken::username instead.') + } + + if $keystone_tenant { + warning('manila::api::keystone_tenant is deprecated, use manila::keystone::authtoken::project_name instead.') + } + + if $keystone_password { + warning('manila::api::keystone_password is deprecated, use manila::keystone::authtoken::password instead.') + } + + if $keystone_auth_uri { + warning('manila::api::keystone_auth_uri is deprecated, use manila::keystone::authtoken::auth_uri instead.') + } + + if $keystone_auth_admin_prefix { + warning('keystone_auth_admin_prefix is deprecated and will be removed in a future release') + } + + if $keystone_auth_host { + warning('keystone_auth_host is deprecated and will be removed in a future release') + } + + if $keystone_auth_port { + warning('keystone_auth_port is deprecated and will be removed in a future release') + } + + if $keystone_auth_protocol { + warning('keystone_auth_protocol is deprecated and will be removed in a future release') + } + + if $service_port { + warning('service port is deprecated and will be removed in a future release') + } + Manila_config<||> ~> Service['manila-api'] Manila_api_paste_ini<||> ~> Service['manila-api'] @@ -160,43 +209,22 @@ class manila::api ( } } - if $keystone_auth_uri { - manila_api_paste_ini { 'filter:authtoken/auth_uri': value => $keystone_auth_uri; } - } else { - manila_api_paste_ini { 'filter:authtoken/auth_uri': value => "${keystone_auth_protocol}://${keystone_auth_host}:${service_port}/"; } - } - if $keystone_enabled { - manila_config { - 'DEFAULT/auth_strategy': value => 'keystone' ; - } - manila_api_paste_ini { - 'filter:authtoken/service_protocol': value => $keystone_auth_protocol; - 'filter:authtoken/service_host': value => $keystone_auth_host; - 'filter:authtoken/service_port': value => $service_port; - 'filter:authtoken/auth_protocol': value => $keystone_auth_protocol; - 'filter:authtoken/auth_host': value => $keystone_auth_host; - 'filter:authtoken/auth_port': value => $keystone_auth_port; - 'filter:authtoken/admin_tenant_name': value => $keystone_tenant; - 'filter:authtoken/admin_user': value => $keystone_user; - 'filter:authtoken/admin_password': value => $keystone_password, secret => true; - } - - if ($ratelimits != undef) { - manila_api_paste_ini { - 'filter:ratelimit/paste.filter_factory': value => $ratelimits_factory; - 'filter:ratelimit/limits': value => $ratelimits; - } + $auth_strategy_real = 'keystone' + } else { + $auth_strategy_real = $auth_strategy } - if $keystone_auth_admin_prefix { - validate_re($keystone_auth_admin_prefix, '^(/.+[^/])?$') + if $auth_strategy_real == 'keystone' { + manila_config { + 'DEFAULT/auth_strategy': value => $auth_strategy_real; + } + include ::manila::keystone::authtoken + + if ($ratelimits != undef) { manila_api_paste_ini { - 'filter:authtoken/auth_admin_prefix': value => $keystone_auth_admin_prefix; - } - } else { - manila_api_paste_ini { - 'filter:authtoken/auth_admin_prefix': ensure => absent; + 'filter:ratelimit/paste.filter_factory': value => $ratelimits_factory; + 'filter:ratelimit/limits': value => $ratelimits; } } } diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp new file mode 100644 index 00000000..95cc3284 --- /dev/null +++ b/manifests/keystone/authtoken.pp @@ -0,0 +1,273 @@ +# class: manila::keystone::authtoken +# +# Configure the keystone_authtoken section in the configuration file +# +# === Parameters +# +# [*password*] +# (Optional) Password to create for the service user +# Defaults to $::os_service_default +# +# [*username*] +# (Optional) The name of the service user +# Defaults to 'manila' +# +# [*auth_url*] +# (Optional) The URL to use for authentication. +# Defaults to 'http://localhost:35357'. +# +# [*project_name*] +# (Optional) Service project name +# Defaults to 'services' +# +# [*user_domain_name*] +# (Optional) Name of domain for $username +# Defaults to $::os_service_default +# +# [*project_domain_name*] +# (Optional) Name of domain for $project_name +# Defaults to $::os_service_default +# +# [*insecure*] +# (Optional) If true, explicitly allow TLS without checking server cert +# against any certificate authorities. WARNING: not recommended. Use with +# caution. +# Defaults to $::os_service_default +# +# [*auth_section*] +# (Optional) Config Section from which to load plugin specific options +# Defaults to $::os_service_default. +# +# [*auth_type*] +# (Optional) Authentication type to load +# Defaults to 'password' +# +# [*auth_uri*] +# (Optional) Complete public Identity API endpoint. +# Defaults to 'http://localhost:5000'. +# +# [*auth_version*] +# (Optional) API version of the admin Identity API endpoint. +# Defaults to $::os_service_default. +# +# [*cache*] +# (Optional) Env key for the swift cache. +# Defaults to $::os_service_default. +# +# [*cafile*] +# (Optional) A PEM encoded Certificate Authority to use when verifying HTTPs +# connections. +# Defaults to $::os_service_default. +# +# [*certfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*check_revocations_for_cached*] +# (Optional) If true, the revocation list will be checked for cached tokens. +# This requires that PKI tokens are configured on the identity server. +# boolean value. +# Defaults to $::os_service_default. +# +# [*delay_auth_decision*] +# (Optional) Do not handle authorization requests within the middleware, but +# delegate the authorization decision to downstream WSGI components. Boolean +# value +# Defaults to $::os_service_default. +# +# [*enforce_token_bind*] +# (Optional) Used to control the use and type of token binding. Can be set +# to: "disabled" to not check token binding. "permissive" (default) to +# validate binding information if the bind type is of a form known to the +# server and ignore it if not. "strict" like "permissive" but if the bind +# type is unknown the token will be rejected. "required" any form of token +# binding is needed to be allowed. Finally the name of a binding method that +# must be present in tokens. String value. +# Defaults to $::os_service_default. +# +# [*hash_algorithms*] +# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a +# single algorithm or multiple. The algorithms are those supported by Python +# standard hashlib.new(). The hashes will be tried in the order given, so put +# the preferred one first for performance. The result of the first hash will +# be stored in the cache. This will typically be set to multiple values only +# while migrating from a less secure algorithm to a more secure one. Once all +# the old tokens are expired this option should be set to a single value for +# better performance. List value. +# Defaults to $::os_service_default. +# +# [*http_connect_timeout*] +# (Optional) Request timeout value for communicating with Identity API +# server. +# Defaults to $::os_service_default. +# +# [*http_request_max_retries*] +# (Optional) How many times are we trying to reconnect when communicating +# with Identity API Server. Integer value +# Defaults to $::os_service_default. +# +# [*include_service_catalog*] +# (Optional) Indicate whether to set the X-Service-Catalog header. If False, +# middleware will not ask for service catalog on token validation and will +# not set the X-Service-Catalog header. Boolean value. +# Defaults to $::os_service_default. +# +# [*keyfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*memcache_pool_conn_get_timeout*] +# (Optional) Number of seconds that an operation will wait to get a memcached +# client connection from the pool. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_dead_retry*] +# (Optional) Number of seconds memcached server is considered dead before it +# is tried again. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_maxsize*] +# (Optional) Maximum total number of open connections to every memcached +# server. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_socket_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_unused_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_secret_key*] +# (Optional, mandatory if memcache_security_strategy is defined) This string +# is used for key derivation. +# Defaults to $::os_service_default. +# +# [*memcache_security_strategy*] +# (Optional) If defined, indicate whether token data should be authenticated +# or authenticated and encrypted. If MAC, token data is authenticated (with +# HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the +# cache. If the value is not one of these options or empty, auth_token will +# raise an exception on initialization. +# Defaults to $::os_service_default. +# +# [*memcache_use_advanced_pool*] +# (Optional) Use the advanced (eventlet safe) memcached client pool. The +# advanced pool will only work under python 2.x Boolean value +# Defaults to $::os_service_default. +# +# [*memcached_servers*] +# (Optional) Optionally specify a list of memcached server(s) to use for +# caching. If left undefined, tokens will instead be cached in-process. +# Defaults to $::os_service_default. +# +# [*region_name*] +# (Optional) The region in which the identity server can be found. +# Defaults to $::os_service_default. +# +# [*revocation_cache_time*] +# (Optional) Determines the frequency at which the list of revoked tokens is +# retrieved from the Identity service (in seconds). A high number of +# revocation events combined with a low cache duration may significantly +# reduce performance. Only valid for PKI tokens. Integer value +# Defaults to $::os_service_default. +# +# [*signing_dir*] +# (Optional) Directory used to cache files related to PKI tokens. +# Defaults to $::os_service_default. +# +# [*token_cache_time*] +# (Optional) In order to prevent excessive effort spent validating tokens, +# the middleware caches previously-seen tokens for a configurable duration +# (in seconds). Set to -1 to disable caching completely. Integer value +# Defaults to $::os_service_default. +# +class manila::keystone::authtoken( + $password = $::os_service_default, + $username = 'manila', + $auth_url = 'http://localhost:35357', + $project_name = 'services', + $user_domain_name = $::os_service_default, + $project_domain_name = $::os_service_default, + $insecure = $::os_service_default, + $auth_section = $::os_service_default, + $auth_type = 'password', + $auth_uri = 'http://localhost:5000', + $auth_version = $::os_service_default, + $cache = $::os_service_default, + $cafile = $::os_service_default, + $certfile = $::os_service_default, + $check_revocations_for_cached = $::os_service_default, + $delay_auth_decision = $::os_service_default, + $enforce_token_bind = $::os_service_default, + $hash_algorithms = $::os_service_default, + $http_connect_timeout = $::os_service_default, + $http_request_max_retries = $::os_service_default, + $include_service_catalog = $::os_service_default, + $keyfile = $::os_service_default, + $memcache_pool_conn_get_timeout = $::os_service_default, + $memcache_pool_dead_retry = $::os_service_default, + $memcache_pool_maxsize = $::os_service_default, + $memcache_pool_socket_timeout = $::os_service_default, + $memcache_pool_unused_timeout = $::os_service_default, + $memcache_secret_key = $::os_service_default, + $memcache_security_strategy = $::os_service_default, + $memcache_use_advanced_pool = $::os_service_default, + $memcached_servers = $::os_service_default, + $region_name = $::os_service_default, + $revocation_cache_time = $::os_service_default, + $signing_dir = $::os_service_default, + $token_cache_time = $::os_service_default, +) { + + if is_service_default($password) and ! $::manila::api::keystone_password { + fail('Please set password for manila service user') + } + + $username_real = pick($::manila::api::keystone_user, $username) + $password_real = pick($::manila::api::keystone_password, $password) + $project_name_real = pick($::manila::api::keystone_tenant, $project_name) + $auth_uri_real = pick($::manila::api::auth_uri, $auth_uri) + + keystone::resource::authtoken { 'manila_config': + username => $username_real, + password => $password_real, + project_name => $project_name_real, + auth_url => $auth_url, + auth_uri => $auth_uri_real, + auth_version => $auth_version, + auth_type => $auth_type, + auth_section => $auth_section, + user_domain_name => $user_domain_name, + project_domain_name => $project_domain_name, + insecure => $insecure, + cache => $cache, + cafile => $cafile, + certfile => $certfile, + check_revocations_for_cached => $check_revocations_for_cached, + delay_auth_decision => $delay_auth_decision, + enforce_token_bind => $enforce_token_bind, + hash_algorithms => $hash_algorithms, + http_connect_timeout => $http_connect_timeout, + http_request_max_retries => $http_request_max_retries, + include_service_catalog => $include_service_catalog, + keyfile => $keyfile, + memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, + memcache_pool_dead_retry => $memcache_pool_dead_retry, + memcache_pool_maxsize => $memcache_pool_maxsize, + memcache_pool_socket_timeout => $memcache_pool_socket_timeout, + memcache_secret_key => $memcache_secret_key, + memcache_security_strategy => $memcache_security_strategy, + memcache_use_advanced_pool => $memcache_use_advanced_pool, + memcache_pool_unused_timeout => $memcache_pool_unused_timeout, + memcached_servers => $memcached_servers, + region_name => $region_name, + revocation_cache_time => $revocation_cache_time, + signing_dir => $signing_dir, + token_cache_time => $token_cache_time, + } +} + diff --git a/releasenotes/notes/authtoken-4c9708f4e3b9605d.yaml b/releasenotes/notes/authtoken-4c9708f4e3b9605d.yaml new file mode 100644 index 00000000..b27b1660 --- /dev/null +++ b/releasenotes/notes/authtoken-4c9708f4e3b9605d.yaml @@ -0,0 +1,24 @@ +--- +features: + - Added manila::keystone::authtoken class to configure the + keystone_authtoken section in configuration file with all + keystone middleware parameters. +deprecations: + - manila::api::keystone_user is deprecated in favor of + manila::keystone::authtoken::username + - manila::api::keystone_tenant is deprecated in favor of + manila::keystone::authtoken::project_name + - manila::api::keystone_password is deprecated in favor of + manila::keystone::authtoken::password + - manila::api::keystone_auth_uri is deprecated in favor of + manila::keystone::authtoken::auth_uri + - manila::api::keystone_auth_admin_prefix is deprecated and will be removed + in a future release + - manila::api::keystone_auth_host is deprecated and will be removed + in a future release + - manila::api::keystone_auth_port is deprecated and will be removed + in a future release + - manila::api::keystone_auth_protocol is deprecated and will be removed + in a future release + - manila::api::service_port is deprecated and will be removed + in a future release diff --git a/spec/acceptance/basic_manila_spec.rb b/spec/acceptance/basic_manila_spec.rb index 2ef3258e..5ce939ef 100644 --- a/spec/acceptance/basic_manila_spec.rb +++ b/spec/acceptance/basic_manila_spec.rb @@ -46,9 +46,10 @@ describe 'basic manila' do class { '::manila::compute::nova': } class { '::manila::network::neutron': } class { '::manila::volume::cinder': } - class { '::manila::api': - keystone_password => 'a_big_secret', + class { '::manila::keystone::authtoken': + password => 'a_big_secret', } + class { '::manila::api': } class { '::manila::scheduler': } # NFS-Ganesha backend. Currently this feature is only for RHEL systems diff --git a/spec/classes/manila_api_spec.rb b/spec/classes/manila_api_spec.rb index 116eacdc..acb2b473 100644 --- a/spec/classes/manila_api_spec.rb +++ b/spec/classes/manila_api_spec.rb @@ -23,21 +23,6 @@ describe 'manila::api' do it 'should configure manila api correctly' do is_expected.to contain_manila_config('DEFAULT/auth_strategy').with(:value => 'keystone') is_expected.to contain_manila_config('DEFAULT/osapi_share_listen').with(:value => '0.0.0.0') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/service_protocol').with(:value => 'http') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/service_host').with(:value => 'localhost') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/service_port').with(:value => '5000') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_protocol').with(:value => 'http') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_host').with(:value => 'localhost') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_port').with(:value => '35357') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_admin_prefix').with(:ensure => 'absent') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/admin_tenant_name').with(:value => 'services') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/admin_user').with(:value => 'manila') - is_expected.to contain_manila_api_paste_ini('filter:authtoken/admin_password').with( - :value => 'foo', - :secret => true - ) - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_uri').with(:value => 'http://localhost:5000/') - is_expected.to_not contain_manila_config('DEFAULT/os_region_name') is_expected.to contain_manila_config('oslo_middleware/enable_proxy_headers_parsing').with_value('') end @@ -58,17 +43,6 @@ describe 'manila::api' do end end - describe 'with custom auth_uri' do - let :params do - req_params.merge({'keystone_auth_uri' => 'http://foo.bar:8080/v2.0/'}) - end - it 'should configure manila auth_uri correctly' do - is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_uri').with( - :value => 'http://foo.bar:8080/v2.0/' - ) - end - end - describe 'with only required params' do let :params do req_params.merge({'bind_host' => '192.168.1.3'}) @@ -91,42 +65,6 @@ describe 'manila::api' do end end - [ '/keystone', '/keystone/admin' ].each do |keystone_auth_admin_prefix| - describe "with keystone_auth_admin_prefix containing correct value #{keystone_auth_admin_prefix}" do - let :params do - { - :keystone_auth_admin_prefix => keystone_auth_admin_prefix, - :keystone_password => 'dummy' - } - end - - it { is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_admin_prefix').with( - :value => keystone_auth_admin_prefix - )} - end - end - - [ - '/keystone/', - 'keystone/', - 'keystone', - '/keystone/admin/', - 'keystone/admin/', - 'keystone/admin' - ].each do |keystone_auth_admin_prefix| - describe "with keystone_auth_admin_prefix containing incorrect value #{keystone_auth_admin_prefix}" do - let :params do - { - :keystone_auth_admin_prefix => keystone_auth_admin_prefix, - :keystone_password => 'dummy' - } - end - - it { expect { is_expected.to contain_manila_api_paste_ini('filter:authtoken/auth_admin_prefix') }.to \ - raise_error(Puppet::Error, /validate_re\(\): "#{keystone_auth_admin_prefix}" does not match/) } - end - end - describe 'with enabled false' do let :params do req_params.merge({'enabled' => false}) diff --git a/spec/classes/manila_keystone_authtoken_spec.rb b/spec/classes/manila_keystone_authtoken_spec.rb new file mode 100644 index 00000000..722c1fd6 --- /dev/null +++ b/spec/classes/manila_keystone_authtoken_spec.rb @@ -0,0 +1,150 @@ +require 'spec_helper' + +describe 'manila::keystone::authtoken' do + + let :params do + { :password => 'manila_password', } + end + + shared_examples 'manila authtoken' do + + context 'without required password parameter' do + before { params.delete(:password) } + it { expect { is_expected.to raise_error(Puppet::Error) } } + end + + context 'with default parameters' do + + it 'configure keystone_authtoken' do + is_expected.to contain_manila_config('keystone_authtoken/username').with_value('manila') + is_expected.to contain_manila_config('keystone_authtoken/password').with_value('manila_password') + is_expected.to contain_manila_config('keystone_authtoken/auth_url').with_value('http://localhost:35357') + is_expected.to contain_manila_config('keystone_authtoken/project_name').with_value('services') + is_expected.to contain_manila_config('keystone_authtoken/user_domain_name').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/project_domain_name').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/insecure').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/auth_section').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/auth_type').with_value('password') + is_expected.to contain_manila_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_manila_config('keystone_authtoken/auth_version').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/cache').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/cafile').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/certfile').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/check_revocations_for_cached').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/delay_auth_decision').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/enforce_token_bind').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/hash_algorithms').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/http_connect_timeout').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/http_request_max_retries').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/include_service_catalog').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/keyfile').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_dead_retry').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_maxsize').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_socket_timeout').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_unused_timeout').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_secret_key').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_security_strategy').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcache_use_advanced_pool').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/memcached_servers').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/region_name').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/revocation_cache_time').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/signing_dir').with_value('') + is_expected.to contain_manila_config('keystone_authtoken/token_cache_time').with_value('') + end + end + + context 'when overriding parameters' do + before do + params.merge!({ + :auth_uri => 'https://10.0.0.1:9999/', + :username => 'myuser', + :password => 'mypasswd', + :auth_url => 'https://127.0.0.1:35357', + :project_name => 'service_project', + :user_domain_name => 'domainX', + :project_domain_name => 'domainX', + :insecure => false, + :auth_section => 'new_section', + :auth_type => 'password', + :auth_version => 'v3', + :cache => 'somevalue', + :cafile => '/opt/stack/data/cafile.pem', + :certfile => 'certfile.crt', + :check_revocations_for_cached => false, + :delay_auth_decision => false, + :enforce_token_bind => 'permissive', + :hash_algorithms => 'md5', + :http_connect_timeout => '300', + :http_request_max_retries => '3', + :include_service_catalog => true, + :keyfile => 'keyfile', + :memcache_pool_conn_get_timeout => '9', + :memcache_pool_dead_retry => '302', + :memcache_pool_maxsize => '11', + :memcache_pool_socket_timeout => '2', + :memcache_pool_unused_timeout => '61', + :memcache_secret_key => 'secret_key', + :memcache_security_strategy => 'ENCRYPT', + :memcache_use_advanced_pool => true, + :memcached_servers => ['memcached01:11211','memcached02:11211'], + :region_name => 'region2', + :revocation_cache_time => '11', + :signing_dir => '/var/cache', + :token_cache_time => '301', + }) + end + + it 'configure keystone_authtoken' do + is_expected.to contain_manila_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_manila_config('keystone_authtoken/username').with_value(params[:username]) + is_expected.to contain_manila_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) + is_expected.to contain_manila_config('keystone_authtoken/auth_url').with_value(params[:auth_url]) + is_expected.to contain_manila_config('keystone_authtoken/project_name').with_value(params[:project_name]) + is_expected.to contain_manila_config('keystone_authtoken/user_domain_name').with_value(params[:user_domain_name]) + is_expected.to contain_manila_config('keystone_authtoken/project_domain_name').with_value(params[:project_domain_name]) + is_expected.to contain_manila_config('keystone_authtoken/insecure').with_value(params[:insecure]) + is_expected.to contain_manila_config('keystone_authtoken/auth_section').with_value(params[:auth_section]) + is_expected.to contain_manila_config('keystone_authtoken/auth_type').with_value(params[:auth_type]) + is_expected.to contain_manila_config('keystone_authtoken/auth_version').with_value(params[:auth_version]) + is_expected.to contain_manila_config('keystone_authtoken/cache').with_value(params[:cache]) + is_expected.to contain_manila_config('keystone_authtoken/cafile').with_value(params[:cafile]) + is_expected.to contain_manila_config('keystone_authtoken/certfile').with_value(params[:certfile]) + is_expected.to contain_manila_config('keystone_authtoken/check_revocations_for_cached').with_value(params[:check_revocations_for_cached]) + is_expected.to contain_manila_config('keystone_authtoken/delay_auth_decision').with_value(params[:delay_auth_decision]) + is_expected.to contain_manila_config('keystone_authtoken/enforce_token_bind').with_value(params[:enforce_token_bind]) + is_expected.to contain_manila_config('keystone_authtoken/hash_algorithms').with_value(params[:hash_algorithms]) + is_expected.to contain_manila_config('keystone_authtoken/http_connect_timeout').with_value(params[:http_connect_timeout]) + is_expected.to contain_manila_config('keystone_authtoken/http_request_max_retries').with_value(params[:http_request_max_retries]) + is_expected.to contain_manila_config('keystone_authtoken/include_service_catalog').with_value(params[:include_service_catalog]) + is_expected.to contain_manila_config('keystone_authtoken/keyfile').with_value(params[:keyfile]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value(params[:memcache_pool_conn_get_timeout]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_dead_retry').with_value(params[:memcache_pool_dead_retry]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_maxsize').with_value(params[:memcache_pool_maxsize]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_socket_timeout').with_value(params[:memcache_pool_socket_timeout]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_pool_unused_timeout').with_value(params[:memcache_pool_unused_timeout]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_secret_key').with_value(params[:memcache_secret_key]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_security_strategy').with_value(params[:memcache_security_strategy]) + is_expected.to contain_manila_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool]) + is_expected.to contain_manila_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211') + is_expected.to contain_manila_config('keystone_authtoken/region_name').with_value(params[:region_name]) + is_expected.to contain_manila_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time]) + is_expected.to contain_manila_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir]) + is_expected.to contain_manila_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time]) + end + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_configures 'manila authtoken' + end + end + +end