chef 16.4.41 → 16.8.9

data/lib/chef/run_lock.rb

@@ -23,7 +23,7 @@ end
 require_relative "config"
 require_relative "exceptions"
 require "timeout" unless defined?(Timeout)
-require_relative "dist"
+require "chef-utils" unless defined?(ChefUtils::CANARY)
 
 class Chef
 
@@ -96,7 +96,7 @@ class Chef
     # Waits until acquiring the system-wide lock.
     #
     def wait
-      Chef::Log.warn("#{Chef::Dist::PRODUCT} #{runpid} is running, will wait for it to finish and then run.")
+      Chef::Log.warn("#{ChefUtils::Dist::Infra::PRODUCT} #{runpid} is running, will wait for it to finish and then run.")
       if ChefUtils.windows?
         mutex.wait
       else
@@ -173,7 +173,7 @@ class Chef
     # Mutex name is case-sensitive contrary to other things in
     # windows. "\" is the only invalid character.
     def acquire_win32_mutex
-      @mutex = Chef::ReservedNames::Win32::Mutex.new("Global\\#{runlock_file.gsub(/[\\]/, "/").downcase}")
+      @mutex = Chef::ReservedNames::Win32::Mutex.new("Global\\#{runlock_file.tr('\\', "/").downcase}")
       mutex.test
     end
 

data/lib/chef/search/query.rb

@@ -20,8 +20,10 @@ require_relative "../config"
 require_relative "../exceptions"
 require_relative "../server_api"
 
-require "uri" unless defined?(URI)
-require "addressable/uri" unless defined?(Addressable::URI)
+autoload :URI, "uri"
+module Addressable
+  autoload :URI, "addressable/uri"
+end
 
 class Chef
   class Search
@@ -132,10 +134,9 @@ class Chef
         args_h
       end
 
-      QUERY_PARAM_VALUE = Addressable::URI::CharacterClasses::QUERY + "\\&\\;"
-
       def escape_value(s)
-        s && Addressable::URI.encode_component(s.to_s, QUERY_PARAM_VALUE)
+        query_param_value = Addressable::URI::CharacterClasses::QUERY + "\\&\\;"
+        s && Addressable::URI.encode_component(s.to_s, query_param_value)
       end
 
       def create_query_string(type, query, rows, start)

data/lib/chef/server_api.rb

@@ -71,10 +71,6 @@ class Chef
       return_value
     rescue Exception => exception
       log_failed_request(response, return_value) unless response.nil?
-
-      if exception.respond_to?(:chef_rest_request=)
-        exception.chef_rest_request = rest_request
-      end
       raise
     end
   end

data/lib/chef/shell.rb

@@ -15,17 +15,22 @@
 # limitations under the License.
 #
 
+module Mixlib
+  module Authentication
+    autoload :Log, "mixlib/authentication"
+  end
+end
 require "singleton" unless defined?(Singleton)
 require "pp" unless defined?(PP)
 require "etc" unless defined?(Etc)
 require "mixlib/cli" unless defined?(Mixlib::CLI)
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 require_relative "../chef"
 require_relative "version"
 require_relative "client"
 require_relative "config"
 require_relative "config_fetcher"
-require_relative "dist"
 
 require_relative "shell/shell_session"
 require_relative "workstation_config_loader"
@@ -126,11 +131,11 @@ module Shell
     irb_conf[:IRB_RC] = lambda do |conf|
       m = conf.main
 
-      conf.prompt_c       = "#{Chef::Dist::EXEC}#{leader(m)} > "
+      conf.prompt_c       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} > "
       conf.return_format  = " => %s \n"
-      conf.prompt_i       = "#{Chef::Dist::EXEC}#{leader(m)} (#{Chef::VERSION})> "
-      conf.prompt_n       = "#{Chef::Dist::EXEC}#{leader(m)} ?> "
-      conf.prompt_s       = "#{Chef::Dist::EXEC}#{leader(m)}%l> "
+      conf.prompt_i       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} (#{Chef::VERSION})> "
+      conf.prompt_n       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} ?> "
+      conf.prompt_s       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)}%l> "
       conf.use_tracer     = false
       conf.instance_variable_set(:@use_multiline, false)
       conf.instance_variable_set(:@use_singleline, false)
