chef 16.0.257-universal-mingw32 → 16.2.44-universal-mingw32

data/lib/chef/resource/ips_package.rb

@@ -27,7 +27,7 @@ class Chef
       provides :ips_package
       provides :package, os: "solaris2"
 
-      description "Use the ips_package resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
+      description "Use the **ips_package** resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
 
       allowed_actions :install, :remove, :upgrade
 

data/lib/chef/resource/kernel_module.rb

@@ -15,15 +15,18 @@ class Chef
 
       provides :kernel_module
 
-      description "Use the kernel_module resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
+      description "Use the **kernel_module** resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, 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 [
@@ -32,31 +35,41 @@ class Chef
           ]
         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.
+
         ```ruby
         kernel_module 'loop' do
           action :disable

data/lib/chef/resource/ksh.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides :ksh
 
-      description "Use the ksh resource to execute scripts using the Korn shell (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"\
                   " with this resource are (by their nature) not idempotent, as they are"\

data/lib/chef/resource/launchd.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       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
@@ -76,20 +76,20 @@ class Chef
       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
+          # 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
+          # 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
+          # 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) }
@@ -105,7 +105,7 @@ class Chef
             end
           end
 
-                  # Don't return array if we only have one entry
+          # Don't return array if we only have one entry
           if array.size == 1
             array.first
           else

data/lib/chef/resource/link.rb

@@ -28,14 +28,14 @@ class Chef
 
       provides :link
 
-      description "Use the link resource to create symbolic or hard links.\n\n"\
+      description "Use the **link** resource to create symbolic or hard links.\n\n"\
                   "A symbolic link—sometimes referred to as a soft link—is a directory entry"\
                   " that associates a file name with a string that contains an absolute or"\
-                  " relative path to a file on any file system. In other words, “a file that"\
-                  " contains a path that points to another file.” A symbolic link creates a new"\
+                  " relative path to a file on any file system. In other words, 'a file that"\
+                  " contains a path that points to another file.' A symbolic link creates a new"\
                   " file with a new inode that points to the inode location of the original file.\n\n"\
                   "A hard link is a directory entry that associates a file with another file in the"\
-                  " same file system. In other words, “multiple directory entries to the same file.”"\
+                  " same file system. In other words, 'multiple directory entries to the same file.'"\
                   " A hard link creates a new file that points to the same inode as the original file."
 
       state_attrs :owner # required since it's not a property below

data/lib/chef/resource/locale.rb

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       provides :locale
 
-      description "Use the locale resource to set the system's locale on Debian and Windows systems. Windows support was added in Chef Infra Client 16.0"
+      description "Use the **locale** resource to set the system's locale on Debian and Windows systems. Windows support was added in Chef Infra Client 16.0"
       introduced "14.5"
 
       examples <<~DOC
@@ -45,7 +45,7 @@ class Chef
       property :lang, String,
         description: "Sets the default system language.",
         regex: [LOCALE_REGEX],
-        validation_message: "The provided lang is not valid. It should be a non-empty string without any leading whitespaces."
+        validation_message: "The provided lang is not valid. It should be a non-empty string without any leading whitespace."
 
       property :lc_env, Hash,
         description: "A Hash of LC_* env variables in the form of `({ 'LC_ENV_VARIABLE' => 'VALUE' })`.",
@@ -59,7 +59,7 @@ class Chef
             end
           end
           unless h.values.all? { |x| x =~ LOCALE_REGEX }
-            error_msg = "Values of option lc_env should be non-empty string without any leading whitespaces."
+            error_msg = "Values of option lc_env should be non-empty string without any leading whitespace."
             raise Chef::Exceptions::ValidationFailed, error_msg
           end
           h
@@ -120,7 +120,7 @@ class Chef
           end
         end
 
-        # Generates the localisation files from templates using locale-gen.
+        # Generates the localization files from templates using locale-gen.
         # @see http://manpages.ubuntu.com/manpages/cosmic/man8/locale-gen.8.html
         # @raise [Mixlib::ShellOut::ShellCommandFailed] not a supported language or locale
         #

data/lib/chef/resource/log.rb

@@ -33,7 +33,7 @@ class Chef
 
       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"\

data/lib/chef/resource/macos_userdefaults.rb

@@ -26,7 +26,7 @@ class Chef
       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,
@@ -62,9 +62,9 @@ class Chef
         desired_state: false,
         skip_docs: true
 
-       # coerce various ways of representing a boolean into either 0 (false) or 1 (true)
-       # which is what the defaults CLI expects. Why? Well defaults itself accepts a few
-       # different formats, but when you do a read command it all comes back as 1 or 0.
+      # coerce various ways of representing a boolean into either 0 (false) or 1 (true)
+      # which is what the defaults CLI expects. Why? Well defaults itself accepts a few
+      # different formats, but when you do a read command it all comes back as 1 or 0.
       def coerce_booleans(val)
         return 1 if [true, "TRUE", "1", "true", "YES", "yes"].include?(val)
         return 0 if [false, "FALSE", "0", "false", "NO", "no"].include?(val)
@@ -74,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

data/lib/chef/resource/macosx_service.rb

@@ -26,7 +26,7 @@ class Chef
       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

@@ -24,7 +24,7 @@ class Chef
       unified_mode true
       provides :macports_package
 
-      description "Use the macports_package resource to manage packages for the macOS platform using the MacPorts package management system."
+      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.",

data/lib/chef/resource/mdadm.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :mdadm
 
-      description "Use the mdadm resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
+      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."

data/lib/chef/resource/mount.rb

@@ -22,7 +22,7 @@ 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
@@ -50,7 +50,7 @@ class Chef
         description: "The type of device: :device, :label, or :uuid",
         coerce: proc { |arg| arg.is_a?(String) ? arg.to_sym : arg },
         default: :device,
-        equal_to: RUBY_PLATFORM =~ /solaris/i ? %i{ device } : %i{ device label uuid }
+        equal_to: RUBY_PLATFORM.match?(/solaris/i) ? %i{ device } : %i{ device label uuid }
 
       # @todo this should get refactored away: https://github.com/chef/chef/issues/7621
       property :mounted, [TrueClass, FalseClass], default: false, skip_docs: true

data/lib/chef/resource/msu_package.rb

@@ -27,7 +27,7 @@ class Chef
 
       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
@@ -39,7 +39,7 @@ class Chef
 
       # 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 versio of the
+      # 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,

data/lib/chef/resource/ohai.rb

@@ -29,7 +29,7 @@ class Chef
 
       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."

data/lib/chef/resource/ohai_hint.rb

@@ -24,7 +24,7 @@ class Chef
 
       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,

data/lib/chef/resource/openbsd_package.rb

@@ -29,7 +29,7 @@ class Chef
       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,

data/lib/chef/resource/openssl_dhparam.rb

@@ -25,7 +25,7 @@ class Chef
 
       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

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -26,7 +26,7 @@ class Chef
 
       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

data/lib/chef/resource/openssl_ec_public_key.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :openssl_ec_public_key
 
-      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files from a given EC private key."
+      description "Use the **openssl_ec_public_key** resource to generate elliptic curve (EC) public key files from a given EC private key."
       introduced "14.4"
       examples <<~DOC
         Generate new ec public key from a private key on disk

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -26,7 +26,7 @@ class Chef
       provides(:openssl_rsa_private_key) { true }
       provides(:openssl_rsa_key) { true } # legacy cookbook resource name
 
-      description "Use the openssl_rsa_private_key resource to generate RSA private key files. If a valid RSA key file can be opened at the specified location, no new file will be created. If the RSA key file cannot be opened, either because it does not exist or because the password to the RSA key file does not match the password in the recipe, it will be overwritten."
+      description "Use the **openssl_rsa_private_key** resource to generate RSA private key files. If a valid RSA key file can be opened at the specified location, no new file will be created. If the RSA key file cannot be opened, either because it does not exist or because the password to the RSA key file does not match the password in the recipe, it will be overwritten."
       introduced "14.0"
       examples <<~DOC
         Generate new 2048bit key with the default des3 cipher

data/lib/chef/resource/openssl_rsa_public_key.rb

@@ -47,7 +47,7 @@ class Chef
         ```
       DOC
 
