chef 12.6.0 → 12.7.2

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

@@ -1,6 +1,6 @@
-# Author:: Christopher Brown (<cb@opscode.com>)
-# Author:: Daniel DeLeo (<dan@opscode.com>)
-# Copyright:: Copyright (c) 2009-2015 Chef Software, Inc
+# Author:: Christopher Brown (<cb@chef.io>)
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2009-2016, Chef Software, Inc
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require 'chef/version'
-require 'chef/util/path_helper'
+require "chef/version"
+require "chef/util/path_helper"
 class Chef
   class Knife
     class SubcommandLoader
@@ -39,7 +39,7 @@ class Chef
         # subcommand loader has been modified to load the plugins by using Kernel.load
         # with the absolute path.
         def gem_and_builtin_subcommands
-          require 'rubygems'
+          require "rubygems"
           find_subcommands_via_rubygems
         rescue LoadError
           find_subcommands_via_dirglob
@@ -47,17 +47,17 @@ class Chef
 
         def find_subcommands_via_dirglob
           # The "require paths" of the core knife subcommands bundled with chef
-          files = Dir[File.join(Chef::Util::PathHelper.escape_glob(File.expand_path('../../../knife', __FILE__)), '*.rb')]
+          files = Dir[File.join(Chef::Util::PathHelper.escape_glob(File.expand_path("../../../knife", __FILE__)), "*.rb")]
           subcommand_files = {}
           files.each do |knife_file|
