chef 15.1.36 → 15.2.20

data/lib/chef/resource/link.rb

@@ -48,24 +48,24 @@ class Chef
       end
 
       property :target_file, String,
-               description: "An optional property to set the target file if it differs from the resource block's name.",
-               name_property: true, identity: true
+        description: "An optional property to set the target file if it differs from the resource block's name.",
+        name_property: true, identity: true
 
       property :to, String,
-               description: "The actual file to which the link is to be created."
+        description: "The actual file to which the link is to be created."
 
       property :link_type, [String, Symbol],
-               description: "The type of link: :symbolic or :hard.",
-               coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
-               equal_to: [ :symbolic, :hard ], default: :symbolic
+        description: "The type of link: :symbolic or :hard.",
+        coerce: proc { |arg| arg.is_a?(String) ? arg.to_sym : arg },
+        equal_to: %i{symbolic hard}, default: :symbolic
 
       property :group, [String, Integer],
-               description: "A group name or ID number that identifies the group associated with a symbolic link.",
-               regex: [Chef::Config[:group_valid_regex]]
+        description: "A group name or ID number that identifies the group associated with a symbolic link.",
+        regex: [Chef::Config[:group_valid_regex]]
 
       property :owner, [String, Integer],
-               description: "The owner associated with a symbolic link.",
-               regex: [Chef::Config[:user_valid_regex]]
+        description: "The owner associated with a symbolic link.",
+        regex: [Chef::Config[:user_valid_regex]]
 
       # make link quack like a file (XXX: not for public consumption)
       def path

data/lib/chef/resource/locale.rb

@@ -32,27 +32,27 @@ class Chef
       LOCALE_PLATFORM_FAMILIES = %w{debian}.freeze
 
       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."
+        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."
 
       property :lc_env, Hash,
-               description: "A Hash of LC_* env variables in the form of ({ 'LC_ENV_VARIABLE' => 'VALUE' }).",
-               default: lazy { {} },
-               coerce: proc { |h|
-                         if h.respond_to?(:keys)
-                           invalid_keys = h.keys - LC_VARIABLES
-                           unless invalid_keys.empty?
-                             error_msg = "Key of option lc_env must be equal to one of: \"#{LC_VARIABLES.join('", "')}\"!  You passed \"#{invalid_keys.join(', ')}\"."
-                             raise Chef::Exceptions::ValidationFailed, error_msg
-                           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."
-                           raise Chef::Exceptions::ValidationFailed, error_msg
-                         end
-                         h
-                       }
+        description: "A Hash of LC_* env variables in the form of ({ 'LC_ENV_VARIABLE' => 'VALUE' }).",
+        default: lazy { {} },
+        coerce: proc { |h|
+          if h.respond_to?(:keys)
+            invalid_keys = h.keys - LC_VARIABLES
+            unless invalid_keys.empty?
+              error_msg = "Key of option lc_env must be equal to one of: \"#{LC_VARIABLES.join('", "')}\"!  You passed \"#{invalid_keys.join(", ")}\"."
+              raise Chef::Exceptions::ValidationFailed, error_msg
+            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."
+            raise Chef::Exceptions::ValidationFailed, error_msg
+          end
+          h
+        }
 
       # @deprecated Use {#lc_env} instead of this property.
       #   {#lc_env} uses Hash with specific LC var as key.
@@ -97,7 +97,7 @@ class Chef
         # @raise [Mixlib::ShellOut::ShellCommandFailed] not a supported language or locale
         #
         def generate_locales
-          shell_out!("locale-gen #{unavailable_locales.join(' ')}")
+          shell_out!("locale-gen #{unavailable_locales.join(" ")}")
         end
 
         # Updates system locale by appropriately writing them in /etc/locale.conf

data/lib/chef/resource/log.rb

@@ -39,12 +39,12 @@ class Chef
                   " of the log resource.)"
 
       property :message, String,
-               name_property: true, identity: true,
-               description: "The message to be added to a log file. If not specified we'll use the resource's name instead."
+        name_property: true, identity: true,
+        description: "The message to be added to a log file. If not specified we'll use the resource's name instead."
 
       property :level, Symbol,
