chef-config 16.4.41 → 16.5.64

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e39a5c8e89a20bd23d7b2187c178ce62226d082b8394af6e119de8ae9a795d
-  data.tar.gz: 54957b26ad4c522a0fd1049fc7993c6b169eec3d96ec90ac5e50af773c3b81d5
+  metadata.gz: 98200061cdf7f6987f89d2810c4f4cf06e73e946703207b1e03270bed58c2a72
+  data.tar.gz: 4c97416eaa59a81959b65596d40efe4f24e10e6e8dc1e5f9f26d5467c0f13385
 SHA512:
-  metadata.gz: fb6fe56b7a2847ebec13e5ca5d4838730214f2416f02c47de9519049e02302c7f9a1a55df58ed62c8e067f3093a3f4b6a68b0b7146d9906bcc463c891160e75a
-  data.tar.gz: 54c77b2de4a193aef3888ec722c7a8c43efb63c8b35b232bef03c53ddc6961b632fa2bd77887aff24215c88bd290a4c945716e813943295d8999a84641f7a12c
+  metadata.gz: 7a3923de2e675cd239dde70ac73595d043da585f5350f083c093fbefe6bd86a5fdd29165e7229fc2ba082018ac645420eb6991db993ea626735cd882ff0ac047
+  data.tar.gz: b0270e4feee69bde6219ec09e07529a40e0b1849ba42ea1066638b74754c7e45c6fdb6d73ec2fb0c78c727f77c131a86d4a0399d5f4fe1b46243a8765e1e6def

data/lib/chef-config/config.rb

@@ -20,8 +20,8 @@
 # limitations under the License.
 
 require "mixlib/config" unless defined?(Mixlib::Config)
-require "pathname" unless defined?(Pathname)
-require "chef-utils" unless defined?(ChefUtils::CANARY)
+autoload :Pathname, "pathname"
+autoload :ChefUtils, "chef-utils"
 
 require_relative "fips"
 require_relative "logger"
@@ -29,12 +29,14 @@ require_relative "windows"
 require_relative "path_helper"
 require_relative "mixin/fuzzy_hostname_matcher"
 
-require "mixlib/shellout" unless defined?(Mixlib::ShellOut::DEFAULT_READ_TIMEOUT)
-require "uri" unless defined?(URI)
-require "addressable/uri" unless defined?(Addressable::URI)
-require "openssl" unless defined?(OpenSSL)
-require "yaml"
-require_relative "dist"
+module Mixlib
+  autoload :ShellOut, "mixlib/shellout"
+end
+autoload :URI, "uri"
+autoload :Addressable, "addressable/uri"
+autoload :OpenSSL, "openssl"
+autoload :YAML, "yaml"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 module ChefConfig
 
@@ -80,7 +82,7 @@ module ChefConfig
     # @return [String] the platform-specific path
     #
     def self.etc_chef_dir(windows: ChefUtils.windows?)
-      path = windows ? c_chef_dir : PathHelper.join("/etc", ChefConfig::Dist::DIR_SUFFIX, windows: windows)
+      path = windows ? c_chef_dir : PathHelper.join("/etc", ChefUtils::Dist::Infra::DIR_SUFFIX, windows: windows)
       PathHelper.cleanpath(path, windows: windows)
     end
 
@@ -90,7 +92,7 @@ module ChefConfig
     # @return [String] the platform-specific path
     #
     def self.var_chef_dir(windows: ChefUtils.windows?)
-      path = windows ? c_chef_dir : PathHelper.join("/var", ChefConfig::Dist::DIR_SUFFIX, windows: windows)
+      path = windows ? c_chef_dir : PathHelper.join("/var", ChefUtils::Dist::Infra::DIR_SUFFIX, windows: windows)
       PathHelper.cleanpath(path, windows: windows)
     end
 
@@ -112,7 +114,7 @@ module ChefConfig
     #
     def self.c_chef_dir(windows: ChefUtils.windows?)
       drive = windows_installation_drive || "C:"
-      PathHelper.join(drive, ChefConfig::Dist::DIR_SUFFIX, windows: windows)
+      PathHelper.join(drive, ChefUtils::Dist::Infra::DIR_SUFFIX, windows: windows)
     end
 
     # On windows, C:/opscode
@@ -123,7 +125,7 @@ module ChefConfig
     #
     def self.c_opscode_dir(windows: ChefUtils.windows?)
       drive = windows_installation_drive || "C:"
