chef 15.1.36 → 15.2.20

data/lib/chef/mixin/params_validate.rb

@@ -42,7 +42,7 @@ class Chef
       #     (`opts[:is].any? { |v| v === value }`). (See #_pv_is.)
       #   @option opts [Object,Array] :equal_to An object, or list
       #     of objects, that must be equal to the value using Ruby's `==`
-      #     operator (`opts[:is].any? { |v| v == value }`)  (See #_pv_equal_to.)
+      #     operator (`opts[:equal_to].any? { |v| v == value }`)  (See #_pv_equal_to.)
       #   @option opts [Regexp,Array<Regexp>] :regex An object, or
       #     list of objects, that must match the value with `regex.match(value)`.
       #     (See #_pv_regex)
@@ -90,13 +90,13 @@ class Chef
         # looking for _pv_:symbol as methods.  Assuming it find them, it calls the right
         # one.
         #++
-        raise ArgumentError, "Options must be a hash" unless opts.kind_of?(Hash)
-        raise ArgumentError, "Validation Map must be a hash" unless map.kind_of?(Hash)
+        raise ArgumentError, "Options must be a hash" unless opts.is_a?(Hash)
+        raise ArgumentError, "Validation Map must be a hash" unless map.is_a?(Hash)
 
         @validation_message ||= {}
 
         map.each do |key, validation|
-          unless key.kind_of?(Symbol) || key.kind_of?(String)
+          unless key.is_a?(Symbol) || key.is_a?(String)
             raise ArgumentError, "Validation map keys must be symbols or strings!"
           end
 
@@ -151,6 +151,7 @@ class Chef
         if is_required
           return true if opts.key?(key.to_s) && (explicitly_allows_nil || !opts[key.to_s].nil?)
           return true if opts.key?(key.to_sym) && (explicitly_allows_nil || !opts[key.to_sym].nil?)
+
           raise Exceptions::ValidationFailed, _validation_message(key, "Required argument #{key.inspect} is missing!")
         end
         true
@@ -176,7 +177,7 @@ class Chef
           end
           # Ruby will print :something as something, which confuses users so make sure to print them as symbols
           # by inspecting the value instead of just printing it
-          raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key} must be equal to one of: #{to_be.map { |v| v.inspect }.join(", ")}!  You passed #{value.inspect}.")
+          raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key} must be equal to one of: #{to_be.map(&:inspect).join(", ")}!  You passed #{value.inspect}.")
         end
       end
 
@@ -193,7 +194,7 @@ class Chef
         unless value.nil?
           to_be = Array(to_be)
           to_be.each do |tb|
-            return true if value.kind_of?(tb)
+            return true if value.is_a?(tb)
           end
           raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key} must be a kind of #{to_be}!  You passed #{value.inspect}.")
         end
@@ -236,7 +237,7 @@ class Chef
       #
       def _pv_cannot_be(opts, key, predicate_method_base_name)
         value = _pv_opts_lookup(opts, key)
-        if !value.nil?
+        unless value.nil?
           Array(predicate_method_base_name).each do |method_name|
             predicate_method = :"#{method_name}?"
 
@@ -278,7 +279,7 @@ class Chef
       def _pv_default(opts, key, default_value)
         value = _pv_opts_lookup(opts, key)
         if value.nil?
-          default_value = default_value.freeze if !default_value.is_a?(DelayedEvaluator)
+          default_value = default_value.freeze unless default_value.is_a?(DelayedEvaluator)
           opts[key] = default_value
         end
       end
@@ -298,7 +299,7 @@ class Chef
       #
       def _pv_regex(opts, key, regex)
         value = _pv_opts_lookup(opts, key)
-        if !value.nil?
+        unless value.nil?
           Array(regex).flatten.each do |r|
             return true if r.match(value.to_s)
           end
@@ -319,9 +320,10 @@ class Chef
       #   ```
       #
       def _pv_callbacks(opts, key, callbacks)
-        raise ArgumentError, "Callback list must be a hash!" unless callbacks.kind_of?(Hash)
+        raise ArgumentError, "Callback list must be a hash!" unless callbacks.is_a?(Hash)
+
         value = _pv_opts_lookup(opts, key)
-        if !value.nil?
+        unless value.nil?
           callbacks.each do |message, zeproc|
             unless zeproc.call(value)
               raise Exceptions::ValidationFailed, _validation_message(key, "Option #{key}'s value #{value} #{message}!")
