openstack
/
puppet-glare
Code Issues Proposed changes

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: Iad22c20436222db89d292c960688c97bc5265d4c
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692
This commit is contained in:
ZhongShengping 2019-04-28 15:00:09 +08:00
parent 4219400de7
commit 625ef78c6e
3 changed files with 64 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
manifests/db.pp
View File

@ -8,7 +8,7 @@
# (Optional) Url used to connect to database. # (Optional) Url used to connect to database.
# Defaults to 'sqlite:////var/lib/glare/glare.sqlite'. # Defaults to 'sqlite:////var/lib/glare/glare.sqlite'.
# #
# [*database_idle_timeout*] # [*database_connection_recycle_time*]
# (Optional) Timeout when db connections should be reaped. # (Optional) Timeout when db connections should be reaped.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
@ -42,16 +42,24 @@
# (Optional) If set, use this value for pool_timeout with SQLAlchemy. # (Optional) If set, use this value for pool_timeout with SQLAlchemy.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# DEPRECATED PARAMETERS
#
# [*database_idle_timeout*]
# Timeout when db connections should be reaped.
# Defaults to undef.
#
class glare::db ( class glare::db (
$database_connection = 'sqlite:////var/lib/glare/glare.sqlite', $database_connection = 'sqlite:////var/lib/glare/glare.sqlite',
$database_idle_timeout = $::os_service_default, $database_connection_recycle_time = $::os_service_default,
$database_min_pool_size = $::os_service_default, $database_min_pool_size = $::os_service_default,
$database_max_pool_size = $::os_service_default, $database_max_pool_size = $::os_service_default,
$database_db_max_retries = $::os_service_default, $database_db_max_retries = $::os_service_default,
$database_max_retries = $::os_service_default, $database_max_retries = $::os_service_default,
$database_retry_interval = $::os_service_default, $database_retry_interval = $::os_service_default,
$database_max_overflow = $::os_service_default, $database_max_overflow = $::os_service_default,
$database_pool_timeout = $::os_service_default, $database_pool_timeout = $::os_service_default,
# DEPRECATED PARAMETERS
$database_idle_timeout = undef,
) { ) {
include ::glare::deps include ::glare::deps
@ -59,15 +67,21 @@ class glare::db (
validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection, validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection,
['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?']) ['^(sqlite|mysql(\+pymysql)?|postgresql):\/\/(\S+:\S+@\S+\/\S+)?'])
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)
oslo::db { 'glare_config': oslo::db { 'glare_config':
connection => $database_connection, connection => $database_connection,
idle_timeout => $database_idle_timeout, connection_recycle_time => $database_connection_recycle_time_real,
min_pool_size => $database_min_pool_size, min_pool_size => $database_min_pool_size,
db_max_retries => $database_db_max_retries, db_max_retries => $database_db_max_retries,
max_retries => $database_max_retries, max_retries => $database_max_retries,
retry_interval => $database_retry_interval, retry_interval => $database_retry_interval,
max_pool_size => $database_max_pool_size, max_pool_size => $database_max_pool_size,
max_overflow => $database_max_overflow, max_overflow => $database_max_overflow,
pool_timeout => $database_pool_timeout, pool_timeout => $database_pool_timeout,
} }
} }

4
releasenotes/notes/deprecate_idle_timeout_parameter-bb16d5b5b4300b0f.yaml Normal file
View File

@ -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.

54
spec/classes/glare_db_spec.rb
View File

@ -6,45 +6,45 @@ describe 'glare::db' do
it { should contain_class('glare::deps') } it { should contain_class('glare::deps') }
it { should contain_oslo__db('glare_config').with( it { should contain_oslo__db('glare_config').with(
:db_max_retries => '<SERVICE DEFAULT>', :db_max_retries => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/glare/glare.sqlite', :connection => 'sqlite:////var/lib/glare/glare.sqlite',
:idle_timeout => '<SERVICE DEFAULT>', :connection_recycle_time => '<SERVICE DEFAULT>',
:min_pool_size => '<SERVICE DEFAULT>', :min_pool_size => '<SERVICE DEFAULT>',
:max_pool_size => '<SERVICE DEFAULT>', :max_pool_size => '<SERVICE DEFAULT>',
:max_retries => '<SERVICE DEFAULT>', :max_retries => '<SERVICE DEFAULT>',
:retry_interval => '<SERVICE DEFAULT>', :retry_interval => '<SERVICE DEFAULT>',
:max_overflow => '<SERVICE DEFAULT>', :max_overflow => '<SERVICE DEFAULT>',
:pool_timeout => '<SERVICE DEFAULT>', :pool_timeout => '<SERVICE DEFAULT>',
)} )}
end end
context 'with specific parameters' do context 'with specific parameters' do
let :params do let :params do
{ {
:database_connection => 'mysql+pymysql://glare:glare@localhost/glare', :database_connection => 'mysql+pymysql://glare:glare@localhost/glare',
:database_idle_timeout => '3601', :database_connection_recycle_time => '3601',
:database_min_pool_size => '2', :database_min_pool_size => '2',
:database_db_max_retries => '-1', :database_db_max_retries => '-1',
:database_max_retries => '11', :database_max_retries => '11',
:database_retry_interval => '11', :database_retry_interval => '11',
:database_max_pool_size => '11', :database_max_pool_size => '11',
:database_max_overflow => '21', :database_max_overflow => '21',
:database_pool_timeout => '21', :database_pool_timeout => '21',
} }
end end
it { should contain_class('glare::deps') } it { should contain_class('glare::deps') }
it { should contain_oslo__db('glare_config').with( it { should contain_oslo__db('glare_config').with(
:db_max_retries => '-1', :db_max_retries => '-1',
:connection => 'mysql+pymysql://glare:glare@localhost/glare', :connection => 'mysql+pymysql://glare:glare@localhost/glare',
:idle_timeout => '3601', :connection_recycle_time => '3601',
:min_pool_size => '2', :min_pool_size => '2',
:max_pool_size => '11', :max_pool_size => '11',
:max_retries => '11', :max_retries => '11',
:retry_interval => '11', :retry_interval => '11',
:max_overflow => '21', :max_overflow => '21',
:pool_timeout => '21', :pool_timeout => '21',
)} )}
end end
end end