cron.rb

#
# Cookbook:: chef-client
# resource:: chef_client_cron
#
# Copyright:: 2020, Chef Software, Inc.
#
# 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.
#

chef_version_for_provides '< 16.0' if respond_to?(:chef_version_for_provides)

provides :chef_client_cron
resource_name :chef_client_cron

property :job_name, String, default: 'chef-client'
property :comment, String

property :user, String, default: 'root'

property :minute, [Integer, String], default: '0,30'
property :hour, [Integer, String], default: '*'
property :day, [Integer, String], default: '*'
property :month, [Integer, String], default: '*'
property :weekday, [Integer, String], default: '*'
property :splay, [Integer, String], default: 300,
                                    coerce: proc { |x| Integer(x) },
                                    callbacks: { 'should be a positive number' => proc { |v| v > 0 } }
property :mailto, String
property :accept_chef_license, [true, false], default: false

property :config_directory, String, default: '/etc/chef'
property :log_directory, String, default: lazy { platform?('mac_os_x') ? '/Library/Logs/Chef' : '/var/log/chef' }
property :log_file_name, String, default: 'client.log'
property :append_log_file, [true, false], default: true
property :chef_binary_path, String, default: '/opt/chef/bin/chef-client'
property :daemon_options, Array, default: []
property :environment, Hash, default: lazy { {} }

property :nice, [Integer, String],
coerce: proc { |x| Integer(x) },
callbacks: { 'should be an Integer between -20 and 19' => proc { |v| v >= -20 && v <= 19 } }

action :add do
  unless new_resource.log_directory.nil? || ::Dir.exist?(new_resource.log_directory)
    directory new_resource.log_directory do
      owner new_resource.user
      mode '0750'
      recursive true
    end
  end

  declare_resource(cron_resource_type, new_resource.job_name) do
    minute      new_resource.minute
    hour        new_resource.hour
    day         new_resource.day
    weekday     new_resource.weekday
    month       new_resource.month
    environment new_resource.environment
    mailto      new_resource.mailto if new_resource.mailto
    user        new_resource.user
    comment     new_resource.comment if new_resource.comment
    command     cron_command
  end
end

action :remove do
  declare_resource(cron_resource_type, new_resource.job_name) do
    action :delete
  end
end

action_class do
  #
  # The complete cron command to run
  #
  # @return [String]
  #
  def cron_command
    cmd = ''
    cmd << "/bin/sleep #{splay_sleep_time(new_resource.splay)}; "
    cmd << "#{which('nice')} -n #{new_resource.nice} " if new_resource.nice
    cmd << "#{new_resource.chef_binary_path} "
    cmd << "#{new_resource.daemon_options.join(' ')} " unless new_resource.daemon_options.empty?
    cmd << "-c #{::File.join(new_resource.config_directory, 'client.rb')} "
    cmd << '--chef-license accept ' if new_resource.accept_chef_license && Gem::Requirement.new('>= 14.12.9').satisfied_by?(Gem::Version.new(Chef::VERSION))
    cmd << log_command
    cmd << " || echo \"#{Chef::Dist::PRODUCT} execution failed\"" if new_resource.mailto
    cmd
  end

  #
  # The portion of the overall cron job that handles logging based on the append_log_file property
  #
  # @return [String]
  #
  def log_command
    if new_resource.append_log_file
      # Chef 15 and lower still sends output to stdout when -L is used
      if Gem::Requirement.new('< 16.0.0').satisfied_by?(Gem::Version.new(Chef::VERSION))
        ">> #{log_path} 2>&1"
      else
        "-L #{log_path}"
      end
    else
      "> #{log_path} 2>&1"
    end
  end

  #
  # The absolute log path location
  #
  # @return [String]
  #
  def log_path
    return new_resource.log_file_name if new_resource.log_directory.nil?
    ::File.join(new_resource.log_directory, new_resource.log_file_name)
  end

  #
  # The type of cron resource to run. Linux systems all support the /etc/cron.d directory
  # and can use the cron_d resource, but Solaris / AIX / FreeBSD need to use the crontab
  # via the legacy cron resource.
  #
  # @return [Symbol]
  #
  def cron_resource_type
    node['os'] == 'linux' ? :cron_d : :cron
  end
end