chef 12.19.36 → 14.14.25

data/lib/chef/knife/cookbook_upload.rb

@@ -2,7 +2,7 @@
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Christopher Walters (<cw@chef.io>)
 # Author:: Nuo Yan (<yan.nuo@gmail.com>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +25,7 @@ class Chef
   class Knife
     class CookbookUpload < Knife
 
-      CHECKSUM = "checksum"
+      CHECKSUM = "checksum".freeze
       MATCH_CHECKSUM = /[0-9a-f]{32,}/
 
       deps do
@@ -37,42 +37,42 @@ class Chef
       banner "knife cookbook upload [COOKBOOKS...] (options)"
 
       option :cookbook_path,
-        :short => "-o PATH:PATH",
-        :long => "--cookbook-path PATH:PATH",
-        :description => "A colon-separated path to look for cookbooks in",
-        :proc => lambda { |o| o.split(":") }
+        short: "-o PATH:PATH",
+        long: "--cookbook-path PATH:PATH",
+        description: "A colon-separated path to look for cookbooks in.",
+        proc: lambda { |o| o.split(":") }
 
       option :freeze,
-        :long => "--freeze",
-        :description => "Freeze this version of the cookbook so that it cannot be overwritten",
-        :boolean => true
+        long: "--freeze",
+        description: "Freeze this version of the cookbook so that it cannot be overwritten.",
+        boolean: true
 
       option :all,
-        :short => "-a",
-        :long => "--all",
-        :description => "Upload all cookbooks, rather than just a single cookbook"
+        short: "-a",
+        long: "--all",
+        description: "Upload all cookbooks, rather than just a single cookbook."
 
       option :force,
-        :long => "--force",
-        :boolean => true,
-        :description => "Update cookbook versions even if they have been frozen"
+        long: "--force",
+        boolean: true,
+        description: "Update cookbook versions even if they have been frozen."
 
       option :concurrency,
-        :long => "--concurrency NUMBER_OF_THREADS",
-        :description => "How many concurrent threads will be used",
-        :default => 10,
-        :proc => lambda { |o| o.to_i }
+        long: "--concurrency NUMBER_OF_THREADS",
+        description: "How many concurrent threads will be used.",
+        default: 10,
+        proc: lambda { |o| o.to_i }
 
       option :environment,
-        :short => "-E",
-        :long  => "--environment ENVIRONMENT",
-        :description => "Set ENVIRONMENT's version dependency match the version you're uploading.",
-        :default => nil
+        short: "-E",
+        long: "--environment ENVIRONMENT",
+        description: "Set ENVIRONMENT's version dependency match the version you're uploading.",
+        default: nil
 
       option :depends,
-        :short => "-d",
-        :long => "--include-dependencies",
-        :description => "Also upload cookbook dependencies"
+        short: "-d",
+        long: "--include-dependencies",
+        description: "Also upload cookbook dependencies."
 
       def run
         # Sanity check before we load anything from the server
@@ -146,12 +146,12 @@ class Chef
           end
 
           if upload_failures == 0
-            ui.info "Uploaded #{upload_ok} cookbook#{upload_ok > 1 ? "s" : ""}."
+            ui.info "Uploaded #{upload_ok} cookbook#{upload_ok == 1 ? "" : "s"}."
           elsif upload_failures > 0 && upload_ok > 0
-            ui.warn "Uploaded #{upload_ok} cookbook#{upload_ok > 1 ? "s" : ""} ok but #{upload_failures} " +
-              "cookbook#{upload_failures > 1 ? "s" : ""} upload failed."
+            ui.warn "Uploaded #{upload_ok} cookbook#{upload_ok == 1 ? "" : "s"} ok but #{upload_failures} " +
+              "cookbook#{upload_failures == 1 ? "" : "s"} upload failed."
           elsif upload_failures > 0 && upload_ok == 0
-            ui.error "Failed to upload #{upload_failures} cookbook#{upload_failures > 1 ? "s" : ""}."
+            ui.error "Failed to upload #{upload_failures} cookbook#{upload_failures == 1 ? "" : "s"}."
             exit 1
           end
         end
@@ -169,10 +169,10 @@ class Chef
             upload_set = {}
             @name_args.each do |cookbook_name|
               begin
-                if ! upload_set.has_key?(cookbook_name)
+                if ! upload_set.key?(cookbook_name)
                   upload_set[cookbook_name] = cookbook_repo[cookbook_name]
                   if config[:depends]
