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

data/lib/chef/resource/log.rb

@@ -31,10 +31,9 @@ class Chef
     class Log < Chef::Resource
       unified_mode true
 
-      resource_name :log
       provides :log, target_mode: true
 
-      description "Use the log resource to create log entries. The log resource behaves"\
+      description "Use the **log** resource to create log entries. The log resource behaves"\
                   " like any other resource: built into the resource collection during the"\
                   " compile phase, and then run during the execution phase. (To create a log"\
                   " entry that is not built into the resource collection, use Chef::Log instead"\
@@ -50,6 +49,18 @@ class Chef
 
       allowed_actions :write
       default_action :write
+
+      def suppress_up_to_date_messages?
+        true
+      end
+
+      # Write the log to Chef's log
+      #
+      # @return [true] Always returns true
+      action :write do
+        logger.send(new_resource.level, new_resource.message)
+        new_resource.updated_by_last_action(true) if Chef::Config[:count_log_resource_updates]
+      end
     end
   end
 end

data/lib/chef/resource/lwrp_base.rb

@@ -67,7 +67,7 @@ class Chef
 
           # wire up the default resource name after the class is parsed only if we haven't declared one.
           # (this ordering is important for MapCollision deprecation warnings)
-          resource_class.resource_name resource_name.to_sym if resource_class.resource_name.nil?
+          resource_class.provides resource_name.to_sym unless Chef::ResourceResolver.includes_handler?(resource_name.to_sym, self)
 
           resource_class
         end

data/lib/chef/resource/macos_userdefaults.rb

@@ -20,12 +20,13 @@ require_relative "../resource"
 class Chef
   class Resource
     class MacosUserDefaults < Chef::Resource
+      unified_mode true
+
       # align with apple's marketing department
-      resource_name :macos_userdefaults
-      provides(:mac_os_x_userdefaults) { true }
       provides(:macos_userdefaults) { true }
+      provides(:mac_os_x_userdefaults) { true }
 
-      description "Use the macos_userdefaults resource to manage the macOS user defaults system. The properties of this resource are passed to the defaults command, and the parameters follow the convention of that command. See the defaults(1) man page for details on how the tool works."
+      description "Use the **macos_userdefaults** resource to manage the macOS user defaults system. The properties of this resource are passed to the defaults command, and the parameters follow the convention of that command. See the defaults(1) man page for details on how the tool works."
       introduced "14.0"
 
       property :domain, String,
@@ -73,12 +74,17 @@ class Chef
 
       load_current_value do |desired|
         value = coerce_booleans(desired.value)
-        drcmd = "defaults read '#{desired.domain}' "
-        drcmd << "'#{desired.key}' " if desired.key
-        shell_out_opts = {}
-        shell_out_opts[:user] = desired.user unless desired.user.nil?
-        vc = shell_out("#{drcmd} | grep -qx '#{value}'", shell_out_opts)
-        is_set vc.exitstatus == 0 ? true : false
+        cmd = "defaults read '#{desired.domain}' "
+        cmd << "'#{desired.key}' " if desired.key
+        cmd << " | grep -qx '#{value}'"
+
+        vc = if desired.user.nil?
+               shell_out(cmd)
+             else
+               shell_out(cmd, user: desired.user)
+             end
+
+        is_set !vc.error?
       end
 
       action :write do
@@ -106,7 +112,9 @@ class Chef
           cmd << "-#{type}" if type
           cmd << value
 
-          declare_resource(:execute, cmd.join(" ")) do
+          # FIXME: this should use cmd directly as an array argument, but then the quoting
+          # of individual args above needs to be removed as well.
+          execute cmd.join(" ") do
             user new_resource.user unless new_resource.user.nil?
           end
         end

data/lib/chef/resource/macosx_service.rb

@@ -21,11 +21,12 @@ require_relative "service"
 class Chef
   class Resource
     class MacosxService < Chef::Resource::Service
-      resource_name :macosx_service
+      unified_mode true
+
       provides :macosx_service
       provides :service, os: "darwin"
 
