chef 16.2.44 → 16.4.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6996ed71a2c95519f3ec64ba83fec62bacb6944505504bb8fdd126e4a2f312a5
-  data.tar.gz: ecee3228486fa1cd0618eee10c7e77eac2f1a787e8f601f15391e5dca152e70c
+  metadata.gz: 5cd173a8bc2e595b0c39776bd219be73951547e20a8ea7ca42e10ab9f4caf301
+  data.tar.gz: 8868bce6fe0f624417e2b431bdd0bd160b7747f1801ce93a2ab73b9225c210dc
 SHA512:
-  metadata.gz: 5f622f40caea4d2fc817252c71918a5bdbc3bb66fb6afd18225c2a65cf29fd12b9449422ea7932f32b56dd66937a8b48d52f4fa37cdb80c831a5305005df50cd
-  data.tar.gz: 58de487e3f809781ea7ce1a9abebaf101f96598aaf1ad6175e28d10a7ca351bccf279fba12b943a232410565e2b36719c34c9bed3055f2b7e39ccc9efd4815a4
+  metadata.gz: 2880171bce3ce18571abc3142417189f5a31f768adfa4654a1d7b3bf7acdee3483032bd0b5da61e895cb3c1613cccbf95edd76788a44bc2290fe0e4c6823534b
+  data.tar.gz: c1d9c41879c5db64c0d104cc41ceb8c3c97a7188d6d2f11333ef33b06ec4574833e586a507c5f1dbbf3c0da43f6df97e462c1c54983cccabdba98075437425f5

data/Gemfile

@@ -9,12 +9,12 @@ gem "chef", path: "."
 
 gem "ohai", git: "https://github.com/chef/ohai.git", branch: "master"
 
-gem "chef-utils", path: File.expand_path("../chef-utils", __FILE__) if File.exist?(File.expand_path("../chef-utils", __FILE__))
-gem "chef-config", path: File.expand_path("../chef-config", __FILE__) if File.exist?(File.expand_path("../chef-config", __FILE__))
+gem "chef-utils", path: File.expand_path("chef-utils", __dir__) if File.exist?(File.expand_path("chef-utils", __dir__))
+gem "chef-config", path: File.expand_path("chef-config", __dir__) if File.exist?(File.expand_path("chef-config", __dir__))
 
-if File.exist?(File.expand_path("../chef-bin", __FILE__))
+if File.exist?(File.expand_path("chef-bin", __dir__))
   # bundling in a git checkout
-  gem "chef-bin", path: File.expand_path("../chef-bin", __FILE__)
+  gem "chef-bin", path: File.expand_path("chef-bin", __dir__)
 else
   # bundling in omnibus
   gem "chef-bin" # rubocop:disable Bundler/DuplicatedGem

data/Rakefile

@@ -18,13 +18,14 @@
 #
 
 # we need this to resolve files required by lib/chef/dist
-$LOAD_PATH.unshift(File.expand_path("../chef-config/lib", __FILE__))
+$LOAD_PATH.unshift(File.expand_path("chef-config/lib", __dir__))
 
 begin
   require_relative "tasks/rspec"
   require_relative "tasks/dependencies"
   require_relative "tasks/announce"
   require_relative "tasks/docs"
+  require_relative "tasks/spellcheck"
   require_relative "lib/chef/dist"
 rescue LoadError => e
   puts "Skipping missing rake dep: #{e}"
@@ -107,18 +108,4 @@ begin
   end
 rescue LoadError
   puts "yard is not available. bundle install first to make sure all dependencies are installed."
-end
-
-namespace :spellcheck do
-  task :run do
-    sh 'cspell "**/*"'
-  end
-
-  desc "List the unique unrecognized words in the project."
-  task :unknown_words do
-    sh 'cspell "**/*" --wordsOnly --no-summary | sort | uniq'
-  end
-end
-
-desc "Run spellcheck on the project."
-task spellcheck: "spellcheck:run"
+end

data/chef-universal-mingw32.gemspec