-      PathHelper.join(drive, ChefConfig::Dist::LEGACY_CONF_DIR, ChefConfig::Dist::DIR_SUFFIX, windows: windows)
+      PathHelper.join(drive, ChefUtils::Dist::Org::LEGACY_CONF_DIR, ChefUtils::Dist::Infra::DIR_SUFFIX, windows: windows)
     end
 
     # the drive where Chef is installed on a windows host. This is determined
@@ -188,7 +190,7 @@ module ChefConfig
       if config_file
         PathHelper.dirname(PathHelper.canonical_path(config_file, false))
       else
-        PathHelper.join(PathHelper.cleanpath(user_home), ChefConfig::Dist::USER_CONF_DIR, "")
+        PathHelper.join(PathHelper.cleanpath(user_home), ChefUtils::Dist::Infra::USER_CONF_DIR, "")
       end
     end
 
@@ -267,7 +269,7 @@ module ChefConfig
         end
         path = new_path
       end
-      ChefConfig.logger.info("Auto-discovered #{ChefConfig::Dist::SHORT} repository at #{path}")
+      ChefConfig.logger.info("Auto-discovered #{ChefUtils::Dist::Infra::SHORT} repository at #{path}")
       path
     end
 
@@ -365,7 +367,7 @@ module ChefConfig
         # Otherwise, we'll create .chef under the user's home directory and use that as
         # the cache path.
         unless path_accessible?(primary_cache_path) || path_accessible?(primary_cache_root)
-          secondary_cache_path = PathHelper.join(user_home, ChefConfig::Dist::USER_CONF_DIR)
+          secondary_cache_path = PathHelper.join(user_home, ChefUtils::Dist::Infra::USER_CONF_DIR)
           secondary_cache_path = target_mode? ? PathHelper.join(secondary_cache_path, target_mode.host) : secondary_cache_path
           ChefConfig.logger.trace("Unable to access cache at #{primary_cache_path}. Switching cache to #{secondary_cache_path}")
           secondary_cache_path
@@ -396,7 +398,7 @@ module ChefConfig
     # If your `file_cache_path` resides on a NFS (or non-flock()-supporting
     # fs), it's recommended to set this to something like
     # '/tmp/chef-client-running.pid'
-    default(:lockfile) { PathHelper.join(file_cache_path, "#{ChefConfig::Dist::CLIENT}-running.pid") }
+    default(:lockfile) { PathHelper.join(file_cache_path, "#{ChefUtils::Dist::Infra::CLIENT}-running.pid") }
 
     ## Daemonization Settings ##
     # What user should Chef run as?
@@ -793,7 +795,7 @@ module ChefConfig
       if chef_server_url.to_s =~ %r{/organizations/(.*)$}
         "#{$1}-validator"
       else
-        "#{ChefConfig::Dist::SHORT}-validator"
+        "#{ChefUtils::Dist::Infra::SHORT}-validator"
       end
     end
 
@@ -867,7 +869,7 @@ module ChefConfig
     default :profile, nil
 
     default :chef_guid_path do
-      PathHelper.join(config_dir, "#{ChefConfig::Dist::SHORT}_guid")
+      PathHelper.join(config_dir, "#{ChefUtils::Dist::Infra::SHORT}_guid")
     end
 
     default :chef_guid, nil
@@ -1076,7 +1078,7 @@ module ChefConfig
       # generated by the DataCollector when Chef is run in Solo mode. This
       # allows users to associate their Solo nodes with faux organizations
       # without the nodes being connected to an actual Chef Server.
-      default :organization, "#{ChefConfig::Dist::SHORT}_solo"
+      default :organization, "#{ChefUtils::Dist::Infra::SHORT}_solo"
     end
 
     configurable(:http_proxy)
@@ -1102,13 +1104,6 @@ module ChefConfig
       export_no_proxy(no_proxy) if key?(:no_proxy) && no_proxy
     end
 
-    # Character classes for Addressable
-    # See https://www.ietf.org/rfc/rfc3986.txt 3.2.1
-    # The user part may not have a : in it
-    USER = Addressable::URI::CharacterClasses::UNRESERVED + Addressable::URI::CharacterClasses::SUB_DELIMS
-    # The password part may have any valid USERINFO characters
-    PASSWORD = USER + "\\:"
-
     # Builds a proxy uri and exports it to the appropriate environment variables. Examples:
     #   http://username:password@hostname:port
     #   https://username@hostname:port
@@ -1120,15 +1115,22 @@ module ChefConfig
     #   pass = password
     # @api private
     def self.export_proxy(scheme, path, user, pass)