@@ -212,17 +217,17 @@ module Shell
       @footer
     end
 
-    banner("#{Chef::Dist::SHELL} #{Chef::VERSION}\n\nUsage: #{Chef::Dist::SHELL} [NAMED_CONF] (OPTIONS)")
+    banner("#{ChefUtils::Dist::Infra::SHELL} #{Chef::VERSION}\n\nUsage: #{ChefUtils::Dist::Infra::SHELL} [NAMED_CONF] (OPTIONS)")
 
     footer(<<~FOOTER)
-      When no CONFIG is specified, #{Chef::Dist::SHELL} attempts to load a default configuration file:
-      * If a NAMED_CONF is given, #{Chef::Dist::SHELL} will load ~/#{Chef::Dist::USER_CONF_DIR}/NAMED_CONF/#{Chef::Dist::SHELL_CONF}
-      * If no NAMED_CONF is given #{Chef::Dist::SHELL} will load ~/#{Chef::Dist::USER_CONF_DIR}/#{Chef::Dist::SHELL_CONF} if it exists
-      * If no #{Chef::Dist::SHELL_CONF} can be found, #{Chef::Dist::SHELL} falls back to load:
-            #{Chef::Dist::CONF_DIR}/client.rb if -z option is given.
-            #{Chef::Dist::CONF_DIR}/solo.rb   if --solo-legacy-mode option is given.
-            #{Chef::Dist::USER_CONF_DIR}/config.rb     if -s option is given.
-            #{Chef::Dist::USER_CONF_DIR}/knife.rb      if -s option is given.
+      When no CONFIG is specified, #{ChefUtils::Dist::Infra::SHELL} attempts to load a default configuration file:
+      * If a NAMED_CONF is given, #{ChefUtils::Dist::Infra::SHELL} will load ~/#{ChefUtils::Dist::Infra::USER_CONF_DIR}/NAMED_CONF/#{ChefUtils::Dist::Infra::SHELL_CONF}
+      * If no NAMED_CONF is given #{ChefUtils::Dist::Infra::SHELL} will load ~/#{ChefUtils::Dist::Infra::USER_CONF_DIR}/#{ChefUtils::Dist::Infra::SHELL_CONF} if it exists
+      * If no #{ChefUtils::Dist::Infra::SHELL_CONF} can be found, #{ChefUtils::Dist::Infra::SHELL} falls back to load:
+            #{ChefConfig::Config.etc_chef_dir}/client.rb if -z option is given.
+            #{ChefConfig::Config.etc_chef_dir}/solo.rb   if --solo-legacy-mode option is given.
+            #{ChefUtils::Dist::Infra::USER_CONF_DIR}/config.rb     if -s option is given.
+            #{ChefUtils::Dist::Infra::USER_CONF_DIR}/knife.rb      if -s option is given.
     FOOTER
 
     option :use_multiline,
@@ -269,19 +274,19 @@ module Shell
     option :solo_shell,
       short: "-s",
       long: "--solo",
-      description: "#{Chef::Dist::SOLO} session",
+      description: "#{ChefUtils::Dist::Solo::PRODUCT} session",
       boolean: true,
       proc: proc { Chef::Config[:solo] = true }
 
     option :client,
       short: "-z",
       long: "--client",
-      description: "#{Chef::Dist::PRODUCT} session",
+      description: "#{ChefUtils::Dist::Infra::PRODUCT} session",
       boolean: true
 
     option :solo_legacy_shell,
       long: "--solo-legacy-mode",
-      description: "#{Chef::Dist::SOLO} legacy session",
+      description: "#{ChefUtils::Dist::Solo::PRODUCT} legacy session",
       boolean: true,
       proc: proc { Chef::Config[:solo_legacy_mode] = true }
 
@@ -294,15 +299,15 @@ module Shell
     option :chef_server_url,
       short: "-S CHEFSERVERURL",
       long: "--server CHEFSERVERURL",
-      description: "The #{Chef::Dist::SERVER_PRODUCT} URL",
+      description: "The #{ChefUtils::Dist::Server::PRODUCT} URL",
       proc: nil
 
     option :version,
       short: "-v",
       long: "--version",
