knife 18.2.7 → 18.3.0

data/knife.gemspec

@@ -1,62 +1,62 @@
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require_relative "lib/chef/knife/version"
-
-Gem::Specification.new do |s|
-  s.name = "knife"
-  s.version = Chef::Knife::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.extra_rdoc_files = ["LICENSE"]
-  s.summary = "The knife CLI for Chef Infra."
-  s.description = s.summary
-  s.license = "Apache-2.0"
-  s.author = "Adam Jacob"
-  s.email = "adam@chef.io" # These seem a bit out of date, and this address probably doesn't go anywhere anymore?
-  s.homepage = "https://www.chef.io"
-
-  s.required_ruby_version = ">= 3.1.0"
-
-  s.add_dependency "chef-config", ">= #{Chef::Knife::VERSION.split(".").first}"
-  s.add_dependency "chef-utils", ">= #{Chef::Knife::VERSION.split(".").first}"
-  s.add_dependency "chef", ">= #{Chef::Knife::VERSION.split(".").first}"
-  s.add_dependency "train-core", "~> 3.10" # 3.2.28 fixes sudo prompts. See https://github.com/chef/chef/pull/9635
-  s.add_dependency "train-winrm", ">= 0.2.5"
-  s.add_dependency "license-acceptance", ">= 1.0.5", "< 3"
-  s.add_dependency "mixlib-cli", ">= 2.1.1", "< 3.0"
-  s.add_dependency "mixlib-archive", ">= 0.4", "< 2.0"
-  s.add_dependency "ohai", "~> 18.0"
-  s.add_dependency "ffi", ">= 1.15" # 1.14 versions are broken on i386 windows
-  s.add_dependency "ffi-yajl", "~> 2.2"
-  s.add_dependency "net-ssh", ">= 5.1", "< 8"
-  s.add_dependency "net-ssh-multi", "~> 1.2", ">= 1.2.1"
-  s.add_dependency "bcrypt_pbkdf", "~> 1.1" # ed25519 ssh key support
-  # disabling this until we get get it to compile on RHEL 7
-  # s.add_dependency "x25519", ">= 1.0.9" # ed25519 KEX module. 1.0.9+ required to resolve sigill failures
-  s.add_dependency "highline", ">= 1.6.9", "< 3" # Used in UI to present a list, no other usage.
-
-  s.add_dependency "tty-prompt", "~> 0.21" # knife ui.ask prompt
-  s.add_dependency "tty-screen", "~> 0.6" # knife list
-  s.add_dependency "tty-table", "~> 0.11" # knife render table output.
-  s.add_dependency "pastel" # knife ui.color
-  s.add_dependency "erubis", "~> 2.7"
-  s.add_dependency "chef-vault" # knife vault
-
-  s.add_development_dependency "chefstyle"
-
-  s.add_dependency "proxifier2", "~> 1.1"
-
-  s.bindir       = "bin"
-  s.executables  = %w{ knife }
-
-  s.require_paths = %w{ lib }
-  s.files = %w{Gemfile Rakefile LICENSE knife.gemspec} +
-    Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
-
-  s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/chef/chef/issues",
-    "changelog_uri"     => "https://github.com/chef/chef/blob/main/CHANGELOG.md",
-    "documentation_uri" => "https://docs.chef.io/",
-    "homepage_uri"      => "https://www.chef.io",
-    "mailing_list_uri"  => "https://discourse.chef.io/",
-    "source_code_uri"   => "https://github.com/chef/chef/",
-  }
-end
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require_relative "lib/chef/knife/version"
+
+Gem::Specification.new do |s|
+  s.name = "knife"
+  s.version = Chef::Knife::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.extra_rdoc_files = ["LICENSE"]
+  s.summary = "The knife CLI for Chef Infra."
+  s.description = s.summary
+  s.license = "Apache-2.0"
+  s.author = "Adam Jacob"
+  s.email = "adam@chef.io" # These seem a bit out of date, and this address probably doesn't go anywhere anymore?
+  s.homepage = "https://www.chef.io"
+
+  s.required_ruby_version = ">= 3.1.0"
+
+  s.add_dependency "chef-config", ">= #{Chef::Knife::VERSION.split(".").first}"
+  s.add_dependency "chef-utils", ">= #{Chef::Knife::VERSION.split(".").first}"
+  s.add_dependency "chef", ">= #{Chef::Knife::VERSION.split(".").first}"
+  s.add_dependency "train-core", "~> 3.10" # 3.2.28 fixes sudo prompts. See https://github.com/chef/chef/pull/9635
+  s.add_dependency "train-winrm", ">= 0.2.5"
+  s.add_dependency "license-acceptance", ">= 1.0.5", "< 3"
+  s.add_dependency "mixlib-cli", ">= 2.1.1", "< 3.0"
+  s.add_dependency "mixlib-archive", ">= 0.4", "< 2.0"
+  s.add_dependency "ohai", "~> 18.0"
+  s.add_dependency "ffi", ">= 1.15" # 1.14 versions are broken on i386 windows
+  s.add_dependency "ffi-yajl", "~> 2.2"
+  s.add_dependency "net-ssh", ">= 5.1", "< 8"
+  s.add_dependency "net-ssh-multi", "~> 1.2", ">= 1.2.1"
+  s.add_dependency "bcrypt_pbkdf", "~> 1.1" # ed25519 ssh key support
+  # disabling this until we get get it to compile on RHEL 7
+  # s.add_dependency "x25519", ">= 1.0.9" # ed25519 KEX module. 1.0.9+ required to resolve sigill failures
+  s.add_dependency "highline", ">= 1.6.9", "< 3" # Used in UI to present a list, no other usage.
+
+  s.add_dependency "tty-prompt", "~> 0.21" # knife ui.ask prompt
+  s.add_dependency "tty-screen", "~> 0.6" # knife list
+  s.add_dependency "tty-table", "~> 0.11" # knife render table output.
+  s.add_dependency "pastel" # knife ui.color
+  s.add_dependency "erubis", "~> 2.7"
+  s.add_dependency "chef-vault" # knife vault
+
+  s.add_development_dependency "chefstyle"
+
+  s.add_dependency "proxifier2", "~> 1.1"
+
+  s.bindir       = "bin"
+  s.executables  = %w{ knife }
+
+  s.require_paths = %w{ lib }
+  s.files = %w{Gemfile Rakefile LICENSE knife.gemspec} +
+    Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/chef/chef/issues",
+    "changelog_uri"     => "https://github.com/chef/chef/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://docs.chef.io/",
+    "homepage_uri"      => "https://www.chef.io",
+    "mailing_list_uri"  => "https://discourse.chef.io/",
+    "source_code_uri"   => "https://github.com/chef/chef/",
+  }
+end