-               equal_to: [ :debug, :info, :warn, :error, :fatal ], default: :info,
-               description: "The logging level to display this message at."
+        equal_to: %i{debug info warn error fatal}, default: :info,
+        description: "The logging level to display this message at."
 
       allowed_actions :write
       default_action :write

data/lib/chef/resource/lwrp_base.rb

@@ -115,6 +115,7 @@ class Chef
         # +default_action+ and other DSL-y methods when extending LWRP::Base.
         def from_superclass(m, default = nil)
           return default if superclass == Chef::Resource::LWRPBase
+
           superclass.respond_to?(m) ? superclass.send(m) : default
         end
       end

data/lib/chef/resource/macos_userdefaults.rb

@@ -29,37 +29,37 @@ class Chef
       introduced "14.0"
 
       property :domain, String,
-               description: "The domain that the user defaults belong to.",
-               required: true
+        description: "The domain that the user defaults belong to.",
+        required: true
 
       property :global, [TrueClass, FalseClass],
-               description: "Determines whether or not the domain is global.",
-               default: false
+        description: "Determines whether or not the domain is global.",
+        default: false
 
       property :key, String,
-               description: "The preference key."
+        description: "The preference key."
 
       property :value, [Integer, Float, String, TrueClass, FalseClass, Hash, Array],
-               description: "The value of the key.",
-               required: true
+        description: "The value of the key.",
+        required: true
 
       property :type, String,
-               description: "The value type of the preference key.",
-               default: ""
+        description: "The value type of the preference key.",
+        default: ""
 
       property :user, String,
-               description: "The system user that the default will be applied to."
+        description: "The system user that the default will be applied to."
 
       property :sudo, [TrueClass, FalseClass],
-               description: "Set to true if the setting you wish to modify requires privileged access.",
-               default: false,
-               desired_state: false
+        description: "Set to true if the setting you wish to modify requires privileged access.",
+        default: false,
+        desired_state: false
 
       # @todo this should get refactored away: https://github.com/chef/chef/issues/7622
       property :is_set, [TrueClass, FalseClass],
-               default: false,
-               desired_state: false,
-               skip_docs: true
+        default: false,
+        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
@@ -67,6 +67,7 @@ class Chef
       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)
+
         val
       end
 

data/lib/chef/resource/macosx_service.rb

@@ -28,7 +28,7 @@ class Chef
       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."
+        description: "A plist to use in the case where the filename and label for the service do not match."
 
       property :session_type, String
 

data/lib/chef/resource/mdadm.rb

@@ -33,35 +33,35 @@ class Chef
       allowed_actions :create, :assemble, :stop
 
       property :chunk, Integer,
-               default: 16,
-               description: "The chunk size. This property should not be used for a RAID 1 mirrored pair (i.e. when the level property is set to 1)."
+        default: 16,
+        description: "The chunk size. This property should not be used for a RAID 1 mirrored pair (i.e. when the level property is set to 1)."
 
       property :devices, Array,
-               default: lazy { [] },
-               description: "The devices to be part of a RAID array."
+        default: lazy { [] },
+        description: "The devices to be part of a RAID array."
 
       # @todo this should get refactored away
       property :exists, [ TrueClass, FalseClass ],
-               default: false,
-               skip_docs: true
+        default: false,
+        skip_docs: true
 
       property :level, Integer,
-               default: 1,
-               description: "The RAID level."
+        default: 1,
+        description: "The RAID level."
 
       property :metadata, String,
-               default: "0.90",
-               description: "The superblock type for RAID metadata."
+        default: "0.90",
+        description: "The superblock type for RAID metadata."
 
       property :bitmap, String,
-                description: "The path to a file in which a write-intent bitmap is stored."
+        description: "The path to a file in which a write-intent bitmap is stored."
 
       property :raid_device, String,
-               identity: 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."
+        identity: 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)."
+        description: "The RAID5 parity algorithm. Possible values: left-asymmetric (or la), left-symmetric (or ls), right-asymmetric (or ra), or right-symmetric (or rs)."
     end
   end
 end

data/lib/chef/resource/mount.rb

@@ -29,13 +29,13 @@ class Chef
 
       # this is a poor API please do not re-use this pattern
       property :supports, [Array, Hash],
