chef 14.15.6 → 15.0.293

data/lib/chef/application/client.rb

@@ -2,7 +2,7 @@
 # Author:: AJ Christensen (<aj@chef.io)
 # Author:: Christopher Brown (<cb@chef.io>)
 # Author:: Mark Mzyk (mmzyk@chef.io)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,22 +17,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "chef/application"
-require "chef/client"
-require "chef/config"
-require "chef/daemon"
-require "chef/log"
-require "chef/config_fetcher"
-require "chef/handler/error_report"
-require "chef/workstation_config_loader"
-require "chef/mixin/shell_out"
+require_relative "../application"
+require_relative "../client"
+require_relative "../config"
+require_relative "../daemon"
+require_relative "../log"
+require_relative "../config_fetcher"
+require_relative "../handler/error_report"
+require_relative "../workstation_config_loader"
+require_relative "../mixin/shell_out"
 require "chef-config/mixin/dot_d"
 require "mixlib/archive"
 require "uri"
+require_relative "../dist"
+require "license_acceptance/cli_flags/mixlib_cli"
 
 class Chef::Application::Client < Chef::Application
   include Chef::Mixin::ShellOut
   include ChefConfig::Mixin::DotD
+  include LicenseAcceptance::CLIFlags::MixlibCLI
 
   # Mimic self_pipe sleep from Unicorn to capture signals safely
   SELF_PIPE = [] # rubocop:disable Style/MutableConstant
@@ -40,11 +43,11 @@ class Chef::Application::Client < Chef::Application
   option :config_file,
     short: "-c CONFIG",
     long: "--config CONFIG",
-    description: "The configuration file to use"
+    description: "The configuration file to use."
 
   option :config_option,
     long: "--config-option OPTION=VALUE",
-    description: "Override a single configuration option",
+    description: "Override a single configuration option.",
     proc: lambda { |option, existing|
       (existing ||= []) << option
       existing
@@ -53,24 +56,24 @@ class Chef::Application::Client < Chef::Application
   option :formatter,
     short: "-F FORMATTER",
     long: "--format FORMATTER",
-    description: "output format to use",
+    description: "The 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",
+    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",
+    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)",
+    description: "Dump complete Ruby call graph stack of entire #{Chef::Dist::PRODUCT} run (expert only).",
     boolean: true,
     default: false
 
@@ -78,24 +81,24 @@ class Chef::Application::Client < Chef::Application
     long: "--[no-]color",
     boolean: true,
     default: true,
-    description: "Use colored output, defaults to enabled"
+    description: "Use colored output, defaults to enabled."
 
   option :log_level,
     short: "-l LEVEL",
     long: "--log_level LEVEL",
-    description: "Set the log level (auto, trace, debug, info, warn, error, fatal)",
+    description: "Set the log level (auto, 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 - recommended for daemonizing",
+    description: "Set the log file location, defaults to STDOUT - recommended for daemonizing.",
     proc: nil
 
   option :help,
     short: "-h",
     long: "--help",
-    description: "Show this message",
+    description: "Show this help message.",
     on: :tail,
     boolean: true,
     show_options: true,
@@ -104,20 +107,20 @@ class Chef::Application::Client < Chef::Application
   option :user,
     short: "-u USER",
     long: "--user USER",
-    description: "User to set privilege to",
+    description: "User to set privilege to.",
     proc: nil
 
   option :group,
     short: "-g GROUP",
     long: "--group GROUP",
-    description: "Group to set privilege to",
+    description: "Group to set privilege to.",
     proc: nil
 
   unless Chef::Platform.windows?
     option :daemonize,
       short: "-d [WAIT]",
       long: "--daemonize [WAIT]",
-      description:         "Daemonize the process. Accepts an optional integer which is the " \
+      description: "Daemonize the process. Accepts an optional integer which is the " \
         "number of seconds to wait before the first daemonized run.",
       proc: lambda { |wait| wait =~ /^\d+$/ ? wait.to_i : true }
   end
@@ -125,83 +128,83 @@ class Chef::Application::Client < Chef::Application
   option :pid_file,
     short: "-P PID_FILE",
     long: "--pid PIDFILE",
-    description: "Set the PID file location, for the chef-client daemon process. Defaults to /tmp/chef-client.pid",
+    description: "Set the PID file location, for the #{Chef::Dist::CLIENT} daemon process. Defaults to /tmp/chef-client.pid.",
     proc: nil
 
   option :lockfile,
     long: "--lockfile LOCKFILE",
-    description: "Set the lockfile location. Prevents multiple client processes from converging at the same time",
+    description: "Set the lockfile location. Prevents multiple client processes from converging at the same time.",
     proc: nil
 
   option :interval,
     short: "-i SECONDS",
     long: "--interval SECONDS",