-      description: "Show #{Chef::Dist::PRODUCT} version",
+      description: "Show #{ChefUtils::Dist::Infra::PRODUCT} version",
       boolean: true,
-      proc: lambda { |v| puts "#{Chef::Dist::PRODUCT}: #{::Chef::VERSION}" },
+      proc: lambda { |v| puts "#{ChefUtils::Dist::Infra::PRODUCT}: #{::Chef::VERSION}" },
       exit: 0
 
     option :override_runlist,
@@ -351,18 +356,18 @@ module Shell
         config[:config_file]
       elsif environment
         Shell.env = environment
-        config_file_to_try = ::File.join(dot_chef_dir, environment, Chef::Dist::SHELL_CONF)
+        config_file_to_try = ::File.join(dot_chef_dir, environment, ChefUtils::Dist::Infra::SHELL_CONF)
         unless ::File.exist?(config_file_to_try)
-          puts "could not find #{Chef::Dist::SHELL} config for environment #{environment} at #{config_file_to_try}"
+          puts "could not find #{ChefUtils::Dist::Infra::SHELL} config for environment #{environment} at #{config_file_to_try}"
           exit 1
         end
         config_file_to_try
-      elsif dot_chef_dir && ::File.exist?(File.join(dot_chef_dir, Chef::Dist::SHELL_CONF))
-        File.join(dot_chef_dir, Chef::Dist::SHELL_CONF)
+      elsif dot_chef_dir && ::File.exist?(File.join(dot_chef_dir, ChefUtils::Dist::Infra::SHELL_CONF))
+        File.join(dot_chef_dir, ChefUtils::Dist::Infra::SHELL_CONF)
       elsif config[:solo_legacy_shell]
-        Chef::Config.platform_specific_path("#{Chef::Dist::CONF_DIR}/solo.rb")
+        Chef::Config.platform_specific_path("#{ChefConfig::Config.etc_chef_dir}/solo.rb")
       elsif config[:client]
-        Chef::Config.platform_specific_path("#{Chef::Dist::CONF_DIR}/client.rb")
+        Chef::Config.platform_specific_path("#{ChefConfig::Config.etc_chef_dir}/client.rb")
       elsif config[:solo_shell]
         Chef::WorkstationConfigLoader.new(nil, Chef::Log).config_location
       else

data/lib/chef/shell/ext.rb

@@ -25,7 +25,7 @@ require_relative "shell_session"
 require_relative "model_wrapper"
 require_relative "../server_api"
 require_relative "../json_compat"
-require_relative "../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 module Shell
   module Extensions
@@ -62,14 +62,14 @@ module Shell
         if subsession = jobs.select_shell_session(context_obj)
           jobs.switch(subsession)
         else
-          irb(context_obj)
+          irb(context_obj) # rubocop: disable Lint/Debugger
         end
       end
 
       def help_banner
         banner = []
         banner << ""
-        banner << "#{Chef::Dist::SHELL} Help"
+        banner << "#{ChefUtils::Dist::Infra::SHELL} Help"
         banner << "".ljust(80, "=")
         banner << "| " + "Command".ljust(25) + "| " + "Description"
         banner << "".ljust(80, "=")
@@ -194,7 +194,7 @@ module Shell
       explain(<<~E)
         ## SUMMARY ##
           When called with no argument, +help+ prints a table of all
-          #{Chef::Dist::SHELL} commands. When called with an argument COMMAND, +help+
+          #{ChefUtils::Dist::Infra::SHELL} commands. When called with an argument COMMAND, +help+
           prints a detailed explanation of the command if available, or the
           description if no explanation is available.
       E
@@ -208,9 +208,9 @@ module Shell
       end
       alias :halp :help
 
-      desc "prints information about #{Chef::Dist::PRODUCT}"
+      desc "prints information about #{ChefUtils::Dist::Infra::PRODUCT}"
       def version
-        puts "Welcome to the #{Chef::Dist::SHELL} #{::Chef::VERSION}\n" +
+        puts "Welcome to the #{ChefUtils::Dist::Infra::SHELL} #{::Chef::VERSION}\n" +
           "For usage see https://docs.chef.io/chef_shell/"
         :ucanhaz_automation
       end
