From 7dd8afd35d49f2d3419ae60e553b3406306675d8 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Sun, 26 Apr 2020 22:08:18 +0900
Subject: [PATCH] Deprecate heat::engione::deferred_auth_method

... because its actual parameter in heat was already deprecated[1].

[1] 9723b0dab707bcedc846415b932b2ade5b7c1317

Change-Id: I782d6b3833f450178ccd34736de4c9f861937399
---
 manifests/engine.pp                           | 23 +++++++++++++------
 ...deferred_auth_method-b87bcd02bc23aea1.yaml |  5 ++++
 spec/classes/heat_engine_spec.rb              |  1 -
 3 files changed, 21 insertions(+), 8 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-deferred_auth_method-b87bcd02bc23aea1.yaml

diff --git a/manifests/engine.pp b/manifests/engine.pp
index 4789c10f..f613c7db 100644
--- a/manifests/engine.pp
+++ b/manifests/engine.pp
@@ -40,11 +40,6 @@
 #   used for stack locking
 #   Defaults to $::os_service_default.
 #
-# [*deferred_auth_method*]
-#   (optional) Select deferred auth method.
-#   Can be "password" or "trusts".
-#   Defaults to $::os_service_default.
-#
 # [*default_software_config_transport*]
 #   (optional) Template default for how the server should receive the metadata
 #   required for software configuration. POLL_SERVER_CFN will allow calls to the
@@ -134,6 +129,13 @@
 #   by user-controlled servers to make calls back to Heat.
 #   Defaults to $::os_service_default
 #
+# DEPRECATED PARAMETERS
+#
+# [*deferred_auth_method*]
+#   (optional) Select deferred auth method.
+#   Can be "password" or "trusts".
+#   Defaults to undef
+#
 class heat::engine (
   $auth_encryption_key,
   $package_ensure                                  = 'present',
@@ -143,7 +145,6 @@ class heat::engine (
   $heat_metadata_server_url                        = $::os_service_default,
   $heat_waitcondition_server_url                   = $::os_service_default,
   $engine_life_check_timeout                       = $::os_service_default,
-  $deferred_auth_method                            = $::os_service_default,
   $default_software_config_transport               = $::os_service_default,
   $default_deployment_signal_transport             = $::os_service_default,
   $default_user_data_format                        = $::os_service_default,
@@ -160,6 +161,8 @@ class heat::engine (
   $plugin_dirs                                     = $::os_service_default,
   $client_retry_limit                              = $::os_service_default,
   $server_keystone_endpoint_type                   = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $deferred_auth_method                            = undef,
 ) {
 
   include heat::deps
@@ -221,7 +224,6 @@ class heat::engine (
     'DEFAULT/default_deployment_signal_transport':             value => $default_deployment_signal_transport;
     'DEFAULT/default_user_data_format':                        value => $default_user_data_format;
     'DEFAULT/trusts_delegated_roles':                          value => $trusts_delegated_roles;
-    'DEFAULT/deferred_auth_method':                            value => $deferred_auth_method;
     'DEFAULT/max_resources_per_stack':                         value => $max_resources_per_stack;
     'DEFAULT/instance_connection_https_validate_certificates': value => $instance_connection_https_validate_certificates;
     'DEFAULT/instance_connection_is_secure':                   value => $instance_connection_is_secure;
@@ -235,4 +237,11 @@ class heat::engine (
     'DEFAULT/client_retry_limit':                              value => $client_retry_limit;
     'DEFAULT/server_keystone_endpoint_type':                   value => $server_keystone_endpoint_type;
   }
+
+  if $deferred_auth_method != undef {
+    warning('deferred_auth_method is deprecated and will be removed in a future release')
+    heat_config {
+      'DEFAULT/deferred_auth_method': value => $deferred_auth_method;
+    }
+  }
 }
diff --git a/releasenotes/notes/deprecate-deferred_auth_method-b87bcd02bc23aea1.yaml b/releasenotes/notes/deprecate-deferred_auth_method-b87bcd02bc23aea1.yaml
new file mode 100644
index 00000000..56685f35
--- /dev/null
+++ b/releasenotes/notes/deprecate-deferred_auth_method-b87bcd02bc23aea1.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``heat::engine::deferred_auth_method`` parameters has been deprecated
+    and will be removed in a future release.
diff --git a/spec/classes/heat_engine_spec.rb b/spec/classes/heat_engine_spec.rb
index 1b628afa..1e03ab22 100644
--- a/spec/classes/heat_engine_spec.rb
+++ b/spec/classes/heat_engine_spec.rb
@@ -10,7 +10,6 @@ describe 'heat::engine' do
       :heat_waitcondition_server_url       => 'http://127.0.0.1:8000/v1/waitcondition',
       :engine_life_check_timeout           => '<SERVICE DEFAULT>',
       :trusts_delegated_roles              => '<SERVICE DEFAULT>',
-      :deferred_auth_method                => '<SERVICE DEFAULT>',
       :default_software_config_transport   => '<SERVICE DEFAULT>',
       :default_deployment_signal_transport => '<SERVICE DEFAULT>',
       :default_user_data_format            => '<SERVICE DEFAULT>',