chef 14.15.6 → 15.0.293

data/lib/chef/application/knife.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2019, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,11 +15,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "chef/knife"
-require "chef/application"
+require_relative "../knife"
+require_relative "../application"
 require "mixlib/log"
 require "ohai/config"
 require "chef/monkey_patches/net_http.rb"
+require_relative "../dist"
 
 class Chef::Application::Knife < Chef::Application
 
@@ -30,12 +31,12 @@ class Chef::Application::Knife < Chef::Application
   option :config_file,
     short: "-c CONFIG",
     long: "--config CONFIG",
-    description: "The configuration file to use",
+    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",
+    description: "Override a single configuration option.",
     proc: lambda { |option, existing|
       (existing ||= []) << option
       existing
@@ -45,7 +46,7 @@ class Chef::Application::Knife < Chef::Application
   option :verbosity,
     short: "-V",
     long: "--verbose",
-    description: "More verbose output. Use twice for max verbosity",
+    description: "More verbose output. Use twice for max verbosity.",
     proc: Proc.new { verbosity_level += 1 },
     default: 0
 
@@ -53,104 +54,104 @@ class Chef::Application::Knife < Chef::Application
     long: "--[no-]color",
     boolean: true,
     default: true,
-    description: "Use colored output, defaults to enabled"
+    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)"
+    description: "Set the #{Chef::Dist::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",
+    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",
+    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",
+    description: "Show this help message.",
     on: :tail,
     boolean: true
 
   option :node_name,
     short: "-u USER",
     long: "--user USER",
-    description: "API Client Username"
+    description: "#{Chef::Dist::SERVER_PRODUCT} API client username."
 
   option :client_key,
     short: "-k KEY",
     long: "--key KEY",
-    description: "API Client Key",
+    description: "#{Chef::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: "Chef Server URL"
+    description: "#{Chef::Dist::SERVER_PRODUCT} URL."
 
   option :yes,
     short: "-y",
     long: "--yes",
-    description: "Say yes to all prompts for confirmation"
+    description: "Say yes to all prompts for confirmation."
 
   option :defaults,
     long: "--defaults",
-    description: "Accept default values for all questions"
+    description: "Accept default values for all questions."
 
   option :print_after,
     long: "--print-after",
-    description: "Show the data after a destructive operation"
+    description: "Show the data after a destructive operation."
 
   option :format,
     short: "-F FORMAT",
     long: "--format FORMAT",
-    description: "Which format to use for output",
+    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",
+    description: "Point knife commands at local repository instead of #{Chef::Dist::SERVER_PRODUCT}.",
     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 :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 :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 :fips,
     long: "--[no-]fips",
-    description: "Enable fips mode",
+    description: "Enable FIPS mode.",
     boolean: true,
     default: nil
 
   option :profile,
     long: "--profile PROFILE",
-    description: "The credentials profile to select"
+    description: "The credentials profile to select."
 
   # Run knife
   def run

data/lib/chef/application/solo.rb

@@ -1,7 +1,7 @@
 #
 # Author:: AJ Christensen (<aj@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");
@@ -16,19 +16,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "chef"
-require "chef/application"
-require "chef/application/client"
-require "chef/client"
-require "chef/config"
-require "chef/daemon"
-require "chef/log"
-require "chef/config_fetcher"
+require_relative "../../chef"
+require_relative "../application"
+require_relative "client"
+require_relative "../client"
+require_relative "../config"
+require_relative "../daemon"
+require_relative "../log"
+require_relative "../config_fetcher"
 require "fileutils"
-require "chef/mixin/shell_out"
+require_relative "../mixin/shell_out"
 require "pathname"
 require "chef-config/mixin/dot_d"
 require "mixlib/archive"
+require_relative "../dist"
 
 class Chef::Application::Solo < Chef::Application
   include Chef::Mixin::ShellOut
@@ -38,11 +39,11 @@ class Chef::Application::Solo < Chef::Application
     short: "-c CONFIG",
     long: "--config CONFIG",
     default: Chef::Config.platform_specific_path("/etc/chef/solo.rb"),
-    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
@@ -51,49 +52,49 @@ class Chef::Application::Solo < 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
 
   option :color,
     long: "--[no-]color",
     boolean: true,
-    default: !Chef::Platform.windows?,
-    description: "Use colored output, defaults to enabled"
+    default: true,
+    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,
@@ -102,50 +103,50 @@ class Chef::Application::Solo < 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",
       long: "--daemonize",
-      description: "Daemonize the process",
+      description: "Daemonize the process.",
       proc: lambda { |p| true }
   end
 
   option :lockfile,
     long: "--lockfile LOCKFILE",
-    description: "Set the lockfile location. Prevents multiple solo processes from converging at the same time",
+    description: "Set the lockfile location. Prevents multiple solo 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 :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 :recipe_url,
@@ -156,15 +157,15 @@ class Chef::Application::Solo < Chef::Application
   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|
@@ -175,23 +176,23 @@ class Chef::Application::Solo < Chef::Application
   option :client_fork,
     short: "-f",
     long: "--[no-]fork",
-    description: "Fork client"
+    description: "Fork #{Chef::Dist::CLIENT} process."
 
   option :why_run,
     short: "-W",
     long: "--why-run",
-    description: "Enable whyrun mode",
+    description: "Enable whyrun mode.",
     boolean: true
 
   option :ez,
     long: "--ez",
-    description: "A memorial for Ezra Zygmuntowicz",
+    description: "A memorial for Ezra Zygmuntowicz.",
     boolean: true
 
   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 :run_lock_timeout,
     long: "--run-lock-timeout SECONDS",
@@ -200,35 +201,31 @@ class Chef::Application::Solo < Chef::Application
 
   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 :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 :solo_legacy_mode,
     long: "--legacy-mode",
-    description: "Run chef-solo in legacy mode",
+    description: "Run chef-solo in legacy mode.",
     boolean: true
 
-  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
-
   attr_reader :chef_client_json
 
   # Get this party started
-  def run
+  def run(enforce_license: false)
     setup_signal_handlers
+    setup_application
     reconfigure
+    check_license_acceptance if enforce_license
     for_ezra if Chef::Config[:ez]
     if !Chef::Config[:solo_legacy_mode]
       Chef::Application::Client.new.run
     else
-      setup_application
       run_application
     end
   end
@@ -293,9 +290,6 @@ class Chef::Application::Solo < Chef::Application
       config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
       @chef_client_json = config_fetcher.fetch_json
     end
-
-    # Disable auditing for solo
-    Chef::Config[:audit_mode] = :disabled
   end
 
   def setup_application
@@ -326,12 +320,12 @@ class Chef::Application::Solo < Chef::Application
         Early contributor to Chef
         Kind hearted open source advocate
         Rest in peace, Ezra.
-EOH
+    EOH
   end
 
   def interval_run_chef_client
     if Chef::Config[:daemonize]
-      Chef::Daemon.daemonize("chef-client")
+      Chef::Daemon.daemonize("#{Chef::Dist::CLIENT}")
     end
 
     loop do
@@ -373,9 +367,9 @@ EOH
   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."
+      "\nEnable #{Chef::Dist::CLIENT} interval runs by setting `:client_fork = true` in your config file or adding `--fork` to your command line options."
   end
 end