@@ -228,7 +228,7 @@ module Shell
         :attributes
       end
 
-      desc "run #{Chef::Dist::PRODUCT} using the current recipe"
+      desc "run #{ChefUtils::Dist::Infra::PRODUCT} using the current recipe"
       def run_chef
         Chef::Log.level = :debug
         session = Shell.session
@@ -237,8 +237,8 @@ module Shell
         runrun
       end
 
-      desc "returns an object to control a paused #{Chef::Dist::PRODUCT} run"
-      subcommands resume: "resume the #{Chef::Dist::PRODUCT} run",
+      desc "returns an object to control a paused #{ChefUtils::Dist::Infra::PRODUCT} run"
+      subcommands resume: "resume the #{ChefUtils::Dist::Infra::PRODUCT} run",
                   step: "run only the next resource",
                   skip_back: "move back in the run list",
                   skip_forward: "move forward in the run list"
@@ -309,9 +309,9 @@ module Shell
               new_node = edit(existing_node)
 
         ## EDITOR SELECTION ##
-          #{Chef::Dist::SHELL} looks for an editor using the following logic
+          #{ChefUtils::Dist::Infra::SHELL} looks for an editor using the following logic
           1. Looks for an EDITOR set by Shell.editor = "EDITOR"
-          2. Looks for an EDITOR configured in your #{Chef::Dist::SHELL} config file
+          2. Looks for an EDITOR configured in your #{ChefUtils::Dist::Infra::SHELL} config file
           3. Uses the value of the EDITOR environment variable
       E
       def edit(object)
@@ -320,7 +320,7 @@ module Shell
           return :failburger
         end
 
-        filename = "#{Chef::Dist::SHELL}-edit-#{object.class.name}-"
+        filename = "#{ChefUtils::Dist::Infra::SHELL}-edit-#{object.class.name}-"
         if object.respond_to?(:name)
           filename += object.name
         elsif object.respond_to?(:id)

data/lib/chef/shell/shell_session.rb

@@ -28,7 +28,7 @@ require_relative "../run_list/run_list_expansion"
 require_relative "../formatters/base"
 require_relative "../formatters/doc"
 require_relative "../formatters/minimal"
-require_relative "../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 module Shell
   class ShellSession
@@ -90,7 +90,7 @@ module Shell
     end
 
     def save_node
-      raise "Not Supported! #{self.class.name} doesn't support #save_node, maybe you need to run #{Chef::Dist::SHELL} in client mode?"
+      raise "Not Supported! #{self.class.name} doesn't support #save_node, maybe you need to run #{ChefUtils::Dist::Infra::SHELL} in client mode?"
     end
 
     def rebuild_context

data/lib/chef/train_transport.rb

@@ -15,114 +15,15 @@
 # limitations under the License.
 #
 
-require "chef-config/mixin/credentials"
-require "train"
-require_relative "dist"
+require "chef-config/mixin/train_transport" unless defined?(ChefConfig::Mixin::TrainTransport)
 
 class Chef
   class TrainTransport
-    extend ChefConfig::Mixin::Credentials
+    include ChefConfig::Mixin::TrainTransport
 