@@ -1,9 +1,8 @@
-gemspec = eval(IO.read(File.expand_path("../chef.gemspec", __FILE__)))
+gemspec = eval(IO.read(File.expand_path("chef.gemspec", __dir__)))
 
 gemspec.platform = Gem::Platform.new(%w{universal mingw32})
 
 gemspec.add_dependency "win32-api", "~> 1.5.3"
-gemspec.add_dependency "win32-dir", "~> 0.5.0"
 gemspec.add_dependency "win32-event", "~> 0.6.1"
 # TODO: Relax this pin and make the necessary updaets. The issue originally
 # leading to this pin has been fixed in 0.6.5.
@@ -14,7 +13,7 @@ gemspec.add_dependency "win32-process", "~> 0.8.2"
 gemspec.add_dependency "win32-service", ">= 2.1.5", "< 3.0"
 gemspec.add_dependency "wmi-lite", "~> 1.0"
 gemspec.add_dependency "win32-taskscheduler", "~> 2.0"
-gemspec.add_dependency "iso8601", "~> 0.12.1"
+gemspec.add_dependency "iso8601", ">= 0.12.1", "< 0.14" # validate 0.14 when it comes out
 gemspec.add_dependency "win32-certstore", "~> 0.3"
 gemspec.extensions << "ext/win32-eventlog/Rakefile"
 gemspec.files += Dir.glob("{distro,ext}/**/*")

data/chef.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency "mixlib-cli", ">= 2.1.1", "< 3.0"
   s.add_dependency "mixlib-log", ">= 2.0.3", "< 4.0"
   s.add_dependency "mixlib-authentication", ">= 2.1", "< 4"
-  s.add_dependency "mixlib-shellout", ">= 3.0.3", "< 4.0"
+  s.add_dependency "mixlib-shellout", ">= 3.1.1", "< 4.0"
   s.add_dependency "mixlib-archive", ">= 0.4", "< 2.0"
   s.add_dependency "ohai", "~> 16.0"
 
@@ -36,11 +36,12 @@ Gem::Specification.new do |s|
   s.add_dependency "ed25519", "~> 1.2" # ed25519 ssh key support
   s.add_dependency "bcrypt_pbkdf", "= 1.1.0.rc1" # ed25519 ssh key support
   s.add_dependency "highline", ">= 1.6.9", "< 3"
+  s.add_dependency "tty-prompt", "~> 0.21" # knife ui.ask prompt
   s.add_dependency "tty-screen", "~> 0.6" # knife list
   s.add_dependency "pastel" # knife ui.color
   s.add_dependency "erubis", "~> 2.7"
-  s.add_dependency "diff-lcs", "~> 1.2", ">= 1.2.4"
-  s.add_dependency "ffi-libarchive"
+  s.add_dependency "diff-lcs", ">= 1.2.4", "< 1.4.0" # 1.4 breaks output
+  s.add_dependency "ffi-libarchive", "~> 1.0", ">= 1.0.3"
   s.add_dependency "chef-zero", ">= 14.0.11"
   s.add_dependency "chef-vault"
 

data/lib/chef/action_collection.rb

@@ -44,6 +44,9 @@ class Chef
       # @return [Exception] The exception that was thrown
       attr_accessor :exception
 
+      # @return [Hash] JSON-formatted error description from the Chef::Formatters::ErrorMapper
+      attr_accessor :error_description
+
       # @return [Numeric] The elapsed time in seconds with machine precision
       attr_accessor :elapsed_time
 
@@ -223,6 +226,7 @@ class Chef
 
       current_record.status = :failed
       current_record.exception = exception
+      current_record.error_description = Formatters::ErrorMapper.resource_failed(new_resource, action, exception).for_json
     end
 
     # Hook called after an action is completed.  This is always called, even if the action fails.

data/lib/chef/api_client/registration.rb

@@ -72,14 +72,14 @@ class Chef
 
       def assert_destination_writable!
         abs_path = File.expand_path(destination)
-        unless File.exists?(File.dirname(abs_path))
+        unless File.exist?(File.dirname(abs_path))
           begin
             FileUtils.mkdir_p(File.dirname(abs_path))
           rescue Errno::EACCES
             raise Chef::Exceptions::CannotWritePrivateKey, "I can't create the configuration directory at #{File.dirname(abs_path)} - check permissions?"
           end
         end
