Skip to content

Commit 5455568

Browse files
sheenaajaysheenaajay
authored
Merge pull request #1207 from aperto/master
Make backup success file path configurable
2 parents 870ce52 + 9e4d639 commit 5455568

File tree

6 files changed

+128
-97
lines changed

6 files changed

+128
-97
lines changed

‎manifests/backup/mysqlbackup.pp

+23-22
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,29 @@
44
# @api private
55
#
66
class mysql::backup::mysqlbackup (
7-
$backupuser = '',
8-
$backuppassword = '',
9-
$maxallowedpacket = '1M',
10-
$backupdir = '',
11-
$backupdirmode = '0700',
12-
$backupdirowner = 'root',
13-
$backupdirgroup = $mysql::params::root_group,
14-
$backupcompress = true,
15-
$backuprotate = 30,
16-
$backupmethod = '',
17-
$ignore_events = true,
18-
$delete_before_dump = false,
19-
$backupdatabases = [],
20-
$file_per_database = false,
21-
$include_triggers = true,
22-
$include_routines = false,
23-
$ensure = 'present',
24-
$time = ['23', '5'],
25-
$prescript = false,
26-
$postscript = false,
27-
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
28-
$optional_args = [],
7+
$backupuser = '',
8+
$backuppassword = '',
9+
$maxallowedpacket = '1M',
10+
$backupdir = '',
11+
$backupdirmode = '0700',
12+
$backupdirowner = 'root',
13+
$backupdirgroup = $mysql::params::root_group,
14+
$backupcompress = true,
15+
$backuprotate = 30,
16+
$backupmethod = '',
17+
$backup_success_file_path = undef,
18+
$ignore_events = true,
19+
$delete_before_dump = false,
20+
$backupdatabases = [],
21+
$file_per_database = false,
22+
$include_triggers = true,
23+
$include_routines = false,
24+
$ensure = 'present',
25+
$time = ['23', '5'],
26+
$prescript = false,
27+
$postscript = false,
28+
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
29+
$optional_args = [],
2930
) inherits mysql::params {
3031

3132
mysql_user { "${backupuser}@localhost":

‎manifests/backup/mysqldump.pp

+25-24
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,31 @@
33
# @api private
44
#
55
class mysql::backup::mysqldump (
6-
$backupuser = '',
7-
$backuppassword = '',
8-
$backupdir = '',
9-
$maxallowedpacket = '1M',
10-
$backupdirmode = '0700',
11-
$backupdirowner = 'root',
12-
$backupdirgroup = $mysql::params::root_group,
13-
$backupcompress = true,
14-
$backuprotate = 30,
15-
$backupmethod = 'mysqldump',
16-
$ignore_events = true,
17-
$delete_before_dump = false,
18-
$backupdatabases = [],
19-
$file_per_database = false,
20-
$include_triggers = false,
21-
$include_routines = false,
22-
$ensure = 'present',
23-
$time = ['23', '5'],
24-
$prescript = false,
25-
$postscript = false,
26-
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
27-
$optional_args = [],
28-
$mysqlbackupdir_ensure = 'directory',
29-
$mysqlbackupdir_target = undef,
6+
$backupuser = '',
7+
$backuppassword = '',
8+
$backupdir = '',
9+
$maxallowedpacket = '1M',
10+
$backupdirmode = '0700',
11+
$backupdirowner = 'root',
12+
$backupdirgroup = $mysql::params::root_group,
13+
$backupcompress = true,
14+
$backuprotate = 30,
15+
$backupmethod = 'mysqldump',
16+
$backup_success_file_path = undef,
17+
$ignore_events = true,
18+
$delete_before_dump = false,
19+
$backupdatabases = [],
20+
$file_per_database = false,
21+
$include_triggers = false,
22+
$include_routines = false,
23+
$ensure = 'present',
24+
$time = ['23', '5'],
25+
$prescript = false,
26+
$postscript = false,
27+
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
28+
$optional_args = [],
29+
$mysqlbackupdir_ensure = 'directory',
30+
$mysqlbackupdir_target = undef,
3031
) inherits mysql::params {
3132

3233
if $backupcompress {

‎manifests/server/backup.pp

+51-49
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@
3131
# @param backupcompress
3232
# Whether or not to compress the backup (when using the mysqldump provider)
3333
# @param backupmethod
34-
# The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup
34+
# The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup
35+
# @param backup_success_file_path
36+
# Specify a path where upon successfull backup a file should be created for checking purposes.
3537
# @param backuprotate
3638
# Backup rotation interval in 24 hour periods.
3739
# @param ignore_events
@@ -56,36 +58,36 @@
5658
# @param execpath
5759
# Allows you to set a custom PATH should your MySQL installation be non-standard places. Defaults to `/usr/bin:/usr/sbin:/bin:/sbin`.
5860
# @param provider
59-
# Sets the server backup implementation. Valid values are:
61+
# Sets the server backup implementation. Valid values are:
6062
# @param maxallowedpacket
6163
# Defines the maximum SQL statement size for the backup dump script. The default value is 1MB, as this is the default MySQL Server value.
6264
# @param optional_args
6365
# Specifies an array of optional arguments which should be passed through to the backup tool. (Supported by the xtrabackup and mysqldump providers.)
64-
#
6566
class mysql::server::backup (
66-
$backupuser = undef,
67-
$backuppassword = undef,
68-
$backupdir = undef,
69-
$backupdirmode = '0700',
70-
$backupdirowner = 'root',
71-
$backupdirgroup = 'root',
72-
$backupcompress = true,
73-
$backuprotate = 30,
74-
$backupmethod = undef,
75-
$ignore_events = true,
76-
$delete_before_dump = false,
77-
$backupdatabases = [],
78-
$file_per_database = false,
79-
$include_routines = false,
80-
$include_triggers = false,
81-
$ensure = 'present',
82-
$time = ['23', '5'],
83-
$prescript = false,
84-
$postscript = false,
85-
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
86-
$provider = 'mysqldump',
87-
$maxallowedpacket = '1M',
88-
$optional_args = [],
67+
$backupuser = undef,
68+
$backuppassword = undef,
69+
$backupdir = undef,
70+
$backupdirmode = '0700',
71+
$backupdirowner = 'root',
72+
$backupdirgroup = 'root',
73+
$backupcompress = true,
74+
$backuprotate = 30,
75+
$backupmethod = undef,
76+
$backup_success_file_path = '/tmp/mysqlbackup_success',
77+
$ignore_events = true,
78+
$delete_before_dump = false,
79+
$backupdatabases = [],
80+
$file_per_database = false,
81+
$include_routines = false,
82+
$include_triggers = false,
83+
$ensure = 'present',
84+
$time = ['23', '5'],
85+
$prescript = false,
86+
$postscript = false,
87+
$execpath = '/usr/bin:/usr/sbin:/bin:/sbin',
88+
$provider = 'mysqldump',
89+
$maxallowedpacket = '1M',
90+
$optional_args = [],
8991
) {
9092

9193
if $prescript and $provider =~ /(mysqldump|mysqlbackup)/ {
@@ -95,29 +97,29 @@
9597

9698
create_resources('class', {
9799
"mysql::backup::${provider}" => {
98-
'backupuser' => $backupuser,
99-
'backuppassword' => $backuppassword,
100-
'backupdir' => $backupdir,
101-
'backupdirmode' => $backupdirmode,
102-
'backupdirowner' => $backupdirowner,
103-
'backupdirgroup' => $backupdirgroup,
104-
'backupcompress' => $backupcompress,
105-
'backuprotate' => $backuprotate,
106-
'backupmethod' => $backupmethod,
107-
'ignore_events' => $ignore_events,
108-
'delete_before_dump' => $delete_before_dump,
109-
'backupdatabases' => $backupdatabases,
110-
'file_per_database' => $file_per_database,
111-
'include_routines' => $include_routines,
112-
'include_triggers' => $include_triggers,
113-
'ensure' => $ensure,
114-
'time' => $time,
115-
'prescript' => $prescript,
116-
'postscript' => $postscript,
117-
'execpath' => $execpath,
118-
'maxallowedpacket' => $maxallowedpacket,
119-
'optional_args' => $optional_args,
100+
'backupuser' => $backupuser,
101+
'backuppassword' => $backuppassword,
102+
'backupdir' => $backupdir,
103+
'backupdirmode' => $backupdirmode,
104+
'backupdirowner' => $backupdirowner,
105+
'backupdirgroup' => $backupdirgroup,
106+
'backupcompress' => $backupcompress,
107+
'backuprotate' => $backuprotate,
108+
'backupmethod' => $backupmethod,
109+
'backup_success_file_path' => $backup_success_file_path,
110+
'ignore_events' => $ignore_events,
111+
'delete_before_dump' => $delete_before_dump,
112+
'backupdatabases' => $backupdatabases,
113+
'file_per_database' => $file_per_database,
114+
'include_routines' => $include_routines,
115+
'include_triggers' => $include_triggers,
116+
'ensure' => $ensure,
117+
'time' => $time,
118+
'prescript' => $prescript,
119+
'postscript' => $postscript,
120+
'execpath' => $execpath,
121+
'maxallowedpacket' => $maxallowedpacket,
122+
'optional_args' => $optional_args,
120123
}
121124
})
122-
123125
}

‎spec/classes/mysql_server_backup_spec.rb

+27
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,33 @@ class { 'mysql::server': }
104104
end
105105
end
106106

107+
context 'with delete after dump' do
108+
let(:custom_params) do
109+
{
110+
'delete_before_dump' => false,
111+
}
112+
end
113+
let(:params) do
114+
default_params.merge!(custom_params)
115+
end
116+
117+
it { is_expected.to contain_file('mysqlbackup.sh').with_content(%r{touch /tmp/mysqlbackup_success}) }
118+
end
119+
120+
context 'with delete after dump and custom success file path' do
121+
let(:custom_params) do
122+
{
123+
'delete_before_dump' => false,
124+
'backup_success_file_path' => '/opt/mysqlbackup_success',
125+
}
126+
end
127+
let(:params) do
128+
default_params.merge!(custom_params)
129+
end
130+
131+
it { is_expected.to contain_file('mysqlbackup.sh').with_content(%r{touch /opt/mysqlbackup_success}) }
132+
end
133+
107134
context 'custom ownership and mode for backupdir' do
108135
let(:params) do
109136
{ backupdirmode: '0750',

‎templates/mysqlbackup.sh.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ done
111111
<% unless @delete_before_dump -%>
112112
if [ $? -eq 0 ] ; then
113113
cleanup
114-
touch /tmp/mysqlbackup_success
114+
touch <%= @backup_success_file_path %>
115115
fi
116116
<% end -%>
117117

‎templates/xtrabackup.sh.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ cleanup
5959
<% unless @delete_before_dump -%>
6060
if [ $? -eq 0 ] ; then
6161
cleanup
62-
touch /tmp/mysqlbackup_success
62+
touch <%= @backup_success_file_path %>
6363
fi
6464
<% end -%>
6565

0 commit comments

Comments
 (0)