chef 14.2.0 → 14.3.37

data/lib/chef/application/exit_code.rb

@@ -36,11 +36,11 @@ class Chef
         REBOOT_FAILED: 41,
         AUDIT_MODE_FAILURE: 42,
         CLIENT_UPGRADED: 213,
-      }
+      }.freeze
 
       DEPRECATED_RFC_062_EXIT_CODES = {
         DEPRECATED_FAILURE: -1,
-      }
+      }.freeze
 
       class << self
 

data/lib/chef/application/knife.rb

@@ -23,137 +23,138 @@ require "chef/monkey_patches/net_http.rb"
 
 class Chef::Application::Knife < Chef::Application
 
-  NO_COMMAND_GIVEN = "You need to pass a sub-command (e.g., knife SUB-COMMAND)\n"
+  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) }
+    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|
+    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 for max verbosity",
-    :proc => Proc.new { verbosity_level += 1 },
-    :default => 0
+    short: "-V",
+    long: "--verbose",
+    description: "More verbose output. Use twice for max 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"
+    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 Chef environment (except for in searches, where this will be flagrantly ignored)"
+    short: "-E ENVIRONMENT",
+    long: "--environment ENVIRONMENT",
+    description: "Set the Chef 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"]
+    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
+    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 message",
-    :on           => :tail,
-    :boolean      => true
+    short: "-h",
+    long: "--help",
+    description: "Show this message",
+    on: :tail,
+    boolean: true
 
   option :node_name,
-    :short => "-u USER",
-    :long => "--user USER",
-    :description => "API Client Username"
+    short: "-u USER",
+    long: "--user USER",
+    description: "API Client Username"
 
   option :client_key,
-    :short => "-k KEY",
-    :long => "--key KEY",
-    :description => "API Client Key",
-    :proc => lambda { |path| File.expand_path(path, Dir.pwd) }
+    short: "-k KEY",
+    long: "--key KEY",
+    description: "API Client Key",
+    proc: lambda { |path| File.expand_path(path, Dir.pwd) }
 
   option :chef_server_url,
-    :short => "-s URL",
-    :long => "--server-url URL",
-    :description => "Chef Server URL"
+    short: "-s URL",
+    long: "--server-url URL",
+    description: "Chef Server URL"
 
   option :yes,
-    :short => "-y",
-    :long => "--yes",
-    :description => "Say yes to all prompts for confirmation"
+    short: "-y",
+    long: "--yes",
+    description: "Say yes to all prompts for confirmation"
 
   option :defaults,
-    :long => "--defaults",
-    :description => "Accept default values for all questions"
+    long: "--defaults",
+    description: "Accept default values for all questions"
 
   option :print_after,
-    :long => "--print-after",
-    :description => "Show the data after a destructive operation"
+    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",
-    :default => "summary"
+    short: "-F FORMAT",
+    long: "--format FORMAT",
+    description: "Which format to use for output",
+    default: "summary"
 
   option :local_mode,
-    :short        => "-z",
-    :long         => "--local-mode",
-    :description  => "Point knife commands at local repository instead of server",
-    :boolean      => true
+    short: "-z",
+    long: "--local-mode",
+    description: "Point knife commands at local repository instead of server",
+    boolean: true
 
   option :chef_zero_host,
-    :long         => "--chef-zero-host HOST",
-    :description  => "Host to start chef-zero on"
+    long: "--chef-zero-host HOST",
+    description: "Host to start chef-zero on"
 
   option :chef_zero_port,
-    :long         => "--chef-zero-port PORT",
-    :description  => "Port (or port range) to start chef-zero on.  Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works."
+    long: "--chef-zero-port PORT",
+    description: "Port (or port range) to start chef-zero 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
+    long: "--[no-]listen",
+    description: "Whether a local mode (-z) server binds to a port",
+    boolean: false
 
   option :version,
-    :short        => "-v",
-    :long         => "--version",
-    :description  => "Show chef version",
-    :boolean      => true,
-    :proc         => lambda { |v| puts "Chef: #{::Chef::VERSION}" },
-    :exit         => 0
+    short: "-v",
+    long: "--version",
+    description: "Show chef version",
+    boolean: true,
+    proc: lambda { |v| puts "Chef: #{::Chef::VERSION}" },
+    exit: 0
 
   option :fips,