-        if (File.exists?(abs_path) && !File.writable?(abs_path)) || !File.writable?(File.dirname(abs_path))
+        if (File.exist?(abs_path) && !File.writable?(abs_path)) || !File.writable?(File.dirname(abs_path))
           raise Chef::Exceptions::CannotWritePrivateKey, "I can't write your private key to #{abs_path} - check permissions?"
         end
       end
@@ -157,12 +157,12 @@ class Chef
       end
 
       def http_api
-        @http_api ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url],
-          {
-            api_version: "0",
-            client_name: Chef::Config[:validation_client_name],
-            signing_key_filename: Chef::Config[:validation_key],
-          })
+        options = {}
+        options[:api_version] = "0"
+        options[:client_name] = Chef::Config[:validation_client_name]
+        options[:raw_key] = Chef::Config[:validation_key_contents]
+        options[:signing_key_filename] = Chef::Config[:validation_key] unless options[:raw_key]
+        @http_api ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url], options)
       end
 
       # Whether or not to generate keys locally and post the public key to the

data/lib/chef/application.rb

@@ -19,13 +19,14 @@
 require "pp" unless defined?(PP)
 require "socket" unless defined?(Socket)
 require_relative "config"
+require "chef-config/mixin/chef_cloud"
 require_relative "exceptions"
 require_relative "local_mode"
 require_relative "log"
 require_relative "platform"
 require "mixlib/cli" unless defined?(Mixlib::CLI)
 require "tmpdir" unless defined?(Dir.mktmpdir)
-require "rbconfig"
+require "rbconfig" unless defined?(RbConfig)
 require_relative "application/exit_code"
 require_relative "dist"
 require "license_acceptance/acceptor"
@@ -136,6 +137,10 @@ class Chef
 
       if config[:config_file].nil?
         logger.warn("No config file found or specified on command line. Using command line options instead.")
+      elsif ChefConfig::Mixin::ChefCloud.cloud_config?
+        logger.warn("*****************************************")
+        logger.warn("Found Chef Cloud configuration. Overriding local values from cloud.")
+        logger.warn("*****************************************")
       elsif config_fetcher.config_missing?
         logger.warn("*****************************************")
         logger.warn("Did not find config file: #{config[:config_file]}. Using command line options instead.")
@@ -194,8 +199,10 @@ class Chef
       chef_config[:log_location].map! do |log_location|
         case log_location
         when :syslog, "syslog"
+          force_force_logger
           logger::Syslog.new
         when :win_evt, "win_evt"
+          force_force_logger
           logger::WinEvt.new
         else
           # should be a path or STDOUT
@@ -204,6 +211,16 @@ class Chef
       end
     end
 
+    # Force the logger by default for the :winevt and :syslog loggers.  Since we do not and cannot
+    # support multiple log levels in a mix-and-match situation with formatters and loggers, and the
+    # formatters do not support syslog, we force the formatter off by default and the log level is
+    # thus info by default.  Users can add `--force-formatter -l info` to get back formatter output
+    # on STDOUT along with syslog logging.
+    #
+    def force_force_logger
+      chef_config[:force_logger] = true unless chef_config[:force_formatter]
+    end
+
     # Use of output formatters is assumed if `force_formatter` is set or if `force_logger` is not set
     def using_output_formatter?
       chef_config[:force_formatter] || !chef_config[:force_logger]

data/lib/chef/application/apply.rb

@@ -21,6 +21,7 @@ require_relative "../../chef"
 require_relative "../application"
 require_relative "../client"
 require_relative "../config"
+require_relative "../config_fetcher"
 require_relative "../log"
 require "fileutils" unless defined?(FileUtils)
 require "tempfile" unless defined?(Tempfile)
@@ -212,11 +213,11 @@ class Chef::Application::Apply < Chef::Application
     end
     runner = Chef::Runner.new(run_context)
     catch(:end_client_run_early) do