-    #
-    # Returns a RFC099 credentials profile as a hash
-    #
-    def self.load_credentials(profile)
-      # Tomlrb.load_file returns a hash with keys as strings
-      credentials = parse_credentials_file
-      if contains_split_fqdn?(credentials, profile)
-        Chef::Log.warn("Credentials file #{credentials_file_path} contains target '#{profile}' as a Hash, expected a string.")
-        Chef::Log.warn("Hostnames must be surrounded by single quotes, e.g. ['host.example.org']")
-      end
-
-      # host names must be specified in credentials file as ['foo.example.org'] with quotes
-      if !credentials.nil? && !credentials[profile].nil?
-        credentials[profile].map { |k, v| [k.to_sym, v] }.to_h # return symbolized keys to match Train.options()
-      else
-        nil
-      end
-    end
-
-    # Toml creates hashes when a key is separated by periods, e.g.
-    # [host.example.org] => { host: { example: { org: {} } } }
-    #
-    # Returns true if the above example is true
-    #
-    # A hostname has to be specified as ['host.example.org']
-    # This will be a common mistake so we should catch it
-    #
-    def self.contains_split_fqdn?(hash, fqdn)
-      fqdn.split(".").reduce(hash) do |h, k|
-        v = h[k]
-        if Hash === v
-          v
-        else
-          break false
-        end
-      end
-    end
-
-    # ChefConfig::Mixin::Credentials.credentials_file_path is designed around knife,
-    # overriding it here.
-    #
-    # Credentials file preference:
-    #
-    # 1) target_mode.credentials_file
-    # 2) /etc/chef/TARGET_MODE_HOST/credentials
-    # 3) #credentials_file_path from parent ($HOME/.chef/credentials)
-    #
-    def self.credentials_file_path
-      tm_config = Chef::Config.target_mode
-      profile = tm_config.host
-
-      credentials_file =
-        if tm_config.credentials_file && File.exist?(tm_config.credentials_file)
-          tm_config.credentials_file
-        elsif File.exist?(Chef::Config.platform_specific_path("#{Chef::Dist::CONF_DIR}/#{profile}/credentials"))
-          Chef::Config.platform_specific_path("#{Chef::Dist::CONF_DIR}/#{profile}/credentials")
-        else
-          super
-        end
-
-      raise ArgumentError, "No credentials file found for target '#{profile}'" unless credentials_file
-      raise ArgumentError, "Credentials file specified for target mode does not exist: '#{credentials_file}'" unless File.exist?(credentials_file)
-
-      Chef::Log.debug("Loading credentials file '#{credentials_file}' for target '#{profile}'")
-
-      credentials_file
-    end
-
-    def self.build_transport(logger = Chef::Log.with_child(subsystem: "transport"))
-      return nil unless Chef::Config.target_mode?
-
-      # TODO: Consider supporting parsing the protocol from a URI passed to `--target`
-      #
-      train_config = {}
-
-      # Load the target_mode config context from Chef::Config, and place any valid settings into the train configuration
-      tm_config = Chef::Config.target_mode
-      protocol = tm_config.protocol
-      train_config = tm_config.to_hash.select { |k| Train.options(protocol).key?(k) }
-      Chef::Log.trace("Using target mode options from #{Chef::Dist::PRODUCT} config file: #{train_config.keys.join(", ")}") if train_config
-
-      # Load the credentials file, and place any valid settings into the train configuration
-      credentials = load_credentials(tm_config.host)
-      if credentials
-        valid_settings = credentials.select { |k| Train.options(protocol).key?(k) }
-        valid_settings[:enable_password] = credentials[:enable_password] if credentials.key?(:enable_password)
-        train_config.merge!(valid_settings)
-        Chef::Log.trace("Using target mode options from credentials file: #{valid_settings.keys.join(", ")}") if valid_settings
-      end
-
-      train_config[:logger] = logger
-
-      # Train handles connection retries for us
-      Train.create(protocol, train_config)
-    rescue SocketError => e # likely a dns failure, not caught by train
-      e.message.replace "Error connecting to #{train_config[:target]} - #{e.message}"
-      raise e
-    rescue Train::PluginLoadError
-      logger.error("Invalid target mode protocol: #{protocol}")
-      exit(false)
+    def config
+      require "chef/config" unless defined?(Chef::Config)
+      Chef::Config
     end
   end
 end

data/lib/chef/util/backup.rb

@@ -36,7 +36,7 @@ class Chef
           slice_number = @new_resource.backup
           backup_files = sorted_backup_files
           if backup_files.length >= @new_resource.backup
-            remainder = backup_files.slice(slice_number..-1)
+            remainder = backup_files.slice(slice_number..)
             remainder.each do |backup_to_delete|
               delete_backup(backup_to_delete)
             end

data/lib/chef/util/diff.rb

@@ -40,9 +40,6 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OF OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require "diff/lcs"
-require "diff/lcs/hunk"
-
 class Chef
   class Util
     class Diff
@@ -86,6 +83,9 @@ class Chef
       # produces a unified-output-format diff with 3 lines of context
       # ChefFS uses udiff() directly
       def udiff(old_file, new_file)
+        require "diff/lcs"
+        require "diff/lcs/hunk"
+
         diff_str = ""
         file_length_difference = 0