-            rel_path = knife_file[/#{CHEF_ROOT}#{Regexp.escape(File::SEPARATOR)}(.*)\.rb/,1]
+            rel_path = knife_file[/#{CHEF_ROOT}#{Regexp.escape(File::SEPARATOR)}(.*)\.rb/, 1]
             subcommand_files[rel_path] = knife_file
           end
           subcommand_files
         end
 
         def find_subcommands_via_rubygems
-          files = find_files_latest_gems 'chef/knife/*.rb'
+          files = find_files_latest_gems "chef/knife/*.rb"
           subcommand_files = {}
           files.each do |file|
             rel_path = file[/(#{Regexp.escape File.join('chef', 'knife', '')}.*)\.rb/, 1]
@@ -77,7 +77,7 @@ class Chef
 
         private
 
-        def find_files_latest_gems(glob, check_load_path=true)
+        def find_files_latest_gems(glob, check_load_path = true)
           files = []
 
           if check_load_path
@@ -103,7 +103,7 @@ class Chef
 
         def latest_gem_specs
           @latest_gem_specs ||= if Gem::Specification.respond_to? :latest_specs
-                                  Gem::Specification.latest_specs(true)  # find prerelease gems
+                                  Gem::Specification.latest_specs(true) # find prerelease gems
                                 else
                                   Gem.source_index.latest_specs(true)
                                 end

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

@@ -1,6 +1,6 @@
 #--
-# Author:: Daniel DeLeo (<dan@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, Inc.
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2011-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,7 +16,7 @@
 # limitations under the License.
 #
 
-require 'chef/knife/core/text_formatter'
+require "chef/knife/core/text_formatter"
 
 class Chef
   class Knife
@@ -32,7 +32,7 @@ class Chef
             option :attribute,
               :short => "-a ATTR1 [-a ATTR2]",
               :long => "--attribute ATTR1 [--attribute ATTR2] ",
-              :proc => lambda {|val| @attrs_to_show << val},
+              :proc => lambda { |val| @attrs_to_show << val },
               :description => "Show one or more attributes"
           end
         end
@@ -80,10 +80,10 @@ class Chef
           when :json
             Chef::JSONCompat.to_json_pretty(data)
           when :yaml
-            require 'yaml'
+            require "yaml"
             YAML::dump(data)
           when :pp
-            require 'stringio'
+            require "stringio"
             # If you were looking for some attribute and there is only one match
             # just dump the attribute value
             if config[:attribute] and data.length == 1
@@ -133,7 +133,7 @@ class Chef
         end
 
         def format_list_for_display(list)
-          config[:with_uri] ? list : list.keys.sort { |a,b| a <=> b }
+          config[:with_uri] ? list : list.keys.sort { |a, b| a <=> b }
         end
 
         def format_for_display(data)
@@ -142,7 +142,7 @@ class Chef
           elsif config[:id_only]
             name_or_id_for(data)
           elsif config[:environment] && data.respond_to?(:chef_environment)
-            {"chef_environment" => data.chef_environment}
+            { "chef_environment" => data.chef_environment }
           else
             data
           end
@@ -150,19 +150,19 @@ class Chef
 
         def format_data_subset_for_display(data)
           subset = if config[:attribute]
-            result = {}
-            Array(config[:attribute]).each do |nested_value_spec|
-              nested_value = extract_nested_value(data, nested_value_spec)
-              result[nested_value_spec] = nested_value
-            end
-            result
-          elsif config[:run_list]
-            run_list = data.run_list.run_list
-            { "run_list" => run_list }
-          else
-            raise ArgumentError, "format_data_subset_for_display requires attribute, run_list, or id_only config option to be set"
-          end
-          {name_or_id_for(data) => subset }
+                     result = {}
+                     Array(config[:attribute]).each do |nested_value_spec|
+                       nested_value = extract_nested_value(data, nested_value_spec)
+                       result[nested_value_spec] = nested_value
+                     end
+                     result
+                   elsif config[:run_list]
+                     run_list = data.run_list.run_list
+                     { "run_list" => run_list }
+                   else
+                     raise ArgumentError, "format_data_subset_for_display requires attribute, run_list, or id_only config option to be set"
+                   end
+          { name_or_id_for(data) => subset }
         end
 
         def name_or_id_for(data)
@@ -173,24 +173,23 @@ class Chef
           config[:attribute] || config[:run_list]
         end
 
-
         def extract_nested_value(data, nested_value_spec)
           nested_value_spec.split(".").each do |attr|
             if data.nil?
               nil # don't get no method error on nil
-            # Must check :[] before attr because spec can include
-            #   `keys` - want the key named `keys`, not a list of
-            #   available keys.
-            elsif data.respond_to?(:[])  && data.has_key?(attr)
+              # Must check :[] before attr because spec can include
+              #   `keys` - want the key named `keys`, not a list of
+              #   available keys.
+            elsif data.respond_to?(:[]) && data.has_key?(attr)
               data = data[attr]
             elsif data.respond_to?(attr.to_sym)
               data = data.send(attr.to_sym)
             else
               data = begin
-                data.send(attr.to_sym)
-              rescue NoMethodError
-                nil
-              end
+                       data.send(attr.to_sym)
+                     rescue NoMethodError
+                       nil
+                     end
             end
           end
           ( !data.kind_of?(Array) && data.respond_to?(:to_hash) ) ? data.to_hash : data
@@ -200,17 +199,17 @@ class Chef
           if config[:with_uri]
             item.inject({}) do |collected, (cookbook, versions)|
               collected[cookbook] = Hash.new
-              versions['versions'].each do |ver|
-                collected[cookbook][ver['version']] = ver['url']
+              versions["versions"].each do |ver|
+                collected[cookbook][ver["version"]] = ver["url"]
               end
               collected
             end
           else
             versions_by_cookbook = item.inject({}) do |collected, ( cookbook, versions )|
-              collected[cookbook] = versions["versions"].map {|v| v['version']}
+              collected[cookbook] = versions["versions"].map { |v| v["version"] }
               collected
             end
-            key_length = versions_by_cookbook.empty? ? 0 : versions_by_cookbook.keys.map {|name| name.size }.max + 2
+            key_length = versions_by_cookbook.empty? ? 0 : versions_by_cookbook.keys.map { |name| name.size }.max + 2
             versions_by_cookbook.sort.map do |cookbook, versions|
               "#{cookbook.ljust(key_length)} #{versions.join('  ')}"
             end

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

@@ -1,5 +1,5 @@
 # Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc
+# Copyright:: Copyright 2015-2016, Chef Software, Inc
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require 'chef/version'
+require "chef/version"
 class Chef
   class Knife
     class SubcommandLoader
@@ -24,7 +24,7 @@ class Chef
       # for the given command.
       #
       class HashedCommandLoader < Chef::Knife::SubcommandLoader
-        KEY = '_autogenerated_command_paths'
+        KEY = "_autogenerated_command_paths"
 
         attr_accessor :manifest
         def initialize(chef_config_dir, plugin_manifest)
@@ -34,11 +34,11 @@ class Chef
 
         def guess_category(args)
           category_words = positional_arguments(args)
-          category_words.map! { |w| w.split('-') }.flatten!
-          find_longest_key(manifest[KEY]["plugins_by_category"], category_words, ' ')
+          category_words.map! { |w| w.split("-") }.flatten!
+          find_longest_key(manifest[KEY]["plugins_by_category"], category_words, " ")
         end
 
-        def list_commands(pref_category=nil)
+        def list_commands(pref_category = nil)
           if pref_category || manifest[KEY]["plugins_by_category"].key?(pref_category)
             { pref_category => manifest[KEY]["plugins_by_category"][pref_category] }
           else

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

@@ -1,6 +1,7 @@
 #
-# Author:: Daniel DeLeo (<dan@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, Inc.
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Jordan Running (<jr@chef.io>)
+# Copyright:: Copyright 2011-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,83 +17,103 @@
 # limitations under the License.
 #
 
-require 'chef/json_compat'
-require 'chef/node'
-require 'tempfile'
+require "chef/json_compat"
+require "chef/node"
 
 class Chef
   class Knife
     class NodeEditor
+      attr_reader :node, :ui, :config
+      private :node, :ui, :config
 
-      attr_reader :node
-      attr_reader :ui
-      attr_reader :config
-
+      # @param node [Chef::Node]
+      # @param ui [Chef::Knife::UI]
+      # @param config [Hash]
       def initialize(node, ui, config)
         @node, @ui, @config = node, ui, config
       end
 
+      # Opens the node data (as JSON) in the user's editor and returns a new
+      # {Chef::Node} reflecting the user's changes.
+      #
+      # @return [Chef::Node]
       def edit_node
         abort "You specified the --disable_editing option, nothing to edit" if config[:disable_editing]
         assert_editor_set!
 
-        updated_node_data = @ui.edit_data(view)
+        updated_node_data = ui.edit_data(view)
         apply_updates(updated_node_data)
         @updated_node
       end
 
+      # Returns an array of the names of properties that have been changed or
+      # +false+ if none were changed.
+      #
+      # @return [Array<String>] if any properties have been changed.
+      # @return [false] if no properties have been changed.
       def updated?
+        return false if @updated_node.nil?
+
         pristine_copy = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(node))
         updated_copy  = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(@updated_node))
-        unless pristine_copy == updated_copy
-          updated_properties = %w{name normal chef_environment run_list default override automatic}.reject do |key|
-             pristine_copy[key] == updated_copy[key]
-          end
+
+        updated_properties = %w{
+          name
+          chef_environment
+          automatic
+          default
+          normal
+          override
+          policy_name
+          policy_group
+          run_list
+        }.reject do |key|
+          pristine_copy[key] == updated_copy[key]
         end
-        ( pristine_copy != updated_copy ) && updated_properties
-      end
 
-      private
+        updated_properties.any? && updated_properties
+      end
 
+      # @api private
       def view
-        result = {}
-        result["name"] = node.name
-        result["chef_environment"] = node.chef_environment
-        result["normal"] = node.normal_attrs
-        result["run_list"] = node.run_list
+        result = {
+          "name" => node.name,
+          "chef_environment" => node.chef_environment,
+          "normal" => node.normal_attrs,
+          "policy_name" => node.policy_name,
+          "policy_group" => node.policy_group,
+          "run_list" => node.run_list,
+        }
 
         if config[:all_attributes]
           result["default"]   = node.default_attrs
           result["override"]  = node.override_attrs
           result["automatic"] = node.automatic_attrs
         end
+
         result
       end
 
+      # @api private
       def apply_updates(updated_data)
         if node.name and node.name != updated_data["name"]
           ui.warn "Changing the name of a node results in a new node being created, #{node.name} will not be modified or removed."
-          confirm = ui.confirm "Proceed with creation of new node"
+          ui.confirm "Proceed with creation of new node"
         end
 
-        @updated_node = Node.new.tap do |n|
-          n.name( updated_data["name"] )
-          n.chef_environment( updated_data["chef_environment"] )
-          n.run_list( updated_data["run_list"])
-          n.normal_attrs = updated_data["normal"]
-
-          if config[:all_attributes]
-            n.default_attrs   = updated_data["default"]
-            n.override_attrs  = updated_data["override"]
-            n.automatic_attrs = updated_data["automatic"]
-          else
-            n.default_attrs   = node.default_attrs
-            n.override_attrs  = node.override_attrs
-            n.automatic_attrs = node.automatic_attrs
-          end
+        data = updated_data.dup
+
+        unless config[:all_attributes]
+          data["automatic"] = node.automatic_attrs
+          data["default"] = node.default_attrs
+          data["override"] = node.override_attrs
         end
+
+        @updated_node = Node.from_hash(data)
       end
 
+      private
+
       def abort(message)
         ui.error(message)
         exit 1

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

@@ -1,6 +1,6 @@
 #
-# Author:: Daniel DeLeo (<dan@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, Inc.
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright 2011-2016, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +16,8 @@
 # limitations under the License.
 #
 
-require 'chef/knife/core/text_formatter'
-require 'chef/knife/core/generic_presenter'
+require "chef/knife/core/text_formatter"
+require "chef/knife/core/generic_presenter"
 
 class Chef
   class Knife
@@ -32,18 +32,18 @@ class Chef
         def self.included(includer)
           includer.class_eval do
             option :medium_output,
-              :short   => '-m',
-              :long    => '--medium',
+              :short   => "-m",
+              :long    => "--medium",
               :boolean => true,
               :default => false,
-              :description => 'Include normal attributes in the output'
+              :description => "Include normal attributes in the output"
 
             option :long_output,
-              :short   => '-l',
-              :long    => '--long',
+              :short   => "-l",
+              :long    => "--long",
               :boolean => true,
               :default => false,
-              :description => 'Include all attributes in the output'
+              :description => "Include all attributes in the output"
           end
         end
       end
@@ -98,7 +98,7 @@ class Chef
             # special case ec2 with their split horizon whatsis.
             ip = (node[:ec2] && node[:ec2][:public_ipv4]) || node[:ipaddress]
 
-            summarized=<<-SUMMARY
+            summarized = <<-SUMMARY
 #{ui.color('Node Name:', :bold)}   #{ui.color(node.name, :bold)}
 SUMMARY
             show_policy = !(node.policy_name.nil? && node.policy_group.nil?)
@@ -128,13 +128,13 @@ ROLES
 #{key('Tags:')}        #{node.tags.join(', ')}
 SUMMARY
             if config[:medium_output] || config[:long_output]
-              summarized +=<<-MORE
+              summarized += <<-MORE
 #{key('Attributes:')}
 #{text_format(node.normal_attrs)}
 MORE
             end
             if config[:long_output]
-              summarized +=<<-MOST
+              summarized += <<-MOST
 #{key('Default Attributes:')}
 #{text_format(node.default_attrs)}
 #{key('Override Attributes:')}
@@ -157,4 +157,3 @@ MOST
     end
   end
 end
-