-      begin
-        runner.converge
-      ensure
-        @recipe_fh.close
-      end
+
+      runner.converge
+    ensure
+      @recipe_fh.close
+
     end
     Chef::Platform::Rebooter.reboot_if_needed!(runner)
   end

data/lib/chef/application/base.rb

@@ -22,6 +22,7 @@ require_relative "../mixin/shell_out"
 require_relative "../config_fetcher"
 require_relative "../dist"
 require_relative "../daemon"
+require "chef-config/mixin/chef_cloud"
 require "chef-config/mixin/dot_d"
 require "license_acceptance/cli_flags/mixlib_cli"
 require "mixlib/archive" unless defined?(Mixlib::Archive)
@@ -39,6 +40,7 @@ require "mixlib/archive" unless defined?(Mixlib::Archive)
 #
 class Chef::Application::Base < Chef::Application
   include Chef::Mixin::ShellOut
+  include ChefConfig::Mixin::ChefCloud
   include ChefConfig::Mixin::DotD
   include LicenseAcceptance::CLIFlags::MixlibCLI
 

data/lib/chef/application/client.rb

@@ -156,6 +156,9 @@ class Chef::Application::Client < Chef::Application::Base
 
     # Load all config files in client.d
     load_dot_d(Chef::Config[:client_d_dir]) if Chef::Config[:client_d_dir]
+
+    # Load cloud config if present
+    load_cloud_config
   end
 
   def configure_logging

data/lib/chef/application/windows_service.rb

@@ -78,33 +78,33 @@ class Chef
         while running?
           # Grab the service_action_mutex to make a chef-client run
           @service_action_mutex.synchronize do
-            begin
-              Chef::Log.info("Next #{Chef::Dist::CLIENT} run will happen in #{timeout} seconds")
-              @service_signal.wait(@service_action_mutex, timeout)
-
-              # Continue only if service is RUNNING
-              next if state != RUNNING
-
-              # Reconfigure each time through to pick up any changes in the client file
-              Chef::Log.info("Reconfiguring with startup parameters")
-              reconfigure(startup_parameters)
-              timeout = Chef::Config[:interval]
-
-              # Honor splay sleep config
-              timeout += rand Chef::Config[:splay]
-
-              # run chef-client only if service is in RUNNING state
-              next if state != RUNNING
-
-              Chef::Log.info("#{Chef::Dist::CLIENT} service is starting a #{Chef::Dist::CLIENT} run...")
-              run_chef_client
-            rescue SystemExit => e
-              # Do not raise any of the errors here in order to
-              # prevent service crash
-              Chef::Log.error("#{e.class}: #{e}")
-            rescue Exception => e
-              Chef::Log.error("#{e.class}: #{e}")
-            end
+
+            Chef::Log.info("Next #{Chef::Dist::CLIENT} run will happen in #{timeout} seconds")
+            @service_signal.wait(@service_action_mutex, timeout)
+
+            # Continue only if service is RUNNING
+            next if state != RUNNING
+
+            # Reconfigure each time through to pick up any changes in the client file
+            Chef::Log.info("Reconfiguring with startup parameters")
+            reconfigure(startup_parameters)
+            timeout = Chef::Config[:interval]
+
+            # Honor splay sleep config
+            timeout += rand Chef::Config[:splay]
+
+            # run chef-client only if service is in RUNNING state
+            next if state != RUNNING
+
+            Chef::Log.info("#{Chef::Dist::CLIENT} service is starting a #{Chef::Dist::CLIENT} run...")
+            run_chef_client
+          rescue SystemExit => e
+            # Do not raise any of the errors here in order to
+            # prevent service crash
+            Chef::Log.error("#{e.class}: #{e}")
+          rescue Exception => e
+            Chef::Log.error("#{e.class}: #{e}")
+
           end
         end
 

data/lib/chef/{whitelist.rb → attribute_allowlist.rb}

@@ -2,14 +2,14 @@
 require_relative "exceptions"
 
 class Chef
-  class Whitelist
+  class AttributeAllowlist
 