+      # Character classes for Addressable
+      # See https://www.ietf.org/rfc/rfc3986.txt 3.2.1
+      # The user part may not have a : in it
+      user_class = Addressable::URI::CharacterClasses::UNRESERVED + Addressable::URI::CharacterClasses::SUB_DELIMS
+      # The password part may have any valid USERINFO characters
+      password_class = user_class + "\\:"
+
       path = "#{scheme}://#{path}" unless path.include?("://")
       # URI.split returns the following parts:
       # [scheme, userinfo, host, port, registry, path, opaque, query, fragment]
       uri = Addressable::URI.encode(path, Addressable::URI)
 
       if user && !user.empty?
-        userinfo = Addressable::URI.encode_component(user, USER)
+        userinfo = Addressable::URI.encode_component(user, user_class)
         if pass
-          userinfo << ":#{Addressable::URI.encode_component(pass, PASSWORD)}"
+          userinfo << ":#{Addressable::URI.encode_component(pass, password_class)}"
         end
         uri.userinfo = userinfo
       end

data/lib/chef-config/mixin/credentials.rb

@@ -15,8 +15,9 @@
 # limitations under the License.
 #
 
-require "tomlrb"
+autoload :Tomlrb, "tomlrb"
 require_relative "../path_helper"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 module ChefConfig
   module Mixin
@@ -36,7 +37,7 @@ module ChefConfig
       #   normally set via a command-line option.
       # @return [String]
       def credentials_profile(profile = nil)
-        context_file = PathHelper.home(ChefConfig::Dist::USER_CONF_DIR, "context").freeze
+        context_file = PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR, "context").freeze
         if !profile.nil?
           profile
         elsif ENV.include?("CHEF_PROFILE")
@@ -53,7 +54,7 @@ module ChefConfig
       # @since 14.4
       # @return [String]
       def credentials_file_path
-        PathHelper.home(ChefConfig::Dist::USER_CONF_DIR, "credentials").freeze
+        PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR, "credentials").freeze
       end
 
       # Load and parse the credentials file.
@@ -84,17 +85,17 @@ module ChefConfig
       # @return [void]
       def load_credentials(profile = nil)
         profile = credentials_profile(profile)
-        config = parse_credentials_file
-        return if config.nil? # No credentials, nothing to do here.
+        cred_config = parse_credentials_file
+        return if cred_config.nil? # No credentials, nothing to do here.
 
-        if config[profile].nil?
+        if cred_config[profile].nil?
           # Unknown profile name. For "default" just silently ignore, otherwise
           # raise an error.
           return if profile == "default"
 
           raise ChefConfig::ConfigurationError, "Profile #{profile} doesn't exist. Please add it to #{credentials_file_path}."
         end
-        apply_credentials(config[profile], profile)
+        apply_credentials(cred_config[profile], profile)
       end
     end
   end

data/lib/chef-config/mixin/train_transport.rb

