chef 14.2.0 → 14.3.37

data/lib/chef/application/windows_service.rb

@@ -37,29 +37,29 @@ class Chef
       include Chef::Mixin::ShellOut
 
       option :config_file,
-        :short => "-c CONFIG",
-        :long => "--config CONFIG",
-        :default => "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
-        :description => ""
+        short: "-c CONFIG",
+        long: "--config CONFIG",
+        default: "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
+        description: ""
 
       option :log_location,
-        :short        => "-L LOGLOCATION",
-        :long         => "--logfile LOGLOCATION",
-        :description  => "Set the log file location"
+        short: "-L LOGLOCATION",
+        long: "--logfile LOGLOCATION",
+        description: "Set the log file location"
 
       option :splay,
-        :short        => "-s SECONDS",
-        :long         => "--splay SECONDS",
-        :description  => "The splay time for running at intervals, in seconds",
-        :proc         => lambda { |s| s.to_i }
+        short: "-s SECONDS",
+        long: "--splay SECONDS",
+        description: "The splay time for running at intervals, in seconds",
+        proc: lambda { |s| s.to_i }
 
       option :interval,
-        :short        => "-i SECONDS",
-        :long         => "--interval SECONDS",
-        :description  => "Set the number of seconds to wait between chef-client runs",
-        :proc         => lambda { |s| s.to_i }
+        short: "-i SECONDS",
+        long: "--interval SECONDS",
+        description: "Set the number of seconds to wait between chef-client runs",
+        proc: lambda { |s| s.to_i }
 
-      DEFAULT_LOG_LOCATION ||= "#{ENV['SYSTEMDRIVE']}/chef/client.log"
+      DEFAULT_LOG_LOCATION ||= "#{ENV['SYSTEMDRIVE']}/chef/client.log".freeze
 
       def service_init
         @service_action_mutex = Mutex.new
@@ -197,11 +197,11 @@ class Chef
 
         result = shell_out(
           "chef-client.bat #{config_params}",
-          :timeout => Chef::Config[:windows_service][:watchdog_timeout],
-          :logger => Chef::Log
+          timeout: Chef::Config[:windows_service][:watchdog_timeout],
+          logger: Chef::Log
         )
-        Chef::Log.trace "#{result.stdout}"
-        Chef::Log.trace "#{result.stderr}"
+        Chef::Log.trace (result.stdout).to_s
+        Chef::Log.trace (result.stderr).to_s
       rescue Mixlib::ShellOut::CommandTimeout => e
         Chef::Log.error "chef-client timed out\n(#{e})"
         Chef::Log.error(<<-EOF)
@@ -228,7 +228,7 @@ class Chef
         configure_chef startup_parameters
         configure_logging
 
-        Chef::Config[:chef_server_url] = config[:chef_server_url] if config.has_key? :chef_server_url
+        Chef::Config[:chef_server_url] = config[:chef_server_url] if config.key? :chef_server_url
         unless Chef::Config[:exception_handlers].any? { |h| Chef::Handler::ErrorReport === h }
           Chef::Config[:exception_handlers] << Chef::Handler::ErrorReport.new
         end

data/lib/chef/application/windows_service_manager.rb

@@ -37,38 +37,38 @@ class Chef
       include Mixlib::CLI
 
       option :action,
-        :short => "-a ACTION",
-        :long  => "--action ACTION",
-        :default => "status",
-        :description => "Action to carry out on chef-service (install, uninstall, status, start, stop, pause, or resume)"
+        short: "-a ACTION",
+        long: "--action ACTION",
+        default: "status",
+        description: "Action to carry out on chef-service (install, uninstall, status, start, stop, pause, or resume)"
 
       option :config_file,
-        :short => "-c CONFIG",
-        :long  => "--config CONFIG",
-        :default => "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
-        :description => "The configuration file to use for chef runs"
+        short: "-c CONFIG",
+        long: "--config CONFIG",
+        default: "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
+        description: "The configuration file to use for chef runs"
 
       option :log_location,
-        :short        => "-L LOGLOCATION",
-        :long         => "--logfile LOGLOCATION",
-        :description  => "Set the log file location for chef-service"
+        short: "-L LOGLOCATION",
+        long: "--logfile LOGLOCATION",
+        description: "Set the log file location for chef-service"
 
       option :help,
-        :short        => "-h",
-        :long         => "--help",
-        :description  => "Show this message",
-        :on           => :tail,
-        :boolean      => true,
-        :show_options => true,
-        :exit         => 0
+        short: "-h",
+        long: "--help",
+        description: "Show this message",
+        on: :tail,
+        boolean: true,
+        show_options: true,
+        exit: 0
 
       option :version,
