1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
#
# Author:: Bryan McLellan (btm@loftninjas.org)
# Copyright:: Copyright 2009-2016, Bryan McLellan
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require_relative "../log"
require_relative "../provider"
class Chef
class Provider
class Cron < Chef::Provider
provides :cron, os: ["!aix", "!solaris2"]
SPECIAL_TIME_VALUES = [:reboot, :yearly, :annually, :monthly, :weekly, :daily, :midnight, :hourly].freeze
CRON_ATTRIBUTES = [:minute, :hour, :day, :month, :weekday, :time, :command, :mailto, :path, :shell, :home, :environment].freeze
WEEKDAY_SYMBOLS = [:sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday].freeze
CRON_PATTERN = /\A([-0-9*,\/]+)\s([-0-9*,\/]+)\s([-0-9*,\/]+)\s([-0-9*,\/]+|[a-zA-Z]{3})\s([-0-9*,\/]+|[a-zA-Z]{3})\s(.*)/.freeze
SPECIAL_PATTERN = /\A(@(#{SPECIAL_TIME_VALUES.join('|')}))\s(.*)/.freeze
ENV_PATTERN = /\A(\S+)=(\S*)/.freeze
ENVIRONMENT_PROPERTIES = %w{MAILTO PATH SHELL HOME}.freeze
def initialize(new_resource, run_context)
super(new_resource, run_context)
@cron_exists = false
@cron_empty = false
end
attr_accessor :cron_exists, :cron_empty
def load_current_resource
crontab_lines = []
@current_resource = Chef::Resource::Cron.new(new_resource.name)
current_resource.user(new_resource.user)
@cron_exists = false
if crontab = read_crontab
cron_found = false
crontab.each_line do |line|
case line.chomp
when "# Chef Name: #{new_resource.name}"
logger.trace("Found cron '#{new_resource.name}'")
cron_found = true
@cron_exists = true
next
when ENV_PATTERN
set_environment_var($1, $2) if cron_found
next
when SPECIAL_PATTERN
if cron_found
current_resource.time($2.to_sym)
current_resource.command($3)
cron_found = false
end
when CRON_PATTERN
if cron_found
current_resource.minute($1)
current_resource.hour($2)
current_resource.day($3)
current_resource.month($4)
current_resource.weekday($5)
current_resource.command($6)
cron_found = false
end
next
else
cron_found = false # We've got a Chef comment with no following crontab line
next
end
end
logger.trace("Cron '#{new_resource.name}' not found") unless @cron_exists
else
logger.trace("Cron empty for '#{new_resource.user}'")
@cron_empty = true
end
current_resource
end
def cron_different?
CRON_ATTRIBUTES.any? do |cron_var|
new_resource.send(cron_var) != current_resource.send(cron_var)
end
end
def action_create
crontab = ""
newcron = ""
cron_found = false
newcron = get_crontab_entry
if @cron_exists
unless cron_different?
logger.trace("Skipping existing cron entry '#{new_resource.name}'")
return
end
read_crontab.each_line do |line|
case line.chomp
when "# Chef Name: #{new_resource.name}"
cron_found = true
next
when ENV_PATTERN
crontab << line unless cron_found
next
when SPECIAL_PATTERN
if cron_found
cron_found = false
crontab << newcron
next
end
when CRON_PATTERN
if cron_found
cron_found = false
crontab << newcron
next
end
else
if cron_found # We've got a Chef comment with no following crontab line
crontab << newcron
cron_found = false
end
end
crontab << line
end
# Handle edge case where the Chef comment is the last line in the current crontab
crontab << newcron if cron_found
converge_by("update crontab entry for #{new_resource}") do
write_crontab crontab
logger.info("#{new_resource} updated crontab entry")
end
else
crontab = read_crontab unless @cron_empty
crontab << newcron
converge_by("add crontab entry for #{new_resource}") do
write_crontab crontab
logger.info("#{new_resource} added crontab entry")
end
end
end
def action_delete
if @cron_exists
crontab = ""
cron_found = false
read_crontab.each_line do |line|
case line.chomp
when "# Chef Name: #{new_resource.name}"
cron_found = true
next
when ENV_PATTERN
next if cron_found
when SPECIAL_PATTERN
if cron_found
cron_found = false
next
end
when CRON_PATTERN
if cron_found
cron_found = false
next
end
else
# We've got a Chef comment with no following crontab line
cron_found = false
end
crontab << line
end
description = cron_found ? "remove #{new_resource.name} from crontab" : "save unmodified crontab"
converge_by(description) do
write_crontab crontab
logger.info("#{new_resource} deleted crontab entry")
end
end
end
private
def set_environment_var(attr_name, attr_value)
if ENVIRONMENT_PROPERTIES.include?(attr_name)
current_resource.send(attr_name.downcase.to_sym, attr_value.gsub(/^"|"$/, ""))
else
current_resource.environment(current_resource.environment.merge(attr_name => attr_value))
end
end
def read_crontab
so = shell_out!("crontab -l -u #{new_resource.user}", returns: [0, 1])
return nil if so.exitstatus == 1
so.stdout
rescue => e
raise Chef::Exceptions::Cron, "Error determining state of #{new_resource.name}, error: #{e}"
end
def write_crontab(crontab)
write_exception = false
so = shell_out!("crontab -u #{new_resource.user} -", input: crontab)
rescue => e
raise Chef::Exceptions::Cron, "Error updating state of #{new_resource.name}, error: #{e}"
end
def get_crontab_entry
newcron = ""
newcron << "# Chef Name: #{new_resource.name}\n"
[ :mailto, :path, :shell, :home ].each do |v|
newcron << "#{v.to_s.upcase}=\"#{new_resource.send(v)}\"\n" if new_resource.send(v)
end
new_resource.environment.each do |name, value|
if ENVIRONMENT_PROPERTIES.include?(name)
unless new_resource.property_is_set?(name.downcase)
logger.warn("#{new_resource.name}: the environment property contains the '#{name}' variable, which should be set separately as a property.")
new_resource.send(name.downcase.to_sym, value.gsub(/^"|"$/, ""))
new_resource.environment.delete(name)
newcron << "#{name.to_s.upcase}=\"#{value}\"\n"
else
raise Chef::Exceptions::Cron, "#{new_resource.name}: the '#{name}' property is set and environment property also contains the '#{name}' variable. Remove the variable from the environment property."
end
else
newcron << "#{name}=#{value}\n"
end
end
if new_resource.time
newcron << "@#{new_resource.time} #{new_resource.command}\n"
else
newcron << "#{new_resource.minute} #{new_resource.hour} #{new_resource.day} #{new_resource.month} #{new_resource.weekday} #{new_resource.command}\n"
end
newcron
end
def weekday_in_crontab
weekday_in_crontab = WEEKDAY_SYMBOLS.index(new_resource.weekday)
if weekday_in_crontab.nil?
new_resource.weekday
else
weekday_in_crontab.to_s
end
end
end
end
end
|