-               description: "Specify a Hash of supported mount features.",
-               default: lazy { { remount: false } },
-               coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
+        description: "Specify a Hash of supported mount features.",
+        default: lazy { { remount: false } },
+        coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
 
       property :password, String,
-               description: "Windows only:. Use to specify the password for username.",
-               sensitive: true
+        description: "Windows only:. Use to specify the password for username.",
+        sensitive: true
 
       property :mount_point, String, name_property: true,
                description: "The directory (or path) in which the device is to be mounted. Defaults to the name of the resource block if not provided."
@@ -44,44 +44,44 @@ class Chef
                description: "Required for :umount and :remount actions (for the purpose of checking the mount command output for presence). The special block device or remote node, a label, or a uuid to be mounted."
 
       property :device_type, [String, Symbol],
-               description: "The type of device: :device, :label, or :uuid",
-               coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
-               default: :device,
-               equal_to: RUBY_PLATFORM =~ /solaris/i ? %i{ device } : %i{ device label uuid }
+        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 }
 
       # @todo this should get refactored away: https://github.com/chef/chef/issues/7621
       property :mounted, [TrueClass, FalseClass], default: false, skip_docs: true
 
       property :fsck_device, String,
-               description: "Solaris only: The fsck device.",
-               default: "-"
+        description: "Solaris only: The fsck device.",
+        default: "-"
 
       property :fstype, [String, nil],
-               description: "The file system type (fstype) of the device.",
-               default: "auto"
+        description: "The file system type (fstype) of the device.",
+        default: "auto"
 
       property :options, [Array, String, nil],
-               description: "An array or comma separated list of options for the mount.",
-               coerce: proc { |arg| arg.kind_of?(String) ? arg.split(",") : arg },
-               default: %w{defaults}
+        description: "An array or comma separated list of options for the mount.",
+        coerce: proc { |arg| arg.is_a?(String) ? arg.split(",") : arg },
+        default: %w{defaults}
 
       property :dump, [Integer, FalseClass],
-               description: "The dump frequency (in days) used while creating a file systems table (fstab) entry.",
-               default: 0
+        description: "The dump frequency (in days) used while creating a file systems table (fstab) entry.",
+        default: 0
 
       property :pass, [Integer, FalseClass],
-               description: "The pass number used by the file system check (fsck) command while creating a file systems table (fstab) entry.",
-               default: 2
+        description: "The pass number used by the file system check (fsck) command while creating a file systems table (fstab) entry.",
+        default: 2
 
       property :enabled, [TrueClass, FalseClass],
-               description: "Use to specify if a mounted file system is enabled.",
-               default: false
+        description: "Use to specify if a mounted file system is enabled.",
+        default: false
 
       property :username, String,
-               description: "Windows only: Use to specify the user name."
+        description: "Windows only: Use to specify the user name."
 
       property :domain, String,
-               description: "Windows only: Use to specify the domain in which the username and password are located."
+        description: "Windows only: Use to specify the domain in which the username and password are located."
 
       private
 

data/lib/chef/resource/msu_package.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Nimisha Sharad (<nimisha.sharad@msystechnologies.com>)
-# Copyright:: Copyright 2008-2016, Chef Software, Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,13 +34,13 @@ class Chef
       default_action :install
 
       property :source, String,
-               description: "The local file path or URL for the MSU package.",
-               coerce: (proc do |s|
-                 unless s.nil?
-                   uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
-                 end
-               end),
-               default: lazy { |r| r.package_name }
+        description: "The local file path or URL for the MSU package.",
+        coerce: (proc do |s|
+          unless s.nil?
+            uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false)
+          end
+        end),
+        default: lazy { package_name }
 
       property :checksum, String, desired_state: false,
                description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."

data/lib/chef/resource/ohai.rb

@@ -29,7 +29,7 @@ class Chef
       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, the #{Chef::Dist::CLIENT} will reload all plugins."
+        description: "The name of an Ohai plugin to be reloaded. If this property is not specified, the #{Chef::Dist::CLIENT} will reload all plugins."
 
       default_action :reload
       allowed_actions :reload

data/lib/chef/resource/ohai_hint.rb

@@ -27,15 +27,15 @@ class Chef
       introduced "14.0"
 
       property :hint_name, String,