data/lib/chef/application/knife.rb

@@ -1,234 +1,234 @@
-#
-# Author:: Adam Jacob (<adam@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 "chef/application"
-require_relative "../knife"
-require "mixlib/log"
-require "ohai/config"
-module Net
-  autoload :HTTP, "net/http"
-end
-require "chef-utils/dist" unless defined?(ChefUtils::Dist)
-
-class Chef::Application::Knife < Chef::Application
-
-  NO_COMMAND_GIVEN = "You need to pass a sub-command (e.g., knife SUB-COMMAND)\n".freeze
-
-  banner "Usage: knife sub-command (options)"
-
-  option :config_file,
-    short: "-c CONFIG",
-    long: "--config CONFIG",
-    description: "The configuration file to use.",
-    proc: lambda { |path| File.expand_path(path, Dir.pwd) }
-
-  option :config_option,
-    long: "--config-option OPTION=VALUE",
-    description: "Override a single configuration option.",
-    proc: lambda { |option, existing|
-      (existing ||= []) << option
-      existing
-    }
-
-  verbosity_level = 0
-  option :verbosity,
-    short: "-V",
-    long: "--verbose",
-    description: "More verbose output. Use twice (-VV) for additional verbosity and three times (-VVV) for maximum verbosity.",
-    proc: Proc.new { verbosity_level += 1 },
-    default: 0
-
-  option :color,
-    long: "--[no-]color",
-    boolean: true,
-    default: true,
-    description: "Use colored output, defaults to enabled."
-
-  option :environment,
-    short: "-E ENVIRONMENT",
-    long: "--environment ENVIRONMENT",
-    description: "Set the #{ChefUtils::Dist::Infra::PRODUCT} environment (except for in searches, where this will be flagrantly ignored)."
-
-  option :editor,
-    short: "-e EDITOR",
-    long: "--editor EDITOR",
-    description: "Set the editor to use for interactive commands.",
-    default: ENV["EDITOR"]
-
-  option :disable_editing,
-    short: "-d",
-    long: "--disable-editing",
-    description: "Do not open EDITOR, just accept the data as is.",
-    boolean: true,
-    default: false
-
-  option :help,
-    short: "-h",
-    long: "--help",
-    description: "Show this help message.",
-    on: :tail,
-    boolean: true
-
-  option :node_name,
-    short: "-u USER",
-    long: "--user USER",
-    description: "#{ChefUtils::Dist::Server::PRODUCT} API client username."
-
-  option :client_key,
-    short: "-k KEY",
-    long: "--key KEY",
-    description: "#{ChefUtils::Dist::Server::PRODUCT} API client key.",
-    proc: lambda { |path| File.expand_path(path, Dir.pwd) }
-
-  option :chef_server_url,
-    short: "-s URL",
-    long: "--server-url URL",
-    description: "#{ChefUtils::Dist::Server::PRODUCT} URL."
-
-  option :yes,
-    short: "-y",
-    long: "--yes",
-    description: "Say yes to all prompts for confirmation."
-
-  option :defaults,
-    long: "--defaults",
-    description: "Accept default values for all questions."
-
-  option :print_after,
-    long: "--print-after",
-    description: "Show the data after a destructive operation."
-
-  option :format,
-    short: "-F FORMAT",
-    long: "--format FORMAT",
-    description: "Which format to use for output.",
-    in: %w{summary text json yaml pp},
-    default: "summary"
-
-  option :local_mode,
-    short: "-z",
-    long: "--local-mode",
-    description: "Point knife commands at local repository instead of #{ChefUtils::Dist::Server::PRODUCT}.",
-    boolean: true
-
-  option :chef_zero_host,
-    long: "--chef-zero-host HOST",
-    description: "Host to start #{ChefUtils::Dist::Zero::PRODUCT} on."
-
-  option :chef_zero_port,
-    long: "--chef-zero-port PORT",
-    description: "Port (or port range) to start #{ChefUtils::Dist::Zero::PRODUCT} on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works."
-
-  option :listen,
-    long: "--[no-]listen",
-    description: "Whether a local mode (-z) server binds to a port.",
-    boolean: false
-
-  option :version,
-    short: "-v",
-    long: "--version",
-    description: "Show #{ChefUtils::Dist::Infra::PRODUCT} version.",
-    boolean: true,
-    proc: lambda { |v| puts "#{ChefUtils::Dist::Infra::PRODUCT}: #{::Chef::VERSION}" },
-    exit: 0
-
-  option :fips,
-    long: "--[no-]fips",
-    description: "Enable FIPS mode.",
-    boolean: true,
-    default: nil
-
-  option :profile,
-    long: "--profile PROFILE",
-    description: "The credentials profile to select."
-
-  # Run knife
-  def run
-    ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
-    Mixlib::Log::Formatter.show_time = false
-    validate_and_parse_options
-    quiet_traps
-    Chef::Knife.run(ARGV, options)
-    exit 0
-  end
-
-  private
-
-  def quiet_traps
-    trap("TERM") do
-      exit 1
-    end
-
-    trap("INT") do
-      exit 2
-    end
-  end
-
-  def validate_and_parse_options
-    # Checking ARGV validity *before* parse_options because parse_options
-    # mangles ARGV in some situations
-    if no_command_given?
-      print_help_and_exit(1, NO_COMMAND_GIVEN)
-    elsif no_subcommand_given?
-      if want_help? || want_version?
-        print_help_and_exit(0)
-      else
-        print_help_and_exit(2, NO_COMMAND_GIVEN)
-      end
-    end
-  end
-
-  def no_subcommand_given?
-    ARGV[0] =~ /^-/
-  end
-
-  def no_command_given?
-    ARGV.empty?
-  end
-
-  def want_help?
-    ARGV[0] =~ /^(--help|-h)$/
-  end
-
-  def want_version?
-    ARGV[0] =~ /^(--version|-v)$/
-  end
-
-  def print_help_and_exit(exitcode = 1, fatal_message = nil)
-    Chef::Log.error(fatal_message) if fatal_message
-
-    begin
-      parse_options
-    rescue OptionParser::InvalidOption => e
-      puts "#{e}\n"
-    end
-
-    if want_help?
-      puts "#{ChefUtils::Dist::Infra::PRODUCT}: #{Chef::VERSION}"
-      puts
-      puts "Docs: #{ChefUtils::Dist::Org::KNIFE_DOCS}"
-      puts "Patents: #{ChefUtils::Dist::Org::PATENTS}"
-      puts
-    end
-
-    puts opt_parser
-    puts
-    Chef::Knife.list_commands
-    exit exitcode
-  end
-
-end
+#
+# Author:: Adam Jacob (<adam@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 "chef/application"
+require_relative "../knife"
+require "mixlib/log"
+require "ohai/config"
+module Net
+  autoload :HTTP, "net/http"
+end
+require "chef-utils/dist" unless defined?(ChefUtils::Dist)
+
+class Chef::Application::Knife < Chef::Application
+
+  NO_COMMAND_GIVEN = "You need to pass a sub-command (e.g., knife SUB-COMMAND)\n".freeze
+
+  banner "Usage: knife sub-command (options)"
+
+  option :config_file,
+    short: "-c CONFIG",
+    long: "--config CONFIG",
+    description: "The configuration file to use.",
+    proc: lambda { |path| File.expand_path(path, Dir.pwd) }
+
+  option :config_option,
+    long: "--config-option OPTION=VALUE",
+    description: "Override a single configuration option.",
+    proc: lambda { |option, existing|
+      (existing ||= []) << option
+      existing
+    }
+
+  verbosity_level = 0
+  option :verbosity,
+    short: "-V",
+    long: "--verbose",
+    description: "More verbose output. Use twice (-VV) for additional verbosity and three times (-VVV) for maximum verbosity.",
+    proc: Proc.new { verbosity_level += 1 },
+    default: 0
+
+  option :color,
+    long: "--[no-]color",
+    boolean: true,
+    default: true,
+    description: "Use colored output, defaults to enabled."
+
+  option :environment,
+    short: "-E ENVIRONMENT",
+    long: "--environment ENVIRONMENT",
+    description: "Set the #{ChefUtils::Dist::Infra::PRODUCT} environment (except for in searches, where this will be flagrantly ignored)."
+
+  option :editor,
+    short: "-e EDITOR",
+    long: "--editor EDITOR",
+    description: "Set the editor to use for interactive commands.",
+    default: ENV["EDITOR"]
+
+  option :disable_editing,
+    short: "-d",
+    long: "--disable-editing",
+    description: "Do not open EDITOR, just accept the data as is.",
+    boolean: true,
+    default: false
+
+  option :help,
+    short: "-h",
+    long: "--help",
+    description: "Show this help message.",
+    on: :tail,
+    boolean: true
+
+  option :node_name,
+    short: "-u USER",
+    long: "--user USER",
+    description: "#{ChefUtils::Dist::Server::PRODUCT} API client username."
+
+  option :client_key,
+    short: "-k KEY",
+    long: "--key KEY",
+    description: "#{ChefUtils::Dist::Server::PRODUCT} API client key.",
+    proc: lambda { |path| File.expand_path(path, Dir.pwd) }
+
+  option :chef_server_url,
+    short: "-s URL",
+    long: "--server-url URL",
+    description: "#{ChefUtils::Dist::Server::PRODUCT} URL."
+
+  option :yes,
+    short: "-y",
+    long: "--yes",
+    description: "Say yes to all prompts for confirmation."
+
+  option :defaults,
+    long: "--defaults",
+    description: "Accept default values for all questions."
+
+  option :print_after,
+    long: "--print-after",
+    description: "Show the data after a destructive operation."
+
+  option :format,
+    short: "-F FORMAT",
+    long: "--format FORMAT",
+    description: "Which format to use for output.",
+    in: %w{summary text json yaml pp},
+    default: "summary"
+
+  option :local_mode,
+    short: "-z",
+    long: "--local-mode",
+    description: "Point knife commands at local repository instead of #{ChefUtils::Dist::Server::PRODUCT}.",
+    boolean: true
+
+  option :chef_zero_host,
+    long: "--chef-zero-host HOST",
+    description: "Host to start #{ChefUtils::Dist::Zero::PRODUCT} on."
+
+  option :chef_zero_port,
+    long: "--chef-zero-port PORT",
+    description: "Port (or port range) to start #{ChefUtils::Dist::Zero::PRODUCT} on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works."
+
+  option :listen,
+    long: "--[no-]listen",
+    description: "Whether a local mode (-z) server binds to a port.",
+    boolean: false
+
+  option :version,
+    short: "-v",
+    long: "--version",
+    description: "Show #{ChefUtils::Dist::Infra::PRODUCT} version.",
+    boolean: true,
+    proc: lambda { |v| puts "#{ChefUtils::Dist::Infra::PRODUCT}: #{::Chef::VERSION}" },
+    exit: 0
+
+  option :fips,
+    long: "--[no-]fips",
+    description: "Enable FIPS mode.",
+    boolean: true,
+    default: nil
+
+  option :profile,
+    long: "--profile PROFILE",
+    description: "The credentials profile to select."
+
+  # Run knife
+  def run
+    ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
+    Mixlib::Log::Formatter.show_time = false
+    validate_and_parse_options
+    quiet_traps
+    Chef::Knife.run(ARGV, options)
+    exit 0
+  end
+
+  private
+
+  def quiet_traps
+    trap("TERM") do
+      exit 1
+    end
+
+    trap("INT") do
+      exit 2
+    end
+  end
+
+  def validate_and_parse_options
+    # Checking ARGV validity *before* parse_options because parse_options
+    # mangles ARGV in some situations
+    if no_command_given?
+      print_help_and_exit(1, NO_COMMAND_GIVEN)
+    elsif no_subcommand_given?
+      if want_help? || want_version?
+        print_help_and_exit(0)
+      else
+        print_help_and_exit(2, NO_COMMAND_GIVEN)
+      end
+    end
+  end
+
+  def no_subcommand_given?
+    ARGV[0] =~ /^-/
+  end
+
+  def no_command_given?
+    ARGV.empty?
+  end
+
+  def want_help?
+    ARGV[0] =~ /^(--help|-h)$/
+  end
+
+  def want_version?
+    ARGV[0] =~ /^(--version|-v)$/
+  end
+
+  def print_help_and_exit(exitcode = 1, fatal_message = nil)
+    Chef::Log.error(fatal_message) if fatal_message
+
+    begin
+      parse_options
+    rescue OptionParser::InvalidOption => e
+      puts "#{e}\n"
+    end
+
+    if want_help?
+      puts "#{ChefUtils::Dist::Infra::PRODUCT}: #{Chef::VERSION}"
+      puts
+      puts "Docs: #{ChefUtils::Dist::Org::KNIFE_DOCS}"
+      puts "Patents: #{ChefUtils::Dist::Org::PATENTS}"
+      puts
+    end
+
+    puts opt_parser
+    puts
+    Chef::Knife.list_commands
+    exit exitcode
+  end
+
+end