@@ -342,6 +344,7 @@ class Chef
         if is_name_property
           if opts[key].nil?
             raise Exceptions::CannotValidateStaticallyError, "name_property cannot be evaluated without a resource." if self == Chef::Mixin::ParamsValidate
+
             opts[key] = instance_variable_get(:"@name")
           end
         end
@@ -407,6 +410,7 @@ class Chef
       #
       def _pv_is(opts, key, to_be)
         return true if !opts.key?(key.to_s) && !opts.key?(key.to_sym)
+
         value = _pv_opts_lookup(opts, key)
         to_be = [ to_be ].flatten(1)
         errors = []
@@ -414,6 +418,7 @@ class Chef
           case tb
           when Proc
             raise Exceptions::CannotValidateStaticallyError, "is: proc { } must be evaluated once for each resource" if self == Chef::Mixin::ParamsValidate
+
             instance_exec(value, &tb)
           when Property
             begin
@@ -422,6 +427,7 @@ class Chef
             rescue Exceptions::ValidationFailed
               # re-raise immediately if there is only one "is" so we get a better stack
               raise if to_be.size == 1
+
               errors << $!
               false
             end
@@ -432,7 +438,7 @@ class Chef
         if passed
           true
         else
-          message = "Property #{key} must be one of: #{to_be.map { |v| v.inspect }.join(", ")}!  You passed #{value.inspect}."
+          message = "Property #{key} must be one of: #{to_be.map(&:inspect).join(", ")}!  You passed #{value.inspect}."
           unless errors.empty?
             message << " Errors:\n#{errors.map { |m| "- #{m}" }.join("\n")}"
           end
@@ -458,9 +464,11 @@ class Chef
       def _pv_coerce(opts, key, coercer)
         if opts.key?(key.to_s)
           raise Exceptions::CannotValidateStaticallyError, "coerce must be evaluated for each resource." if self == Chef::Mixin::ParamsValidate
+
           opts[key.to_s] = instance_exec(opts[key], &coercer)
         elsif opts.key?(key.to_sym)
           raise Exceptions::CannotValidateStaticallyError, "coerce must be evaluated for each resource." if self == Chef::Mixin::ParamsValidate
+
           opts[key.to_sym] = instance_exec(opts[key], &coercer)
         end
       end
@@ -478,7 +486,7 @@ class Chef
         def get(resource, nil_set: false)
           value = super
           # All values are sticky, frozen or not
-          if !is_set?(resource)
+          unless is_set?(resource)
             set_value(resource, value)
           end
           value

data/lib/chef/mixin/powershell_out.rb

@@ -91,7 +91,7 @@ class Chef
           "-InputFormat None",
         ]
 
-        "powershell.exe #{flags.join(' ')} -Command \"#{script.gsub('"', '\"')}\""
+        "powershell.exe #{flags.join(" ")} -Command \"#{script.gsub('"', '\"')}\""
       end
     end
   end

data/lib/chef/mixin/powershell_type_coercions.rb

@@ -52,14 +52,14 @@ class Chef
         translated = x.inject([]) do |memo, (k, v)|
           memo << "#{k}=#{translate_type(v)}"
         end
-        "@{#{translated.join(';')}}"
+        "@{#{translated.join(";")}}"
       end
 
       def translate_array(x)
         translated = x.map do |v|
           translate_type(v)
         end
-        "@(#{translated.join(',')})"
+        "@(#{translated.join(",")})"
       end
 
       def unsafe?(s)

data/lib/chef/mixin/properties.rb

@@ -102,7 +102,7 @@ class Chef
 
           options = options.inject({}) { |memo, (key, value)| memo[key.to_sym] = value; memo }
 
-          options[:instance_variable_name] = :"@#{name}" if !options.key?(:instance_variable_name)
+          options[:instance_variable_name] = :"@#{name}" unless options.key?(:instance_variable_name)
           options[:name] = name
           options[:declared_in] = self
 
@@ -191,8 +191,8 @@ class Chef
         # @return [Array<Property>] All properties in desired state.
         #
         def state_properties(*names)
-          if !names.empty?
-            names = names.map { |name| name.to_sym }.uniq
+          unless names.empty?
+            names = names.map(&:to_sym).uniq
 
             local_properties = properties(false)
             # Add new properties to the list.
@@ -214,7 +214,7 @@ class Chef
             end
           end
 
