chef 16.4.35 → 16.6.14

data/lib/chef/knife/config_list_profiles.rb

@@ -16,112 +16,22 @@
 #
 
 require_relative "../knife"
+require_relative "./config_list"
 
 class Chef
   class Knife
-    class ConfigListProfiles < Knife
-      banner "knife config list-profiles (options)"
-
-      deps do
-        require_relative "../workstation_config_loader"
-      end
+    class ConfigListProfiles < ConfigList
 
-      option :ignore_knife_rb,
-        short: "-i",
-        long: "--ignore-knife-rb",
-        description: "Ignore the current config.rb/knife.rb configuration.",
-        default: false
+      # Handle the subclassing (knife doesn't do this :()
+      dependency_loaders.concat(superclass.dependency_loaders)
 
-      def configure_chef
-        apply_computed_config
-      end
+      banner "knife config list-profiles (options)"
+      category "deprecated"
 
       def run
-        credentials_data = self.class.config_loader.parse_credentials_file
-        if credentials_data.nil? || credentials_data.empty?
-          # Should this just show the ambient knife.rb config as "default" instead?
-          ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
-          exit 1
-        end
-
-        current_profile = self.class.config_loader.credentials_profile(config[:profile])
-        profiles = credentials_data.keys.map do |profile|
-          if config[:ignore_knife_rb]
-            # Don't do any fancy loading nonsense, just the raw data.
-            profile_data = credentials_data[profile]
-            {
-              profile: profile,
-              active: profile == current_profile,
-              client_name: profile_data["client_name"] || profile_data["node_name"],
-              client_key: profile_data["client_key"],
-              server_url: profile_data["chef_server_url"],
-            }
-          else
-            # Fancy loading nonsense so we get what the actual config would be.
-            # Note that this modifies the global config, after this, all bets are
-            # off as to whats in the config.
-            Chef::Config.reset
-            wcl = Chef::WorkstationConfigLoader.new(nil, Chef::Log, profile: profile)
-            wcl.load
-            {
-              profile: profile,
-              active: profile == current_profile,
-              client_name: Chef::Config[:node_name],
-              client_key: Chef::Config[:client_key],
-              server_url: Chef::Config[:chef_server_url],
-            }
-          end
-        end
-
-        # Try to reset the config.
-        unless config[:ignore_knife_rb]
-          Chef::Config.reset
-          apply_computed_config
-        end
-
-        if ui.interchange?
-          # Machine-readable output.
-          ui.output(profiles)
-        else
-          # Table output.
-          ui.output(render_table(profiles))
-        end
-      end
-
-      private
-
-      def render_table(profiles, padding: 2)
-        # Replace the home dir in the client key path with ~.
-        profiles.each do |profile|
-          profile[:client_key] = profile[:client_key].to_s.gsub(/^#{Regexp.escape(Dir.home)}/, "~") if profile[:client_key]
-        end
-        # Render the data to a 2D array that will be used for the table.
-        table_data = [["", "Profile", "Client", "Key", "Server"]] + profiles.map do |profile|
-          [profile[:active] ? "*" : ""] + profile.values_at(:profile, :client_name, :client_key, :server_url).map(&:to_s)
-        end
-        # Compute column widths.
-        column_widths = Array.new(table_data.first.length) do |i|
-          table_data.map { |row| row[i].length + padding }.max
-        end
-        # Special case, the first col gets no padding (because indicator) and last
-        # get no padding because last.
-        column_widths[0] -= padding
-        column_widths[-1] -= padding
-        # Build the format string for each row.
-        format_string = column_widths.map { |w| "%-#{w}.#{w}s" }.join("")
-        format_string << "\n"
-        # Print the header row and a separator.
-        table = ui.color(format_string % table_data.first, :green)
-        table << "-" * column_widths.sum
-        table << "\n"
-        # Print the rest of the table.
-        table_data.drop(1).each do |row|
-          table << format_string % row
-        end
-        # Trim the last newline because ui.output adds one.
-        table.chomp!
+        Chef::Log.warn("knife config list-profiles has been deprecated in favor of knife config list. This will be removed in the major release version!")
+        super
       end
-
     end
   end
 end

data/lib/chef/knife/config_show.rb

@@ -0,0 +1,127 @@
+#
+# Author:: Vivek Singh (<vsingh@chef.io>)
+# 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 "../knife"
+
+class Chef
+  class Knife
+    class ConfigShow < Knife
+      banner "knife config show [OPTION...] (options)\nDisplays the value of Chef::Config[OPTION] (or all config values)"
+
+      option :all,
+        short: "-a",
+        long: "--all",
+        description: "Include options that are not set in the configuration.",
+        default: false
+
+      option :raw,
+        short: "-r",
+        long: "--raw",
+        description: "Display a each value with no formatting.",
+        default: false
+
+      def run
+        if config[:format] == "summary" && !config[:raw]
+          # If using the default, human-readable output, also show which config files are being loaded.
+          # Some of this is a bit hacky since it duplicates
+          wcl = self.class.config_loader
+          if wcl.credentials_found
+            loading_from("credentials", ChefConfig::PathHelper.home(".chef", "credentials"))
+          end
+          if wcl.config_location
+            loading_from("configuration", wcl.config_location)
+          end
+
+          if Chef::Config[:config_d_dir]
+            wcl.find_dot_d(Chef::Config[:config_d_dir]).each do |path|
+              loading_from(".d/ configuration", path)
+            end
+          end
+        end
+
+        # Dump the whole config, including defaults is --all was given.
+        config_data = Chef::Config.save(config[:all])
+        # Two special cases, these are set during knife startup but we don't usually care about them.
+        unless config[:all]
+          config_data.delete(:color)
+          # Only keep these if true, false is much less important because it's the default.
+          config_data.delete(:local_mode) unless config_data[:local_mode]
+          config_data.delete(:enforce_default_paths) unless config_data[:enforce_default_paths]
+          config_data.delete(:enforce_path_sanity) unless config_data[:enforce_path_sanity]
+        end
+
+        # Extract the data to show.
+        output_data = {}
+        if @name_args.empty?
+          output_data = config_data
+        else
+          @name_args.each do |filter|
+            if filter =~ %r{^/(.*)/(i?)$}
+              # It's a regex.
+              filter_re = Regexp.new($1, $2 ? Regexp::IGNORECASE : 0)
+              config_data.each do |key, value|
+                output_data[key] = value if key.to_s&.match?(filter_re)
+              end
+            else
+              # It's a dotted path string.
+              filter_parts = filter.split(/\./)
+              extract = lambda do |memo, filter_part|
+                memo.is_a?(Hash) ? memo[filter_part.to_sym] : nil
+              end
+              # Check against both config_data and all of the data, so that even
+              # in non-all mode, if you ask for a key that isn't in the non-all
+              # data, it will check against the broader set.
+              output_data[filter] = filter_parts.inject(config_data, &extract) || filter_parts.inject(Chef::Config.save(true), &extract)
+            end
+          end
+        end
+
+        # Fix up some values.
+        output_data.each do |key, value|
+          if value == STDOUT
+            output_data[key] = "STDOUT"
+          elsif value == STDERR
+            output_data[key] = "STDERR"
+          end
+        end
+
+        # Show the data.
+        if config[:raw]
+          output_data.each_value do |value|
+            ui.msg(value)
+          end
+        else
+          ui.output(output_data)
+        end
+      end
+
+      private
+
+      # Display a banner about loading from a config file.
+      #
+      # @api private
+      # @param type_of_file [String] Description of the file for the banner.
+      # @param path [String] Path of the file.
+      # @return [nil]
+      def loading_from(type_of_file, path)
+        path = Pathname.new(path).realpath
+        ui.msg(ui.color("Loading from #{type_of_file} file #{path}", :yellow))
+      end
+    end
+  end
+end

data/lib/chef/knife/config_use.rb

@@ -0,0 +1,61 @@
+#
+# Author:: Vivek Singh (<vsingh@chef.io>)
+# 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 "../knife"
+
+class Chef
+  class Knife
+    class ConfigUse < Knife
+      banner "knife config use [PROFILE]"
+
+      deps do
+        require "fileutils" unless defined?(FileUtils)
+      end
+
+      # Disable normal config loading since this shouldn't fail if the profile
+      # doesn't exist of the config is otherwise corrupted.
+      def configure_chef
+        apply_computed_config
+      end
+
+      def run
+        profile = @name_args[0]&.strip
+        if profile.nil? || profile.empty?
+          ui.msg(self.class.config_loader.credentials_profile(config[:profile]))
+        else
+          credentials_data = self.class.config_loader.parse_credentials_file
+          context_file = ChefConfig::PathHelper.home(".chef", "context").freeze
+
+          if credentials_data.nil? || credentials_data.empty?
+            ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
+            exit 1
+          end
+
+          if credentials_data[profile].nil?
+            raise ChefConfig::ConfigurationError, "Profile #{profile} doesn't exist. Please add it to #{self.class.config_loader.credentials_file_path} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles."
+          else
+            # Ensure the .chef/ folder exists.
+            FileUtils.mkdir_p(File.dirname(context_file))
+            IO.write(context_file, "#{profile}\n")
+            ui.msg("Set default profile to #{profile}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/config_use_profile.rb

@@ -16,23 +16,21 @@
 #
 
 require_relative "../knife"
+require_relative "./config_use"
 
 class Chef
   class Knife
-    class ConfigUseProfile < Knife
-      banner "knife config use-profile PROFILE"
+    class ConfigUseProfile < ConfigUse
 
-      deps do
-        require "fileutils" unless defined?(FileUtils)
-      end
+      # Handle the subclassing (knife doesn't do this :()
+      dependency_loaders.concat(superclass.dependency_loaders)
 
-      # Disable normal config loading since this shouldn't fail if the profile
-      # doesn't exist of the config is otherwise corrupted.
-      def configure_chef
-        apply_computed_config
-      end
+      banner "knife config use-profile PROFILE"
+      category "deprecated"
 
       def run
+        Chef::Log.warn("knife config use-profile has been deprecated in favor of knife config use. This will be removed in the major release version!")
+
         credentials_data = self.class.config_loader.parse_credentials_file
         context_file = ChefConfig::PathHelper.home(".chef", "context").freeze
         profile = @name_args[0]&.strip
@@ -42,21 +40,8 @@ class Chef
           exit 1
         end
 
-        if credentials_data.nil? || credentials_data.empty?
-          ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
-          exit 1
-        end
-
-        if credentials_data[profile].nil?
-          raise ChefConfig::ConfigurationError, "Profile #{profile} doesn't exist. Please add it to #{self.class.config_loader.credentials_file_path} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles."
-        else
-          # Ensure the .chef/ folder exists.
-          FileUtils.mkdir_p(File.dirname(context_file))
-          IO.write(context_file, "#{profile}\n")
-          ui.msg("Set default profile to #{profile}")
-        end
+        super
       end
-
     end
   end
 end

data/lib/chef/knife/configure.rb

@@ -17,7 +17,7 @@
 #
 
 require_relative "../knife"
-require_relative "../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Knife
@@ -27,6 +27,8 @@ class Chef
 
       deps do
         require_relative "../util/path_helper"
+        require_relative "client_create"
+        require_relative "user_create"
         require "ohai" unless defined?(Ohai::System)
         Chef::Knife::ClientCreate.load_deps
         Chef::Knife::UserCreate.load_deps
@@ -117,7 +119,7 @@ class Chef
         if config[:initial]
           @new_client_name        = config[:node_name] || ask_question("Please enter a name for the new user: ", default: Etc.getlogin)
           @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin name: ", default: "admin")
-          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", default: "#{Chef::Dist::SERVER_CONF_DIR}/admin.pem")
+          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", default: "#{ChefUtils::Dist::Server::CONF_DIR}/admin.pem")
           @admin_client_key       = File.expand_path(@admin_client_key)
         else
           @new_client_name = config[:node_name] || ask_question("Please enter an existing username or clientname for the API: ", default: Etc.getlogin)

data/lib/chef/knife/core/bootstrap_context.rb

@@ -19,7 +19,7 @@
 require_relative "../../run_list"
 require_relative "../../util/path_helper"
 require "pathname" unless defined?(Pathname)
-require_relative "../../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Knife
@@ -184,7 +184,7 @@ class Chef
 
         def start_chef
           # If the user doesn't have a client path configure, let bash use the PATH for what it was designed for
-          client_path = chef_config[:chef_client_path] || "#{Chef::Dist::CLIENT}"
+          client_path = chef_config[:chef_client_path] || ChefUtils::Dist::Infra::CLIENT
           s = "#{client_path} -j /etc/chef/first-boot.json"
           if config[:verbosity] && config[:verbosity] >= 3
             s << " -l trace"

data/lib/chef/knife/core/object_loader.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 #
 
-require "ffi_yajl" unless defined?(FFI_Yajl)
+autoload :FFI_Yajl, "ffi_yajl"
 require_relative "../../util/path_helper"
 require_relative "../../data_bag_item"
 

data/lib/chef/knife/core/ui.rb

@@ -70,7 +70,7 @@ class Chef
       # pastel.decorate is a lightweight replacement for highline.color
       def pastel
         @pastel ||= begin
-          require "pastel"
+          require "pastel" unless defined?(Pastel)
           Pastel.new
         end
       end

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -18,7 +18,7 @@
 
 require_relative "bootstrap_context"
 require_relative "../../util/path_helper"
-require_relative "../../dist"
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Knife
@@ -175,7 +175,7 @@ class Chef
           bootstrap_environment_option = bootstrap_environment.nil? ? "" : " -E #{bootstrap_environment}"
 
           start_chef = "SET \"PATH=%SYSTEM32%;%SystemRoot%;%SYSTEM32%\\Wbem;%SYSTEM32%\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;#{c_opscode_dir}\\bin;#{c_opscode_dir}\\embedded\\bin\;%PATH%\"\n"
-          start_chef << "#{Chef::Dist::CLIENT} -c #{client_rb} -j #{first_boot}#{bootstrap_environment_option}\n"
+          start_chef << "#{ChefUtils::Dist::Infra::CLIENT} -c #{client_rb} -j #{first_boot}#{bootstrap_environment_option}\n"
         end
 
         def win_wget
@@ -288,7 +288,7 @@ class Chef
         end
 
         def local_download_path
-          "%TEMP%\\#{Chef::Dist::CLIENT}-latest.msi"
+          "%TEMP%\\#{ChefUtils::Dist::Infra::CLIENT}-latest.msi"
         end
 
         # Build a URL to query www.chef.io that will redirect to the correct
@@ -365,7 +365,7 @@ class Chef
           <<~EOH
             @set MSIERRORCODE=!ERRORLEVEL!
             @if ERRORLEVEL 1 (
-                @echo WARNING: Failed to install #{Chef::Dist::PRODUCT} MSI package in remote context with status code !MSIERRORCODE!.
+                @echo WARNING: Failed to install #{ChefUtils::Dist::Infra::PRODUCT} MSI package in remote context with status code !MSIERRORCODE!.
                 @echo WARNING: This may be due to a defect in operating system update KB2918614: http://support.microsoft.com/kb/2918614
                 @set OLDLOGLOCATION="%CHEF_CLIENT_MSI_LOG_PATH%-fail.log"
                 @move "%CHEF_CLIENT_MSI_LOG_PATH%" "!OLDLOGLOCATION!" > NUL
@@ -374,26 +374,26 @@ class Chef
                 @schtasks /create /f  /sc once /st 00:00:00 /tn chefclientbootstraptask /ru SYSTEM /rl HIGHEST /tr \"cmd /c #{command} & sleep 2 & waitfor /s %computername% /si chefclientinstalldone\"
 
                 @if ERRORLEVEL 1 (
-                    @echo ERROR: Failed to create #{Chef::Dist::PRODUCT} installation scheduled task with status code !ERRORLEVEL! > "&2"
+                    @echo ERROR: Failed to create #{ChefUtils::Dist::Infra::PRODUCT} installation scheduled task with status code !ERRORLEVEL! > "&2"
                 ) else (
-                    @echo Successfully created scheduled task to install #{Chef::Dist::PRODUCT}.
+                    @echo Successfully created scheduled task to install #{ChefUtils::Dist::Infra::PRODUCT}.
                     @schtasks /run /tn chefclientbootstraptask
                     @if ERRORLEVEL 1 (
-                        @echo ERROR: Failed to execute #{Chef::Dist::PRODUCT} installation scheduled task with status code !ERRORLEVEL!. > "&2"
+                        @echo ERROR: Failed to execute #{ChefUtils::Dist::Infra::PRODUCT} installation scheduled task with status code !ERRORLEVEL!. > "&2"
                     ) else (
-                        @echo Successfully started #{Chef::Dist::PRODUCT} installation scheduled task.
+                        @echo Successfully started #{ChefUtils::Dist::Infra::PRODUCT} installation scheduled task.
                         @echo Waiting for installation to complete -- this may take a few minutes...
                         waitfor chefclientinstalldone /t 600
                         if ERRORLEVEL 1 (
-                            @echo ERROR: Timed out waiting for #{Chef::Dist::PRODUCT} package to install
+                            @echo ERROR: Timed out waiting for #{ChefUtils::Dist::Infra::PRODUCT} package to install
                         ) else (
-                            @echo Finished waiting for #{Chef::Dist::PRODUCT} package to install.
+                            @echo Finished waiting for #{ChefUtils::Dist::Infra::PRODUCT} package to install.
                         )
                         @schtasks /delete /f /tn chefclientbootstraptask > NUL
                     )
                 )
             ) else (
-                @echo Successfully installed #{Chef::Dist::PRODUCT} package.
+                @echo Successfully installed #{ChefUtils::Dist::Infra::PRODUCT} package.
             )
           EOH
         end