chef 15.11.3-universal-mingw32 → 16.1.16-universal-mingw32

data/lib/chef/resource/cron_access.rb

@@ -23,27 +23,31 @@ require_relative "../resource"
 class Chef
   class Resource
     class CronAccess < Chef::Resource
-      resource_name :cron_access
+      unified_mode true
+      provides :cron_access
       provides(:cron_manage) # legacy name @todo in Chef 15 we should { true } this so it wins over the cookbook
 
       introduced "14.4"
-      description "Use the cron_access resource to manage the /etc/cron.allow and /etc/cron.deny files."
+      description "Use the **cron_access** resource to manage the /etc/cron.allow and /etc/cron.deny files. Note: This resource previously shipped in the `cron` cookbook as `cron_manage`, which it can still be used as for backwards compatibility with existing Chef Infra Client releases."
       examples <<~DOC
-        Add the mike user to cron.allow
+        **Add the mike user to cron.allow**
+
         ```ruby
         cron_access 'mike'
         ```
 
-        Add the mike user to cron.deny
+        **Add the mike user to cron.deny**
+
         ```ruby
         cron_access 'mike' do
           action :deny
         end
         ```
 
-        Specify the username with the user property
+        **Specify the username with the user property**
+
         ```ruby
-        cron_access 'Deny the tomcat access to cron for security purposes' do
+        cron_access 'Deny the jenkins user access to cron for security purposes' do
           user 'jenkins'
           action :deny
         end

data/lib/chef/resource/cron_d.rb

@@ -16,18 +16,21 @@
 #
 
 require_relative "../resource"
+require_relative "helpers/cron_validations"
 require "shellwords" unless defined?(Shellwords)
 require_relative "../dist"
 
 class Chef
   class Resource
     class CronD < Chef::Resource
-      resource_name :cron_d
+      unified_mode true
+      provides :cron_d
 
       introduced "14.4"
-      description "Use the cron_d resource to manage cron definitions in /etc/cron.d. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
+      description "Use the **cron_d** resource to manage cron job files in the /etc/cron.d directory. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
       examples <<~DOC
-        To run a program on the fifth hour of the day
+        **Run a program on the fifth hour of the day**
+
         ```ruby
         cron_d 'noop' do
           hour '5'
@@ -36,7 +39,8 @@ class Chef
         end
         ```
 
-        To run an entry if a folder exists
+        **Run an entry if a folder exists**
+
         ```ruby
         cron_d 'ganglia_tomcat_thread_max' do
           command "/usr/bin/gmetric
@@ -48,18 +52,21 @@ class Chef
         end
         ```
 
-        To run an entry every Saturday, 8:00 AM
+        **Run an entry every Saturday, 8:00 AM**
+
         ```ruby
         cron_d 'name_of_cron_entry' do
           minute '0'
           hour '8'
           weekday '6'
           mailto 'admin@example.com'
+          command "/bin/true"
           action :create
         end
         ```
 
-        To run an entry at 8:00 PM, every weekday (Monday through Friday), but only in November
+        **Run an entry at 8:00 PM, every weekday (Monday through Friday), but only in November**
+
         ```ruby
         cron_d 'name_of_cron_entry' do
           minute '0'
@@ -67,155 +74,97 @@ class Chef
           day '*'
           month '11'
           weekday '1-5'
+          command "/bin/true"
           action :create
         end
         ```
-      DOC
-
-      # validate a provided value is between two other provided values
-      # we also allow * as a valid input
-      # @param spec the value to validate
-      # @param min the lowest value allowed
-      # @param max the highest value allowed
-      # @return [Boolean] valid or not?
-      def self.validate_numeric(spec, min, max)
-        return true if spec == "*"
-
-        #  binding.pry
-        if spec.respond_to? :to_int
-          return false unless spec >= min && spec <= max
-
-          return true
-        end
-
-        # Lists of invidual values, ranges, and step values all share the validity range for type
-        spec.split(%r{\/|-|,}).each do |x|
-          next if x == "*"
-          return false unless x =~ /^\d+$/
 
-          x = x.to_i
-          return false unless x >= min && x <= max
-        end
-        true
-      end
-
-      # validate the provided month value to be jan - dec, 1 - 12, or *
-      # @param spec the value to validate
-      # @return [Boolean] valid or not?
-      def self.validate_month(spec)
-        return true if spec == "*"
-
-        if spec.respond_to? :to_int
-          validate_numeric(spec, 1, 12)
-        elsif spec.respond_to? :to_str
-          return true if spec == "*"
-          # Named abbreviations are permitted but not as part of a range or with stepping
-          return true if %w{jan feb mar apr may jun jul aug sep oct nov dec}.include? spec.downcase
-
-          # 1-12 are legal for months
-          validate_numeric(spec, 1, 12)
-        else
-          false
-        end
-      end
+        **Remove a cron job by name**:
 
-      # validate the provided day of the week is sun-sat, 0-7, or *
-      # @param spec the value to validate
-      # @return [Boolean] valid or not?
-      def self.validate_dow(spec)
-        return true if spec == "*"
-
-        if spec.respond_to? :to_int
-          validate_numeric(spec, 0, 7)
-        elsif spec.respond_to? :to_str
-          return true if spec == "*"
-          # Named abbreviations are permitted but not as part of a range or with stepping
-          return true if %w{sun mon tue wed thu fri sat}.include? spec.downcase
-
-          # 0-7 are legal for days of week
-          validate_numeric(spec, 0, 7)
-        else
-          false
+        ```ruby
+        cron_d 'job_to_remove' do
+          action :delete
         end