-        :short        => "-v",
-        :long         => "--version",
-        :description  => "Show chef version",
-        :boolean      => true,
-        :proc         => lambda { |v| puts "Chef: #{::Chef::VERSION}" },
-        :exit         => 0
+        short: "-v",
+        long: "--version",
+        description: "Show chef version",
+        boolean: true,
+        proc: lambda { |v| puts "Chef: #{::Chef::VERSION}" },
+        exit: 0
 
       def initialize(service_options)
         # having to call super in initialize is the most annoying
@@ -80,7 +80,7 @@ class Chef
         required_options = [:service_name, :service_display_name, :service_description, :service_file_path]
 
         required_options.each do |req_option|
-          if !service_options.has_key?(req_option)
+          if !service_options.key?(req_option)
             raise ArgumentError, "Service definition doesn't contain required option #{req_option}"
           end
         end
@@ -114,22 +114,22 @@ class Chef
             cmd = "\"#{ruby}\" \"#{@service_file_path}\" #{opts}".gsub(File::SEPARATOR, File::ALT_SEPARATOR)
 
             ::Win32::Service.new(
-              :service_name       => @service_name,
-              :display_name       => @service_display_name,
-              :description        => @service_description,
+              service_name: @service_name,
+              display_name: @service_display_name,
+              description: @service_description,
               # Prior to 0.8.5, win32-service creates interactive services by default,
               # and we don't want that, so we need to override the service type.
-              :service_type       => ::Win32::Service::SERVICE_WIN32_OWN_PROCESS,
-              :start_type         => ::Win32::Service::SERVICE_AUTO_START,
-              :binary_path_name   => cmd,
-              :service_start_name => @service_start_name,
-              :password           => @password,
-              :dependencies       => @dependencies
+              service_type: ::Win32::Service::SERVICE_WIN32_OWN_PROCESS,
+              start_type: ::Win32::Service::SERVICE_AUTO_START,
+              binary_path_name: cmd,
+              service_start_name: @service_start_name,
+              password: @password,
+              dependencies: @dependencies
             )
             unless @delayed_start.nil?
               ::Win32::Service.configure(
-                :service_name     => @service_name,
-                :delayed_start    => @delayed_start
+                service_name: @service_name,
+                delayed_start: @delayed_start
               )
             end
             puts "Service '#{@service_name}' has successfully been installed."
@@ -163,9 +163,9 @@ class Chef
       private
 
       # Just some state constants
-      STOPPED = "stopped"
-      RUNNING = "running"
-      PAUSED = "paused"
+      STOPPED = "stopped".freeze
+      RUNNING = "running".freeze
+      PAUSED = "paused".freeze
 
       def service_exists?
         ::Win32::Service.exists?(@service_name)

data/lib/chef/audit/audit_event_proxy.rb

@@ -79,12 +79,12 @@ class Chef
         outermost_group_desc = describe_groups.shift
 
         [outermost_group_desc, {
-            :name => example.description,
-            :desc => example.full_description,
-            :resource_type => resource_type,
-            :resource_name => resource_name,
-            :context => describe_groups,
-            :line_number => example.metadata[:line_number],
+            name: example.description,
+            desc: example.full_description,
+            resource_type: resource_type,
+            resource_name: resource_name,
+            context: describe_groups,
+            line_number: example.metadata[:line_number],
         }]
       end
 

data/lib/chef/audit/audit_reporter.rb

@@ -28,7 +28,7 @@ class Chef
       attr_reader :rest_client, :audit_data, :ordered_control_groups, :run_status
       private :rest_client, :audit_data, :ordered_control_groups, :run_status
 
-      PROTOCOL_VERSION = "0.1.1"
+      PROTOCOL_VERSION = "0.1.1".freeze
 
       def initialize(rest_client)
         @rest_client = rest_client
@@ -78,7 +78,7 @@ class Chef
       end
 
       def control_group_started(name)
-        if ordered_control_groups.has_key?(name)
+        if ordered_control_groups.key?(name)
           raise Chef::Exceptions::AuditControlGroupDuplicate.new(name)
         end
         metadata = run_context.audits[name].metadata

data/lib/chef/audit/control_group_data.rb

@@ -37,11 +37,11 @@ class Chef
 
       def to_hash
         {
-            :node_name => node_name,
-            :run_id => run_id,
-            :start_time => start_time,
-            :end_time => end_time,
-            :control_groups => control_groups.collect { |c| c.to_hash },
+            node_name: node_name,
+            run_id: run_id,
+            start_time: start_time,
+            end_time: end_time,
+            control_groups: control_groups.collect { |c| c.to_hash },
         }
       end
     end
