chef 14.2.0 → 14.3.37

data/lib/chef/dsl/audit.rb

@@ -30,7 +30,7 @@ class Chef
         name = args[0]
         if name.nil? || name.empty?
           raise Chef::Exceptions::AuditNameMissing
-        elsif run_context.audits.has_key?(name)
+        elsif run_context.audits.key?(name)
           raise Chef::Exceptions::AuditControlGroupDuplicate.new(name)
         end
 

data/lib/chef/dsl/definitions.rb

@@ -18,7 +18,7 @@ class Chef
 
       # @api private
       def has_resource_definition?(name)
-        run_context.definitions.has_key?(name)
+        run_context.definitions.key?(name)
       end
 
       # Processes the arguments and block as a resource definition.

data/lib/chef/dsl/platform_introspection.rb

@@ -259,6 +259,11 @@ class Chef
            node[:virtualization][:systems][:docker] && node[:virtualization][:systems][:docker] == "guest")
       end
 
+      # a simple helper to determine if we're on a windows release pre-2012 / 8
+      # @return [Boolean] Is the system older than Windows 8 / 2012
+      def older_than_win_2012_or_8?(node = run_context.nil? ? nil : run_context.node)
+        node["platform_version"].to_f < 6.2
+      end
     end
   end
 end

data/lib/chef/dsl/reboot_pending.rb

@@ -37,7 +37,7 @@ class Chef
           # due to a file being in use (usually a temporary file and a system file)
           # \??\c:\temp\test.sys!\??\c:\winnt\system32\test.sys
           # http://technet.microsoft.com/en-us/library/cc960241.aspx
-          registry_value_exists?('HKLM\SYSTEM\CurrentControlSet\Control\Session Manager', { :name => "PendingFileRenameOperations" }) ||
+          registry_value_exists?('HKLM\SYSTEM\CurrentControlSet\Control\Session Manager', { name: "PendingFileRenameOperations" }) ||
 
           # RebootRequired key contains Update IDs with a value of 1 if they require a reboot.
           # The existence of RebootRequired alone is sufficient on my Windows 8.1 workstation in Windows Update

data/lib/chef/encrypted_data_bag_item.rb

@@ -47,8 +47,8 @@ require "open-uri"
 # such nodes in the infrastructure.
 #
 class Chef::EncryptedDataBagItem
-  ALGORITHM = "aes-256-cbc"
-  AEAD_ALGORITHM = "aes-256-gcm"
+  ALGORITHM = "aes-256-cbc".freeze
+  AEAD_ALGORITHM = "aes-256-gcm".freeze
 
   #
   # === Synopsis

data/lib/chef/encrypted_data_bag_item/check_encrypted.rb

@@ -39,7 +39,7 @@ class Chef::EncryptedDataBagItem
     # true only when there is an exact match between the VersionXEncryptor
     # keys and the hash's keys.
     def looks_like_encrypted?(data)
-      return false unless data.is_a?(Hash) && data.has_key?("version")
+      return false unless data.is_a?(Hash) && data.key?("version")
       case data["version"]
         when 1
           Chef::EncryptedDataBagItem::Encryptor::Version1Encryptor.encryptor_keys.sort == data.keys.sort

data/lib/chef/encrypted_data_bag_item/encryptor.rb

@@ -123,7 +123,7 @@ class Chef::EncryptedDataBagItem
       # Strings) that do not produce valid JSON when serialized without the
       # wrapper.
       def serialized_data
-        FFI_Yajl::Encoder.encode(:json_wrapper => plaintext_data)
+        FFI_Yajl::Encoder.encode(json_wrapper: plaintext_data)
       end
 
       def self.encryptor_keys

data/lib/chef/environment.rb

@@ -29,7 +29,7 @@ require "chef/server_api"
 class Chef
   class Environment
 
-    DEFAULT = "default"
+    DEFAULT = "default".freeze
 
     include Chef::Mixin::ParamsValidate
     include Chef::Mixin::FromFile
@@ -57,7 +57,7 @@ class Chef
       set_or_return(
         :name,
         arg,
-        { :regex => /^[\-[:alnum:]_]+$/, :kind_of => String }
+        { regex: /^[\-[:alnum:]_]+$/, kind_of: String }
       )
     end
 
@@ -65,7 +65,7 @@ class Chef
       set_or_return(
         :description,
         arg,
-        :kind_of => String
+        kind_of: String
       )
     end
 
