From 77e67abc75c2764451dc44e3cc1fc8b6173a12c3 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 3 Nov 2024 09:20:25 +0900
Subject: [PATCH] Add support for [cache] backend_expiration_time

Depends-on: https://review.opendev.org/933978
Change-Id: Ia4637623fcaff1600bbf72bb9fc65f5befe94b0d
---
 manifests/cache.pp                                         | 7 +++++++
 .../cache-backend-expiration-time-20dac67206ee9f16.yaml    | 4 ++++
 spec/classes/heat_cache_spec.rb                            | 3 +++
 3 files changed, 14 insertions(+)
 create mode 100644 releasenotes/notes/cache-backend-expiration-time-20dac67206ee9f16.yaml

diff --git a/manifests/cache.pp b/manifests/cache.pp
index a1c4573a..0478989d 100644
--- a/manifests/cache.pp
+++ b/manifests/cache.pp
@@ -18,6 +18,11 @@
 #   (integer value)
 #   Defaults to $facts['os_service_default']
 #
+# [*backend_expiration_time*]
+#   (Optional) Expiration time in cache backend to purge expired records
+#   automatically.
+#   Defaults to $facts['os_service_default']
+#
 # [*backend*]
 #   (Optional) Dogpile.cache backend module. It is recommended that
 #   Memcache with pooling (oslo_cache.memcache_pool) or Redis
@@ -242,6 +247,7 @@
 class heat::cache (
   $config_prefix                         = $facts['os_service_default'],
   $expiration_time                       = $facts['os_service_default'],
+  $backend_expiration_time               = $facts['os_service_default'],
   $backend                               = $facts['os_service_default'],
   $backend_argument                      = $facts['os_service_default'],
   $proxies                               = $facts['os_service_default'],
@@ -292,6 +298,7 @@ class heat::cache (
   oslo::cache { 'heat_config':
     config_prefix                        => $config_prefix,
     expiration_time                      => $expiration_time,
+    backend_expiration_time              => $backend_expiration_time,
     backend                              => $backend,
     backend_argument                     => $backend_argument,
     proxies                              => $proxies,
diff --git a/releasenotes/notes/cache-backend-expiration-time-20dac67206ee9f16.yaml b/releasenotes/notes/cache-backend-expiration-time-20dac67206ee9f16.yaml
new file mode 100644
index 00000000..58ceb961
--- /dev/null
+++ b/releasenotes/notes/cache-backend-expiration-time-20dac67206ee9f16.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    The new ``heat::cache::backend_expiration_time`` parameter has been added.
diff --git a/spec/classes/heat_cache_spec.rb b/spec/classes/heat_cache_spec.rb
index 418ed18c..03aa5045 100644
--- a/spec/classes/heat_cache_spec.rb
+++ b/spec/classes/heat_cache_spec.rb
@@ -13,6 +13,7 @@ describe 'heat::cache' do
         is_expected.to contain_oslo__cache('heat_config').with(
           :config_prefix                        => '<SERVICE DEFAULT>',
           :expiration_time                      => '<SERVICE DEFAULT>',
+          :backend_expiration_time              => '<SERVICE DEFAULT>',
           :backend                              => '<SERVICE DEFAULT>',
           :backend_argument                     => '<SERVICE DEFAULT>',
           :proxies                              => '<SERVICE DEFAULT>',
@@ -65,6 +66,7 @@ describe 'heat::cache' do
         {
           :config_prefix                         => 'prefix',
           :expiration_time                       => 3600,
+          :backend_expiration_time               => 7200,
           :backend                               => 'oslo_cache.memcache_pool',
           :proxies                               => ['proxy01:8888', 'proxy02:8888'],
           :enabled                               => true,
@@ -110,6 +112,7 @@ describe 'heat::cache' do
         is_expected.to contain_oslo__cache('heat_config').with(
           :config_prefix                        => 'prefix',
           :expiration_time                      => 3600,
+          :backend_expiration_time              => 7200,
           :backend                              => 'oslo_cache.memcache_pool',
           :backend_argument                     => '<SERVICE DEFAULT>',
           :proxies                              => ['proxy01:8888', 'proxy02:8888'],