-      description "Use the openssl_rsa_public_key resource to generate RSA public key files for a given RSA private key."
+      description "Use the **openssl_rsa_public_key** resource to generate RSA public key files for a given RSA private key."
       introduced "14.0"
 
       property :path, String,

data/lib/chef/resource/openssl_x509_certificate.rb

@@ -27,7 +27,7 @@ class Chef
       provides :openssl_x509_certificate
       provides(:openssl_x509) { true } # legacy cookbook name.
 
-      description "Use the openssl_x509_certificate resource to generate signed or self-signed, PEM-formatted x509 certificates. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate. If a CA private key and certificate are provided, the certificate will be signed with them. Note: This resource was renamed from openssl_x509 to openssl_x509_certificate. The legacy name will continue to function, but cookbook code should be updated for the new resource name."
+      description "Use the **openssl_x509_certificate** resource to generate signed or self-signed, PEM-formatted x509 certificates. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate. If a CA private key and certificate are provided, the certificate will be signed with them. Note: This resource was renamed from openssl_x509 to openssl_x509_certificate. The legacy name will continue to function, but cookbook code should be updated for the new resource name."
       introduced "14.4"
       examples <<~DOC
         Create a simple self-signed certificate file

data/lib/chef/resource/openssl_x509_crl.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :openssl_x509_crl
 