-    :long         => "--[no-]fips",
-    :description  => "Enable fips mode",
-    :boolean      => true,
-    :default      => nil
+    long: "--[no-]fips",
+    description: "Enable fips mode",
+    boolean: true,
+    default: nil
 
   option :profile,
-    :long         => "--profile PROFILE",
-    :description  => "The credentials profile to select"
+    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

data/lib/chef/application/solo.rb

@@ -35,137 +35,137 @@ class Chef::Application::Solo < Chef::Application
   include ChefConfig::Mixin::DotD
 
   option :config_file,
-    :short => "-c CONFIG",
-    :long  => "--config CONFIG",
-    :default => Chef::Config.platform_specific_path("/etc/chef/solo.rb"),
-    :description => "The configuration file to use"
+    short: "-c CONFIG",
+    long: "--config CONFIG",
+    default: Chef::Config.platform_specific_path("/etc/chef/solo.rb"),
+    description: "The configuration file to use"
 
   option :config_option,
-    :long         => "--config-option OPTION=VALUE",
-    :description  => "Override a single configuration option",
-    :proc         => lambda { |option, existing|
+    long: "--config-option OPTION=VALUE",
+    description: "Override a single configuration option",
+    proc: lambda { |option, existing|
       (existing ||= []) << option
       existing
     }
 
   option :formatter,
-    :short        => "-F FORMATTER",
-    :long         => "--format FORMATTER",
-    :description  => "output format to use",
-    :proc         => lambda { |format| Chef::Config.add_formatter(format) }
+    short: "-F FORMATTER",
+    long: "--format FORMATTER",
+    description: "output format to use",
+    proc: lambda { |format| Chef::Config.add_formatter(format) }
 
   option :force_logger,
-    :long         => "--force-logger",
-    :description  => "Use logger output instead of formatter output",
-    :boolean      => true,
-    :default      => false
+    long: "--force-logger",
+    description: "Use logger output instead of formatter output",
+    boolean: true,
+    default: false
 
   option :force_formatter,
-    :long         => "--force-formatter",
-    :description  => "Use formatter output instead of logger output",
-    :boolean      => true,
-    :default      => false
+    long: "--force-formatter",
+    description: "Use formatter output instead of logger output",
+    boolean: true,
+    default: false
 
   option :profile_ruby,
-    :long         => "--[no-]profile-ruby",
-    :description  => "Dump complete Ruby call graph stack of entire Chef run (expert only)",
-    :boolean      => true,
-    :default      => false
+    long: "--[no-]profile-ruby",
+    description: "Dump complete Ruby call graph stack of entire Chef run (expert only)",
+    boolean: true,
+    default: false
 
   option :color,
-    :long         => "--[no-]color",
-    :boolean      => true,
-    :default      => !Chef::Platform.windows?,
-    :description  => "Use colored output, defaults to enabled"
+    long: "--[no-]color",
+    boolean: true,
+    default: !Chef::Platform.windows?,
+    description: "Use colored output, defaults to enabled"
 
   option :log_level,
-    :short        => "-l LEVEL",
-    :long         => "--log_level LEVEL",
-    :description  => "Set the log level (trace, debug, info, warn, error, fatal)",
-    :proc         => lambda { |l| l.to_sym }
+    short: "-l LEVEL",
+    long: "--log_level LEVEL",
+    description: "Set the log level (trace, debug, info, warn, error, fatal)",
+    proc: lambda { |l| l.to_sym }
 
   option :log_location,
-    :short        => "-L LOGLOCATION",
-    :long         => "--logfile LOGLOCATION",
-    :description  => "Set the log file location, defaults to STDOUT",
-    :proc         => nil
+    short: "-L LOGLOCATION",
+    long: "--logfile LOGLOCATION",
+    description: "Set the log file location, defaults to STDOUT",
+    proc: nil
 
   option :help,
-    :short        => "-h",
-    :long         => "--help",
-    :description  => "Show this message",
-    :on           => :tail,
-    :boolean      => true,
-    :show_options => true,
-    :exit         => 0
+    short: "-h",
+    long: "--help",
+    description: "Show this message",
+    on: :tail,
+    boolean: true,
+    show_options: true,
+    exit: 0
 
   option :user,
-    :short => "-u USER",
-    :long => "--user USER",
-    :description => "User to set privilege to",
-    :proc => nil
+    short: "-u USER",
+    long: "--user USER",
+    description: "User to set privilege to",
+    proc: nil
 
   option :group,
-    :short => "-g GROUP",
-    :long => "--group GROUP",
-    :description => "Group to set privilege to",
-    :proc => nil
+    short: "-g GROUP",
+    long: "--group GROUP",
+    description: "Group to set privilege to",
+    proc: nil
 
   unless Chef::Platform.windows?
     option :daemonize,
-      :short => "-d",
-      :long => "--daemonize",
-      :description => "Daemonize the process",
-      :proc => lambda { |p| true }
+      short: "-d",
+      long: "--daemonize",
+      description: "Daemonize the process",
+      proc: lambda { |p| true }
   end
 
   option :lockfile,
-    :long         => "--lockfile LOCKFILE",
-    :description  => "Set the lockfile location. Prevents multiple processes from converging at the same time",
-    :proc         => nil
+    long: "--lockfile LOCKFILE",
+    description: "Set the lockfile location. Prevents multiple processes from converging at the same time",
+    proc: nil
 
   option :interval,
-    :short => "-i SECONDS",
-    :long => "--interval SECONDS",
-    :description => "Run chef-client periodically, in seconds",
-    :proc => lambda { |s| s.to_i }
+    short: "-i SECONDS",
+    long: "--interval SECONDS",
+    description: "Run chef-client periodically, in seconds",
+    proc: lambda { |s| s.to_i }
 
   option :json_attribs,
-    :short => "-j JSON_ATTRIBS",
-    :long => "--json-attributes JSON_ATTRIBS",
-    :description => "Load attributes from a JSON file or URL",
-    :proc => nil
+    short: "-j JSON_ATTRIBS",
+    long: "--json-attributes JSON_ATTRIBS",
+    description: "Load attributes from a JSON file or URL",
+    proc: nil
 
   option :node_name,
-    :short => "-N NODE_NAME",
-    :long => "--node-name NODE_NAME",
-    :description => "The node name for this client",
-    :proc => nil
+    short: "-N NODE_NAME",
+    long: "--node-name NODE_NAME",
+    description: "The node name for this client",
+    proc: nil
 
   option :splay,
-    :short => "-s SECONDS",
-    :long => "--splay SECONDS",
-    :description => "The splay time for running at intervals, in seconds",
-    :proc => lambda { |s| s.to_i }
+    short: "-s SECONDS",
+    long: "--splay SECONDS",
+    description: "The splay time for running at intervals, in seconds",
+    proc: lambda { |s| s.to_i }
 
   option :recipe_url,
-    :short        => "-r RECIPE_URL",
-    :long         => "--recipe-url RECIPE_URL",
-    :description  => "Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache."
+    short: "-r RECIPE_URL",
+    long: "--recipe-url RECIPE_URL",
+    description: "Pull down a remote gzipped tarball of recipes and untar it to the cookbook cache."
 
   option :version,
-    :short        => "-v",
-    :long         => "--version",
-    :description  => "Show chef version",
-    :boolean      => true,
-    :proc         => lambda { |v| puts "Chef: #{::Chef::VERSION}" },
-    :exit         => 0
+    short: "-v",
+    long: "--version",
+    description: "Show chef version",
+    boolean: true,
+    proc: lambda { |v| puts "Chef: #{::Chef::VERSION}" },
+    exit: 0
 
   option :override_runlist,
-    :short        => "-o RunlistItem,RunlistItem...",
-    :long         => "--override-runlist RunlistItem,RunlistItem...",
-    :description  => "Replace current run list with specified items",
-    :proc         => lambda { |items|
+    short: "-o RunlistItem,RunlistItem...",
+    long: "--override-runlist RunlistItem,RunlistItem...",
+    description: "Replace current run list with specified items",
+    proc: lambda { |items|
       items = items.split(",")
       items.compact.map do |item|
         Chef::RunList::RunListItem.new(item)
@@ -173,45 +173,45 @@ class Chef::Application::Solo < Chef::Application
     }
 
   option :client_fork,
-    :short        => "-f",
-    :long         => "--[no-]fork",
-    :description  => "Fork client"
+    short: "-f",
+    long: "--[no-]fork",
+    description: "Fork client"
 
   option :why_run,
-    :short        => "-W",
-    :long         => "--why-run",
-    :description  => "Enable whyrun mode",
-    :boolean      => true
+    short: "-W",
+    long: "--why-run",
+    description: "Enable whyrun mode",
+    boolean: true
 
   option :ez,
-    :long         => "--ez",
-    :description  => "A memorial for Ezra Zygmuntowicz",
-    :boolean      => true
+    long: "--ez",
+    description: "A memorial for Ezra Zygmuntowicz",
+    boolean: true
 
   option :environment,
-    :short        => "-E ENVIRONMENT",
-    :long         => "--environment ENVIRONMENT",
-    :description  => "Set the Chef Environment on the node"
+    short: "-E ENVIRONMENT",
+    long: "--environment ENVIRONMENT",
+    description: "Set the Chef Environment on the node"
 
   option :run_lock_timeout,
-    :long         => "--run-lock-timeout SECONDS",
-    :description  => "Set maximum duration to wait for another client run to finish, default is indefinitely.",
-    :proc         => lambda { |s| s.to_i }
+    long: "--run-lock-timeout SECONDS",
+    description: "Set maximum duration to wait for another client run to finish, default is indefinitely.",
+    proc: lambda { |s| s.to_i }
 
   option :minimal_ohai,
-    :long           => "--minimal-ohai",
-    :description    => "Only run the bare minimum ohai plugins chef needs to function",
-    :boolean        => true
+    long: "--minimal-ohai",
+    description: "Only run the bare minimum ohai plugins chef needs to function",
+    boolean: true
 
   option :delete_entire_chef_repo,
-    :long           => "--delete-entire-chef-repo",
-    :description    => "DANGEROUS: does what it says, only useful with --recipe-url",
-    :boolean        => true
+    long: "--delete-entire-chef-repo",
+    description: "DANGEROUS: does what it says, only useful with --recipe-url",
+    boolean: true
 
   option :solo_legacy_mode,
-    :long           => "--legacy-mode",
-    :description    => "Run chef-solo in legacy mode",
-    :boolean        => true
+    long: "--legacy-mode",
+    description: "Run chef-solo in legacy mode",
+    boolean: true
 
   attr_reader :chef_client_json
 
@@ -244,7 +244,7 @@ class Chef::Application::Solo < Chef::Application
       # For back compat reasons, we need to ensure that we try and use the cache_path as a repo first
       Chef::Log.trace "Current chef_repo_path is #{Chef::Config.chef_repo_path}"
 
-      if !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
+      if !Chef::Config.key?(:cookbook_path) && !Chef::Config.key?(:chef_repo_path)
         Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Chef::Config[:cache_path])
       end
 
@@ -273,7 +273,7 @@ class Chef::Application::Solo < Chef::Application
 
       if Chef::Config[:delete_entire_chef_repo]
         Chef::Log.trace "Cleanup path #{recipes_path} before extract recipes into it"
-        FileUtils.rm_rf(recipes_path, :secure => true)
+        FileUtils.rm_rf(recipes_path, secure: true)
       end
       Chef::Log.trace "Creating path #{recipes_path} to extract recipes into"
       FileUtils.mkdir_p(recipes_path)
@@ -315,12 +315,12 @@ class Chef::Application::Solo < Chef::Application
   private
 
   def for_ezra
-    puts <<-EOH
-For Ezra Zygmuntowicz:
-  The man who brought you Chef Solo
-  Early contributor to Chef
-  Kind hearted open source advocate
-  Rest in peace, Ezra.
+    puts <<~EOH
+      For Ezra Zygmuntowicz:
+        The man who brought you Chef Solo
+        Early contributor to Chef
+        Kind hearted open source advocate
+        Rest in peace, Ezra.
 EOH
   end
 
@@ -370,7 +370,7 @@ EOH
   def unforked_interval_error_message
     "Unforked chef-client interval runs are disabled in Chef 12." +
       "\nConfiguration settings:" +
-      "#{"\n  interval  = #{Chef::Config[:interval]} seconds" if Chef::Config[:interval]}" +
+      ("\n  interval  = #{Chef::Config[:interval]} seconds" if Chef::Config[:interval]).to_s +
       "\nEnable chef-client interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options."
   end
 end