From abd4775dd5e4930ef28e326a7781f782e5b2ebaf Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Wed, 28 Dec 2016 13:57:14 +0800
Subject: [PATCH] Deprecate signing_dir option

The signing_dir is deprecated for removel because of PKI token format
is no longer supported.
Update warning message and release note.

Change-Id: I26180ba65060b2af6ee610e4fe438b26cb5580e9
Closes-Bug: #1652700
---
 manifests/keystone/authtoken.pp                | 18 ++++++++++++------
 ...signing_dir_parameter-6135a83f34551ef9.yaml |  4 ++++
 .../classes/gnocchi_keystone_authtoken_spec.rb |  3 ---
 3 files changed, 16 insertions(+), 9 deletions(-)
 create mode 100644 releasenotes/notes/deprecate_signing_dir_parameter-6135a83f34551ef9.yaml

diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp
index b48ef90f..9ac89f94 100644
--- a/manifests/keystone/authtoken.pp
+++ b/manifests/keystone/authtoken.pp
@@ -175,16 +175,18 @@
 #   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.
 #
+# DEPRECATED PARAMETERS
+#
+# [*signing_dir*]
+#   (Optional) Directory used to cache files related to PKI tokens.
+#   Defaults to undef
+#
 class gnocchi::keystone::authtoken(
   $username                       = 'gnocchi',
   $password                       = $::os_service_default,
@@ -219,8 +221,9 @@ class gnocchi::keystone::authtoken(
   $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,
+  # DEPRECATED PARAMETERS
+  $signing_dir                    = undef,
 ) {
 
   include ::gnocchi::deps
@@ -229,6 +232,10 @@ class gnocchi::keystone::authtoken(
     fail('Please set password for Gnocchi service user')
   }
 
+  if $signing_dir {
+    warning('signing_dir parameter is deprecated, has no effect and will be removed in the P release.')
+  }
+
   keystone::resource::authtoken { 'gnocchi_config':
     username                       => $username,
     password                       => $password,
@@ -263,7 +270,6 @@ class gnocchi::keystone::authtoken(
     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/deprecate_signing_dir_parameter-6135a83f34551ef9.yaml b/releasenotes/notes/deprecate_signing_dir_parameter-6135a83f34551ef9.yaml
new file mode 100644
index 00000000..9c3ade95
--- /dev/null
+++ b/releasenotes/notes/deprecate_signing_dir_parameter-6135a83f34551ef9.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - signing_dir option is now deprecated for removal, the
+    parameter has no effect.
diff --git a/spec/classes/gnocchi_keystone_authtoken_spec.rb b/spec/classes/gnocchi_keystone_authtoken_spec.rb
index 42d55f59..8892b60b 100644
--- a/spec/classes/gnocchi_keystone_authtoken_spec.rb
+++ b/spec/classes/gnocchi_keystone_authtoken_spec.rb
@@ -44,7 +44,6 @@ describe 'gnocchi::keystone::authtoken' do
         is_expected.to contain_gnocchi_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_gnocchi_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_gnocchi_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
-        is_expected.to contain_gnocchi_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_gnocchi_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
       end
     end
@@ -85,7 +84,6 @@ describe 'gnocchi::keystone::authtoken' do
           :memcached_servers                    => ['memcached01:11211','memcached02:11211'],
           :region_name                          => 'region2',
           :revocation_cache_time                => '11',
-          :signing_dir                          => '/var/cache',
           :token_cache_time                     => '301',
         })
       end
@@ -124,7 +122,6 @@ describe 'gnocchi::keystone::authtoken' do
         is_expected.to contain_gnocchi_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
         is_expected.to contain_gnocchi_config('keystone_authtoken/region_name').with_value(params[:region_name])
         is_expected.to contain_gnocchi_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
-        is_expected.to contain_gnocchi_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
         is_expected.to contain_gnocchi_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
       end
     end