From 516c0e1ea4555a6212ac4e6d9039a4136a133e6b Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Wed, 8 Mar 2017 18:07:44 +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: I843bdc0b9f72b4758c19e6a8ddad1368c7d80977
Closes-Bug: #1668732
---
 manifests/init.pp                             | 22 ++++++++++++++++---
 ...re_package_parameter-12a9e89713d6791f.yaml |  4 ++++
 spec/classes/watcher_init_spec.rb             |  2 +-
 3 files changed, 24 insertions(+), 4 deletions(-)
 create mode 100644 releasenotes/notes/deprecate_ensure_package_parameter-12a9e89713d6791f.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 61025fc..6891ad7 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -33,7 +33,7 @@
 #   include amqp and zmq.
 #   Defaults to 'rabbit'.
 #
-# [*ensure_package*]
+# [*package_ensure*]
 #  (optional) Whether the watcher api package will be installed
 #  Defaults to 'present'
 #
@@ -300,6 +300,12 @@
 #   in the watcher config.
 #   Defaults to false.
 #
+# DEPRECATED PARAMETERS
+#
+# [*ensure_package*]
+#  (optional) Whether the watcher api package will be installed
+#  Defaults to undef
+#
 # === Authors
 #
 # Daniel Pawlik  <daniel.pawlik@corp.ovh.com>
@@ -313,7 +319,7 @@ class watcher (
   $neutron_client_api_version           = '2',
   $nova_client_api_version              = '2',
   $rpc_backend                          = 'rabbit',
-  $ensure_package                       = 'present',
+  $package_ensure                       = 'present',
   $rabbit_login_method                  = $::os_service_default,
   $rabbit_retry_interval                = $::os_service_default,
   $rabbit_retry_backoff                 = $::os_service_default,
@@ -372,6 +378,8 @@ class watcher (
   $notification_transport_url           = $::os_service_default,
   $notification_driver                  = $::os_service_default,
   $notification_topics                  = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $ensure_package                       = undef,
 ) {
 
   include ::openstacklib::openstackclient
@@ -382,8 +390,16 @@ class watcher (
   include ::watcher::db
   include ::watcher::logging
 
+  if $ensure_package {
+    warning("watcher::ensure_package is deprecated and will be removed in \
+the future release. Please use watcher::package_ensure instead.")
+    $package_ensure_real = $ensure_package
+  } else {
+    $package_ensure_real = $package_ensure
+  }
+
   package { 'watcher':
-    ensure => $ensure_package,
+    ensure => $package_ensure_real,
     name   => $::watcher::params::common_package_name,
     tag    => ['openstack', 'watcher-package'],
   }
diff --git a/releasenotes/notes/deprecate_ensure_package_parameter-12a9e89713d6791f.yaml b/releasenotes/notes/deprecate_ensure_package_parameter-12a9e89713d6791f.yaml
new file mode 100644
index 0000000..190e982
--- /dev/null
+++ b/releasenotes/notes/deprecate_ensure_package_parameter-12a9e89713d6791f.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - watcher::ensure_package is now deprecated and will be removed in the
+    future release. Please use watcher::package_ensure instead.
diff --git a/spec/classes/watcher_init_spec.rb b/spec/classes/watcher_init_spec.rb
index 4878fa0..5ea8c0c 100644
--- a/spec/classes/watcher_init_spec.rb
+++ b/spec/classes/watcher_init_spec.rb
@@ -65,7 +65,7 @@ describe 'watcher' do
           :kombu_compression                  => 'gzip',
           :notification_transport_url         => 'rabbit://rabbit_user:password@localhost:5673',
           :notification_topics                => 'notifications',
-          :ensure_package                     => '2012.1.1-15.el6',
+          :package_ensure                     => '2012.1.1-15.el6',
         }
       end
       it 'configures rabbit' do