-      end
+        ```
+      DOC
 
       property :cron_name, String,
         description: "An optional property to set the cron name if it differs from the resource block's name.",
         name_property: true
 
-      property :cookbook, String, desired_state: false
+      property :cookbook, String, desired_state: false, skip_docs: true
 
       property :predefined_value, String,
         description: "Schedule your cron job with one of the special predefined value instead of ** * pattern.",
         equal_to: %w{ @reboot @yearly @annually @monthly @weekly @daily @midnight @hourly }
 
       property :minute, [Integer, String],
-        description: "The minute at which the cron entry should run (0 - 59).",
+        description: "The minute at which the cron entry should run (`0 - 59`).",
         default: "*", callbacks: {
-          "should be a valid minute spec" => ->(spec) { validate_numeric(spec, 0, 59) },
+          "should be a valid minute spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 59) },
         }
 
       property :hour, [Integer, String],
-        description: "The hour at which the cron entry is to run (0 - 23).",
+        description: "The hour at which the cron entry is to run (`0 - 23`).",
         default: "*", callbacks: {
-          "should be a valid hour spec" => ->(spec) { validate_numeric(spec, 0, 23) },
+          "should be a valid hour spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 0, 23) },
         }
 
       property :day, [Integer, String],
-        description: "The day of month at which the cron entry should run (1 - 31).",
+        description: "The day of month at which the cron entry should run (`1 - 31`).",
         default: "*", callbacks: {
-          "should be a valid day spec" => ->(spec) { validate_numeric(spec, 1, 31) },
+          "should be a valid day spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_numeric(spec, 1, 31) },
         }
 
       property :month, [Integer, String],
-        description: "The month in the year on which a cron entry is to run (1 - 12, jan-dec, or *).",
+        description: "The month in the year on which a cron entry is to run (`1 - 12`, `jan-dec`, or `*`).",
         default: "*", callbacks: {
-          "should be a valid month spec" => ->(spec) { validate_month(spec) },
+          "should be a valid month spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_month(spec) },
         }
 
       property :weekday, [Integer, String],
-        description: "The day of the week on which this entry is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
+        description: "The day of the week on which this entry is to run (`0-7`, `mon-sun`, or `*`), where Sunday is both `0` and `7`.",
         default: "*", callbacks: {
-          "should be a valid weekday spec" => ->(spec) { validate_dow(spec) },
+          "should be a valid weekday spec" => ->(spec) { Chef::ResourceHelpers::CronValidations.validate_dow(spec) },
         }
 
       property :command, String,
         description: "The command to run.",
-        required: true
+        required: [:create]
 
       property :user, String,
         description: "The name of the user that runs the command.",
         default: "root"
 
       property :mailto, String,
-        description: "Set the MAILTO environment variable in the cron.d file."
+        description: "Set the `MAILTO` environment variable in the cron.d file."
 
       property :path, String,
-        description: "Set the PATH environment variable in the cron.d file."
+        description: "Set the `PATH` environment variable in the cron.d file."
 
       property :home, String,
-        description: "Set the HOME environment variable in the cron.d file."
+        description: "Set the `HOME` environment variable in the cron.d file."
 
       property :shell, String,
-        description: "Set the SHELL environment variable in the cron.d file."
+        description: "Set the `SHELL` environment variable in the cron.d file."
 
       property :comment, String,
         description: "A comment to place in the cron.d file."
 
       property :environment, Hash,
-        description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of ``({'ENV_VARIABLE' => 'VALUE'})``.",
+        description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
         default: lazy { {} }
 
       TIMEOUT_OPTS = %w{duration preserve-status foreground kill-after signal}.freeze
       TIMEOUT_REGEX = /\A\S+/.freeze
 
       property :time_out, Hash,
-        description: "A Hash of timeouts in the form of ({'OPTION' => 'VALUE'}).
+        description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`.
         Accepted valid options are:
