From e837bed3ff294879b2da19156e5f8cbfc40631bf Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Wed, 8 Mar 2017 17:09:33 +0800 Subject: [PATCH] Inconsistent package_ensure parameter name The parameter name used to enforce package state is inconsistent across manifests and modules. I settle on package_ensure since it's already widely used. Change-Id: I9868f954a032a0014b9304526daf5476b0922c5d Closes-Bug: #1668732 --- manifests/agent.pp | 2 +- manifests/api.pp | 2 +- manifests/central.pp | 2 +- manifests/generic_service.pp | 22 ++++++++++++++++--- manifests/mdns.pp | 2 +- manifests/sink.pp | 2 +- manifests/zone_manager.pp | 2 +- ...re_package_parameter-8a34ef9781df9735.yaml | 5 +++++ .../defines/designate_generic_service_spec.rb | 2 +- spec/shared_examples.rb | 2 +- 10 files changed, 32 insertions(+), 11 deletions(-) create mode 100644 releasenotes/notes/deprecate_ensure_package_parameter-8a34ef9781df9735.yaml diff --git a/manifests/agent.pp b/manifests/agent.pp index c559c574..05e20cfd 100644 --- a/manifests/agent.pp +++ b/manifests/agent.pp @@ -47,7 +47,7 @@ class designate::agent ( designate::generic_service { 'agent': enabled => $enabled, manage_service => $service_ensure, - ensure_package => $package_ensure, + package_ensure => $package_ensure, package_name => $agent_package_name, service_name => $::designate::params::agent_service_name, } diff --git a/manifests/api.pp b/manifests/api.pp index 8d7a798a..0d628b06 100644 --- a/manifests/api.pp +++ b/manifests/api.pp @@ -172,7 +172,7 @@ class designate::api ( designate::generic_service { 'api': enabled => $enabled, manage_service => $service_ensure, - ensure_package => $package_ensure, + package_ensure => $package_ensure, package_name => $api_package_name, service_name => $::designate::params::api_service_name, } diff --git a/manifests/central.pp b/manifests/central.pp index 94b9e99d..bf6ff166 100644 --- a/manifests/central.pp +++ b/manifests/central.pp @@ -78,7 +78,7 @@ class designate::central ( designate::generic_service { 'central': enabled => $enabled, manage_service => $service_ensure, - ensure_package => $package_ensure, + package_ensure => $package_ensure, package_name => $central_package_name, service_name => $::designate::params::central_service_name, } diff --git a/manifests/generic_service.pp b/manifests/generic_service.pp index 12912782..12ebbe42 100644 --- a/manifests/generic_service.pp +++ b/manifests/generic_service.pp @@ -27,16 +27,24 @@ # (optional) Manage or not the service (if a service_name is provided). # Defaults to true. # -# [*ensure_package*] +# [*package_ensure*] # (optional) Control the ensure parameter for the package ressource. # Defaults to 'present'. # +# DEPRECATED PARAMETERS +# +# [*ensure_package*] +# (optional) Control the ensure parameter for the package ressource. +# Defaults to undef. +# define designate::generic_service( $package_name, $service_name, $enabled = false, $manage_service = true, - $ensure_package = 'present' + $package_ensure = 'present', + # DEPRECATED PARAMETERS + $ensure_package = undef ) { include ::designate::deps @@ -46,10 +54,18 @@ define designate::generic_service( $designate_title = "designate-${name}" Exec['post-designate_config'] ~> Anchor['designate::service::end'] + if $ensure_package { + warning("designate::generic_service::ensure_package is deprecated and will be removed in \ +the future release. Please use designate::generic_service::package_ensure instead.") + $package_ensure_real = $ensure_package + } else { + $package_ensure_real = $package_ensure + } + if ($package_name) { if !defined(Package[$package_name]) { package { $designate_title: - ensure => $ensure_package, + ensure => $package_ensure_real, name => $package_name, notify => Service[$designate_title], tag => ['openstack', 'designate-package'], diff --git a/manifests/mdns.pp b/manifests/mdns.pp index 1c598ccf..888b0c7d 100644 --- a/manifests/mdns.pp +++ b/manifests/mdns.pp @@ -103,7 +103,7 @@ class designate::mdns ( designate::generic_service { 'mdns': enabled => $enabled, manage_service => $manage_service, - ensure_package => $package_ensure, + package_ensure => $package_ensure, package_name => $mdns_package_name, service_name => $::designate::params::mdns_service_name, } diff --git a/manifests/sink.pp b/manifests/sink.pp index b01fde8a..1be8c64a 100644 --- a/manifests/sink.pp +++ b/manifests/sink.pp @@ -39,7 +39,7 @@ class designate::sink ( designate::generic_service { 'sink': enabled => $enabled, manage_service => $service_ensure, - ensure_package => $package_ensure, + package_ensure => $package_ensure, package_name => $sink_package_name, service_name => $::designate::params::sink_service_name, } diff --git a/manifests/zone_manager.pp b/manifests/zone_manager.pp index caffdf9c..bef7c54f 100644 --- a/manifests/zone_manager.pp +++ b/manifests/zone_manager.pp @@ -55,7 +55,7 @@ class designate::zone_manager ( } designate::generic_service { 'zone-manager': - ensure_package => $package_ensure, + package_ensure => $package_ensure, enabled => $enabled, package_name => $package_name, manage_service => $service_ensure, diff --git a/releasenotes/notes/deprecate_ensure_package_parameter-8a34ef9781df9735.yaml b/releasenotes/notes/deprecate_ensure_package_parameter-8a34ef9781df9735.yaml new file mode 100644 index 00000000..1fb36226 --- /dev/null +++ b/releasenotes/notes/deprecate_ensure_package_parameter-8a34ef9781df9735.yaml @@ -0,0 +1,5 @@ +--- +deprecations: + - designate::generic_service::ensure_package is now + deprecated and will be removed in the future release. + Please use designate::generic_service::package_ensure instead. diff --git a/spec/defines/designate_generic_service_spec.rb b/spec/defines/designate_generic_service_spec.rb index 38be9548..4d4bae70 100644 --- a/spec/defines/designate_generic_service_spec.rb +++ b/spec/defines/designate_generic_service_spec.rb @@ -12,7 +12,7 @@ describe 'designate::generic_service' do :service_name => 'food', :enabled => true, :manage_service => true, - :ensure_package => 'latest', + :package_ensure => 'latest', } end diff --git a/spec/shared_examples.rb b/spec/shared_examples.rb index 9e7f9f2c..b1f10a23 100644 --- a/spec/shared_examples.rb +++ b/spec/shared_examples.rb @@ -25,7 +25,7 @@ shared_examples 'generic designate service' do |service| context 'with overridden parameters' do let :params do { :enabled => true, - :ensure_package => '2014.2-1' } + :package_ensure => '2014.2-1' } end it 'installs package and service' do