openstack
/
puppet-ec2api
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: Ia27a94e1867142b898f85460b17d38e9668454ca
Depends-On: https://review.opendev.org/656106/
Closes-Bug: #1826692
This commit is contained in:
ZhongShengping 2019-04-28 15:00:07 +08:00
parent f1a2ba8859
commit 43bd2960d2
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

@ -13,7 +13,7 @@
# Url used to connect to database.
# (Optional) Defaults to "sqlite:////var/lib/ec2api/ec2api.sqlite".
#
# [*database_idle_timeout*]
# [*database_connection_recycle_time*]
# Timeout when db connections should be reaped.
# (Optional) Defaults to $::os_service_default
#
@ -42,16 +42,24 @@
# (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 ec2api::db (
$database_connection = 'sqlite:////var/lib/ec2api/ec2api.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/ec2api/ec2api.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 ::ec2api::deps
@ -59,16 +67,22 @@ class ec2api::db (
validate_legacy(Oslo::Dbconn, 'validate_re', $database_connection,
['^(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 { 'ec2api_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,
}
}

4
releasenotes/notes/deprecate_idle_timeout_parameter-843bf248f6d17e32.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/ec2api_db_spec.rb
View File

@ -6,45 +6,45 @@ describe 'ec2api::db' do
it { should contain_class('ec2api::deps') }
it { should contain_oslo__db('ec2api_config').with(
:connection => 'sqlite:////var/lib/ec2api/ec2api.sqlite',
:idle_timeout => '<SERVICE DEFAULT>',
:min_pool_size => '<SERVICE DEFAULT>',
:db_max_retries => '<SERVICE DEFAULT>',
:max_retries => '<SERVICE DEFAULT>',
:retry_interval => '<SERVICE DEFAULT>',
:max_pool_size => '<SERVICE DEFAULT>',
:max_overflow => '<SERVICE DEFAULT>',
:pool_timeout => '<SERVICE DEFAULT>',
:connection => 'sqlite:////var/lib/ec2api/ec2api.sqlite',
:connection_recycle_time => '<SERVICE DEFAULT>',
:min_pool_size => '<SERVICE DEFAULT>',
:db_max_retries => '<SERVICE DEFAULT>',
:max_retries => '<SERVICE DEFAULT>',
:retry_interval => '<SERVICE DEFAULT>',
:max_pool_size => '<SERVICE DEFAULT>',
:max_overflow => '<SERVICE DEFAULT>',
:pool_timeout => '<SERVICE DEFAULT>',
)}
end
context 'with specific parameters' do
let :params do
{
:database_connection => 'sqlite:////path/to/my/db.sqlite',
:database_idle_timeout => '1',
:database_min_pool_size => '2',
:database_db_max_retries => '-1',
:database_max_retries => '3',
:database_retry_interval => '4',
:database_max_pool_size => '5',
:database_max_overflow => '6',
:database_pool_timeout => '7',
:database_connection => 'sqlite:////path/to/my/db.sqlite',
:database_connection_recycle_time => '1',
:database_min_pool_size => '2',
:database_db_max_retries => '-1',
:database_max_retries => '3',
:database_retry_interval => '4',
:database_max_pool_size => '5',
:database_max_overflow => '6',
:database_pool_timeout => '7',
}
end
it { should contain_class('ec2api::deps') }
it { should contain_oslo__db('ec2api_config').with(
:connection => 'sqlite:////path/to/my/db.sqlite',
:idle_timeout => '1',
:min_pool_size => '2',
:db_max_retries => '-1',
:max_retries => '3',
:retry_interval => '4',
:max_pool_size => '5',
:max_overflow => '6',
:pool_timeout => '7',
:connection => 'sqlite:////path/to/my/db.sqlite',
:connection_recycle_time => '1',
:min_pool_size => '2',
:db_max_retries => '-1',
:max_retries => '3',
:retry_interval => '4',
:max_pool_size => '5',
:max_overflow => '6',
:pool_timeout => '7',
)}
end
end