-      description "Use the macosx_service resource to manage services on the macOS platform."
+      description "Use the **macosx_service** resource to manage services on the macOS platform."
 
       property :plist, String,
         description: "A plist to use in the case where the filename and label for the service do not match."

data/lib/chef/resource/macports_package.rb

@@ -21,9 +21,17 @@ require_relative "package"
 class Chef
   class Resource
     class MacportsPackage < Chef::Resource::Package
-      resource_name :macports_package
+      unified_mode true
+      provides :macports_package
 
-      description "Use the macports_package resource to manage packages for the macOS platform."
+      description "Use the **macports_package** resource to manage packages for the macOS platform using the MacPorts package management system."
+
+      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/mdadm.rb

@@ -22,9 +22,11 @@ require_relative "../resource"
 class Chef
   class Resource
     class Mdadm < Chef::Resource
-      resource_name :mdadm
+      unified_mode true
 
-      description "Use the mdadm resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
+      provides :mdadm
+
+      description "Use the **mdadm** resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
                   " will create and assemble an array, but it will not create the config file that is used to persist the array upon"\
                   " reboot. If the config file is required, it must be done by specifying a template with the correct array layout,"\
                   " and then by using the mount provider to create a file systems table (fstab) entry."
@@ -57,11 +59,69 @@ class Chef
         description: "The path to a file in which a write-intent bitmap is stored."
 
       property :raid_device, String,
-        identity: true, name_property: true,
+        name_property: true,
         description: "An optional property to specify the name of the RAID device if it differs from the resource block's name."
 
       property :layout, String,
         description: "The RAID5 parity algorithm. Possible values: left-asymmetric (or la), left-symmetric (or ls), right-asymmetric (or ra), or right-symmetric (or rs)."
+
+      action_class do
+        def load_current_resource
+          @current_resource = Chef::Resource::Mdadm.new(new_resource.name)
+          current_resource.raid_device(new_resource.raid_device)
+          logger.trace("#{new_resource} checking for software raid device #{current_resource.raid_device}")
+
+          device_not_found = 4
+          mdadm = shell_out!("mdadm", "--detail", "--test", new_resource.raid_device, returns: [0, device_not_found])
+          exists = (mdadm.status == 0)
+          current_resource.exists(exists)
+        end
+      end
+
+      action :create do
+        unless current_resource.exists
+          converge_by("create RAID device #{new_resource.raid_device}") do
+            command = "yes | mdadm --create #{new_resource.raid_device} --level #{new_resource.level}"
+            command << " --chunk=#{new_resource.chunk}" unless new_resource.level == 1
+            command << " --metadata=#{new_resource.metadata}"
+            command << " --bitmap=#{new_resource.bitmap}" if new_resource.bitmap
+            command << " --layout=#{new_resource.layout}" if new_resource.layout
+            command << " --raid-devices #{new_resource.devices.length} #{new_resource.devices.join(" ")}"
+            logger.trace("#{new_resource} mdadm command: #{command}")
+            shell_out!(command)
+            logger.info("#{new_resource} created raid device (#{new_resource.raid_device})")
+          end
+        else
+          logger.trace("#{new_resource} raid device already exists, skipping create (#{new_resource.raid_device})")
+        end
+      end
+
+      action :assemble do
+        unless current_resource.exists
+          converge_by("assemble RAID device #{new_resource.raid_device}") do
+            command = "yes | mdadm --assemble #{new_resource.raid_device} #{new_resource.devices.join(" ")}"
+            logger.trace("#{new_resource} mdadm command: #{command}")
+            shell_out!(command)
+            logger.info("#{new_resource} assembled raid device (#{new_resource.raid_device})")
+          end
+        else
+          logger.trace("#{new_resource} raid device already exists, skipping assemble (#{new_resource.raid_device})")
+        end
+      end
+
+      action :stop do
+        if current_resource.exists
+          converge_by("stop RAID device #{new_resource.raid_device}") do
+            command = "yes | mdadm --stop #{new_resource.raid_device}"
+            logger.trace("#{new_resource} mdadm command: #{command}")
+            shell_out!(command)
+            logger.info("#{new_resource} stopped raid device (#{new_resource.raid_device})")
+          end
+        else
+          logger.trace("#{new_resource} raid device doesn't exist (#{new_resource.raid_device}) - not stopping")
+        end
+      end
+
     end
   end
 end