-                    upload_set[cookbook_name].metadata.dependencies.each { |dep, ver| @name_args << dep }
+                    upload_set[cookbook_name].metadata.dependencies.each_key { |dep| @name_args << dep }
                   end
                 end
               rescue Exceptions::CookbookNotFoundInRepo => e
@@ -209,12 +209,12 @@ class Chef
 
         unless cookbook_repo.merged_cookbooks.empty?
           ui.warn "* " * 40
-          ui.warn(<<-WARNING)
-The cookbooks: #{cookbook_repo.merged_cookbooks.join(', ')} exist in multiple places in your cookbook_path.
-A composite version of these cookbooks has been compiled for uploading.
+          ui.warn(<<~WARNING)
+            The cookbooks: #{cookbook_repo.merged_cookbooks.join(', ')} exist in multiple places in your cookbook_path.
+            A composite version of these cookbooks has been compiled for uploading.
 
-#{ui.color('IMPORTANT:', :red, :bold)} In a future version of Chef, this behavior will be removed and you will no longer
-be able to have the same version of a cookbook in multiple places in your cookbook_path.
+            #{ui.color('IMPORTANT:', :red, :bold)} In a future version of Chef, this behavior will be removed and you will no longer
+            be able to have the same version of a cookbook in multiple places in your cookbook_path.
 WARNING
           ui.warn "The affected cookbooks are located:"
           ui.output ui.format_for_display(cookbook_repo.merged_cookbook_paths)
@@ -226,7 +226,7 @@ WARNING
 
       def assert_environment_valid!
         environment
-      rescue Net::HTTPServerException => e
+      rescue Net::HTTPClientException => e
         if e.response.code.to_s == "404"
           ui.error "The environment #{config[:environment]} does not exist on the server, aborting."
           Log.debug(e)
@@ -242,7 +242,7 @@ WARNING
           check_for_broken_links!(cb)
           check_for_dependencies!(cb)
         end
-        Chef::CookbookUploader.new(cookbooks, :force => config[:force], :concurrency => config[:concurrency]).upload_cookbooks
+        Chef::CookbookUploader.new(cookbooks, force: config[:force], concurrency: config[:concurrency]).upload_cookbooks
       rescue Chef::Exceptions::CookbookFrozen => e
         ui.error e
         raise

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

@@ -45,7 +45,7 @@ class Chef
         end
 
         def validation_key
-          if @chef_config.has_key?(:validation_key) &&
+          if @chef_config[:validation_key] &&
               File.exist?(File.expand_path(@chef_config[:validation_key]))
             IO.read(File.expand_path(@chef_config[:validation_key]))
           else
@@ -62,7 +62,7 @@ class Chef
         end
 
         # Contains commands and content, see trusted_certs_content
-        # TODO: Rename to trusted_certs_script
+        # @todo Rename to trusted_certs_script
         def trusted_certs
           @trusted_certs ||= trusted_certs_content
         end
@@ -86,9 +86,9 @@ class Chef
         end
 
         def config_content
-          client_rb = <<-CONFIG
-chef_server_url  "#{@chef_config[:chef_server_url]}"
-validation_client_name "#{@chef_config[:validation_client_name]}"
+          client_rb = <<~CONFIG
+            chef_server_url  "#{@chef_config[:chef_server_url]}"
+            validation_client_name "#{@chef_config[:validation_client_name]}"
           CONFIG
 
           if !(@chef_config[:config_log_level].nil? || @chef_config[:config_log_level].empty?)
@@ -105,14 +105,14 @@ validation_client_name "#{@chef_config[:validation_client_name]}"
 
           # We configure :verify_api_cert only when it's overridden on the CLI
           # or when specified in the knife config.
