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

data/lib/chef/resource/apt_update.rb

@@ -21,13 +21,15 @@ require_relative "../resource"
 class Chef
   class Resource
     class AptUpdate < Chef::Resource
-      resource_name :apt_update
+      unified_mode true
+
       provides(:apt_update) { true }
 
-      description "Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms."
+      description "Use the **apt_update** resource to manage APT repository updates on Debian and Ubuntu platforms."
       introduced "12.7"
       examples <<~DOC
-        Update the Apt repository at a specified interval
+        **Update the Apt repository at a specified interval**:
+
         ```ruby
         apt_update 'all platforms' do
         frequency 86400
@@ -35,7 +37,8 @@ class Chef
         end
         ```
 
-        Update the Apt repository at the start of a Chef Infra Client run
+        **Update the Apt repository at the start of a Chef Infra Client run**:
+
         ```ruby
         apt_update 'update'
         ```
@@ -45,11 +48,61 @@ class Chef
       property :name, String, default: ""
 
       property :frequency, Integer,
-        description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.",
+        description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the `:periodic` action is specified.",
         default: 86_400
 
       default_action :periodic
       allowed_actions :update, :periodic
+
+      action_class do
+        APT_CONF_DIR = "/etc/apt/apt.conf.d".freeze
+        STAMP_DIR = "/var/lib/apt/periodic".freeze
+
+        # Determines whether we need to run `apt-get update`
+        #
+        # @return [Boolean]
+        def apt_up_to_date?
+          ::File.exist?("#{STAMP_DIR}/update-success-stamp") &&
+            ::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency
+        end
+
+        def do_update
+          [STAMP_DIR, APT_CONF_DIR].each do |d|
+            directory d do
+              recursive true
+            end
+          end
+
+          file "#{APT_CONF_DIR}/15update-stamp" do
+            content "APT::Update::Post-Invoke-Success {\"touch #{STAMP_DIR}/update-success-stamp 2>/dev/null || true\";};\n"
+            action :create_if_missing
+          end
+
+          execute "apt-get -q update" do
+            command [ "apt-get", "-q", "update" ]
+            default_env true
+          end
+        end
+      end
+
+      action :periodic do
+        return unless debian?
+
+        unless apt_up_to_date?
+          converge_by "update new lists of packages" do
+            do_update
+          end
+        end
+      end
+
+      action :update do
+        return unless debian?
+
+        converge_by "force update new lists of packages" do
+          do_update
+        end
+      end
+
     end
   end
 end

data/lib/chef/resource/archive_file.rb

@@ -23,15 +23,16 @@ require_relative "../resource"
 class Chef
   class Resource
     class ArchiveFile < Chef::Resource
+      unified_mode true
 
-      resource_name :archive_file
       provides :archive_file
       provides :libarchive_file # legacy cookbook name
 
       introduced "15.0"
-      description "Use the archive_file resource to extract archive files to disk. This resource uses the libarchive library to extract multiple archive formats including tar, gzip, bzip, and zip formats."
+      description "Use the **archive_file** resource to extract archive files to disk. This resource uses the libarchive library to extract multiple archive formats including tar, gzip, bzip, and zip formats."
       examples <<~DOC
