chef 14.15.6 → 18.1.0

data/lib/chef/resource/kernel_module.rb

@@ -3,94 +3,123 @@
 #
 # The MIT License (MIT)
 #
-# Copyright 2016-2018, Shopify Inc.
-# Copyright 2018, Chef Software, Inc.
+# Copyright:: 2016-2018, Shopify Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class KernelModule < Chef::Resource
-      preview_resource true
-      resource_name :kernel_module
 
-      description "Use the kernel_module resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, install, and uninstall modules."
+      provides :kernel_module
+
+      description "Use the **kernel_module** resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, enable, install, and uninstall modules."
       introduced "14.3"
       examples <<~DOC
         Install and load a kernel module, and ensure it loads on reboot.
+
         ```ruby
         kernel_module 'loop'
         ```
+
         Install and load a kernel with a specific set of options, and ensure it loads on reboot. Consult kernel module
         documentation for specific options that are supported.
+
         ```ruby
         kernel_module 'loop' do
           options [
             'max_loop=4',
-            'max_part=8'
+            'max_part=8',
           ]
         end
         ```
+
         Load a kernel module.
+
         ```ruby
         kernel_module 'loop' do
           action :load
         end
         ```
-        Unload a kernel module and remove module config, so it doesn’t load on reboot.
+
+        Unload a kernel module and remove module config, so it doesn't load on reboot.
+
         ```ruby
         kernel_module 'loop' do
           action :uninstall
         end
         ```
+
         Unload kernel module.
+
         ```ruby
         kernel_module 'loop' do
           action :unload
         end
         ```
+
         Blacklist a module from loading.
+
         ```ruby
         kernel_module 'loop' do
           action :blacklist
         end
         ```
-        Disable a kernel module.
+
+        Disable a kernel module so that it is not installable.
+
         ```ruby
         kernel_module 'loop' do
           action :disable
         end
         ```
+
+        Enable a kernel module so that it is can be installed.  Does not load or install.
+
+        ```ruby
+        kernel_module 'loop' do
+          action :enable
+        end
+        ```
       DOC
 
       property :modname, String,
-               description: "An optional property to set the kernel module name if it differs from the resource block's name.",
-               name_property: true, identity: true
+        description: "An optional property to set the kernel module name if it differs from the resource block's name.",
+        name_property: true
 
       property :options, Array,
         description: "An optional property to set options for the kernel module.",
-        introduced: "14.15"
+        introduced: "15.4"
 
       property :load_dir, String,
-               description: "The directory to load modules from.",
-               default: "/etc/modules-load.d"
+        description: "The directory to load modules from.",
+        default: "/etc/modules-load.d"
 
       property :unload_dir, String,
-               description: "The modprobe.d directory.",
-               default: "/etc/modprobe.d"
+        description: "The modprobe.d directory.",
+        default: "/etc/modprobe.d"
+
+      action :install, description: "Load kernel module, and ensure it loads on reboot." do
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
+        end
 
-      action :install do
-        description "Load kernel module, and ensure it loads on reboot."
+        # Remove the "disable file" before trying to install
+        action_enable
 
         # create options file before loading the module
         unless new_resource.options.nil?
           file "#{new_resource.unload_dir}/options_#{new_resource.modname}.conf" do
             content "options #{new_resource.modname} #{new_resource.options.join(" ")}\n"
-          end.run_action(:create)
+          end
         end
 
         # load the module first before installing
-        new_resource.run_action(:load)
+        action_load
 
         directory new_resource.load_dir do
           recursive true
@@ -100,17 +129,15 @@ class Chef
           content "#{new_resource.modname}\n"
           notifies :run, "execute[update initramfs]", :delayed
         end
+      end
 
+      action :uninstall, description: "Unload a kernel module and remove module config, so it doesn't load on reboot." do
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
             action :nothing
           end
         end