-          properties.values.select { |property| property.desired_state? }
+          properties.values.select(&:desired_state?)
         end
 
         #
@@ -240,8 +240,8 @@ class Chef
         # @return [Array<Property>] All identity properties.
         #
         def identity_properties(*names)
-          if !names.empty?
-            names = names.map { |name| name.to_sym }
+          unless names.empty?
+            names = names.map(&:to_sym)
 
             # Add or change properties that are not part of the identity.
             names.each do |name|
@@ -263,7 +263,7 @@ class Chef
             end
           end
 
-          result = properties.values.select { |property| property.identity? }
+          result = properties.values.select(&:identity?)
           result = [ properties[:name] ] if result.empty?
           result
         end
@@ -288,7 +288,8 @@ class Chef
       #
       def property_is_set?(name)
         property = self.class.properties[name.to_sym]
-        raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
+        raise ArgumentError, "Property #{name} is not defined in class #{self}" unless property
+
         property.is_set?(self)
       end
 
@@ -301,7 +302,8 @@ class Chef
       #
       def reset_property(name)
         property = self.class.properties[name.to_sym]
-        raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
+        raise ArgumentError, "Property #{name} is not defined in class #{self}" unless property
+
         property.reset(self)
       end
 
@@ -312,7 +314,8 @@ class Chef
       # @return [String] The description of the property.
       def property_description(name)
         property = self.class.properties[name.to_sym]
-        raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
+        raise ArgumentError, "Property #{name} is not defined in class #{self}" unless property
+
         property.description
       end
 

data/lib/chef/mixin/securable.rb