-        Extract a zip file to a specified directory
+        **Extract a zip file to a specified directory**:
+
         ```ruby
         archive_file 'Precompiled.zip' do
           path '/tmp/Precompiled.zip'
@@ -60,11 +61,11 @@ class Chef
         required: true
 
       property :options, [Array, Symbol],
-        description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default, this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.",
+        description: "An array of symbols representing extraction flags. Example: `:no_overwrite` to prevent overwriting files on disk. By default, this properly sets `:time` which preserves the modification timestamps of files in the archive when writing them to disk.",
         default: lazy { [:time] }
 
       property :overwrite, [TrueClass, FalseClass, :auto],
-        description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
+        description: "Should the resource overwrite the destination file contents if they already exist? If set to `:auto` the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
         default: false
 
       # backwards compatibility for the legacy cookbook names

data/lib/chef/resource/bash.rb

@@ -24,7 +24,9 @@ class Chef
     class Bash < Chef::Resource::Script
       unified_mode true
 
-      description "Use the bash resource to execute scripts using the Bash 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 unique to the environment in which they are run. Use not_if and only_if to guard this resource for idempotence."
+      provides :bash
+
+      description "Use the **bash** resource to execute scripts using the Bash 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 unique to the environment in which they are run. Use not_if and only_if to guard this resource for idempotence."
 
       def initialize(name, run_context = nil)
         super

data/lib/chef/resource/batch.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides :batch
 
-      description "Use the batch resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource creates and executes a temporary file (similar to how the script resource behaves), rather than running the command inline. 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."
+      description "Use the **batch** resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource creates and executes a temporary file (similar to how the script resource behaves), rather than running the command inline. 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."
 
       def initialize(name, run_context = nil)
         super(name, run_context, nil, "cmd.exe")

data/lib/chef/resource/bff_package.rb

@@ -21,11 +21,19 @@ require_relative "package"
 class Chef
   class Resource
     class BffPackage < Chef::Resource::Package
-      resource_name :bff_package
+      unified_mode true
+
       provides :bff_package
 
-      description "Use the bff_package resource to manage packages for the AIX platform using the installp utility. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources."
+      description "Use the **bff_package** resource to manage packages for the AIX platform using the installp utility. When a package is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources."
       introduced "12.0"
+
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
     end
   end
 end

data/lib/chef/resource/breakpoint.rb

@@ -25,9 +25,8 @@ class Chef
       unified_mode true
 
       provides :breakpoint, target_mode: true
-      resource_name :breakpoint
 
-      description "Use the breakpoint resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
+      description "Use the **breakpoint** resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
       introduced "12.0"
 
       default_action :break

data/lib/chef/resource/build_essential.rb

@@ -20,34 +20,42 @@ require "plist"
 class Chef
   class Resource
     class BuildEssential < Chef::Resource
-      resource_name :build_essential
+      unified_mode true
+
       provides(:build_essential) { true }
 
-      description "Use the build_essential resource to install the packages required for compiling C software from source."
+      description "Use the **build_essential** resource to install the packages required for compiling C software from source."
       introduced "14.0"
       examples <<~DOC
-        Install compilation packages
+        **Install compilation packages**:
+
         ```ruby
         build_essential
         ```
 
-        Install compilation packages during the compilation phase
+        **Install compilation packages during the compilation phase**:
+
         ```ruby
         build_essential 'Install compilation tools' do
           compile_time true
         end
         ```
+
+        **Upgrade compilation packages on macOS systems**:
+
+        ```ruby
+        build_essential 'Install compilation tools' do
+          action :upgrade
+        end
+        ```
       DOC
 
       # this allows us to use build_essential without setting a name
       property :name, String, default: ""
 
-      property :compile_time, [TrueClass, FalseClass],
-        description: "Install the build essential packages at compile time.",
-        default: false, desired_state: false
-
       property :raise_if_unsupported, [TrueClass, FalseClass],
         description: "Raise a hard error on platforms where this resource is unsupported.",
+        introduced: "15.5",
         default: false, desired_state: false # FIXME: make this default to true
 
       action :install do
@@ -57,11 +65,8 @@ class Chef
         case
         when debian?
           package %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev }
-         when fedora_derived?
-           package %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch }
-
-           # Ensure GCC 4 is available on older pre-6 EL
-           package %w{ gcc44 gcc44-c++ } if platform_family?("rhel") && node["platform_version"].to_i < 6
+        when fedora_derived?
+          package %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch }
         when freebsd?
           package "devel/gmake"
           package "devel/autoconf"
@@ -88,11 +93,7 @@ class Chef
           package "bison"
           package "gnu-coreutils"
           package "flex"
-          package "gcc" do
-            # lock because we don't use 5 yet
-            version "4.8.2"
-          end
-          package "gcc-3"
+          package "gcc"
           package "gnu-grep"
           package "gnu-make"
           package "gnu-patch"
@@ -109,22 +110,33 @@ class Chef
           package "pkg-config"
         when suse?
           package %w{ autoconf bison flex gcc gcc-c++ kernel-default-devel make m4 }
-          package %w{ gcc48 gcc48-c++ } if node["platform_version"].to_i < 12
         else
-          if new_resource.raise_if_unsupported
-            raise <<-EOH
+          msg = <<-EOH
         The build_essential resource does not currently support the '#{node["platform_family"]}'
         platform family. Skipping...
-            EOH
+          EOH
+          if new_resource.raise_if_unsupported
+            raise msg
           else
-            Chef::Log.warn <<-EOH
-        The build_essential resource does not currently support the '#{node["platform_family"]}'
-        platform family. Skipping...
-            EOH
+            Chef::Log.warn msg
           end
         end
       end
 
+      action :upgrade do
+        description "Upgrade build essential (Xcode Command Line) tools on macOS"
+
+        if macos?
+          pkg_label = xcode_cli_package_label
+
+          # With upgrade action we should install if it's not installed or if there's an available update.
+          # `xcode_cli_package_label` will be nil if there's no update.
+          install_xcode_cli_tools(pkg_label) if !xcode_cli_installed? || xcode_cli_package_label
+        else
+          Chef::Log.info "The build_essential resource :upgrade action is only supported on macOS systems. Skipping..."
+        end
+      end
+
       action_class do
         #
         # Install Xcode Command Line tools via softwareupdate CLI
@@ -134,19 +146,16 @@ class Chef
         def install_xcode_cli_tools(label)
           # This script was graciously borrowed and modified from Tim Sutton's
           # osx-vm-templates at https://github.com/timsutton/osx-vm-templates/blob/b001475df54a9808d3d56d06e71b8fa3001fff42/scripts/xcode-cli-tools.sh
-
-          if label.nil?
-            Chef::Log.warn("Could not determine a Xcode CLI Tools package to install via softwareupdate")
-          else
-            # create the placeholder file that's checked by CLI updates' .dist code
-            # in Apple's SUS catalog and then remove it when we're done
-            execute "install Xcode Command Line tools" do
-              command <<-EOH
-                touch /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
-                softwareupdate -i "#{label}" --verbose
-                rm -f /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
-              EOH
-            end
+          execute "install Xcode Command Line tools" do
+            command <<-EOH
+              # create the placeholder file that's checked by CLI updates' .dist code
+              # in Apple's SUS catalog
+              touch /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
+              # install it
+              softwareupdate -i "#{label}" --verbose
+              # Remove the placeholder to prevent perpetual appearance in the update utility
+              rm -f /tmp/.com.apple.dt.CommandLineTools.installondemand.in-progress
+            EOH
           end
         end
 
@@ -156,7 +165,7 @@ class Chef
         #
         # @return [true, false]
         def xcode_cli_installed?
-          packages = Plist.parse_xml(::File.open("/Library/Receipts/InstallHistory.plist", "r"))
+          packages = ::Plist.parse_xml(::File.open("/Library/Receipts/InstallHistory.plist", "r"))
           packages.select! { |package| package["displayName"].match? "Command Line Tools" }
           !packages.empty?
         end
@@ -176,17 +185,6 @@ class Chef
           available_updates.stdout[/^\s*\* (?:Label: )?(Command Line Tools.*)/, 1]
         end
       end
-
-      # this resource forces itself to run at compile_time
-      #
-      # @return [void]
-      def after_created
-        return unless compile_time
-
-        Array(action).each do |action|
-          run_action(action)
-        end
-      end
     end
   end
 end

data/lib/chef/resource/cab_package.rb

@@ -23,15 +23,22 @@ class Chef
   class Resource
     class CabPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
+      unified_mode true
 
-      resource_name :cab_package
       provides :cab_package
 
-      description "Use the cab_package resource to install or remove Microsoft Windows cabinet (.cab) packages."
+      description "Use the **cab_package** resource to install or remove Microsoft Windows cabinet (.cab) packages."
       introduced "12.15"
 
       allowed_actions :install, :remove
 
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
+
       property :source, String,
         description: "The local file path or URL for the CAB package.",
         coerce: (proc do |s|

data/lib/chef/resource/chef_client_cron.rb

@@ -0,0 +1,228 @@
+#
+# Copyright:: Copyright (c) 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.
+#
+
+require_relative "../resource"
+require_relative "../dist"
+require_relative "helpers/cron_validations"
+require "digest/md5"
+
+class Chef
+  class Resource
+    class ChefClientCron < Chef::Resource
+      unified_mode true
+
+      provides :chef_client_cron
+
+      description "Use the **chef_client_cron** resource to setup the #{Chef::Dist::PRODUCT} to run as a cron job. This resource will also create the specified log directory if it doesn't already exist."
+      introduced "16.0"
+      examples <<~DOC
+      **Setup #{Chef::Dist::PRODUCT} to run using the default 30 minute cadence**:
+
+      ```ruby
+      chef_client_cron "Run #{Chef::Dist::PRODUCT} as a cron job"
+      ```
+
+      **Run #{Chef::Dist::PRODUCT} twice a day**:
+
+      ```ruby
+      chef_client_cron "Run #{Chef::Dist::PRODUCT} every 12 hours" do
+        minute 0
+        hour "0,12"
+      end
+      ```
+
+      **Run #{Chef::Dist::PRODUCT} with extra options passed to the client**:
+
+      ```ruby
+      chef_client_cron "Run an override recipe" do
+        daemon_options ["--override-runlist mycorp_base::default"]
+      end
+      ```
+      DOC
+
+      extend Chef::ResourceHelpers::CronValidations
+
+      property :job_name, String,
+        default: Chef::Dist::CLIENT,
+        description: "The name of the cron job to create."
+
+      property :comment, String,
+        description: "A comment to place in the cron.d file."
+
+      property :user, String,
+        description: "The name of the user that #{Chef::Dist::PRODUCT} runs as.",
+        default: "root"
+
+      property :minute, [Integer, String],
+        description: "The minute at which #{Chef::Dist::PRODUCT} is to run (0 - 59) or a cron pattern such as '0,30'.",
+        default: "0,30", callbacks: {
+          "should be a valid minute spec" => method(:validate_minute),
+        }
+
+      property :hour, [Integer, String],
+        description: "The hour at which #{Chef::Dist::PRODUCT} is to run (0 - 23) or a cron pattern such as '0,12'.",
+        default: "*", callbacks: {
+          "should be a valid hour spec" => method(:validate_hour),
+        }
+
+      property :day, [Integer, String],
+        description: "The day of month at which #{Chef::Dist::PRODUCT} is to run (1 - 31) or a cron pattern such as '1,7,14,21,28'.",
+        default: "*", callbacks: {
+          "should be a valid day spec" => method(:validate_day),
+        }
+
+      property :month, [Integer, String],
+        description: "The month in the year on which #{Chef::Dist::PRODUCT} is to run (1 - 12, jan-dec, or *).",
+        default: "*", callbacks: {
+          "should be a valid month spec" => method(:validate_month),
+        }
+
+      property :weekday, [Integer, String],
+        description: "The day of the week on which #{Chef::Dist::PRODUCT} is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
+        default: "*", callbacks: {
+          "should be a valid weekday spec" => method(:validate_dow),
+        }
+
+      property :splay, [Integer, String],
+        default: 300,
+        coerce: proc { |x| Integer(x) },
+        callbacks: { "should be a positive number" => proc { |v| v > 0 } },
+        description: "A random number of seconds between 0 and X to add to interval so that all #{Chef::Dist::CLIENT} commands don't execute at the same time."
+
+      property :mailto, String,
+        description: "The e-mail address to e-mail any cron task failures to."
+
+      property :accept_chef_license, [true, false],
+        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
+        default: false
+
+      property :config_directory, String,
+        default: Chef::Dist::CONF_DIR,
+        description: "The path of the config directory."
+
+      property :log_directory, String,
+        default: lazy { platform?("mac_os_x") ? "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize}" : "/var/log/#{Chef::Dist::DIR_SUFFIX}" },
+        default_description: "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize} on macOS and /var/log/#{Chef::Dist::DIR_SUFFIX} otherwise",
+        description: "The path of the directory to create the log file in."
+
+      property :log_file_name, String,
+        default: "client.log",
+        description: "The name of the log file to use."
+
+      property :append_log_file, [true, false],
+        default: true,
+        description: "Append to the log file instead of overwriting the log file on each run."
+
+      property :chef_binary_path, String,
+        default: "/opt/#{Chef::Dist::DIR_SUFFIX}/bin/#{Chef::Dist::CLIENT}",
+        description: "The path to the #{Chef::Dist::CLIENT} binary."
+
+      property :daemon_options, Array,
+        default: lazy { [] },
+        description: "An array of options to pass to the #{Chef::Dist::CLIENT} command."
+
+      property :environment, Hash,
+        default: lazy { {} },
+        description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`."
+
+      action :add do
+        # TODO: Replace this with a :create_if_missing action on directory when that exists
+        unless ::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
+        #
+        # Generate a uniformly distributed unique number to sleep from 0 to the splay time
+        #
+        # @param [Integer] splay The number of seconds to splay
+        #
+        # @return [Integer]
+        #
+        def splay_sleep_time(splay)
+          seed = node["shard_seed"] || Digest::MD5.hexdigest(node.name).to_s.hex
+          random = Random.new(seed.to_i)
+          random.rand(splay)
+        end
+
+        #
+        # The complete cron command to run
+        #
+        # @return [String]
+        #
+        def cron_command
+          cmd = ""
+          cmd << "/bin/sleep #{splay_sleep_time(new_resource.splay)}; "
+          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
+          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
+            "-L #{::File.join(new_resource.log_directory, new_resource.log_file_name)}"
+          else
+            "> #{::File.join(new_resource.log_directory, new_resource.log_file_name)} 2>&1"
+          end
+        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
+          linux? ? :cron_d : :cron
+        end
+      end
+    end
+  end
+end