-          if !@config[:node_verify_api_cert].nil? || knife_config.has_key?(:verify_api_cert)
+          if !@config[:node_verify_api_cert].nil? || knife_config.key?(:verify_api_cert)
             value = @config[:node_verify_api_cert].nil? ? knife_config[:verify_api_cert] : @config[:node_verify_api_cert]
             client_rb << %Q{verify_api_cert #{value}\n}
           end
 
           # We configure :ssl_verify_mode only when it's overridden on the CLI
           # or when specified in the knife config.
-          if @config[:node_ssl_verify_mode] || knife_config.has_key?(:ssl_verify_mode)
+          if @config[:node_ssl_verify_mode] || knife_config.key?(:ssl_verify_mode)
             value = case @config[:node_ssl_verify_mode]
                     when "peer"
                       :verify_peer
@@ -161,13 +161,14 @@ validation_client_name "#{@chef_config[:validation_client_name]}"
           end
 
           if Chef::Config[:fips]
-            client_rb << <<-CONFIG
-fips true
-chef_version = ::Chef::VERSION.split(".")
-unless chef_version[0].to_i > 12 || (chef_version[0].to_i == 12 && chef_version[1].to_i >= 8)
-  raise "FIPS Mode requested but not supported by this client"
-end
-CONFIG
+            client_rb << <<-CONFIG.gsub(/^ {14}/, "")
+              fips true
+              require "chef/version"
+              chef_version = ::Chef::VERSION.split(".")
+              unless chef_version[0].to_i > 12 || (chef_version[0].to_i == 12 && chef_version[1].to_i >= 8)
+                raise "FIPS Mode requested but not supported by this client"
+              end
+            CONFIG
           end
 
           client_rb
@@ -177,7 +178,11 @@ CONFIG
           # 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-client"
           s = "#{client_path} -j /etc/chef/first-boot.json"
-          s << " -l debug" if @config[:verbosity] && @config[:verbosity] >= 2
+          if @config[:verbosity] && @config[:verbosity] >= 3
+            s << " -l trace"
+          elsif @config[:verbosity] && @config[:verbosity] >= 2
+            s << " -l debug"
+          end
           s << " -E #{bootstrap_environment}" unless bootstrap_environment.nil?
           s << " --no-color" unless @config[:color]
           s
@@ -222,7 +227,8 @@ CONFIG
               attributes[:run_list] = @run_list
             end
 
-            attributes.merge!(:tags => @config[:tags]) if @config[:tags] && !@config[:tags].empty?
+            attributes.delete(:run_list) if attributes[:policy_name] && !attributes[:policy_name].empty?
+            attributes.merge!(tags: @config[:tags]) if @config[:tags] && !@config[:tags].empty?
           end
         end
 
@@ -253,7 +259,7 @@ CONFIG
                   content << "mkdir #{file_on_node}\n"
                 else
                   content << "cat > #{file_on_node} <<'EOP'\n" +
-                    f.read + "\nEOP\n"
+                    f.read.gsub("'", "'\\\\''") + "\nEOP\n"
                 end
               end
             end

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

@@ -151,7 +151,7 @@ class Chef
       end
 
       def git(command)
-        shell_out!("git #{command}", :cwd => repo_path)
+        shell_out!("git #{command}", cwd: repo_path)
       end
 
     end

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

@@ -25,19 +25,19 @@ class Chef
       # Allows includer knife commands to  return multiple attributes
       # @brief knife node show NAME -a ATTR1 -a ATTR2
       module MultiAttributeReturnOption
-        # :nodoc:
+        # @private
         def self.included(includer)
           includer.class_eval do
             option :field_separator,
-              :short => "-S SEPARATOR",
-              :long => "--field-separator SEPARATOR",
-              :description => "Character separator used to delineate nesting in --attribute filters (default \".\")"
+              short: "-S SEPARATOR",
+              long: "--field-separator SEPARATOR",
+              description: "Character separator used to delineate nesting in --attribute filters (default \".\")"
 
             option :attribute,
-              :short => "-a ATTR1 [-a ATTR2]",
-              :long => "--attribute ATTR1 [--attribute ATTR2] ",
-              :description => "Show one or more attributes",
-              :proc => Proc.new { |a|
+              short: "-a ATTR1 [-a ATTR2]",
+              long: "--attribute ATTR1 [--attribute ATTR2] ",
+              description: "Show one or more attributes",
+              proc: Proc.new { |a|
                 Chef::Config[:knife][:attribute] ||= []
                 Chef::Config[:knife][:attribute].push(a)
               }
@@ -45,7 +45,6 @@ class Chef
         end
       end
 
-      #==Chef::Knife::Core::GenericPresenter
       # The base presenter class for displaying structured data in knife commands.
       # This is not an abstract base class, and it is suitable for displaying
       # most kinds of objects that knife needs to display.

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

@@ -24,7 +24,7 @@ class Chef
       # for the given command.
       #
       class HashedCommandLoader < Chef::Knife::SubcommandLoader
-        KEY = "_autogenerated_command_paths"
+        KEY = "_autogenerated_command_paths".freeze
 
         attr_accessor :manifest
         def initialize(chef_config_dir, plugin_manifest)
@@ -60,7 +60,7 @@ class Chef
           if errors.empty?
             commands
           else
-            Chef::Log.error "There are files specified in the manifest that are missing. Please rehash to update the subcommands cache. If you see this error after rehashing delete the cache at #{Chef::Knife::SubcommandLoader.plugin_manifest_path}"
+            Chef::Log.error "There are plugin files specified in the knife cache that cannot be found. Please run knife rehash to update the subcommands cache. If you see this error after rehashing delete the cache at #{Chef::Knife::SubcommandLoader.plugin_manifest_path}"
             Chef::Log.error "Missing files:\n\t#{errors.values.flatten.join("\n\t")}"
             {}
           end

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

@@ -26,29 +26,28 @@ class Chef
       # This module may be included into a knife subcommand class to automatically
       # add configuration options used by the NodePresenter
       module NodeFormattingOptions
-        # :nodoc:
+        # @private
         # Would prefer to do this in a rational way, but can't be done b/c of
         # Mixlib::CLI's design :(
         def self.included(includer)
           includer.class_eval do
             option :medium_output,
-              :short   => "-m",
-              :long    => "--medium",
-              :boolean => true,
-              :default => false,
-              :description => "Include normal attributes in the output"
+              short: "-m",
+              long: "--medium",
+              boolean: true,
+              default: false,
+              description: "Include normal attributes in the output"
 
             option :long_output,
-              :short   => "-l",
-              :long    => "--long",
-              :boolean => true,
-              :default => false,
-              :description => "Include all attributes in the output"
+              short: "-l",
+              long: "--long",
+              boolean: true,
+              default: false,
+              description: "Include all attributes in the output"
           end
         end
       end
 
-      #==Chef::Knife::Core::NodePresenter
       # A customized presenter for Chef::Node objects. Supports variable-length
       # output formats for displaying node data
       class NodePresenter < GenericPresenter
@@ -98,49 +97,49 @@ class Chef
             # special case ec2 with their split horizon whatsis.
             ip = (node[:ec2] && node[:ec2][:public_ipv4]) || node[:ipaddress]
 
-            summarized = <<-SUMMARY
-#{ui.color('Node Name:', :bold)}   #{ui.color(node.name, :bold)}
+            summarized = <<~SUMMARY
+              #{ui.color('Node Name:', :bold)}   #{ui.color(node.name, :bold)}
 SUMMARY
             show_policy = !(node.policy_name.nil? && node.policy_group.nil?)
             if show_policy
-              summarized << <<-POLICY
-#{key('Policy Name:')}  #{node.policy_name}
-#{key('Policy Group:')} #{node.policy_group}
+              summarized << <<~POLICY
+                #{key('Policy Name:')}  #{node.policy_name}
+                #{key('Policy Group:')} #{node.policy_group}
 POLICY
             else
-              summarized << <<-ENV
-#{key('Environment:')} #{node.chef_environment}
+              summarized << <<~ENV
+                #{key('Environment:')} #{node.chef_environment}
 ENV
             end
-            summarized << <<-SUMMARY
-#{key('FQDN:')}        #{node[:fqdn]}
-#{key('IP:')}          #{ip}
-#{key('Run List:')}    #{node.run_list}
+            summarized << <<~SUMMARY
+              #{key('FQDN:')}        #{node[:fqdn]}
+              #{key('IP:')}          #{ip}
+              #{key('Run List:')}    #{node.run_list}
 SUMMARY
             unless show_policy
-              summarized << <<-ROLES
-#{key('Roles:')}       #{Array(node[:roles]).join(', ')}
+              summarized << <<~ROLES
+                #{key('Roles:')}       #{Array(node[:roles]).join(', ')}
 ROLES
             end
-            summarized << <<-SUMMARY
-#{key('Recipes:')}     #{Array(node[:recipes]).join(', ')}
-#{key('Platform:')}    #{node[:platform]} #{node[:platform_version]}
-#{key('Tags:')}        #{node.tags.join(', ')}
+            summarized << <<~SUMMARY
+              #{key('Recipes:')}     #{Array(node[:recipes]).join(', ')}
+              #{key('Platform:')}    #{node[:platform]} #{node[:platform_version]}
+              #{key('Tags:')}        #{node.tags.join(', ')}
 SUMMARY
             if config[:medium_output] || config[:long_output]
-              summarized += <<-MORE
-#{key('Attributes:')}
-#{text_format(node.normal_attrs)}
+              summarized += <<~MORE
+                #{key('Attributes:')}
+                #{text_format(node.normal_attrs)}
 MORE
             end
             if config[:long_output]
-              summarized += <<-MOST
-#{key('Default Attributes:')}
-#{text_format(node.default_attrs)}
-#{key('Override Attributes:')}
-#{text_format(node.override_attrs)}
-#{key('Automatic Attributes (Ohai Data):')}
-#{text_format(node.automatic_attrs)}
+              summarized += <<~MOST
+                #{key('Default Attributes:')}
+                #{text_format(node.default_attrs)}
+                #{key('Override Attributes:')}
+                #{text_format(node.override_attrs)}
+                #{key('Automatic Attributes (Ohai Data):')}
+                #{text_format(node.automatic_attrs)}
 MOST
             end
             summarized

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

@@ -26,29 +26,28 @@ class Chef
       # This module may be included into a knife subcommand class to automatically
       # add configuration options used by the StatusPresenter
       module StatusFormattingOptions
-        # :nodoc:
+        # @private
         # Would prefer to do this in a rational way, but can't be done b/c of
         # Mixlib::CLI's design :(
         def self.included(includer)
           includer.class_eval do
             option :medium_output,
-              :short   => "-m",
-              :long    => "--medium",
-              :boolean => true,
-              :default => false,
-              :description => "Include normal attributes in the output"
+              short: "-m",
+              long: "--medium",
+              boolean: true,
+              default: false,
+              description: "Include normal attributes in the output"
 
             option :long_output,
-              :short   => "-l",
-              :long    => "--long",
-              :boolean => true,
-              :default => false,
-              :description => "Include all attributes in the output"
+              short: "-l",
+              long: "--long",
+              boolean: true,
+              default: false,
+              description: "Include all attributes in the output"
           end
         end
       end
 
-      #==Chef::Knife::Core::StatusPresenter
       # A customized presenter for Chef::Node objects. Supports variable-length
       # output formats for displaying node data
       class StatusPresenter < GenericPresenter
@@ -101,29 +100,45 @@ class Chef
             fqdn = (node[:ec2] && node[:ec2][:public_hostname]) || node[:fqdn]
             name = node["name"] || node.name
 
-            hours, minutes, = time_difference_in_hms(node["ohai_time"])
-            hours_text   = "#{hours} hour#{hours == 1 ? ' ' : 's'}"
-            minutes_text = "#{minutes} minute#{minutes == 1 ? ' ' : 's'}"
-            run_list = "#{node['run_list']}" if config[:run_list]
-            if hours > 24
-              color = :red
-              text = hours_text
-            elsif hours >= 1
-              color = :yellow
-              text = hours_text
-            else
-              color = :green
-              text = minutes_text
+            if config[:run_list]
+              if config[:long_output]
+                run_list = node.run_list.map { |rl| "#{rl.type}[#{rl.name}]" }
+              else
+                run_list = node["run_list"]
+              end
             end
 
             line_parts = Array.new
-            line_parts << @ui.color(text, color) + " ago" << name
+
+            if node["ohai_time"]
+              hours, minutes, seconds = time_difference_in_hms(node["ohai_time"])
+              hours_text   = "#{hours} hour#{hours == 1 ? ' ' : 's'}"
+              minutes_text = "#{minutes} minute#{minutes == 1 ? ' ' : 's'}"
+              seconds_text = "#{seconds} second#{seconds == 1 ? ' ' : 's'}"
+              if hours > 24
+                color = :red
+                text = hours_text
+              elsif hours >= 1
+                color = :yellow
+                text = hours_text
+              elsif minutes >= 1
+                color = :green
+                text = minutes_text
+              else
+                color = :green
+                text = seconds_text
+              end
+              line_parts << @ui.color(text, color) + " ago" << name
+            else
+              line_parts << "Node #{name} has not yet converged"
+            end
+
             line_parts << fqdn if fqdn
             line_parts << ip if ip
-            line_parts << run_list if run_list
+            line_parts << run_list.to_s if run_list
 
             if node["platform"]
-              platform = node["platform"]
+              platform = node["platform"].dup
               if node["platform_version"]
                 platform << " #{node['platform_version']}"
               end
@@ -139,8 +154,8 @@ class Chef
           ui.color(key_text, :cyan)
         end
 
-        # :nodoc:
-        # TODO: this is duplicated from StatusHelper in the Webui. dedup.
+        # @private
+        # @todo this is duplicated from StatusHelper in the Webui. dedup.
         def time_difference_in_hms(unix_time)
           now = Time.now.to_i
           difference = now - unix_time.to_i