@@ -44,7 +44,7 @@ class Chef
           arg,
           callbacks: {
             "not in valid numeric range" => lambda do |m|
-              if m.kind_of?(String)
+              if m.is_a?(String)
                 m =~ /^0/ || m = "0#{m}"
               end
 
@@ -128,13 +128,13 @@ class Chef
                   if permission < 0 || permission > 1 << 32
                     raise ArgumentError, "permissions flags must be positive and <= 32 bits (#{permission})"
                   end
-                elsif !([:full_control, :modify, :read_execute, :read, :write].include?(permission.to_sym))
+                elsif !(%i{full_control modify read_execute read write}.include?(permission.to_sym))
                   raise ArgumentError, "permissions parameter must be :full_control, :modify, :read_execute, :read, :write or an integer representing Windows permission flags"
                 end
               end
 
               [ principals ].flatten.each do |principal|
-                if !principal.is_a?(String)
+                unless principal.is_a?(String)
                   raise ArgumentError, "principals parameter must be a string or array of strings representing usernames"
                 end
               end

data/lib/chef/mixin/shell_out.rb

@@ -75,6 +75,7 @@ class Chef
         # historically resources have not properly declared defaults on their timeouts, so a default default of 900s was enforced here
         default_val = 900
         return options if options.key?(:timeout)
+
         # FIXME: need to nuke descendents tracker out of Chef::Provider so we can just define that class here without requiring the
         # world, and then just use symbol lookup
         if obj.class.ancestors.map(&:name).include?("Chef::Provider") && obj.respond_to?(:new_resource) && obj.new_resource.respond_to?(:timeout) && !options.key?(:timeout)

data/lib/chef/mixin/template.rb

@@ -102,6 +102,7 @@ class Chef
         # by the bare `node` everywhere.
         def node
           return @node if @node
+
           raise "Could not find a value for node. If you are explicitly setting variables in a template, " +
             "include a node variable if you plan to use it."
         end
@@ -183,7 +184,7 @@ class Chef
 
         def _extend_modules(module_names)
           module_names.each do |mod|
-            context_methods = [:node, :render, :render_template, :render_template_from_string]
+            context_methods = %i{node render render_template render_template_from_string}
             context_methods.each do |core_method|
               if mod.method_defined?(core_method) || mod.private_method_defined?(core_method)
                 Chef::Log.warn("Core template method `#{core_method}' overridden by extension module #{mod}")

data/lib/chef/mixin/user_context.rb

@@ -30,7 +30,7 @@ class Chef
           raise Exceptions::UnsupportedPlatform, "User context impersonation is supported only on the Windows platform"
         end
 
-        if ! block_given?
+        unless block_given?
           raise ArgumentError, "You must supply a block to `with_user_context`"
         end
 

data/lib/chef/mixin/which.rb

@@ -56,6 +56,7 @@ class Chef
             File.executable?(filename) && !File.directory?(filename)
           end
         return false unless is_executable
+
         block ? yield(filename) : true
       end
     end

data/lib/chef/mixin/windows_architecture_helper.rb

@@ -49,8 +49,8 @@ class Chef
         node ||= begin
           os_arch = ENV["PROCESSOR_ARCHITEW6432"] ||
             ENV["PROCESSOR_ARCHITECTURE"]
-          Hash.new.tap do |n|
-            n[:kernel] = Hash.new
+          {}.tap do |n|
+            n[:kernel] = {}
             n[:kernel][:machine] = os_arch == "AMD64" ? :x86_64 : :i386
           end
         end
@@ -82,9 +82,9 @@ class Chef
       end
 
       def assert_valid_windows_architecture!(architecture)
-        if !valid_windows_architecture?(architecture)
+        unless valid_windows_architecture?(architecture)
           raise Chef::Exceptions::Win32ArchitectureIncorrect,
-          "The specified architecture was not valid. It must be one of :i386 or :x86_64"
+            "The specified architecture was not valid. It must be one of :i386 or :x86_64"
         end
       end
 

data/lib/chef/mixin/windows_env_helper.rb

@@ -46,8 +46,8 @@ class Chef
         if SendMessageTimeoutA(HWND_BROADCAST, WM_SETTINGCHANGE, 0, FFI::MemoryPointer.from_string("Environment").address, flags, 5000, nil) == 0
           Chef::ReservedNames::Win32::Error.raise!
         end
-        if  SendMessageTimeoutW(HWND_BROADCAST, WM_SETTINGCHANGE, 0, FFI::MemoryPointer.from_string(
-            utf8_to_wide("Environment")
+        if SendMessageTimeoutW(HWND_BROADCAST, WM_SETTINGCHANGE, 0, FFI::MemoryPointer.from_string(
+          utf8_to_wide("Environment")
         ).address, flags, 5000, nil) == 0
           Chef::ReservedNames::Win32::Error.raise!
         end

data/lib/chef/monkey_patches/net_http.rb

@@ -25,7 +25,7 @@ module Net
   end
 end
 
-if Net::HTTP.instance_methods.map { |m| m.to_s }.include?("proxy_uri")
+if Net::HTTP.instance_methods.map(&:to_s).include?("proxy_uri")
   begin
     # Ruby 2.0 changes the way proxy support is implemented in Net::HTTP.
     # The implementation does not work correctly with IPv6 literals because it

data/lib/chef/monkey_patches/webrick-utils.rb

@@ -24,11 +24,12 @@ module WEBrick
       unless port
         raise ArgumentError, "must specify port"
       end
+
       res = Socket.getaddrinfo(address, port,
-                                Socket::AF_UNSPEC,   # address family
-                                Socket::SOCK_STREAM, # socket type
-                                0,                   # protocol
-                                Socket::AI_PASSIVE)  # flag
+        Socket::AF_UNSPEC,   # address family
+        Socket::SOCK_STREAM, # socket type
+        0,                   # protocol
+        Socket::AI_PASSIVE)  # flag
       last_error = nil
       sockets = []
       res.each do |ai|
@@ -44,6 +45,7 @@ module WEBrick
         end
       end
       raise last_error if sockets.empty?
+
       sockets
     end
     module_function :create_listeners

data/lib/chef/node.rb

@@ -20,8 +20,8 @@
 
 require "forwardable" unless defined?(Forwardable)
 require "securerandom" unless defined?(SecureRandom)
+require_relative "constants"
 require_relative "config"
-require_relative "nil_argument"
 require_relative "mixin/params_validate"
 require_relative "mixin/from_file"
 require_relative "mixin/deep_merge"
@@ -66,8 +66,6 @@ class Chef
 
     include Chef::Mixin::ParamsValidate
 
-    NULL_ARG = Object.new
-
     # Create a new Chef::Node object.
     def initialize(chef_server_rest: nil, logger: nil)
       @chef_server_rest = chef_server_rest
@@ -90,6 +88,7 @@ class Chef
     # and setup the node[:cookbooks] attribute so that it is published in the node object
     def set_cookbook_attribute
       return unless run_context.cookbook_collection
+
       run_context.cookbook_collection.each do |cookbook_name, cookbook|
         automatic_attrs[:cookbooks][cookbook_name][:version] = cookbook.version
       end
@@ -116,11 +115,12 @@ class Chef
     def name(arg = nil)
       if !arg.nil?
         validate(
-                 { name: arg },
-                 { name: { kind_of: String,
-                           cannot_be: :blank,
-                           regex: /^[\-[:alnum:]_:.]+$/ },
-                 })
+          { name: arg },
+          { name: { kind_of: String,
+                    cannot_be: :blank,
+                    regex: /^[\-[:alnum:]_:.]+$/ },
+          }
+        )
         @name = arg
       else
         @name
@@ -150,8 +150,9 @@ class Chef
     #
     # @param arg [String] the new policy_name value
     # @return [String] the current policy_name, or the one you just set
-    def policy_name(arg = NULL_ARG)
-      return @policy_name if arg.equal?(NULL_ARG)
+    def policy_name(arg = NOT_PASSED)
+      return @policy_name if arg.equal?(NOT_PASSED)
+
       validate({ policy_name: arg }, { policy_name: { kind_of: [ String, NilClass ], regex: /^[\-:.[:alnum:]_]+$/ } })
       @policy_name = arg
     end
@@ -172,8 +173,9 @@ class Chef
     #
     # @param arg [String] the new policy_group value
     # @return [String] the current policy_group, or the one you just set
-    def policy_group(arg = NULL_ARG)
-      return @policy_group if arg.equal?(NULL_ARG)
+    def policy_group(arg = NOT_PASSED)
+      return @policy_group if arg.equal?(NOT_PASSED)
+
       validate({ policy_group: arg }, { policy_group: { kind_of: [ String, NilClass ], regex: /^[\-:.[:alnum:]_]+$/ } })
       @policy_group = arg
     end
@@ -316,6 +318,7 @@ class Chef
     # @return [Chef::RunList] the override run list
     def override_runlist(*args)
       return @override_runlist if args.length == 0
+
       @override_runlist_set = true
       @override_runlist.reset!(args)
     end
@@ -403,6 +406,7 @@ class Chef
         if attrs.key?("recipes") || attrs.key?("run_list")
           raise Chef::Exceptions::AmbiguousRunlistSpecification, "please set the node's run list using the 'run_list' attribute only."
         end
+
         logger.info("Setting the run_list to #{new_run_list} from CLI options")
         run_list(new_run_list)
       end
@@ -518,7 +522,7 @@ class Chef
         "default" => attributes.combined_default.to_hash,
         "override" => attributes.combined_override.to_hash,
         # Render correctly for run_list items so malformed json does not result
-        "run_list" => @primary_runlist.run_list.map { |item| item.to_s },
+        "run_list" => @primary_runlist.run_list.map(&:to_s),
       }
       # Chef Server rejects node JSON with extra keys; prior to 12.3,
       # "policy_name" and "policy_group" are unknown; after 12.3 they are
