From 5b8bae1452c201a676e59d587cfa912c8c3e1b98 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Thu, 20 Jan 2022 19:12:06 +0900
Subject: [PATCH] Deprecate the change_password_available parameter

The [compute] change_password_available parameter was renamed in 2013
by d5c9602bee0b9366bca1f118379f196a794ed907 but the corresponding
parameter in puppet-tempest was not updated and still configuring
the old, unused parameter.

This change deprecates the parameter because it has has no effect for
a long time.

Closes-Bug: #1958511
Change-Id: I11ed3c7014b9c14bbbd1a08f98d3aa2dd947f74e
---
 manifests/init.pp                                   | 13 +++++++++----
 ...-change_password_available-6368d13e5003c015.yaml |  5 +++++
 spec/classes/tempest_init_spec.rb                   |  2 +-
 3 files changed, 15 insertions(+), 5 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-change_password_available-6368d13e5003c015.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 3209ba38..1a61de6d 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -110,8 +110,6 @@
 #   Defaults to undef
 #  [*resize_available*]
 #   Defaults to false
-#  [*change_password_available*]
-#   Defaults to undef
 #  [*use_dynamic_credentials*]
 #   Defaults to undef
 #  [*public_network_id*]
@@ -221,6 +219,8 @@
 #   Defaults to undef
 #  [*keystone_v2*]
 #   Defaults to undef
+#  [*change_password_available*]
+#   Defaults to undef
 #
 class tempest(
   $package_ensure                   = 'present',
@@ -302,7 +302,6 @@ class tempest(
   $whitebox_db_uri                  = undef,
   # testing features that are supported
   $resize_available                 = false,
-  $change_password_available        = undef,
   $use_dynamic_credentials          = undef,
   $l2gw_switch                      = undef,
   # neutron config
@@ -361,6 +360,7 @@ class tempest(
   $img_dir                          = undef,
   $panko_available                  = undef,
   $keystone_v2                      = undef,
+  $change_password_available        = undef,
 ) {
 
   if !is_service_default($tempest_roles) and !empty($tempest_roles){
@@ -393,6 +393,10 @@ class tempest(
     warning('The keystone_v2 parameter has been deprecated and will be removed in a future release.')
   }
 
+  if $change_password_available != undef {
+    warning('The change_password_available parameter has been deprecated and has no effect')
+  }
+
   include tempest::params
 
   include openstacklib::openstackclient
@@ -501,7 +505,8 @@ class tempest(
     'auth/admin_system':                               value => $admin_system;
     'auth/tempest_roles':                              value => $tempest_roles_real;
     'auth/use_dynamic_credentials':                    value => $use_dynamic_credentials;
-    'compute/change_password_available':               value => $change_password_available;
+    # TODO(tkajinam): Remove this when we remove the change_password_available parameter
+    'compute/change_password_available':               value => $::os_service_default;
     'compute/flavor_ref':                              value => $flavor_ref;
     'compute/flavor_ref_alt':                          value => $flavor_ref_alt;
     'compute/image_alt_ssh_user':                      value => $image_alt_ssh_user;
diff --git a/releasenotes/notes/deprecate-change_password_available-6368d13e5003c015.yaml b/releasenotes/notes/deprecate-change_password_available-6368d13e5003c015.yaml
new file mode 100644
index 00000000..abe5be79
--- /dev/null
+++ b/releasenotes/notes/deprecate-change_password_available-6368d13e5003c015.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``tempest::change_password_available`` parameter has been deprecated
+    and has no effect now.
diff --git a/spec/classes/tempest_init_spec.rb b/spec/classes/tempest_init_spec.rb
index bf68e343..e54d96e3 100644
--- a/spec/classes/tempest_init_spec.rb
+++ b/spec/classes/tempest_init_spec.rb
@@ -206,7 +206,7 @@ describe 'tempest' do
           is_expected.to contain_tempest_config('auth/tempest_roles').with(:value => '<SERVICE DEFAULT>')
           is_expected.to contain_tempest_config('auth/use_dynamic_credentials').with(:value => nil)
           is_expected.to contain_tempest_config('dns/nameservers').with(:value => nil)
-          is_expected.to contain_tempest_config('compute/change_password_available').with(:value => nil)
+          is_expected.to contain_tempest_config('compute/change_password_available').with(:value => '<SERVICE DEFAULT>')
           is_expected.to contain_tempest_config('compute/flavor_ref').with(:value => nil)
           is_expected.to contain_tempest_config('compute/flavor_ref_alt').with(:value => nil)
           is_expected.to contain_tempest_config('compute/image_alt_ssh_user').with(:value => nil)