-    description: "Run chef-client periodically, in seconds",
+    description: "Run #{Chef::Dist::CLIENT} periodically, in seconds.",
     proc: lambda { |s| s.to_i }
 
   option :once,
     long: "--once",
-    description: "Cancel any interval or splay options, run chef once and exit",
+    description: "Cancel any interval or splay options, run #{Chef::Dist::CLIENT} once and exit.",
     boolean: true
 
   option :json_attribs,
     short: "-j JSON_ATTRIBS",
     long: "--json-attributes JSON_ATTRIBS",
-    description: "Load attributes from a JSON file or URL",
+    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",
+    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",
+    description: "The splay time for running at intervals, in seconds.",
     proc: lambda { |s| s.to_i }
 
   option :chef_server_url,
     short: "-S CHEFSERVERURL",
     long: "--server CHEFSERVERURL",
-    description: "The chef server URL",
+    description: "The #{Chef::Dist::SERVER_PRODUCT} URL.",
     proc: nil
 
   option :validation_key,
     short: "-K KEY_FILE",
     long: "--validation_key KEY_FILE",
-    description: "Set the validation key file location, used for registering new clients",
+    description: "Set the validation key file location, used for registering new clients.",
     proc: nil
 
   option :client_key,
     short: "-k KEY_FILE",
     long: "--client_key KEY_FILE",
-    description: "Set the client key file location",
+    description: "Set the client key file location.",
     proc: nil
 
   option :named_run_list,
     short: "-n NAMED_RUN_LIST",
     long: "--named-run-list NAMED_RUN_LIST",
-    description: "Use a policyfile's named run list instead of the default run list"
+    description: "Use a policyfile's named run list instead of the default run list."
 
   option :environment,
     short: "-E ENVIRONMENT",
     long: "--environment ENVIRONMENT",
-    description: "Set the Chef Environment on the node"
+    description: "Set the #{Chef::Dist::PRODUCT} environment on the node."
 
   option :version,
     short: "-v",
     long: "--version",
-    description: "Show chef version",
+    description: "Show #{Chef::Dist::PRODUCT} version.",
     boolean: true,
-    proc: lambda { |v| puts "Chef: #{::Chef::VERSION}" },
+    proc: lambda { |v| puts "#{Chef::Dist::PRODUCT}: #{::Chef::VERSION}" },
     exit: 0
 
   option :override_runlist,
     short: "-o RunlistItem,RunlistItem...",
     long: "--override-runlist RunlistItem,RunlistItem...",
