class Chef::Provider::Cron
Constants
- CRON_ATTRIBUTES
- CRON_PATTERN
- ENVIRONMENT_PROPERTIES
- ENV_PATTERN
- SPECIAL_PATTERN
- SPECIAL_TIME_VALUES
- Solaris
Just to create an alias so 'Chef::Provider::Cron::Solaris' is exposed and accessible to existing consumers of class.
- WEEKDAY_SYMBOLS
Attributes
cron_empty[RW]
cron_exists[RW]
Public Class Methods
new(new_resource, run_context)
click to toggle source
Calls superclass method
Chef::Provider::new
# File lib/chef/provider/cron.rb, line 37 def initialize(new_resource, run_context) super(new_resource, run_context) @cron_exists = false @cron_empty = false end
Public Instance Methods
action_create()
click to toggle source
# File lib/chef/provider/cron.rb, line 98 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
action_delete()
click to toggle source
# File lib/chef/provider/cron.rb, line 158 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
cron_different?()
click to toggle source
# File lib/chef/provider/cron.rb, line 92 def cron_different? CRON_ATTRIBUTES.any? do |cron_var| new_resource.send(cron_var) != current_resource.send(cron_var) end end
load_current_resource()
click to toggle source
# File lib/chef/provider/cron.rb, line 44 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
Private Instance Methods
get_crontab_entry()
click to toggle source
# File lib/chef/provider/cron.rb, line 218 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
read_crontab()
click to toggle source
# File lib/chef/provider/cron.rb, line 203 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
set_environment_var(attr_name, attr_value)
click to toggle source
# File lib/chef/provider/cron.rb, line 195 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
weekday_in_crontab()
click to toggle source
# File lib/chef/provider/cron.rb, line 246 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
write_crontab(crontab)
click to toggle source
# File lib/chef/provider/cron.rb, line 211 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