-      end
-
-      action :uninstall do
-        description "Unload a kernel module and remove module config, so it doesn't load on reboot."
 
         file "#{new_resource.load_dir}/#{new_resource.modname}.conf" do
           action :delete
@@ -126,6 +153,10 @@ class Chef
           action :delete
         end
 
+        action_unload
+      end
+
+      action :blacklist, description: "Blacklist a kernel module." do
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
@@ -133,17 +164,15 @@ class Chef
           end
         end
 
-        new_resource.run_action(:unload)
-      end
-
-      action :blacklist do
-        description "Blacklist a kernel module."
-
         file "#{new_resource.unload_dir}/blacklist_#{new_resource.modname}.conf" do
           content "blacklist #{new_resource.modname}"
           notifies :run, "execute[update initramfs]", :delayed
         end
 
+        action_unload
+      end
+
+      action :disable, description: "Disable a kernel module. **New in Chef Infra Client 15.2.**" do
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
@@ -151,12 +180,29 @@ class Chef
           end
         end
 
-        new_resource.run_action(:unload)
+        file "#{new_resource.unload_dir}/disable_#{new_resource.modname}.conf" do
+          content "install #{new_resource.modname} /bin/false"
+          notifies :run, "execute[update initramfs]", :delayed
+        end
+
+        action_unload
       end
 
-      action :load do
-        description "Load a kernel module."
+      action :enable, description: "Enable a kernel module.  Reverse :disable actions" do
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
+        end
 
+        file "#{new_resource.unload_dir}/disable_#{new_resource.modname}.conf" do
+          action :delete
+          notifies :run, "execute[update initramfs]", :delayed
+        end
+      end
+
+      action :load, description: "Load a kernel module." do
         unless module_loaded?
           converge_by("load kernel module #{new_resource.modname}") do
             shell_out!("modprobe #{new_resource.modname}")
@@ -164,9 +210,7 @@ class Chef
         end
       end
 
-      action :unload do
-        description "Unload kernel module."
-
+      action :unload, description: "Unload kernel module." do
         if module_loaded?
           converge_by("unload kernel module #{new_resource.modname}") do
             shell_out!("modprobe -r #{new_resource.modname}")

data/lib/chef/resource/ksh.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nolan Davidson (<nolan.davidson@gmail.com>)
-# Copyright:: Copyright 2015-2016, Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,17 +16,20 @@
 # limitations under the License.
 #
 
-require "chef/resource/script"
+require_relative "script"
 
 class Chef
   class Resource
     class Ksh < Chef::Resource::Script
-      description "Use the ksh resource to execute scripts using the Korn shell (ksh)"\
+
+      provides :ksh
+
+      description "Use the **ksh** resource to execute scripts using the Korn shell (ksh)"\
                   " interpreter. This resource may also use any of the actions and properties"\
-                  " that are available to the execute resource. Commands that are executed"\
+                  " that are available to the **execute** resource. Commands that are executed"\
                   " with this resource are (by their nature) not idempotent, as they are"\
-                  " typically unique to the environment in which they are run. Use not_if"\
-                  " and only_if to guard this resource for idempotence."
+                  " typically unique to the environment in which they are run. Use `not_if`"\
+                  " and `only_if` to guard this resource for idempotence."
       introduced "12.6"
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/launchd.rb

@@ -16,237 +16,241 @@
 # limitations under the License.
 #
 
-require "chef/resource"
+require_relative "../resource"
 
 class Chef
   class Resource
     class Launchd < Chef::Resource
-      resource_name :launchd
       provides :launchd
 
-      description "Use the launchd resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
+      description "Use the **launchd** resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
       introduced "12.8"
 
       default_action :create
       allowed_actions :create, :create_if_missing, :delete, :enable, :disable, :restart
 
       property :label, String,
-               identity: true, name_property: true,
-               description: "The unique identifier for the job."
+        name_property: true,
+        description: "The unique identifier for the job."
 
       property :backup, [Integer, FalseClass],