-               description: "An optional property to set the hint name if it differs from the resource block's name.",
-               name_property: true
+        description: "An optional property to set the hint name if it differs from the resource block's name.",
+        name_property: true
 
       property :content, Hash,
-               description: "Values to include in the hint file."
+        description: "Values to include in the hint file."
 
       property :compile_time, [TrueClass, FalseClass],
-               description: "Determines whether or not the resource is executed during the compile time phase.",
-               default: true, desired_state: false
+        description: "Determines whether or not the resource is executed during the compile time phase.",
+        default: true, desired_state: false
 
       action :create do
         description "Create an Ohai hint file."
@@ -79,6 +79,7 @@ class Chef
         # @return [JSON] json representation of the content of an empty string if content was nil
         def format_content(content)
           return "" if content.nil? || content.empty?
+
           JSON.pretty_generate(content)
         end
       end
@@ -88,6 +89,7 @@ class Chef
       # @return [void]
       def after_created
         return unless compile_time
+
         Array(action).each do |action|
           run_action(action)
         end

data/lib/chef/resource/openssl_dhparam.rb

@@ -30,30 +30,30 @@ class Chef
       introduced "14.0"
 
       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.",
-               name_property: true
+        description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
+        name_property: true
 
       property :key_length, Integer,
-               equal_to: [1024, 2048, 4096, 8192],
-               validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
-               description: "The desired bit length of the generated key.",
-               default: 2048
+        equal_to: [1024, 2048, 4096, 8192],
+        validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
+        description: "The desired bit length of the generated key.",
+        default: 2048
 
       property :generator, Integer,
-               equal_to: [2, 5],
-               validation_message: "generator must be either 2 or 5.",
-               description: "The desired Diffie-Hellmann generator.",
-               default: 2
+        equal_to: [2, 5],
+        validation_message: "generator must be either 2 or 5.",
+        description: "The desired Diffie-Hellmann generator.",
+        default: 2
 
       property :owner, [String, Integer],
-               description: "The owner applied to all files created by the resource."
+        description: "The owner applied to all files created by the resource."
 
       property :group, [String, Integer],
-               description: "The group ownership applied to all files created by the resource."
+        description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode applied to all files created by the resource.",
-               default: "0640"
+        description: "The permission mode applied to all files created by the resource.",
+        default: "0640"
 
       action :create do
         description "Create the dhparam file."

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -30,36 +30,36 @@ class Chef
       introduced "14.4"
 
       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.",
-               name_property: true
+        description: "An optional property for specifying the path to write the file to if it differs from the resource block's name.",
+        name_property: true
 
       property :key_curve, String,
-               equal_to: %w{secp384r1 secp521r1 prime256v1 secp224r1 secp256k1},
-               description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.",
-               default: "prime256v1"
+        equal_to: %w{secp384r1 secp521r1 prime256v1 secp224r1 secp256k1},
+        description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.",
+        default: "prime256v1"
 
       property :key_pass, String,
-               description: "The desired passphrase for the key."
+        description: "The desired passphrase for the key."
 
       property :key_cipher, String,
-               equal_to: OpenSSL::Cipher.ciphers,
-               validation_message: "key_cipher must be a cipher known to openssl. Run `openssl list-cipher-algorithms` to see available options.",
-               description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
-               default: "des3"
+        equal_to: OpenSSL::Cipher.ciphers,
+        validation_message: "key_cipher must be a cipher known to openssl. Run `openssl list-cipher-algorithms` to see available options.",
+        description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
+        default: "des3"
 
       property :owner, [String, Integer],
-               description: "The owner applied to all files created by the resource."
+        description: "The owner applied to all files created by the resource."
 
       property :group, [String, Integer],
-               description: "The group ownership applied to all files created by the resource."
+        description: "The group ownership applied to all files created by the resource."
 
       property :mode, [Integer, String],
-               description: "The permission mode applied to all files created by the resource.",
-               default: "0600"
+        description: "The permission mode applied to all files created by the resource.",
+        default: "0600"
 
       property :force, [TrueClass, FalseClass],
-               description: "Force creation of the key even if the same key already exists on the node.",
-               default: false, desired_state: false
+        description: "Force creation of the key even if the same key already exists on the node.",
+        default: false, desired_state: false
 
       action :create do
         description "Generate the ec private key"