data/lib/chef/resource/mount.rb

@@ -22,7 +22,10 @@ require_relative "../resource"
 class Chef
   class Resource
     class Mount < Chef::Resource
-      description "Use the mount resource to manage a mounted file system."
+      description "Use the **mount** resource to manage a mounted file system."
+      unified_mode true
+
+      provides :mount
 
       default_action :mount
       allowed_actions :mount, :umount, :unmount, :remount, :enable, :disable

data/lib/chef/resource/msu_package.rb

@@ -23,16 +23,28 @@ class Chef
   class Resource
     class MsuPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
+      unified_mode true
 
-      resource_name :msu_package
       provides :msu_package
 
-      description "Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
+      description "Use the **msu_package** resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
       introduced "12.17"
 
       allowed_actions :install, :remove
       default_action :install
 
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      # This is the same property as the main package resource except it has the skip docs set to true
+      # This resource abuses the package resource by storing the versions of all the cabs in the MSU file
+      # in the version attribute from load current value even though those aren't technically the version of the
+      # msu. Since the user wouldn't actually set this we don't want it on the docs site.
+      property :version, [String, Array],
+        skip_docs: true,
+        description: "The version of a package to be installed or upgraded."
+
       property :source, String,
         description: "The local file path or URL for the MSU package.",
         coerce: (proc do |s|
@@ -44,6 +56,11 @@ class Chef
 
       property :checksum, String, desired_state: false,
                description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."
+
+      property :timeout, [String, Integer],
+        default: 3600,
+        description: "The amount of time (in seconds) to wait before timing out.",
+        desired_state: false
     end
   end
 end

data/lib/chef/resource/notify_group.rb

@@ -20,18 +20,16 @@ require_relative "../dist"
 class Chef
   class Resource
     class NotifyGroup < Chef::Resource
-      resource_name :notify_group
       provides :notify_group
 
       unified_mode true
 
       description "The notify_group resource does nothing, and always fires notifications which are set on it.  Use it to DRY blocks of notifications that are common to multiple resources, and provide a single target for other resources to notify.  Unlike most resources, its default action is :nothing."
       introduced "15.8"
-
       examples <<~DOC
         Wire up a notification from a service resource to stop and start the service with a 60 second delay.
 
-        ```
+        ```ruby
         service "crude" do
           action [ :enable, :start ]
         end
@@ -64,6 +62,13 @@ class Chef
         new_resource.updated_by_last_action(true)
       end
 
+      # This is deliberate.  Users should be sending a single notification to a notify_group resource which then
+      # distributes multiple notifications.  Having a notify_group run by default is unnecessary indirection and
+      # should be replaced by just running the resources in order.  If resources need to be batch run multiple times
+      # per invocation then the resources themselves are not properly declarative idempotent resources, and the user
+      # is attempting to turn Chef into an imperative language using this construct and/or the batch of resources
+      # need to be turned into a custom resource.
+      #
       default_action :nothing
     end
   end

data/lib/chef/resource/ohai.rb

@@ -2,6 +2,7 @@
 # Author:: Michael Leinartas (<mleinartas@gmail.com>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
 # Copyright:: Copyright 2010-2016, Michael Leinartas
+# Copyright:: Copyright (c) Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,22 +20,37 @@
 
 require_relative "../resource"
 require_relative "../dist"
+require "ohai" unless defined?(Ohai::System)
 
 class Chef
   class Resource
     class Ohai < Chef::Resource
       unified_mode true
 
-      resource_name :ohai
       provides :ohai
 
-      description "Use the ohai resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{Chef::Dist::CLIENT} run."
+      description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{Chef::Dist::CLIENT} run."
 
       property :plugin, String,
         description: "The name of an Ohai plugin to be reloaded. If this property is not specified, #{Chef::Dist::PRODUCT} will reload all plugins."
 
-      default_action :reload
-      allowed_actions :reload
+      def load_current_resource
+        true
+      end
+
+      action :reload do
+        converge_by("re-run ohai and merge results into node attributes") do
+          ohai = ::Ohai::System.new
+
+          # If new_resource.plugin is nil, ohai will reload all the plugins
+          # Otherwise it will only reload the specified plugin
+          # Note that any changes to plugins, or new plugins placed on
+          # the path are picked up by ohai.
+          ohai.all_plugins new_resource.plugin
+          node.automatic_attrs.merge! ohai.data
+          logger.info("#{new_resource} reloaded")
+        end
+      end
     end
   end
 end

data/lib/chef/resource/ohai_hint.rb

@@ -20,10 +20,11 @@ require_relative "../resource"
 class Chef
   class Resource
     class OhaiHint < Chef::Resource
-      resource_name :ohai_hint
+      unified_mode true
+
       provides(:ohai_hint) { true }
 
-      description "Use the ohai_hint resource to aid in configuration detection by passing hint data to Ohai."
+      description "Use the **ohai_hint** resource to aid in configuration detection by passing hint data to Ohai."
       introduced "14.0"
 
       property :hint_name, String,
@@ -33,6 +34,7 @@ class Chef
       property :content, Hash,
         description: "Values to include in the hint file."
 
+      # override compile_time property to default to true
       property :compile_time, [TrueClass, FalseClass],
         description: "Determines whether or not the resource is executed during the compile time phase.",
         default: true, desired_state: false
@@ -83,17 +85,6 @@ class Chef
           JSON.pretty_generate(content)
         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/openbsd_package.rb

@@ -25,11 +25,19 @@ require_relative "../provider/package/openbsd"
 class Chef
   class Resource
     class OpenbsdPackage < Chef::Resource::Package
-      resource_name :openbsd_package
+      unified_mode true
+      provides :openbsd_package
       provides :package, os: "openbsd"
 
-      description "Use the openbsd_package resource to manage packages for the OpenBSD platform."
+      description "Use the **openbsd_package** resource to manage packages for the OpenBSD platform."
       introduced "12.1"
+
+      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/openssl_dhparam.rb

@@ -23,11 +23,20 @@ class Chef
       require_relative "../mixin/openssl_helper"
       include Chef::Mixin::OpenSSLHelper
 
-      resource_name :openssl_dhparam
       provides(:openssl_dhparam) { true }
 
-      description "Use the openssl_dhparam resource to generate dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten."
+      description "Use the **openssl_dhparam** resource to generate dhparam.pem files. If a valid dhparam.pem file is found at the specified location, no new file will be created. If a file is found at the specified location but it is not a valid dhparam file, it will be overwritten."
       introduced "14.0"
+      examples <<~DOC
+        Create a 1024bit dhparam file
+
+        ```ruby
+        openssl_dhparam '/etc/ssl_files/dhparam.pem' do
+          key_length 1024
+          action :create
+        end
+        ```
+      DOC
 
       property :path, String,
         description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -24,10 +24,32 @@ class Chef
       require_relative "../mixin/openssl_helper"
       include Chef::Mixin::OpenSSLHelper
 
-      resource_name :openssl_ec_private_key
+      provides :openssl_ec_private_key
 
-      description "Use the openssl_ec_private_key resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
+      description "Use the **openssl_ec_private_key** resource to generate an elliptic curve (EC) private key file. If a valid EC key file can be opened at the specified location, no new file will be created. If the EC key file cannot be opened, either because it does not exist or because the password to the EC key file does not match the password in the recipe, then it will be overwritten."
       introduced "14.4"
+      examples <<~DOC
+        Generate a new ec privatekey with prime256v1 key curve and default des3 cipher
+
+        ```ruby
+        openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
+          key_curve 'prime256v1'
+          key_pass 'something'
+          action :create
+        end
+        ```
+
+        Generate a new ec private key with prime256v1 key curve and aes-128-cbc cipher
+
+        ```ruby
+        openssl_ec_private_key '/etc/ssl_files/eckey_prime256v1_des3.pem' do
+          key_curve 'prime256v1'
+          key_cipher 'aes-128-cbc'
+          key_pass 'something'
+          action :create
+        end
+        ```
+      DOC
 
       property :path, String,
         description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",