-               desired_state: false,
-               description: "The number of backups to be kept in /var/chef/backup. Set to false to prevent backups from being kept."
+        desired_state: false,
+        description: "The number of backups to be kept in `/var/chef/backup`. Set to `false` to prevent backups from being kept."
 
       property :cookbook, String,
-               desired_state: false,
-               description: "The name of the cookbook in which the source files are located."
+        desired_state: false,
+        description: "The name of the cookbook in which the source files are located."
 
       property :group, [String, Integer],
-               description: "When launchd is run as the root user, the group to run the job as. If the username property is specified and this property is not, this value is set to the default group for the user."
+        description: "When launchd is run as the root user, the group to run the job as. If the username property is specified and this property is not, this value is set to the default group for the user."
 
       property :plist_hash, Hash,
-               introduced: "12.19",
-               description: "A Hash of key value pairs used to create the launchd property list."
+        introduced: "12.19",
+        description: "A Hash of key value pairs used to create the launchd property list."
 
       property :mode, [String, Integer],
-               description: "A quoted 3-5 character string that defines the octal mode. For example: '755', '0755', or 00755."
+        description: "A quoted 3-5 character string that defines the octal mode. For example: '755', '0755', or 00755."
 
       property :owner, [String, Integer],
-               description: "A string or ID that identifies the group owner by user name, including fully qualified user names such as domain_user or user@domain. If this value is not specified, existing owners remain unchanged and new owner assignments use the current user (when necessary)."
+        description: "A string or ID that identifies the group owner by user name, including fully qualified user names such as domain_user or user@domain. If this value is not specified, existing owners remain unchanged and new owner assignments use the current user (when necessary)."
 
       property :path, String,
-               description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
+        description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
 
       property :source, String,
-               description: "The path to the launchd property list."
+        description: "The path to the launchd property list."
 
       property :session_type, String,
-               description: "The type of launchd plist to be created. Possible values: system (default) or user."
+        description: "The type of launchd plist to be created. Possible values: system (default) or user."
 
       # StartCalendarInterval has some gotchas so we coerce it to help sanity
       # check.  According to `man 5 launchd.plist`:
       #   StartCalendarInterval <dictionary of integers or array of dictionaries of integers>
       #     ... Missing arguments are considered to be wildcard.
-      # What the man page doesn't state, but what was observed (OSX 10.11.5, launchctrl v3.4.0)
+      # What the man page doesn't state, but what was observed (OSX 10.11.5, launchctl v3.4.0)
       # Is that keys that are specified, but invalid, will also be treated as a wildcard
       # this means that an entry like:
       #   { "Hour"=>0, "Weekday"=>"6-7"}
       # will not just run on midnight of Sat and Sun, rather it will run _every_ midnight.
       property :start_calendar_interval, [Hash, Array],