@@ -81,11 +81,11 @@ class Chef
         # they appeared in the recipe
         controls.sort! { |x, y| x.line_number <=> y.line_number }
         h = {
-              :name => name,
-              :status => status,
-              :number_succeeded => number_succeeded,
-              :number_failed => number_failed,
-              :controls => controls.collect { |c| c.to_hash },
+              name: name,
+              status: status,
+              number_succeeded: number_succeeded,
+              number_failed: number_failed,
+              controls: controls.collect { |c| c.to_hash },
         }
         # If there is a duplicate key, metadata will overwrite it
         add_display_only_data(h).merge(metadata)
@@ -124,11 +124,11 @@ class Chef
 
       def to_hash
         h = {
-            :name => name,
-            :status => status,
-            :details => details,
-            :resource_type => resource_type,
-            :resource_name => resource_name,
+            name: name,
+            status: status,
+            details: details,
+            resource_type: resource_type,
+            resource_name: resource_name,
         }
         h[:context] = context || []
         h

data/lib/chef/audit/runner.rb

@@ -148,7 +148,7 @@ class Chef
       def configure_specinfra
         if Chef::Platform.windows?
           Specinfra.configuration.backend = :cmd
-          Specinfra.configuration.os = { :family => "windows" }
+          Specinfra.configuration.os = { family: "windows" }
         else
           Specinfra.configuration.backend = :exec
         end

data/lib/chef/chef_class.rb

@@ -200,13 +200,14 @@ class Chef
     #
     # Emit a deprecation message.
     #
-    # @param [Symbol] type The message to send. This should refer to a class
+    # @param type [Symbol] The message to send. This should refer to a class
     #   defined in Chef::Deprecated
-    # @param message  An explicit message to display, rather than the generic one
-    #   associated with the deprecation.
-    # @param location The location. Defaults to the caller who called you (since
-    #   generally the person who triggered the check is the one that needs to be
-    #   fixed).
+    # @param message [String, nil] An explicit message to display, rather than
+    #   the generic one associated with the deprecation.
+    # @param location [String, nil] The location. Defaults to the caller who
+    #   called you (since generally the person who triggered the check is the one
+    #   that needs to be fixed).
+    # @return [void]
     #
     # @example
     #     Chef.deprecated(:my_deprecation, message: "This is deprecated!")
@@ -220,11 +221,18 @@ class Chef
       # run. If we are not yet in a run, print to `Chef::Log`.
       if run_context && run_context.events
         run_context.events.deprecation(deprecation, location)
-      else
-        Chef::Log.deprecation(deprecation, location)
+      elsif !deprecation.silenced?
+        Chef::Log.deprecation(deprecation.to_s)
       end
     end
 
+    # Log a generic deprecation warning that doesn't have a specific class in
+    # Chef::Deprecated.
+    #
+    # This should generally not be used, as the user will not be given a link
+    # to get more infomration on fixing the deprecation warning.
+    #
+    # @see #deprecated
     def log_deprecation(message, location = nil)
       location ||= Chef::Log.caller_location
       Chef.deprecated(:generic, message, location)

data/lib/chef/chef_fs/chef_fs_data_store.rb

@@ -210,7 +210,7 @@ class Chef
         elsif path[0] == "policy_groups" && path[2] == "policies"
           # Just set or create the proper entry in the hash
           update_json(to_chef_fs_path(path[0..1]), {}, *options) do |group|
-            if policies.has_key?(path[3])
+            if policies.key?(path[3])
               raise ChefZero::DataStore::DataAlreadyExistsError.new(path, group)
             end
 
@@ -319,7 +319,7 @@ class Chef
             result.each_pair do |key, value|
               if value.is_a?(Array)
                 value.each do |file|
-                  if file.is_a?(Hash) && file.has_key?("checksum")
+                  if file.is_a?(Hash) && file.key?("checksum")
                     relative = ["file_store", "repo", cookbook_type]
                     if chef_fs.versioned_cookbooks || cookbook_type == "cookbook_artifacts"
                       relative << "#{path[1]}-#{path[2]}"
@@ -398,7 +398,7 @@ class Chef
         # DELETE /policy_groups/GROUP/policies/POLICY
         elsif path[0] == "policy_groups" && path[2] == "policies" && path.length == 4
           update_json(to_chef_fs_path(path[0..1]), {}) do |group|
-            unless group["policies"] && group["policies"].has_key?(path[3])
+            unless group["policies"] && group["policies"].key?(path[3])
               raise ChefZero::DataStore::DataNotFoundError.new(path)
             end
             group["policies"].delete(path[3])
@@ -537,9 +537,9 @@ class Chef
           if chef_fs.versioned_cookbooks || path[0] == "cookbook_artifacts"
             result = with_entry([ path[0] ]) do |entry|
               # list /cookbooks/name = filter /cookbooks/name-version down to name
