From e209161a6c7ba05bb30aa1f605d74f2f4806edf4 Mon Sep 17 00:00:00 2001
From: ZhongShengping <chdzsp@163.com>
Date: Mon, 23 Nov 2020 09:27:52 +0800
Subject: [PATCH] Allow db sync timeouts to be configurable

As Openstack projects continue to have longer database migration
chains, the Puppet default timeout of 300 seconds for an execution
is becoming too short a duration on some hardware, leading to timeouts.
As projects continue to add more migration scripts without pruning
the base, timeouts will continue to become more frequent unless
this time can be expanded.

Change-Id: I1c0896d9b729fe0d2aeeed02386b48fb9e6debe5
Closes-Bug: #1904962
---
 manifests/db/sync.pp                                       | 7 +++++++
 .../notes/add_db_sync_timeout-9c30cd6350a06ed9.yaml        | 3 +++
 spec/classes/barbican_db_sync_spec.rb                      | 7 ++++++-
 3 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/add_db_sync_timeout-9c30cd6350a06ed9.yaml

diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp
index 040de0db..7a74974d 100644
--- a/manifests/db/sync.pp
+++ b/manifests/db/sync.pp
@@ -13,9 +13,14 @@
 #   to the barbican-db-manage command.
 #   Defaults to undef
 #
+# [*db_sync_timeout*]
+#   (Optional) Timeout for the execution of the db_sync
+#   Defaults to 300
+#
 class barbican::db::sync(
   $extra_params              = undef,
   $secret_store_extra_params = undef,
+  $db_sync_timeout           = 300,
 ) {
 
   include barbican::deps
@@ -27,6 +32,7 @@ class barbican::db::sync(
     refreshonly => true,
     try_sleep   => 5,
     tries       => 10,
+    timeout     => $db_sync_timeout,
     logoutput   => on_failure,
     subscribe   => [
       Anchor['barbican::install::end'],
@@ -44,6 +50,7 @@ class barbican::db::sync(
     refreshonly => true,
     try_sleep   => 5,
     tries       => 10,
+    timeout     => $db_sync_timeout,
     logoutput   => on_failure,
     subscribe   => [
       Anchor['barbican::install::end'],
diff --git a/releasenotes/notes/add_db_sync_timeout-9c30cd6350a06ed9.yaml b/releasenotes/notes/add_db_sync_timeout-9c30cd6350a06ed9.yaml
new file mode 100644
index 00000000..233445f6
--- /dev/null
+++ b/releasenotes/notes/add_db_sync_timeout-9c30cd6350a06ed9.yaml
@@ -0,0 +1,3 @@
+---
+features:
+  - Adds db_sync_timeout parameter to db sync.
diff --git a/spec/classes/barbican_db_sync_spec.rb b/spec/classes/barbican_db_sync_spec.rb
index e2b28b7d..1c711e15 100644
--- a/spec/classes/barbican_db_sync_spec.rb
+++ b/spec/classes/barbican_db_sync_spec.rb
@@ -15,6 +15,7 @@ describe 'barbican::db::sync' do
         :try_sleep   => 5,
         :tries       => 10,
         :logoutput   => 'on_failure',
+        :timeout     => 300,
         :subscribe   => ['Anchor[barbican::install::end]',
                          'Anchor[barbican::config::end]',
                          'Anchor[barbican::dbsync::begin]'],
@@ -28,6 +29,7 @@ describe 'barbican::db::sync' do
         :refreshonly => 'true',
         :try_sleep   => 5,
         :tries       => 10,
+        :timeout     => 300,
         :logoutput   => 'on_failure',
         :subscribe   => ['Anchor[barbican::install::end]',
                          'Anchor[barbican::config::end]',
@@ -37,11 +39,12 @@ describe 'barbican::db::sync' do
       )
     end
 
-    describe "overriding extra_params" do
+    describe "overriding params" do
       let :params do
         {
           :extra_params              => '--config-file /etc/barbican/barbican.conf',
           :secret_store_extra_params => '--config-file /etc/barbican/barbican.conf',
+          :db_sync_timeout           => 750,
         }
       end
 
@@ -53,6 +56,7 @@ describe 'barbican::db::sync' do
           :refreshonly => 'true',
           :try_sleep   => 5,
           :tries       => 10,
+          :timeout     => 750,
           :logoutput   => 'on_failure',
           :subscribe   => ['Anchor[barbican::install::end]',
                          'Anchor[barbican::config::end]',
@@ -67,6 +71,7 @@ describe 'barbican::db::sync' do
           :refreshonly => 'true',
           :try_sleep   => 5,
           :tries       => 10,
+          :timeout     => 750,
           :logoutput   => 'on_failure',
           :subscribe   => ['Anchor[barbican::install::end]',
                            'Anchor[barbican::config::end]',