@@ -73,7 +73,7 @@ class Chef
       set_or_return(
         :default_attributes,
         arg,
-        :kind_of => Hash
+        kind_of: Hash
       )
     end
 
@@ -85,7 +85,7 @@ class Chef
       set_or_return(
         :override_attributes,
         arg,
-        :kind_of => Hash
+        kind_of: Hash
       )
     end
 
@@ -98,8 +98,8 @@ class Chef
         :cookbook_versions,
         arg,
         {
-          :kind_of => Hash,
-          :callbacks => {
+          kind_of: Hash,
+          callbacks: {
             "should be a valid set of cookbook version requirements" => lambda { |cv| Chef::Environment.validate_cookbook_versions(cv) },
           },
         }
@@ -108,10 +108,10 @@ class Chef
 
     def cookbook(cookbook, version)
       validate({
-        :version => version,
+        version: version,
       }, {
-        :version => {
-          :callbacks => { "should be a valid version requirement" => lambda { |v| Chef::Environment.validate_cookbook_version(v) } },
+        version: {
+          callbacks: { "should be a valid version requirement" => lambda { |v| Chef::Environment.validate_cookbook_version(v) } },
         },
       })
       @cookbook_versions[cookbook] = version

data/lib/chef/event_loggers/windows_eventlog.rb

@@ -35,7 +35,7 @@ class Chef
       LOG_CATEGORY_ID = 11001
 
       # Since we must install the event logger, this is not really configurable
-      SOURCE = "Chef"
+      SOURCE = "Chef".freeze
 
       def self.available?
         Chef::Platform.windows?
@@ -47,36 +47,36 @@ class Chef
 
       def run_start(version)
         @eventlog.report_event(
-          :event_type => ::Win32::EventLog::INFO_TYPE,
-          :source => SOURCE,
-          :event_id => RUN_START_EVENT_ID,
-          :data => [version]
+          event_type: ::Win32::EventLog::INFO_TYPE,
+          source: SOURCE,
+          event_id: RUN_START_EVENT_ID,
+          data: [version]
         )
       end
 
       def run_started(run_status)
         @run_status = run_status
         @eventlog.report_event(
-          :event_type => ::Win32::EventLog::INFO_TYPE,
-          :source => SOURCE,
-          :event_id => RUN_STARTED_EVENT_ID,
-          :data => [run_status.run_id]
+          event_type: ::Win32::EventLog::INFO_TYPE,
+          source: SOURCE,
+          event_id: RUN_STARTED_EVENT_ID,
+          data: [run_status.run_id]
         )
       end
 
       def run_completed(node)
         @eventlog.report_event(
-          :event_type => ::Win32::EventLog::INFO_TYPE,
-          :source => SOURCE,
-          :event_id => RUN_COMPLETED_EVENT_ID,
-          :data => [@run_status.run_id, @run_status.elapsed_time.to_s]
+          event_type: ::Win32::EventLog::INFO_TYPE,
+          source: SOURCE,
+          event_id: RUN_COMPLETED_EVENT_ID,
+          data: [@run_status.run_id, @run_status.elapsed_time.to_s]
         )
       end
 
-      #Failed chef-client run %1 in %2 seconds.
-      #Exception type: %3
-      #Exception message: %4
-      #Exception backtrace: %5
+      # Failed chef-client run %1 in %2 seconds.
+      # Exception type: %3
+      # Exception message: %4
+      # Exception backtrace: %5
       def run_failed(e)
         data =
           if @run_status
@@ -87,10 +87,10 @@ class Chef
           end
 
         @eventlog.report_event(
-          :event_type => ::Win32::EventLog::ERROR_TYPE,
-          :source => SOURCE,
-          :event_id => RUN_FAILED_EVENT_ID,
-          :data => data + [e.class.name,
+          event_type: ::Win32::EventLog::ERROR_TYPE,
+          source: SOURCE,
+          event_id: RUN_FAILED_EVENT_ID,
+          data: data + [e.class.name,
                            e.message,
                            e.backtrace.join("\n")]
         )

data/lib/chef/exceptions.rb

@@ -398,9 +398,9 @@ class Chef
     # length declared in the http response.
     class ContentLengthMismatch < RuntimeError
       def initialize(response_length, content_length)
-        super <<-EOF
-Response body length #{response_length} does not match HTTP Content-Length header #{content_length}.
-This error is most often caused by network issues (proxies, etc) outside of chef-client.
+        super <<~EOF
+          Response body length #{response_length} does not match HTTP Content-Length header #{content_length}.
+          This error is most often caused by network issues (proxies, etc) outside of chef-client.
         EOF
       end
     end

data/lib/chef/file_cache.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,12 +42,12 @@ class Chef
       def store(path, contents, perm = 0640)
         validate(
           {
-            :path => path,
-            :contents => contents,
+            path: path,
+            contents: contents,
           },
           {
-            :path => { :kind_of => String },
-            :contents => { :kind_of => String },
+            path: { kind_of: String },
+            contents: { kind_of: String },
           }
         )
 
@@ -68,12 +68,12 @@ class Chef
       def move_to(file, path)
         validate(
           {
-            :file => file,
-            :path => path,
+            file: file,
+            path: path,
           },
           {
-            :file => { :kind_of => String },
-            :path => { :kind_of => String },
+            file: { kind_of: String },
+            path: { kind_of: String },
           }
         )
 
@@ -105,10 +105,10 @@ class Chef
       def load(path, read = true)
         validate(
           {
-            :path => path,
+            path: path,
           },
           {
-            :path => { :kind_of => String },
+            path: { kind_of: String },
           }
         )
         cache_path = create_cache_path(path, false)
@@ -131,10 +131,10 @@ class Chef
       def delete(path)
         validate(
           {
-            :path => path,
+            path: path,
           },
           {
-            :path => { :kind_of => String },
+            path: { kind_of: String },
           }
         )
         cache_path = create_cache_path(path, false)
@@ -175,13 +175,13 @@ class Chef
       # === Returns
       # True:: If the file exists
       # False:: If it does not
-      def has_key?(path)
+      def key?(path)
         validate(
           {
-            :path => path,
+            path: path,
           },
           {
-            :path => { :kind_of => String },
+            path: { kind_of: String },
           }
         )
         full_path = create_cache_path(path, false)
@@ -192,6 +192,8 @@ class Chef
         end
       end
 
+      alias_method :has_key?, :key?
+
       # Create a full path to a given file in the cache. By default,
       # also creates the path if it does not exist.
       #

data/lib/chef/formatters/base.rb

@@ -96,7 +96,7 @@ class Chef
         if @output.indent < 0
           # This is left commented out for now.  We need to uncomment it and fix at least one bug in
           # the formatter, and then leave this line uncommented in the future.
-          #Chef::Log.warn "Internal Formatter Error -- Attempt to indent by negative number of spaces"
+          # Chef::Log.warn "Internal Formatter Error -- Attempt to indent by negative number of spaces"
           @output.indent = 0
         end
         @output.indent
@@ -110,7 +110,7 @@ class Chef
       end
 
       def registration_failed(node_name, exception, config)
-        #A Formatters::ErrorDescription object
+        # A Formatters::ErrorDescription object
         description = ErrorMapper.registration_failed(node_name, exception, config)
         display_error(description)
       end
@@ -212,14 +212,13 @@ class Chef
         file_load_failed(path, exception)
       end
 
-      def deprecation(message, location = caller(2..2)[0])
-        out = if is_structured_deprecation?(message)
-                message.inspect
-              else
-                "#{message} at #{location}"
-              end
-
-        Chef::Log.deprecation(out)
+      # Log a deprecation warning object.
+      #
+      # @param deprecation [Chef::Deprecated::Base] Deprecation object to log.
+      #   In previous versions, this could be a string. Don't do that anymore.
+      # @param location [Object] Unused, present only for compatbility.
+      def deprecation(deprecation, _location = nil)
+        Chef::Log.deprecation(deprecation.to_s) unless deprecation.silenced?
       end
 
       def is_structured_deprecation?(deprecation)

data/lib/chef/formatters/doc.rb

@@ -254,7 +254,7 @@ class Chef
         puts_line ""
         puts_line "Audit phase exception:"
         indent
-        puts_line "#{error.message}"
+        puts_line (error.message).to_s
         if error.backtrace
           error.backtrace.each do |l|
             puts_line l
@@ -285,7 +285,7 @@ class Chef
           indent
         end
         # TODO: info about notifies
-        start_line "* #{resource} action #{action}", :stream => resource
+        start_line "* #{resource} action #{action}", stream: resource
         indent
       end
 
@@ -318,7 +318,7 @@ class Chef
       def resource_skipped(resource, action, conditional)
         @skipped_resources += 1
         # TODO: more info about conditional
-        puts " (skipped due to #{conditional.short_description})", :stream => resource
+        puts " (skipped due to #{conditional.short_description})", stream: resource
         unindent
       end
 
@@ -329,12 +329,12 @@ class Chef
       # Called when a resource has no converge actions, e.g., it was already correct.
       def resource_up_to_date(resource, action)
         @up_to_date_resources += 1
-        puts " (up to date)", :stream => resource
+        puts " (up to date)", stream: resource
         unindent
       end
 
       def resource_bypassed(resource, action, provider)
-        puts " (Skipped: whyrun not supported by provider #{provider.class.name})", :stream => resource
+        puts " (Skipped: whyrun not supported by provider #{provider.class.name})", stream: resource
         unindent
       end
 
@@ -375,7 +375,7 @@ class Chef
       end
 
       def stream_output(stream, output, options = {})
-        print(output, { :stream => stream }.merge(options))
+        print(output, { stream: stream }.merge(options))
       end
 
       # Called before handlers run
@@ -414,19 +414,15 @@ class Chef
         end
       end
 
-      def deprecation(message, location = caller(2..2)[0])
+      # (see Base#deprecation)
+      def deprecation(deprecation, _location = nil)
         if Chef::Config[:treat_deprecation_warnings_as_errors]
           super
+        elsif !deprecation.silenced?
+          # Save non-silenced deprecations to the screen until the end.
+          deprecations[deprecation.message] ||= { url: deprecation.url, locations: Set.new }
+          deprecations[deprecation.message][:locations] << deprecation.location
         end
-
-        # Save deprecations to the screen until the end
-        if is_structured_deprecation?(message)
-          url = message.url
-          message = message.message
-        end
-
-        deprecations[message] ||= { url: url, locations: Set.new }
-        deprecations[message][:locations] << location
       end
 
       def indent

data/lib/chef/formatters/error_inspectors/api_error_formatting.rb

@@ -23,82 +23,82 @@ class Chef
 
     module APIErrorFormatting
 
-      NETWORK_ERROR_CLASSES = [Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError]
+      NETWORK_ERROR_CLASSES = [Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError].freeze
 
       def describe_network_errors(error_description)
-        error_description.section("Networking Error:", <<-E)
-#{exception.message}
+        error_description.section("Networking Error:", <<~E)
+          #{exception.message}
 
-Your chef_server_url may be misconfigured, or the network could be down.
+          Your chef_server_url may be misconfigured, or the network could be down.
 E
-        error_description.section("Relevant Config Settings:", <<-E)
-chef_server_url  "#{server_url}"
+        error_description.section("Relevant Config Settings:", <<~E)
+          chef_server_url  "#{server_url}"
 E
       end
 
       def describe_eof_error(error_description)
-        error_description.section("Authentication Error:", <<-E)
-Received an EOF on transport socket.  This almost always indicates a network
-error external to chef-client.  Some causes include:
+        error_description.section("Authentication Error:", <<~E)
+          Received an EOF on transport socket.  This almost always indicates a network
+          error external to chef-client.  Some causes include:
 
-  - Blocking ICMP Dest Unreachable (breaking Path MTU Discovery)
-  - IPsec or VPN tunnelling / TCP Encapsulation MTU issues
-  - Jumbo frames configured only on one side (breaking Path MTU)
-  - Jumbo frames configured on a LAN that does not support them
-  - Proxies or Load Balancers breaking large POSTs
-  - Broken TCP offload in network drivers/hardware
+            - Blocking ICMP Dest Unreachable (breaking Path MTU Discovery)
+            - IPsec or VPN tunnelling / TCP Encapsulation MTU issues
+            - Jumbo frames configured only on one side (breaking Path MTU)
+            - Jumbo frames configured on a LAN that does not support them
+            - Proxies or Load Balancers breaking large POSTs
+            - Broken TCP offload in network drivers/hardware
 
-Try sending large pings to the destination:
+          Try sending large pings to the destination:
 
-   windows:  ping server.example.com -f -l 9999
-   unix:  ping server.example.com -s 9999
+             windows:  ping server.example.com -f -l 9999
+             unix:  ping server.example.com -s 9999
 
-Try sending large POSTs to the destination (any HTTP code returned is success):
+          Try sending large POSTs to the destination (any HTTP code returned is success):
 
-   e.g.:  curl http://server.example.com/`printf '%*s' 9999 '' | tr ' ' 'a'`
+             e.g.:  curl http://server.example.com/`printf '%*s' 9999 '' | tr ' ' 'a'`
 
-Try disabling TCP Offload Engines (TOE) in your ethernet drivers.
+          Try disabling TCP Offload Engines (TOE) in your ethernet drivers.
 
-  windows:
-    Disable-NetAdapterChecksumOffload * -TcpIPv4 -UdpIPv4 -IpIPv4 -NoRestart
-    Disable-NetAdapterLso * -IPv4 -NoRestart
-    Set-NetAdapterAdvancedProperty * -DisplayName "Large Receive Offload (IPv4)" -DisplayValue Disabled –NoRestart
-    Restart-NetAdapter *
-  unix(bash):
-    for i in rx tx sg tso ufo gso gro lro rxvlan txvlan rxhash; do /sbin/ethtool -K eth0 $i off; done
+            windows:
+              Disable-NetAdapterChecksumOffload * -TcpIPv4 -UdpIPv4 -IpIPv4 -NoRestart
+              Disable-NetAdapterLso * -IPv4 -NoRestart
+              Set-NetAdapterAdvancedProperty * -DisplayName "Large Receive Offload (IPv4)" -DisplayValue Disabled –NoRestart
+              Restart-NetAdapter *
+            unix(bash):
+              for i in rx tx sg tso ufo gso gro lro rxvlan txvlan rxhash; do /sbin/ethtool -K eth0 $i off; done
 
-In some cases the underlying virtualization layer (Xen, VMware, KVM, Hyper-V, etc) may have
-broken virtual networking code.
+          In some cases the underlying virtualization layer (Xen, VMware, KVM, Hyper-V, etc) may have
+          broken virtual networking code.
         E
       end
 
       def describe_401_error(error_description)
         if clock_skew?
-          error_description.section("Authentication Error:", <<-E)
-Failed to authenticate to the chef server (http 401).
-The request failed because your clock has drifted by more than 15 minutes.
-Syncing your clock to an NTP Time source should resolve the issue.
+          error_description.section("Authentication Error:", <<~E)
+            Failed to authenticate to the chef server (http 401).
+            The request failed because your clock has drifted by more than 15 minutes.
+            Syncing your clock to an NTP Time source should resolve the issue.
 E
         else
-          error_description.section("Authentication Error:", <<-E)
-Failed to authenticate to the chef server (http 401).
+          error_description.section("Authentication Error:", <<~E)
+            Failed to authenticate to the chef server (http 401).
 E
 
           error_description.section("Server Response:", format_rest_error)
-          error_description.section("Relevant Config Settings:", <<-E)
-chef_server_url   "#{server_url}"
-node_name         "#{username}"
-client_key        "#{api_key}"
+          error_description.section("Relevant Config Settings:", <<~E)
+            chef_server_url   "#{server_url}"
+            node_name         "#{username}"
+            client_key        "#{api_key}"
 
-If these settings are correct, your client_key may be invalid, or
-you may have a chef user with the same client name as this node.
+            If these settings are correct, your client_key may be invalid, or
+            you may have a chef user with the same client name as this node.
 E
         end
       end
 
       def describe_400_error(error_description)
-        error_description.section("Invalid Request Data:", <<-E)
-The data in your request was invalid (HTTP 400).
+        error_description.section("Invalid Request Data:", <<~E)
+          The data in your request was invalid (HTTP 400).
 E
         error_description.section("Server Response:", format_rest_error)
       end
@@ -110,11 +110,11 @@ E
           min_server_version = version_header["min_version"]
           max_server_version = version_header["max_version"]
 
-          error_description.section("Incompatible server API version:", <<-E)
-This version of the API that this Chef request specified is not supported by the Chef server you sent this request to.
-The server supports a min API version of #{min_server_version} and a max API version of #{max_server_version}.
-Chef just made a request with an API version of #{client_api_version}.
-Please either update your Chef client or server to be a compatible set.
+          error_description.section("Incompatible server API version:", <<~E)
+            This version of the API that this Chef request specified is not supported by the Chef server you sent this request to.
+            The server supports a min API version of #{min_server_version} and a max API version of #{max_server_version}.
+            Chef just made a request with an API version of #{client_api_version}.
+            Please either update your Chef client or server to be a compatible set.
 E
         else
           describe_http_error(error_description)
@@ -122,8 +122,8 @@ E
       end
 
       def describe_500_error(error_description)
-        error_description.section("Unknown Server Error:", <<-E)
-The server had a fatal error attempting to load the node data.
+        error_description.section("Unknown Server Error:", <<~E)
+          The server had a fatal error attempting to load the node data.
 E
         error_description.section("Server Response:", format_rest_error)
       end