Deprecate idle_timeout option

The idle_timeout parameter is deprecated, use connection_recycle_time
instead[1].

[1]https://review.opendev.org/#/c/334182/

Change-Id: I8022329f612925eaad1efe7d445e584170b04d14
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692

manifests/db.pp

@@ -8,7 +8,7 @@
 #   Url used to connect to database.
 #   (Optional) Defaults to 'sqlite:////var/lib/heat/heat.sqlite'.
 #
-# [*database_idle_timeout*]
+# [*database_connection_recycle_time*]
 #   Timeout when db connections should be reaped.
 #   (Optional) Defaults to $::os_service_default.
 #
@@ -46,9 +46,16 @@
 #   (Optional) Run db sync on nodes after connection setting has been set.
 #   Defaults to true
 #
+# DEPRECATED PARAMETERS
+#
+# [*database_idle_timeout*]
+#   Timeout when db connections should be reaped.
+#   Defaults to undef.
+#
+
 class heat::db (
   $database_connection              = 'sqlite:////var/lib/heat/heat.sqlite',
-  $database_idle_timeout   = $::os_service_default,
+  $database_connection_recycle_time = $::os_service_default,
   $database_min_pool_size           = $::os_service_default,
   $database_max_pool_size           = $::os_service_default,
   $database_max_retries             = $::os_service_default,
@@ -57,14 +64,21 @@ class heat::db (
   $database_pool_timeout            = $::os_service_default,
   $database_db_max_retries          = $::os_service_default,
   $sync_db                          = true,
+  # DEPRECATED PARAMETERS
+  $database_idle_timeout            = undef,
 ) {
 
   include ::heat::deps
 
+  if $database_idle_timeout {
+    warning('The database_idle_timeout parameter is deprecated. Please use \
+database_connection_recycle_time instead.')
+  }
+
   # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
   # to use heat::<myparam> if heat::db::<myparam> isn't specified.
   $database_connection_real = pick($::heat::database_connection, $database_connection)
-  $database_idle_timeout_real = pick($::heat::database_idle_timeout, $database_idle_timeout)
+  $database_connection_recycle_time_real = pick($::heat::database_idle_timeout, $database_idle_timeout, $database_connection_recycle_time)
   $database_min_pool_size_real = pick($::heat::database_min_pool_size, $database_min_pool_size)
   $database_max_pool_size_real = pick($::heat::database_max_pool_size, $database_max_pool_size)
   $database_max_retries_real = pick($::heat::database_max_retries, $database_max_retries)
@@ -77,7 +91,7 @@ class heat::db (
 
   oslo::db { 'heat_config':
     connection              => $database_connection_real,
-    idle_timeout   => $database_idle_timeout_real,
+    connection_recycle_time => $database_connection_recycle_time_real,
     min_pool_size           => $database_min_pool_size_real,
     max_pool_size           => $database_max_pool_size_real,
     max_retries             => $database_max_retries_real,

releasenotes/notes/deprecate_idle_timeout_parameter-9634c25458cd349b.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - database_idle_timeout is deprecated and will be removed in a future
+    release. Please use database_connection_recycle_time instead.

spec/classes/heat_db_spec.rb

@@ -8,7 +8,7 @@ describe 'heat::db' do
       it { should contain_oslo__db('heat_config').with(
         :db_max_retries          => '<SERVICE DEFAULT>',
         :connection              => 'sqlite:////var/lib/heat/heat.sqlite',
-        :idle_timeout   => '<SERVICE DEFAULT>',
+        :connection_recycle_time => '<SERVICE DEFAULT>',
         :min_pool_size           => '<SERVICE DEFAULT>',
         :max_pool_size           => '<SERVICE DEFAULT>',
         :max_retries             => '<SERVICE DEFAULT>',
@@ -24,7 +24,7 @@ describe 'heat::db' do
       let :params do
         {
           :database_connection              => 'mysql+pymysql://heat:heat@localhost/heat',
-          :database_idle_timeout   => '3601',
+          :database_connection_recycle_time => '3601',
           :database_min_pool_size           => '2',
           :database_max_pool_size           => '12',
           :database_max_retries             => '11',
@@ -41,7 +41,7 @@ describe 'heat::db' do
       it { should contain_oslo__db('heat_config').with(
         :db_max_retries          => '-1',
         :connection              => 'mysql+pymysql://heat:heat@localhost/heat',
-        :idle_timeout   => '3601',
+        :connection_recycle_time => '3601',
         :min_pool_size           => '2',
         :max_pool_size           => '12',
         :max_retries             => '11',