-               description: "A Hash (similar to crontab) that defines the calendar frequency at which a job is started or an Array.",
-               coerce: proc { |type|
-                         # Coerce into an array of hashes to make validation easier
-                         array = if type.is_a?(Array)
-                                   type
-                                 else
-                                   [type]
-                                 end
-
-                         # Check to make sure that our array only has hashes
-                         unless array.all? { |obj| obj.is_a?(Hash) }
-                           error_msg = "start_calendar_interval must be a single hash or an array of hashes!"
-                           raise Chef::Exceptions::ValidationFailed, error_msg
-                         end
-
-                         # Make sure the hashes don't have any incorrect keys/values
-                         array.each do |entry|
-                           allowed_keys = %w{Minute Hour Day Weekday Month}
-                           unless entry.keys.all? { |key| allowed_keys.include?(key) }
-                             failed_keys = entry.keys.reject { |k| allowed_keys.include?(k) }.join(", ")
-                             error_msg = "The following key(s): #{failed_keys} are invalid for start_calendar_interval, must be one of: #{allowed_keys.join(", ")}"
-                             raise Chef::Exceptions::ValidationFailed, error_msg
-                           end
-
-                           unless entry.values.all? { |val| val.is_a?(Integer) }
-                             failed_values = entry.values.reject { |val| val.is_a?(Integer) }.join(", ")
-                             error_msg = "Invalid value(s) (#{failed_values}) for start_calendar_interval item.  Values must be integers!"
-                             raise Chef::Exceptions::ValidationFailed, error_msg
-                           end
-                         end
-
-                         # Don't return array if we only have one entry
-                         if array.size == 1
-                           array.first
-                         else
-                           array
-                         end
-                       }
+        description: "A Hash (similar to crontab) that defines the calendar frequency at which a job is started or an Array.",
+        coerce: proc { |type|
+          # Coerce into an array of hashes to make validation easier
+          array = if type.is_a?(Array)
+                    type
+                  else
+                    [type]
+                  end
+
+          # Check to make sure that our array only has hashes
+          unless array.all?(Hash)
+            error_msg = "start_calendar_interval must be a single hash or an array of hashes!"
+            raise Chef::Exceptions::ValidationFailed, error_msg
+          end
+
+          # Make sure the hashes don't have any incorrect keys/values
+          array.each do |entry|
+            allowed_keys = %w{Minute Hour Day Weekday Month}
+            unless entry.keys.all? { |key| allowed_keys.include?(key) }
+              failed_keys = entry.keys.reject { |k| allowed_keys.include?(k) }.join(", ")
+              error_msg = "The following key(s): #{failed_keys} are invalid for start_calendar_interval, must be one of: #{allowed_keys.join(", ")}"
+              raise Chef::Exceptions::ValidationFailed, error_msg
+            end
+
+            unless entry.values.all?(Integer)
+              failed_values = entry.values.reject { |val| val.is_a?(Integer) }.join(", ")
+              error_msg = "Invalid value(s) (#{failed_values}) for start_calendar_interval item.  Values must be integers!"
+              raise Chef::Exceptions::ValidationFailed, error_msg
+            end
+          end
+
+          # Don't return array if we only have one entry
+          if array.size == 1
+            array.first
+          else
+            array
+          end
+        }
 
       property :type, String,
-               description: "The type of resource. Possible values: daemon (default), agent.",
-               default: "daemon", coerce: proc { |type|
-                                            type = type ? type.downcase : "daemon"
-                                            types = %w{daemon agent}
-
-                                            unless types.include?(type)
-                                              error_msg = "type must be daemon or agent"
-                                              raise Chef::Exceptions::ValidationFailed, error_msg
-                                            end
-                                            type
-                                          }
+        description: "The type of resource. Possible values: daemon (default), agent.",
+        default: "daemon", coerce: proc { |type|
+          type = type ? type.downcase : "daemon"
+          types = %w{daemon agent}
+
+          unless types.include?(type)
+            error_msg = "type must be daemon or agent"
+            raise Chef::Exceptions::ValidationFailed, error_msg
+          end
+          type
+        }
 
       # Apple LaunchD Keys
       property :abandon_process_group, [ TrueClass, FalseClass ],
-               description: "If a job dies, all remaining processes with the same process ID may be kept running. Set to true to kill all remaining processes."
+        description: "If a job dies, all remaining processes with the same process ID may be kept running. Set to true to kill all remaining processes."
+
+      property :associated_bundle_identifiers, Hash,
+        description: "This optional key indicates which bundles the Login Items Added by Apps panel associates with the helper executable."
 
       property :debug, [ TrueClass, FalseClass ],
-               description: "Sets the log mask to LOG_DEBUG for this job."
+        description: "Sets the log mask to `LOG_DEBUG` for this job."
 
       property :disabled, [ TrueClass, FalseClass ], default: false,
-               description: "Hints to launchctl to not submit this job to launchd."
+               description: "Hints to `launchctl` to not submit this job to launchd."
 
       property :enable_globbing, [ TrueClass, FalseClass ],