-    description: "Replace current run list with specified items for a single run",
+    description: "Replace current run list with specified items for a single run.",
     proc: lambda { |items|
       items = items.split(",")
       items.compact.map do |item|
@@ -212,23 +215,24 @@ class Chef::Application::Client < Chef::Application
   option :runlist,
     short: "-r RunlistItem,RunlistItem...",
     long: "--runlist RunlistItem,RunlistItem...",
-    description: "Permanently replace current run list with specified items",
+    description: "Permanently replace current run list with specified items.",
     proc: lambda { |items|
       items = items.split(",")
       items.compact.map do |item|
         Chef::RunList::RunListItem.new(item)
       end
     }
+
   option :why_run,
     short: "-W",
     long: "--why-run",
-    description: "Enable whyrun mode",
+    description: "Enable whyrun mode.",
     boolean: true
 
   option :client_fork,
     short: "-f",
     long: "--[no-]fork",
-    description: "Fork client"
+    description: "Fork #{Chef::Dist::CLIENT} process."
 
   option :recipe_url,
     long: "--recipe-url=RECIPE_URL",
@@ -237,26 +241,26 @@ class Chef::Application::Client < Chef::Application
   option :enable_reporting,
     short: "-R",
     long: "--enable-reporting",
-    description: "Enable reporting data collection for chef runs",
+    description: "Enable reporting data collection for #{Chef::Dist::PRODUCT} runs.",
     boolean: true
 
   option :local_mode,
     short: "-z",
     long: "--local-mode",
-    description: "Point chef-client at local repository",
+    description: "Point #{Chef::Dist::CLIENT} at local repository.",
     boolean: true
 
   option :chef_zero_host,
     long: "--chef-zero-host HOST",
-    description: "Host to start chef-zero on"
+    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."
+    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 :disable_config,
     long: "--disable-config",
-    description: "Refuse to load a config file and use defaults. This is for development and not a stable API",
+    description: "Refuse to load a config file and use defaults. This is for development and not a stable API.",
     boolean: true
 
   option :run_lock_timeout,
@@ -268,44 +272,43 @@ class Chef::Application::Client < Chef::Application
     option :fatal_windows_admin_check,
       short: "-A",
       long: "--fatal-windows-admin-check",
-      description: "Fail the run when chef-client doesn't have administrator privileges on Windows",
+      description: "Fail the run when #{Chef::Dist::CLIENT} doesn't have administrator privileges on Windows.",
       boolean: true
   end
 
-  option :audit_mode,
-    long: "--audit-mode MODE",
-    description: "Enable audit-mode with `enabled`. Disable audit-mode with `disabled`. Skip converge and only perform audits with `audit-only`",
-    proc: lambda { |mo| mo.tr("-", "_").to_sym }
-
   option :minimal_ohai,
     long: "--minimal-ohai",
-    description: "Only run the bare minimum ohai plugins chef needs to function",
+    description: "Only run the bare minimum Ohai plugins #{Chef::Dist::PRODUCT} needs to function.",
     boolean: true
 
   option :listen,
     long: "--[no-]listen",
-    description: "Whether a local mode (-z) server binds to a port",
+    description: "Whether a local mode (-z) server binds to a port.",
     boolean: false
 
   option :fips,
     long: "--[no-]fips",
-    description: "Enable fips mode",
+    description: "Enable FIPS mode.",
     boolean: true
 
   option :delete_entire_chef_repo,
     long: "--delete-entire-chef-repo",
-    description: "DANGEROUS: does what it says, only useful with --recipe-url",
+    description: "DANGEROUS: does what it says, only useful with --recipe-url.",
     boolean: true
 
   option :skip_cookbook_sync,
     long: "--[no-]skip-cookbook-sync",
-    description: "Use cached cookbooks without overwriting local differences from the server",
+    description: "Use cached cookbooks without overwriting local differences from the #{Chef::Dist::SERVER_PRODUCT}.",
     boolean: false
 
-  option :chef_license,
-    long: "--chef-license ACCEPTANCE",
-    description: "Placeholder option for Chef license acceptance to provide compatibility with Chef Infra 15+ command line options.",
-    required: false
+  option :target,
+    short: "-t TARGET",
+    long: "--target TARGET",
+    description: "Target #{Chef::Dist::PRODUCT} against a remote system or device",
+    proc: lambda { |target|
+      Chef::Log.warn "-- EXPERIMENTAL -- Target mode activated, resources and dsl may change without warning -- EXPERIMENTAL --"
+      target
+    }
 
   IMMEDIATE_RUN_SIGNAL = "1".freeze
   RECONFIGURE_SIGNAL = "H".freeze
@@ -338,11 +341,11 @@ class Chef::Application::Client < Chef::Application
 
     if Chef::Config[:recipe_url]
       if !Chef::Config.local_mode
-        Chef::Application.fatal!("chef-client recipe-url can be used only in local-mode")
+        Chef::Application.fatal!("recipe-url can be used only in local-mode")
       else
         if Chef::Config[:delete_entire_chef_repo]
           Chef::Log.trace "Cleanup path #{Chef::Config.chef_repo_path} before extract recipes into it"
-          FileUtils.rm_rf(recipes_path, secure: true)
+          FileUtils.rm_rf(Chef::Config.chef_repo_path, secure: true)
         end
         Chef::Log.trace "Creating path #{Chef::Config.chef_repo_path} to extract recipes into"
         FileUtils.mkdir_p(Chef::Config.chef_repo_path)
@@ -357,6 +360,12 @@ class Chef::Application::Client < Chef::Application
     Chef::Config.chef_zero.host = config[:chef_zero_host] if config[:chef_zero_host]
     Chef::Config.chef_zero.port = config[:chef_zero_port] if config[:chef_zero_port]
 
+    if config[:target] || Chef::Config.target
+      Chef::Config.target_mode.enabled = true
+      Chef::Config.target_mode.host = config[:target] || Chef::Config.target
+      Chef::Config.node_name = Chef::Config.target_mode.host unless Chef::Config.node_name
+    end
+
     if Chef::Config[:daemonize]
       Chef::Config[:interval] ||= 1800
     end
@@ -379,17 +388,6 @@ class Chef::Application::Client < Chef::Application
       config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
       @chef_client_json = config_fetcher.fetch_json
     end
-
-    if mode = config[:audit_mode] || Chef::Config[:audit_mode]
-      if [:enabled, :audit_only].include?(mode)
-        Chef.deprecated(:audit_mode, "Chef's Audit mode has been deprecated and will be removed in Chef 15 (April 2019). Consider migrating to InSpec as a replacement for this functionality.")
-      end
-
-      expected_modes = [:enabled, :disabled, :audit_only]
-      unless expected_modes.include?(mode)
-        Chef::Application.fatal!(unrecognized_audit_mode(mode))
-      end
-    end
   end
 
   def load_config_file
@@ -440,7 +438,7 @@ class Chef::Application::Client < Chef::Application
   # Run the chef client, optionally daemonizing or looping at intervals.
   def run_application
     if Chef::Config[:version]
-      puts "Chef version: #{::Chef::VERSION}"
+      puts "#{Chef::Dist::PRODUCT} version: #{::Chef::VERSION}"
     end
 
     if !Chef::Config[:client_fork] || Chef::Config[:once]
@@ -461,7 +459,7 @@ class Chef::Application::Client < Chef::Application
 
   def interval_run_chef_client
     if Chef::Config[:daemonize]
-      Chef::Daemon.daemonize("chef-client")
+      Chef::Daemon.daemonize(Chef::Dist::CLIENT)
 
       # Start first daemonized run after configured number of seconds
       if Chef::Config[:daemonize].is_a?(Integer)
@@ -524,21 +522,10 @@ class Chef::Application::Client < Chef::Application
   end
 
   def unforked_interval_error_message
-    "Unforked chef-client interval runs are disabled in Chef 12." +
+    "Unforked #{Chef::Dist::CLIENT} interval runs are disabled by default." +
       "\nConfiguration settings:" +
       ("\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
-
-  def audit_mode_settings_explanation
-    "\n* To enable audit mode after converge, use command line option `--audit-mode enabled` or set `audit_mode :enabled` in your config file." +
-      "\n* To disable audit mode, use command line option `--audit-mode disabled` or set `audit_mode :disabled` in your config file." +
-      "\n* To only run audit mode, use command line option `--audit-mode audit-only` or set `audit_mode :audit_only` in your config file." +
-      "\nAudit mode is disabled by default."
-  end
-
-  def unrecognized_audit_mode(mode)
-    "Unrecognized setting #{mode} for audit mode." + audit_mode_settings_explanation
+      "\nEnable #{Chef::Dist::CLIENT} interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options."
   end
 
   def fetch_recipe_tarball(url, path)

data/lib/chef/application/exit_code.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Murawski (<smurawski@chef.io>)
-# Copyright:: Copyright 2016, Chef Software, Inc.
+# Copyright:: Copyright 2016-2019, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,6 +22,7 @@ class Chef
     # These are the exit codes defined in Chef RFC 062
     # https://github.com/chef/chef-rfc/blob/master/rfc062-exit-status.md
     class ExitCode
+      require_relative "../dist"
 
       # -1 is defined as DEPRECATED_FAILURE in RFC 062, so it is
       # not enumerated in an active constant.
@@ -34,7 +35,7 @@ class Chef
         REBOOT_SCHEDULED: 35,
         REBOOT_NEEDED: 37,
         REBOOT_FAILED: 41,
-        AUDIT_MODE_FAILURE: 42,
+        # 42 was used by audit mode and should not be reused
         CLIENT_UPGRADED: 213,
       }.freeze
 
@@ -78,8 +79,6 @@ class Chef
             VALID_RFC_062_EXIT_CODES[:REBOOT_NEEDED]
           elsif reboot_failed?(exception)
             VALID_RFC_062_EXIT_CODES[:REBOOT_FAILED]
-          elsif audit_failure?(exception)
-            VALID_RFC_062_EXIT_CODES[:AUDIT_MODE_FAILURE]
           elsif client_upgraded?(exception)
             VALID_RFC_062_EXIT_CODES[:CLIENT_UPGRADED]
           else
@@ -105,12 +104,6 @@ class Chef
           end
         end
 
-        def audit_failure?(exception)
-          resolve_exception_array(exception).any? do |e|
-            e.is_a? Chef::Exceptions::AuditError
-          end
-        end
-
         def client_upgraded?(exception)
           resolve_exception_array(exception).any? do |e|
             e.is_a? Chef::Exceptions::ClientUpgraded
@@ -151,10 +144,10 @@ class Chef
         end
 
         def non_standard_exit_code_warning(exit_code)
-          "Chef attempted to exit with a non-standard exit code of #{exit_code}." \
-          " Chef RFC 062 (https://github.com/chef/chef-rfc/blob/master/rfc062-exit-status.md) defines the" \
-          " exit codes that should be used with Chef.  Chef::Application::ExitCode defines valid exit codes"  \
-          " Non-standard exit codes are redefined as GENERIC_FAILURE."
+          "#{Chef::Dist::CLIENT} attempted to exit with a non-standard exit code of #{exit_code}." \
+          " The Chef-Client Exit Codes design document (https://github.com/chef/chef-rfc/blob/master/rfc062-exit-status.md)" \
+          " defines the exit codes that should be used with Chef. Chef::Application::ExitCode defines"  \
+          " valid exit codes Non-standard exit codes are redefined as GENERIC_FAILURE."
         end
 
       end