From 4ad8b2ce95310c93a7fcae5277f7966133388fb5 Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Wed, 8 Mar 2017 16:44:14 +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: Ibd0ae9f702bdc740948d7530ab5729ec80c4ce2a
Closes-Bug: #1668732
---
 manifests/api.pp                              | 19 ++++++++++++++++---
 ...re_package_parameter-71a2359813d234ef.yaml |  4 ++++
 2 files changed, 20 insertions(+), 3 deletions(-)
 create mode 100644 releasenotes/notes/deprecate_ensure_package_parameter-71a2359813d234ef.yaml

diff --git a/manifests/api.pp b/manifests/api.pp
index 990ec34b..38b6cd5b 100644
--- a/manifests/api.pp
+++ b/manifests/api.pp
@@ -5,7 +5,7 @@
 #
 # === Parameters
 #
-# [*ensure_package*]
+# [*package_ensure*]
 #   (optional) The state of barbican packages
 #   Defaults to 'present'
 #
@@ -249,8 +249,12 @@
 #   (optional) The RabbitMQ virtual host.
 #   Defaults to $::os_service_default
 #
+# [*ensure_package*]
+#   (optional) The state of barbican packages
+#   Defaults to undef
+#
 class barbican::api (
-  $ensure_package                                = 'present',
+  $package_ensure                                = 'present',
   $client_package_ensure                         = 'present',
   $bind_host                                     = '0.0.0.0',
   $bind_port                                     = '9311',
@@ -304,6 +308,7 @@ class barbican::api (
   $rabbit_port                                   = $::os_service_default,
   $rabbit_userid                                 = $::os_service_default,
   $rabbit_virtual_host                           = $::os_service_default,
+  $ensure_package                                = undef,
 ) inherits barbican::params {
 
 
@@ -323,6 +328,14 @@ barbican::rabbit_port, barbican::rabbit_userid and barbican::rabbit_virtual_host
 deprecated. Please use barbican::default_transport_url instead.")
   }
 
+  if $ensure_package {
+    warning("barbican::api::ensure_package is deprecated and will be removed in \
+the future release. Please use barbican::api::package_ensure instead.")
+    $package_ensure_real = $ensure_package
+  } else {
+    $package_ensure_real = $package_ensure
+  }
+
   # TODO: Remove the posix users and permissions and merge this definition
   # with the previous one, once the barbican package has been updated
   # with the correct ownership for this directory.
@@ -336,7 +349,7 @@ deprecated. Please use barbican::default_transport_url instead.")
   }
 
   package { 'barbican-api':
-    ensure => $ensure_package,
+    ensure => $package_ensure_real,
     name   => $::barbican::params::api_package_name,
     tag    => ['openstack', 'barbican-package'],
   }
diff --git a/releasenotes/notes/deprecate_ensure_package_parameter-71a2359813d234ef.yaml b/releasenotes/notes/deprecate_ensure_package_parameter-71a2359813d234ef.yaml
new file mode 100644
index 00000000..98cd4800
--- /dev/null
+++ b/releasenotes/notes/deprecate_ensure_package_parameter-71a2359813d234ef.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - barbican::api::ensure_package is now deprecated and will be removed
+    in the future release. Please use barbican::api::package_ensure instead.