-               description: "Update program arguments before invocation."
+        description: "Update program arguments before invocation."
 
       property :enable_transactions, [ TrueClass, FalseClass ],
-               description: "Track in-progress transactions; if none, then send the SIGKILL signal."
+        description: "Track in-progress transactions; if none, then send the `SIGKILL` signal."
 
       property :environment_variables, Hash,
-               description: "Additional environment variables to set before running a job."
+        description: "Additional environment variables to set before running a job."
 
       property :exit_timeout, Integer,
-               description: "The amount of time (in seconds) launchd waits before sending a SIGKILL signal."
+        description: "The amount of time (in seconds) launchd waits before sending a `SIGKILL` signal."
 
       property :hard_resource_limits, Hash,
-               description: "A Hash of resource limits to be imposed on a job."
+        description: "A Hash of resource limits to be imposed on a job."
 
       property :inetd_compatibility, Hash,
-               description: "Specifies if a daemon expects to be run as if it were launched from inetd. Set to wait => true to pass standard input, output, and error file descriptors. Set to wait => false to call the accept system call on behalf of the job, and then pass standard input, output, and error file descriptors."
+        description: "Specifies if a daemon expects to be run as if it were launched from inetd. Set to `wait => true` to pass standard input, output, and error file descriptors. Set to `wait => false` to call the accept system call on behalf of the job, and then pass standard input, output, and error file descriptors."
 
       property :init_groups, [ TrueClass, FalseClass ],
-               description: "Specify if initgroups is called before running a job."
+        description: "Specify if `initgroups` is called before running a job."
 
       property :keep_alive, [ TrueClass, FalseClass, Hash ],
-               introduced: "12.14",
-               description: "Keep a job running continuously (true) or allow demand and conditions on the node to determine if the job keeps running (false)."
+        introduced: "12.14",
+        description: "Keep a job running continuously (true) or allow demand and conditions on the node to determine if the job keeps running (`false`)."
+
+      property :launch_events, [ Hash ],
+        introduced: "15.1",
+        description: "Specify higher-level event types to be used as launch-on-demand event sources."
 
       property :launch_only_once, [ TrueClass, FalseClass ],
-               description: "Specify if a job can be run only one time. Set this value to true if a job cannot be restarted without a full machine reboot."
+        description: "Specify if a job can be run only one time. Set this value to true if a job cannot be restarted without a full machine reboot."
 
       property :ld_group, String,
-               description: "The group name."
+        description: "The group name."
 
       property :limit_load_from_hosts, Array,
-               description: "An array of hosts to which this configuration file does not apply, i.e. 'apply this configuration file to all hosts not specified in this array'."
+        description: "An array of hosts to which this configuration file does not apply, i.e. 'apply this configuration file to all hosts not specified in this array'."
 
       property :limit_load_to_hosts, Array,
-               description: "An array of hosts to which this configuration file applies."
+        description: "An array of hosts to which this configuration file applies."
 
       property :limit_load_to_session_type, [ Array, String ],
-               description: "The session type(s) to which this configuration file applies."
+        description: "The session type(s) to which this configuration file applies."
 
       property :low_priority_io, [ TrueClass, FalseClass ],
-               description: "Specify if the kernel on the node should consider this daemon to be low priority during file system I/O."
+        description: "Specify if the kernel on the node should consider this daemon to be low priority during file system I/O."
 
       property :mach_services, Hash,
-               description: "Specify services to be registered with the bootstrap subsystem."
+        description: "Specify services to be registered with the bootstrap subsystem."
 
       property :nice, Integer,
