From 6f1d9da697a84dfda50a0219955a0190af7a88ac Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Sun, 28 Apr 2019 15:00:14 +0800 Subject: [PATCH] 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: I2326155b79bd5a5f7141520eb16f239485e04573 Depends-On: https://review.opendev.org/656106/ Closes-Bug: #1826692 --- manifests/db.pp | 52 +++++++++++------- ...le_timeout_parameter-b131e1bb6f927b3a.yaml | 4 ++ spec/classes/watcher_db_spec.rb | 54 +++++++++---------- 3 files changed, 64 insertions(+), 46 deletions(-) create mode 100644 releasenotes/notes/deprecate_idle_timeout_parameter-b131e1bb6f927b3a.yaml diff --git a/manifests/db.pp b/manifests/db.pp index 2fe574e..9c34ef1 100644 --- a/manifests/db.pp +++ b/manifests/db.pp @@ -8,7 +8,7 @@ # (Optional) Url used to connect to database. # Defaults to "sqlite:////var/lib/watcher/watcher.sqlite". # -# [*database_idle_timeout*] +# [*database_connection_recycle_time*] # (Optional) Timeout when db connections should be reaped. # Defaults to $::os_service_default # @@ -42,32 +42,46 @@ # (Optional) If set, use this value for pool_timeout with SQLAlchemy. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*database_idle_timeout*] +# Timeout when db connections should be reaped. +# Defaults to undef. +# class watcher::db ( - $database_connection = 'sqlite:////var/lib/watcher/watcher.sqlite', - $database_idle_timeout = $::os_service_default, - $database_min_pool_size = $::os_service_default, - $database_max_pool_size = $::os_service_default, - $database_db_max_retries = $::os_service_default, - $database_max_retries = $::os_service_default, - $database_retry_interval = $::os_service_default, - $database_max_overflow = $::os_service_default, - $database_pool_timeout = $::os_service_default, + $database_connection = 'sqlite:////var/lib/watcher/watcher.sqlite', + $database_connection_recycle_time = $::os_service_default, + $database_min_pool_size = $::os_service_default, + $database_max_pool_size = $::os_service_default, + $database_db_max_retries = $::os_service_default, + $database_max_retries = $::os_service_default, + $database_retry_interval = $::os_service_default, + $database_max_overflow = $::os_service_default, + $database_pool_timeout = $::os_service_default, + # DEPRECATED PARAMETERS + $database_idle_timeout = undef, ) { include ::watcher::deps + if $database_idle_timeout { + warning('The database_idle_timeout parameter is deprecated. Please use \ +database_connection_recycle_time instead.') + } + $database_connection_recycle_time_real = pick($database_idle_timeout, $database_connection_recycle_time) + validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection, ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) oslo::db { 'watcher_config': - connection => $database_connection, - idle_timeout => $database_idle_timeout, - min_pool_size => $database_min_pool_size, - db_max_retries => $database_db_max_retries, - max_retries => $database_max_retries, - retry_interval => $database_retry_interval, - max_pool_size => $database_max_pool_size, - max_overflow => $database_max_overflow, - pool_timeout => $database_pool_timeout, + connection => $database_connection, + connection_recycle_time => $database_connection_recycle_time_real, + min_pool_size => $database_min_pool_size, + db_max_retries => $database_db_max_retries, + max_retries => $database_max_retries, + retry_interval => $database_retry_interval, + max_pool_size => $database_max_pool_size, + max_overflow => $database_max_overflow, + pool_timeout => $database_pool_timeout, } } diff --git a/releasenotes/notes/deprecate_idle_timeout_parameter-b131e1bb6f927b3a.yaml b/releasenotes/notes/deprecate_idle_timeout_parameter-b131e1bb6f927b3a.yaml new file mode 100644 index 0000000..09e76c4 --- /dev/null +++ b/releasenotes/notes/deprecate_idle_timeout_parameter-b131e1bb6f927b3a.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. diff --git a/spec/classes/watcher_db_spec.rb b/spec/classes/watcher_db_spec.rb index c34579c..839f501 100644 --- a/spec/classes/watcher_db_spec.rb +++ b/spec/classes/watcher_db_spec.rb @@ -6,45 +6,45 @@ describe 'watcher::db' do it { should contain_class('watcher::deps') } it { should contain_oslo__db('watcher_config').with( - :db_max_retries => '', - :connection => 'sqlite:////var/lib/watcher/watcher.sqlite', - :idle_timeout => '', - :min_pool_size => '', - :max_pool_size => '', - :max_retries => '', - :retry_interval => '', - :max_overflow => '', - :pool_timeout => '', + :db_max_retries => '', + :connection => 'sqlite:////var/lib/watcher/watcher.sqlite', + :connection_recycle_time => '', + :min_pool_size => '', + :max_pool_size => '', + :max_retries => '', + :retry_interval => '', + :max_overflow => '', + :pool_timeout => '', )} end context 'with specific parameters' do let :params do { - :database_connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', - :database_idle_timeout => '3601', - :database_min_pool_size => '2', - :database_db_max_retries => '-1', - :database_max_retries => '11', - :database_retry_interval => '11', - :database_max_pool_size => '11', - :database_max_overflow => '21', - :database_pool_timeout => '21', + :database_connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', + :database_connection_recycle_time => '3601', + :database_min_pool_size => '2', + :database_db_max_retries => '-1', + :database_max_retries => '11', + :database_retry_interval => '11', + :database_max_pool_size => '11', + :database_max_overflow => '21', + :database_pool_timeout => '21', } end it { should contain_class('watcher::deps') } it { should contain_oslo__db('watcher_config').with( - :db_max_retries => '-1', - :connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', - :idle_timeout => '3601', - :min_pool_size => '2', - :max_pool_size => '11', - :max_retries => '11', - :retry_interval => '11', - :max_overflow => '21', - :pool_timeout => '21', + :db_max_retries => '-1', + :connection => 'mysql+pymysql://watcher:watcher@localhost/watcher', + :connection_recycle_time => '3601', + :min_pool_size => '2', + :max_pool_size => '11', + :max_retries => '11', + :retry_interval => '11', + :max_overflow => '21', + :pool_timeout => '21', )} end end