-        preserve-status (BOOL, default: 'false'),
-        foreground (BOOL, default: 'false'),
-        kill-after (in seconds),
-        signal (a name like 'HUP' or a number)",
+        `preserve-status` (BOOL, default: 'false'),
+        `foreground` (BOOL, default: 'false'),
+        `kill-after` (in seconds),
+        `signal` (a name like 'HUP' or a number)",
         default: lazy { {} },
         introduced: "15.7",
         coerce: proc { |h|
@@ -226,7 +175,7 @@ class Chef
               raise Chef::Exceptions::ValidationFailed, error_msg
             end
             unless h.values.all? { |x| x =~ TIMEOUT_REGEX }
-              error_msg = "Values of option time_out should be non-empty string without any leading whitespaces."
+              error_msg = "Values of option time_out should be non-empty string without any leading whitespace."
               raise Chef::Exceptions::ValidationFailed, error_msg
             end
             h
@@ -240,7 +189,7 @@ class Chef
         default: "0600"
 
       property :random_delay, Integer,
-        description: "Set the RANDOM_DELAY environment variable in the cron.d file."
+        description: "Set the `RANDOM_DELAY` environment variable in the cron.d file."
 
       # warn if someone passes the deprecated cookbook property
       def after_created

data/lib/chef/resource/csh.rb

@@ -24,7 +24,9 @@ class Chef
     class Csh < Chef::Resource::Script
       unified_mode true
 
-      description "Use the csh resource to execute scripts using the csh interpreter."\
+      provides :csh
+
+      description "Use the **csh** resource to execute scripts using the csh interpreter."\
                   " This resource may also use any of the actions and properties that are"\
                   " available to the execute resource. Commands that are executed with this"\
                   " resource are (by their nature) not idempotent, as they are typically"\

data/lib/chef/resource/directory.rb

@@ -26,9 +26,9 @@ class Chef
     class Directory < Chef::Resource
       unified_mode true
 
-      resource_name :directory
+      provides :directory
 
-      description "Use the directory resource to manage a directory, which is a hierarchy"\
+      description "Use the **directory** resource to manage a directory, which is a hierarchy"\
                   " of folders that comprises all of the information stored on a computer."\
                   " The root directory is the top-level, under which the rest of the directory"\
                   " is organized. The directory resource uses the name property to specify the"\
@@ -42,7 +42,7 @@ class Chef
       default_action :create
       allowed_actions :create, :delete
 
-      property :path, String, name_property: true, identity: true,
+      property :path, String, name_property: true,
                description: "The path to the directory. Using a fully qualified path is recommended, but is not always required."
 
       property :recursive, [ TrueClass, FalseClass ],

data/lib/chef/resource/dmg_package.rb

@@ -20,13 +20,15 @@ require_relative "../resource"
 class Chef
   class Resource
     class DmgPackage < Chef::Resource
-      resource_name :dmg_package
+      unified_mode true
+
       provides(:dmg_package) { true }
 
-      description "Use the dmg_package resource to install a package from a .dmg file. The resource will retrieve the dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory) to the specified destination (/Applications), and detach the image using hdiutil. The dmg file will be stored in the Chef::Config[:file_cache_path]."
+      description "Use the **dmg_package** resource to install a package from a .dmg file. The resource will retrieve the dmg file from a remote URL, mount it using macOS' `hdidutil`, copy the application (.app directory) to the specified destination (`/Applications`), and detach the image using `hdiutil`. The dmg file will be stored in the `Chef::Config[:file_cache_path]`."
       introduced "14.0"
       examples <<~DOC
-        Install Google Chrome via the DMG package
+        **Install Google Chrome via the DMG package**:
+
         ```ruby
         dmg_package 'Google Chrome' do
           dmg_name 'googlechrome'
@@ -36,7 +38,8 @@ class Chef
         end
         ```
 
-        Install Virtualbox from the .mpkg
+        **Install Virtualbox from the .mpkg**:
+
         ```ruby
         dmg_package 'Virtualbox' do
           source 'http://dlc.sun.com.edgesuite.net/virtualbox/4.0.8/VirtualBox-4.0.8-71778-OSX.dmg'
@@ -44,7 +47,8 @@ class Chef
         end
         ```
 
-        Install pgAdmin and automatically accept the EULA
+        **Install pgAdmin and automatically accept the EULA**:
+
         ```ruby
         dmg_package 'pgAdmin3' do
           source   'http://wwwmaster.postgresql.org/redir/198/h/pgadmin3/release/v1.12.3/osx/pgadmin3-1.12.3.dmg'
@@ -55,31 +59,31 @@ class Chef
       DOC
 
       property :app, String,
-        description: "The name of the application as it appears in the /Volumes directory if it differs from the resource block's name.",
+        description: "The name of the application as it appears in the `/Volumes` directory if it differs from the resource block's name.",
         name_property: true
 
       property :source, String,
-        description: "The remote URL that is used to download the .dmg file, if specified."
+        description: "The remote URL that is used to download the `.dmg` file, if specified."
 
       property :file, String,
-        description: "The full path to the .dmg file on the local system."
+        description: "The full path to the `.dmg` file on the local system."
 
       property :owner, [String, Integer],
         description: "The user that should own the package installation."
 
       property :destination, String,
-        description: "The directory to copy the .app into.",
+        description: "The directory to copy the `.app` into.",
         default: "/Applications"
 
       property :checksum, String,
-        description: "The sha256 checksum of the .dmg file to download."
+        description: "The sha256 checksum of the `.dmg` file to download."
 
       property :volumes_dir, String,
-        description: "The directory under /Volumes where the dmg is mounted if it differs from the name of the .dmg file.",
+        description: "The directory under `/Volumes` where the `dmg` is mounted if it differs from the name of the `.dmg` file.",
         default: lazy { app }, default_description: "The value passed for the application name."
 
       property :dmg_name, String,
-        description: "The name of the .dmg file if it differs from that of the app, or if the name has spaces.",
+        description: "The name of the `.dmg` file if it differs from that of the app, or if the name has spaces.",
         desired_state: false,
         default: lazy { app }, default_description: "The value passed for the application name."
 
@@ -89,18 +93,18 @@ class Chef
         default: "app", desired_state: false
 
       property :package_id, String,
-        description: "The package ID that is registered with pkgutil when a pkg or mpkg is installed."
+        description: "The package ID that is registered with `pkgutil` when a `pkg` or `mpkg` is installed."
 
       property :dmg_passphrase, String,
-        description: "Specify a passphrase to be used to decrypt the .dmg file during the mount process.",
+        description: "Specify a passphrase to be used to decrypt the `.dmg` file during the mount process.",
         desired_state: false
 
       property :accept_eula, [TrueClass, FalseClass],
-        description: "Specify whether to accept the EULA. Certain dmgs require acceptance of EULA before mounting.",
+        description: "Specify whether to accept the EULA. Certain dmg files require acceptance of EULA before mounting.",
         default: false, desired_state: false
 
       property :headers, Hash,
-        description: "Allows custom HTTP headers (like cookies) to be set on the remote_file resource.",
+        description: "Allows custom HTTP headers (like cookies) to be set on the `remote_file` resource.",
         desired_state: false
 
       property :allow_untrusted, [TrueClass, FalseClass],
@@ -129,8 +133,8 @@ class Chef
             end
           end
 
-          ruby_block "attach #{dmg_file}" do
-            block do
+          unless dmg_attached?
+            converge_by "attach #{dmg_file}" do
               raise "This DMG package requires EULA acceptance. Add 'accept_eula true' to dmg_package resource to accept the EULA during installation." if software_license_agreement? && !new_resource.accept_eula
 
               attach_cmd = new_resource.accept_eula ? "yes | " : ""
@@ -138,7 +142,6 @@ class Chef
 
               shell_out!(attach_cmd, env: { "PAGER" => "true" })
             end
-            not_if { dmg_attached? }
           end
 
           case new_resource.type

data/lib/chef/resource/dnf_package.rb

@@ -26,7 +26,8 @@ class Chef
       extend Chef::Mixin::Which
       extend Chef::Mixin::ShellOut
 
-      resource_name :dnf_package
+      unified_mode true
+      provides :dnf_package
 
       # all rhel variants >= 8 will use DNF
       provides :package, platform_family: "rhel", platform_version: ">= 8"
@@ -39,9 +40,7 @@ class Chef
         which("dnf")
       end
 
-      provides :dnf_package
-
-      description "Use the dnf_package resource to install, upgrade, and remove packages with DNF for Fedora and RHEL 8+. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
+      description "Use the **dnf_package** resource to install, upgrade, and remove packages with DNF for Fedora and RHEL 8+. The dnf_package resource is able to resolve provides data for packages much like DNF can do when it is run from the command line. This allows a variety of options for installing packages, like minimum versions, virtual provides and library names."
       introduced "12.18"
 
       allowed_actions :install, :upgrade, :remove, :purge, :reconfig, :lock, :unlock, :flush_cache