@@ -542,7 +546,8 @@ class Chef
     end
 
     def self.from_hash(o)
-      return o if o.kind_of? Chef::Node
+      return o if o.is_a? Chef::Node
+
       node = new
       node.name(o["name"])
 
@@ -574,7 +579,7 @@ class Chef
 
     def self.list_by_environment(environment, inflate = false)
       if inflate
-        response = Hash.new
+        response = {}
         Chef::Search::Query.new.search(:node, "chef_environment:#{environment}") { |n| response[n.name] = n unless n.nil? }
         response
       else
@@ -584,7 +589,7 @@ class Chef
 
     def self.list(inflate = false)
       if inflate
-        response = Hash.new
+        response = {}
         Chef::Search::Query.new.search(:node) do |n|
           n = Chef::Node.from_hash(n)
           response[n.name] = n unless n.nil?
@@ -599,6 +604,7 @@ class Chef
       load(node_name)
     rescue Net::HTTPClientException => e
       raise unless e.response.code == "404"
+
       node = build(node_name)
       node.create
     end
@@ -660,7 +666,7 @@ class Chef
     end
 
     def ==(other)
-      if other.kind_of?(self.class)
+      if other.is_a?(self.class)
         name == other.name
       else
         false
@@ -679,6 +685,7 @@ class Chef
       chef_server_rest.put("nodes/#{name}", trimmed_data)
     rescue Net::HTTPClientException => e
       raise e unless e.response.code == "404"
+
       chef_server_rest.post("nodes", trimmed_data)
     end