-               description: "The program scheduling priority value in the range -20 to 20."
+        description: "The program scheduling priority value in the range -20 to 19.",
+        callbacks: { "should be a Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
 
       property :on_demand, [ TrueClass, FalseClass ],
-               description: "Keep a job alive. Only applies to macOS version 10.4 (and earlier); use keep_alive instead for newer versions."
+        description: "Keep a job alive. Only applies to macOS version 10.4 (and earlier); use `keep_alive` instead for newer versions."
 
       property :process_type, String,
-               description: "The intended purpose of the job: Adaptive, Background, Interactive, or Standard."
+        description: "The intended purpose of the job: `Adaptive`, `Background`, `Interactive`, or `Standard`."
 
       property :program, String,
-               description: "The first argument of execvp, typically the file name associated with the file to be executed. This value must be specified if program_arguments is not specified, and vice-versa."
+        description: "The first argument of `execvp`, typically the file name associated with the file to be executed. This value must be specified if `program_arguments` is not specified, and vice-versa."
 
       property :program_arguments, Array,
-               description: "The second argument of execvp. If program is not specified, this property must be specified and will be handled as if it were the first argument."
+        description: "The second argument of `execvp`. If program is not specified, this property must be specified and will be handled as if it were the first argument."
 
       property :queue_directories, Array,
-               description: "An array of non-empty directories which, if any are modified, will cause a job to be started."
+        description: "An array of non-empty directories which, if any are modified, will cause a job to be started."
 
       property :root_directory, String,
-               description: "chroot to this directory, and then run the job."
+        description: "`chroot` to this directory, and then run the job."
 
       property :run_at_load, [ TrueClass, FalseClass ],
-               description: "Launch a job once (at the time it is loaded)."
+        description: "Launch a job once (at the time it is loaded)."
 
       property :sockets, Hash,
-               description: "A Hash of on-demand sockets that notify launchd when a job should be run."
+        description: "A Hash of on-demand sockets that notify launchd when a job should be run."
 
       property :soft_resource_limits, Array,
-               description: "A Hash of resource limits to be imposed on a job."
+        description: "A Hash of resource limits to be imposed on a job."
 
       property :standard_error_path, String,
-               description: "The file to which standard error (stderr) is sent."
+        description: "The file to which standard error (`stderr`) is sent."
 
       property :standard_in_path, String,
-               description: "The file to which standard input (stdin) is sent."
+        description: "The file to which standard input (`stdin`) is sent."
 
       property :standard_out_path, String,
-               description: "The file to which standard output (stdout) is sent."
+        description: "The file to which standard output (`stdout`) is sent."
 
       property :start_interval, Integer,
-               description: "The frequency (in seconds) at which a job is started."
+        description: "The frequency (in seconds) at which a job is started."
 
       property :start_on_mount, [ TrueClass, FalseClass ],
-               description: "Start a job every time a file system is mounted."
+        description: "Start a job every time a file system is mounted."
 
       property :throttle_interval, Integer,
-               description: "The frequency (in seconds) at which jobs are allowed to spawn."
+        description: "The frequency (in seconds) at which jobs are allowed to spawn."
 
       property :time_out, Integer,
-               description: "The amount of time (in seconds) a job may be idle before it times out. If no value is specified, the default timeout value for launchd will be used."
-
-      property :umask, Integer,
-               description: "A decimal value to pass to umask before running a job."
+        description: "The amount of time (in seconds) a job may be idle before it times out. If no value is specified, the default timeout value for launchd will be used."
 
       property :username, String,
-               description: "When launchd is run as the root user, the user to run the job as."
+        description: "When launchd is run as the root user, the user to run the job as."
 
       property :wait_for_debugger, [ TrueClass, FalseClass ],
-               description: "Specify if launchd has a job wait for a debugger to attach before executing code."
+        description: "Specify if launchd has a job wait for a debugger to attach before executing code."
 
       property :watch_paths, Array,
-               description: "An array of paths which, if any are modified, will cause a job to be started."
+        description: "An array of paths which, if any are modified, will cause a job to be started."
 
       property :working_directory, String,
-               description: "Chdir to this directory, and then run the job."
+        description: "`chdir` to this directory, and then run the job."
     end
   end
 end