-    # filter takes two arguments - the data you want to filter, and a whitelisted array
-    # of keys you want included. You can capture a subtree of the data to filter by
+    # filter takes two arguments - the data you want to filter, and an array of
+    # keys you want included. You can capture a subtree of the data to filter by
     # providing a "/"-delimited string of keys. If some key includes "/"-characters,
     # you must provide an array of keys instead.
     #
-    # Whitelist.filter(
+    # AttributeAllowlist.filter(
     #   { "filesystem" => {
     #       "/dev/disk" => {
     #         "size" => "10mb"
@@ -27,18 +27,18 @@ class Chef
     #   },
     #   ["network/interfaces/eth0", ["filesystem", "/dev/disk"]])
     # will capture the eth0 and /dev/disk subtrees.
-    def self.filter(data, whitelist = nil)
-      return data if whitelist.nil?
+    def self.filter(data, allowlist = nil)
+      return data if allowlist.nil?
 
       new_data = {}
-      whitelist.each do |item|
+      allowlist.each do |item|
         add_data(data, new_data, item)
       end
       new_data
     end
 
-    # Walk the data has according to the keys provided by the whitelisted item
-    # and add the data to the whitelisting result.
+    # Walk the data has according to the keys provided by the allowlisted item
+    # and add the data to the allowlisting result.
     def self.add_data(data, new_data, item)
       parts = to_array(item)
 
@@ -46,7 +46,7 @@ class Chef
       filtered_data = new_data
       parts[0..-2].each do |part|
         unless all_data.key?(part)
-          Chef::Log.warn("Could not find whitelist attribute #{item}.")
+          Chef::Log.warn("Could not find allowlist attribute #{item}.")
           return nil
         end
 
@@ -58,7 +58,7 @@ class Chef
       # Note: You can't do all_data[parts[-1]] here because the value
       # may be false-y
       unless all_data.key?(parts[-1])
-        Chef::Log.warn("Could not find whitelist attribute #{item}.")
+        Chef::Log.warn("Could not find allowlist attribute #{item}.")
         return nil
       end
 

data/lib/chef/{blacklist.rb → attribute_blocklist.rb}

@@ -2,14 +2,14 @@
 require_relative "exceptions"
 
 class Chef
-  class Blacklist
+  class AttributeBlocklist
 
-    # filter takes two arguments - the data you want to filter, and a blacklisted array
+    # filter takes two arguments - the data you want to filter, and an array
     # of keys you want discarded. You can capture a subtree of the data to filter by
     # providing a "/"-delimited string of keys. If some key includes "/"-characters,
     # you must provide an array of keys instead.
     #
-    # Blacklist.filter(
+    # AttributeBlocklist.filter(
     #   { "filesystem" => {
     #       "/dev/disk" => {
     #         "size" => "10mb"
@@ -27,17 +27,17 @@ class Chef
     #   },
     #   ["network/interfaces/eth0", ["filesystem", "/dev/disk"]])
     # will exclude the eth0 and /dev/disk subtrees.
-    def self.filter(data, blacklist = nil)
-      return data if blacklist.nil?
+    def self.filter(data, blocklist = nil)
+      return data if blocklist.nil?
 
-      blacklist.each do |item|
+      blocklist.each do |item|
         Chef::Log.warn("Removing item #{item}")
         remove_data(data, item)
       end
       data
     end
 
-    # Walk the data according to the keys provided by the blacklisted item
+    # Walk the data according to the keys provided by the blocklisted item
     # to get a reference to the item that will be removed.
     def self.remove_data(data, item)
       parts = to_array(item)
@@ -45,7 +45,7 @@ class Chef
       item_ref = data
       parts[0..-2].each do |part|
         unless item_ref[part]
-          Chef::Log.warn("Could not find blacklist attribute #{item}.")
+          Chef::Log.warn("Could not find blocklist attribute #{item}.")
           return nil
         end
 
@@ -53,7 +53,7 @@ class Chef
       end
 
       unless item_ref.key?(parts[-1])
-        Chef::Log.warn("Could not find blacklist attribute #{item}.")
+        Chef::Log.warn("Could not find blocklist attribute #{item}.")
         return nil
       end