@@ -0,0 +1,141 @@
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "credentials"
+autoload :Train, "train"
+require_relative "../config"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+module ChefConfig
+  module Mixin
+    module TrainTransport
+      include ChefConfig::Mixin::Credentials
+
+      attr_accessor :logger
+
+      def initialize(logger)
+        @logger = logger
+      end
+
+      #
+      # Returns a RFC099 credentials profile as a hash
+      #
+      def load_credentials(profile)
+        # Tomlrb.load_file returns a hash with keys as strings
+        credentials = parse_credentials_file
+        if contains_split_fqdn?(credentials, profile)
+          logger.warn("Credentials file #{credentials_file_path} contains target '#{profile}' as a Hash, expected a string.")
+          logger.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 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 credentials_file_path
+        tm_config = 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?(config.platform_specific_path("#{ChefConfig::Config.etc_chef_dir}/#{profile}/credentials"))
+            config.platform_specific_path("#{ChefConfig::Config.etc_chef_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)
+
+        logger.debug("Loading credentials file '#{credentials_file}' for target '#{profile}'")
+
+        credentials_file
+      end
+
+      def build_transport
+        return nil unless config.target_mode?
+
+        # TODO: Consider supporting parsing the protocol from a URI passed to `--target`
+        #
+        train_config = {}
+
+        # Load the target_mode config context from config, and place any valid settings into the train configuration
+        tm_config = config.target_mode
+        protocol = tm_config.protocol
+        train_config = tm_config.to_hash.select { |k| Train.options(protocol).key?(k) }
+        logger.trace("Using target mode options from #{ChefUtils::Dist::Infra::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)
+          logger.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(1)
+      end
+
+      def config
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/chef-config/version.rb

@@ -15,5 +15,5 @@
 
 module ChefConfig
   CHEFCONFIG_ROOT = File.expand_path("..", __dir__)
-  VERSION = "16.4.41".freeze
+  VERSION = "16.5.64".freeze
 end

data/lib/chef-config/workstation_config_loader.rb

@@ -59,7 +59,7 @@ module ChefConfig
         @chef_config_dir = false
         full_path = working_directory.split(File::SEPARATOR)
         (full_path.length - 1).downto(0) do |i|
-          candidate_directory = File.join(full_path[0..i] + [ChefConfig::Dist::USER_CONF_DIR])
+          candidate_directory = File.join(full_path[0..i] + [ChefUtils::Dist::Infra::USER_CONF_DIR])
           if File.exist?(candidate_directory) && File.directory?(candidate_directory)
             @chef_config_dir = candidate_directory
             break
@@ -129,7 +129,7 @@ module ChefConfig
         candidate_configs << File.join(chef_config_dir, "knife.rb")
       end
       # Look for $HOME/.chef/knife.rb
-      PathHelper.home(ChefConfig::Dist::USER_CONF_DIR) do |dot_chef_dir|
+      PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR) do |dot_chef_dir|
         candidate_configs << File.join(dot_chef_dir, "config.rb")
         candidate_configs << File.join(dot_chef_dir, "knife.rb")
       end
@@ -184,7 +184,7 @@ module ChefConfig
     end
 
     def home_chef_dir
-      @home_chef_dir ||= PathHelper.home(ChefConfig::Dist::USER_CONF_DIR)
+      @home_chef_dir ||= PathHelper.home(ChefUtils::Dist::Infra::USER_CONF_DIR)
     end
 
     def apply_config(config_content, config_file_path)

data/spec/unit/config_spec.rb

@@ -170,7 +170,7 @@ RSpec.describe ChefConfig::Config do
           apply_config
           expect(described_class[:data_bag_path]).to eq("#{current_directory}/data_bags")
           expect(described_class[:cookbook_path]).to eq("#{current_directory}/cookbooks")
-          expect(described_class[:chef_repo_path]).to eq("#{current_directory}")
+          expect(described_class[:chef_repo_path]).to eq(current_directory)
         end
       end
 
@@ -225,7 +225,7 @@ RSpec.describe ChefConfig::Config do
   end
 
   describe "#var_chef_path" do
-    let (:dirname) { ChefConfig::Dist::DIR_SUFFIX }
+    let (:dirname) { ChefUtils::Dist::Infra::DIR_SUFFIX }
 
     context "on unix", :unix_only do
       it "var_chef_dir is /var/chef" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-config
 version: !ruby/object:Gem::Version
-  version: 16.4.41
+  version: 16.5.64
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-utils
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 16.4.41
+        version: 16.5.64
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 16.4.41
+        version: 16.5.64
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -174,13 +174,13 @@ files:
 - chef-config.gemspec
 - lib/chef-config.rb
 - lib/chef-config/config.rb
-- lib/chef-config/dist.rb
 - lib/chef-config/exceptions.rb
 - lib/chef-config/fips.rb
 - lib/chef-config/logger.rb
 - lib/chef-config/mixin/credentials.rb
 - lib/chef-config/mixin/dot_d.rb
 - lib/chef-config/mixin/fuzzy_hostname_matcher.rb
+- lib/chef-config/mixin/train_transport.rb
 - lib/chef-config/path_helper.rb
 - lib/chef-config/version.rb
 - lib/chef-config/windows.rb

data/lib/chef-config/dist.rb

@@ -1,33 +0,0 @@
-module ChefConfig
-  class Dist
-    # The chef executable name.
-    EXEC = "chef".freeze
-
-    # The client's alias (chef-client)
-    CLIENT = "chef-client".freeze
-
-    # A short name for the product
-    SHORT = "chef".freeze
-
-    # The suffix for Chef's /etc/chef, /var/chef and C:\\Chef directories
-    # "cinc" => /etc/cinc, /var/cinc, C:\\cinc
-    DIR_SUFFIX = "chef".freeze
-
-    # The user's configuration directory
-    USER_CONF_DIR = ".chef".freeze
-
-    # The legacy conf folder: C:/opscode/chef. Specifically the "opscode" part
-    # DIR_SUFFIX is appended to it in code where relevant
-    LEGACY_CONF_DIR = "opscode".freeze
-
-    # Enable forcing Chef EULA
-    ENFORCE_LICENSE = true
-
-    # The servers's alias (chef-server)
-    SERVER = "chef-server".freeze
-
-    # The server's configuration utility
-    SERVER_CTL = "chef-server-ctl".freeze
-
-  end
-end