-      description "Use the openssl_x509_crl resource to generate PEM-formatted x509 certificate revocation list (CRL) files."
+      description "Use the **openssl_x509_crl** resource to generate PEM-formatted x509 certificate revocation list (CRL) files."
       introduced "14.4"
       examples <<~DOC
         Generate a CRL file given a cert file and key file

data/lib/chef/resource/openssl_x509_request.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :openssl_x509_request
 
-      description "Use the openssl_x509_request resource to generate PEM-formatted x509 certificates requests. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate."
+      description "Use the **openssl_x509_request** resource to generate PEM-formatted x509 certificates requests. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate."
       introduced "14.4"
       examples <<~DOC
         Generate new ec key and csr file

data/lib/chef/resource/osx_profile.rb

@@ -26,7 +26,7 @@ class Chef
       provides :osx_profile
       provides :osx_config_profile
 
-      description "Use the osx_profile resource to manage configuration profiles (.mobileconfig files) on the macOS platform. The osx_profile resource installs profiles by using the uuidgen library to generate a unique ProfileUUID, and then using the profiles command to install the profile on the system."
+      description "Use the **osx_profile** resource to manage configuration profiles (.mobileconfig files) on the macOS platform. The osx_profile resource installs profiles by using the uuidgen library to generate a unique ProfileUUID, and then using the profiles command to install the profile on the system."
       introduced "12.7"
 
       default_action :install

data/lib/chef/resource/package.rb

@@ -25,7 +25,7 @@ class Chef
       unified_mode true
       provides :package
 
-      description "Use the package resource to manage packages. When the package is"\
+      description "Use the **package** resource to manage packages. When the package is"\
                   " installed from a local file (such as with RubyGems, dpkg, or RPM"\
                   " Package Manager), the file must be added to the node using the remote_file"\
                   " or cookbook_file resources.\n\nThis resource is the base resource for"\

data/lib/chef/resource/pacman_package.rb

@@ -25,7 +25,7 @@ class Chef
 
       provides :pacman_package
 
-      description "Use the pacman_package resource to manage packages (using pacman) on the Arch Linux platform."
+      description "Use the **pacman_package** resource to manage packages (using pacman) on the Arch Linux platform."
     end
   end
 end

data/lib/chef/resource/paludis_package.rb

@@ -26,7 +26,7 @@ class Chef
 
       provides :paludis_package
 
-      description "Use the paludis_package resource to manage packages for the Paludis platform."
+      description "Use the **paludis_package** resource to manage packages for the Paludis platform."
       introduced "12.1"
 
       allowed_actions :install, :remove, :upgrade