-              entry.children.map { |child| split_name_version(child.name) }.
-              select { |name, version| name == path[1] }.
-              map { |name, version| version }
+              entry.children.map { |child| split_name_version(child.name) }
+              .select { |name, version| name == path[1] }
+              .map { |name, version| version }
             end
             if result.empty?
               raise ChefZero::DataStore::DataNotFoundError.new(path)
@@ -581,7 +581,7 @@ class Chef
         # /policy_groups/NAME/policies/POLICYNAME
         elsif path[0] == "policy_groups" && path[2] == "policies" && path.length == 4
           group = get_json(to_chef_fs_path(path[0..1]), {})
-          group["policies"] && group["policies"].has_key?(path[3])
+          group["policies"] && group["policies"].key?(path[3])
 
         else
           path_always_exists?(path) || Chef::ChefFS::FileSystem.resolve_path(chef_fs, to_chef_fs_path(path)).exists?
@@ -628,7 +628,7 @@ class Chef
         cookbook.each_pair do |key, value|
           if value.is_a?(Array)
             value.each do |file|
-              if file.is_a?(Hash) && file.has_key?("checksum")
+              if file.is_a?(Hash) && file.key?("checksum")
                 file_data = @memory_store.get(["file_store", "checksums", file["checksum"]])
                 cookbook_fs.add_file(File.join(cookbook_path, file["path"]), file_data)
               end

data/lib/chef/chef_fs/config.rb

@@ -44,7 +44,7 @@ class Chef
         "users" => "user",
         "policies" => "policy",
         "policy_groups" => "policy_group",
-      }
+      }.freeze
       INFLECTIONS.each { |k, v| k.freeze; v.freeze }
       INFLECTIONS.freeze
 
@@ -173,7 +173,7 @@ class Chef
 
       def create_chef_fs
         require "chef/chef_fs/file_system/chef_server/chef_server_root_dir"
-        Chef::ChefFS::FileSystem::ChefServer::ChefServerRootDir.new("remote", @chef_config, :cookbook_version => @cookbook_version)
+        Chef::ChefFS::FileSystem::ChefServer::ChefServerRootDir.new("remote", @chef_config, cookbook_version: @cookbook_version)
       end
 
       def local_fs

data/lib/chef/chef_fs/file_system/chef_server/acl_entry.rb

@@ -24,7 +24,7 @@ class Chef
     module FileSystem
       module ChefServer
         class AclEntry < RestListEntry
-          PERMISSIONS = %w{create read update delete grant}
+          PERMISSIONS = %w{create read update delete grant}.freeze
 
           def api_path
             "#{super}/_acl"

data/lib/chef/chef_fs/file_system/chef_server/acls_dir.rb

@@ -28,7 +28,7 @@ class Chef
     module FileSystem
       module ChefServer
         class AclsDir < BaseFSDir
-          ENTITY_TYPES = %w{clients containers cookbook_artifacts cookbooks data_bags environments groups nodes policies policy_groups roles} # we don't read sandboxes, so we don't read their acls
+          ENTITY_TYPES = %w{clients containers cookbook_artifacts cookbooks data_bags environments groups nodes policies policy_groups roles}.freeze # we don't read sandboxes, so we don't read their acls
 
           def data_handler
             @data_handler ||= Chef::ChefFS::DataHandler::AclDataHandler.new

data/lib/chef/chef_fs/file_system/chef_server/chef_server_root_dir.rb

@@ -99,7 +99,7 @@ class Chef
           end
 
           def rest
-            Chef::ServerAPI.new(chef_server_url, :client_name => chef_username, :signing_key_filename => chef_private_key, :raw_output => true, :api_version => "0")
+            Chef::ServerAPI.new(chef_server_url, client_name: chef_username, signing_key_filename: chef_private_key, raw_output: true, api_version: "0")
           end
 
           def get_json(path)
@@ -107,7 +107,7 @@ class Chef
           end
 
           def chef_rest
-            Chef::ServerAPI.new(chef_server_url, :client_name => chef_username, :signing_key_filename => chef_private_key, :api_version => "0")
+            Chef::ServerAPI.new(chef_server_url, client_name: chef_username, signing_key_filename: chef_private_key, api_version: "0")
           end
 
           def api_path

data/lib/chef/chef_fs/file_system/chef_server/cookbooks_dir.rb

@@ -74,7 +74,7 @@ class Chef
           def upload_cookbook(other, options)
             cookbook_to_upload = other.chef_object
             cookbook_to_upload.freeze_version if options[:freeze]
-            uploader = Chef::CookbookUploader.new(cookbook_to_upload, :force => options[:force], :rest => chef_rest)
+            uploader = Chef::CookbookUploader.new(cookbook_to_upload, force: options[:force], rest: chef_rest)
 
             with_actual_cookbooks_dir(other.parent.file_path) do
               uploader.upload_cookbooks