From be05efdc44c488e36491c9653f4188364e9c0f4e Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Mon, 1 Nov 2021 20:18:34 +0900
Subject: [PATCH] Deprecate support for [api] middlewares

... because the parameter was deprecated in gnocchi 1.3.0[1] and was
removed in gnocchi 2.0.0[2].

[1] https://github.com/gnocchixyz/gnocchi/commit/7000300646f742216f63e09c0c105f2c737cc659
[2] https://github.com/gnocchixyz/gnocchi/commit/7e56cd671282c34f5f8c0efc215e2f1c77fe38a2

Change-Id: I7f52310b4f66813b30313d55a2d71ab3cf54493e
---
 manifests/api.pp                              | 19 ++++++++++++++-----
 ...cate-api-middlewares-20287ca86b384799.yaml |  5 +++++
 spec/classes/gnocchi_api_spec.rb              |  1 -
 3 files changed, 19 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-api-middlewares-20287ca86b384799.yaml

diff --git a/manifests/api.pp b/manifests/api.pp
index 2414953d..6ff24136 100644
--- a/manifests/api.pp
+++ b/manifests/api.pp
@@ -46,9 +46,11 @@
 #   (Optional) Set max request body size
 #   Defaults to $::os_service_default.
 #
+# DEPRECATED PARAMETERS
+#
 # [*middlewares*]
 #   (optional) Middlewares to use.
-#   Defaults to $::os_service_default
+#   Defaults to undef
 #
 class gnocchi::api (
   $manage_service               = true,
@@ -60,12 +62,20 @@ class gnocchi::api (
   $auth_strategy                = 'keystone',
   $enable_proxy_headers_parsing = $::os_service_default,
   $max_request_body_size        = $::os_service_default,
-  $middlewares                  = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $middlewares                  = undef,
 ) inherits gnocchi::params {
 
   include gnocchi::deps
   include gnocchi::policy
 
+  if $middlewares != undef {
+    warning('The gnocchi::api::middleware parameter is deprecated and has no effect')
+  }
+  gnocchi_config {
+    'api/middlewares': ensure => absent;
+  }
+
   package { 'gnocchi-api':
     ensure => $package_ensure,
     name   => $::gnocchi::params::api_package_name,
@@ -112,9 +122,8 @@ standalone service, or httpd for being run by a httpd server")
   }
 
   gnocchi_config {
-    'api/max_limit': value   => $max_limit;
-    'api/auth_mode': value   => $auth_strategy;
-    'api/middlewares': value => $middlewares;
+    'api/max_limit': value => $max_limit;
+    'api/auth_mode': value => $auth_strategy;
   }
 
   oslo::middleware { 'gnocchi_config':
diff --git a/releasenotes/notes/deprecate-api-middlewares-20287ca86b384799.yaml b/releasenotes/notes/deprecate-api-middlewares-20287ca86b384799.yaml
new file mode 100644
index 00000000..3313517a
--- /dev/null
+++ b/releasenotes/notes/deprecate-api-middlewares-20287ca86b384799.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``gnocchi::api::middlewares`` parameter has been deprecated and will be
+    removed in a future release. The parmaeter has no effect now.
diff --git a/spec/classes/gnocchi_api_spec.rb b/spec/classes/gnocchi_api_spec.rb
index 2da650f2..ebc2d274 100644
--- a/spec/classes/gnocchi_api_spec.rb
+++ b/spec/classes/gnocchi_api_spec.rb
@@ -60,7 +60,6 @@ describe 'gnocchi::api' do
     it 'configures gnocchi-api' do
       is_expected.to contain_gnocchi_config('api/max_limit').with_value( params[:max_limit] )
       is_expected.to contain_gnocchi_config('api/auth_mode').with_value('keystone')
-      is_expected.to contain_gnocchi_config('api/middlewares').with_value('<SERVICE DEFAULT>')
       is_expected.to contain_oslo__middleware('gnocchi_config').with(
         :enable_proxy_headers_parsing => '<SERVICE DEFAULT>',
         :max_request_body_size        => '<SERVICE DEFAULT>',