knife 18.2.7 → 18.3.0

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

@@ -1,130 +1,130 @@
-#
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Author:: Jordan Running (<jr@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require "chef/json_compat" unless defined?(Chef::JSONCompat)
-require "chef/node" unless defined?(Chef::Node)
-
-class Chef
-  class Knife
-    class NodeEditor
-      attr_reader :node, :ui, :config
-      private :node, :ui, :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_hash(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))
-
-        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
-
-        updated_properties.any? && updated_properties
-      end
-
-      # @api private
-      def view
-        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 && 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."
-          ui.confirm "Proceed with creation of new node"
-        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
-      end
-
-      def assert_editor_set!
-        unless config[:editor]
-          abort "You must set your EDITOR environment variable or configure your editor via knife.rb"
-        end
-      end
-
-    end
-  end
-end
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Jordan Running (<jr@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef/json_compat" unless defined?(Chef::JSONCompat)
+require "chef/node" unless defined?(Chef::Node)
+
+class Chef
+  class Knife
+    class NodeEditor
+      attr_reader :node, :ui, :config
+      private :node, :ui, :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_hash(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))
+
+        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
+
+        updated_properties.any? && updated_properties
+      end
+
+      # @api private
+      def view
+        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 && 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."
+          ui.confirm "Proceed with creation of new node"
+        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
+      end
+
+      def assert_editor_set!
+        unless config[:editor]
+          abort "You must set your EDITOR environment variable or configure your editor via knife.rb"
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,133 +1,133 @@
-#
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require_relative "text_formatter"
-require_relative "generic_presenter"
-
-class Chef
-  class Knife
-    module Core
-
-      # A customized presenter for Chef::Node objects. Supports variable-length
-      # output formats for displaying node data
-      class NodePresenter < GenericPresenter
-
-        def format(data)
-          if parse_format_option == :json
-            summarize_json(data)
-          else
-            super
-          end
-        end
-
-        def summarize_json(data)
-          if data.is_a?(Chef::Node)
-            node = data
-            result = {}
-
-            result["name"] = node.name
-            if node.policy_name.nil? && node.policy_group.nil?
-              result["chef_environment"] = node.chef_environment
-            else
-              result["policy_name"] = node.policy_name
-              result["policy_group"] = node.policy_group
-            end
-            result["run_list"] = node.run_list
-            result["normal"] = node.normal_attrs
-
-            if config[:long_output]
-              result["default"]   = node.default_attrs
-              result["override"]  = node.override_attrs
-              result["automatic"] = node.automatic_attrs
-            end
-
-            Chef::JSONCompat.to_json_pretty(result)
-          else
-            Chef::JSONCompat.to_json_pretty(data)
-          end
-        end
-
-        # Converts a Chef::Node object to a string suitable for output to a
-        # terminal. If config[:medium_output] or config[:long_output] are set
-        # the volume of output is adjusted accordingly. Uses colors if enabled
-        # in the ui object.
-        def summarize(data)
-          if data.is_a?(Chef::Node)
-            node = data
-            # special case clouds with their split horizon thing.
-            ip = (node[:cloud] && node[:cloud][:public_ipv4_addrs] && node[:cloud][:public_ipv4_addrs].first) || node[:ipaddress]
-
-            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}
-              POLICY
-            else
-              summarized << <<~ENV
-                #{key("Environment:")} #{node.chef_environment}
-              ENV
-            end
-            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(", ")}
-              ROLES
-            end
-            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)}
-              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)}
-              MOST
-            end
-            summarized
-          else
-            super
-          end
-        end
-
-        def key(key_text)
-          ui.color(key_text, :cyan)
-        end
-
-      end
-    end
-  end
-end
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "text_formatter"
+require_relative "generic_presenter"
+
+class Chef
+  class Knife
+    module Core
+
+      # A customized presenter for Chef::Node objects. Supports variable-length
+      # output formats for displaying node data
+      class NodePresenter < GenericPresenter
+
+        def format(data)
+          if parse_format_option == :json
+            summarize_json(data)
+          else
+            super
+          end
+        end
+
+        def summarize_json(data)
+          if data.is_a?(Chef::Node)
+            node = data
+            result = {}
+
+            result["name"] = node.name
+            if node.policy_name.nil? && node.policy_group.nil?
+              result["chef_environment"] = node.chef_environment
+            else
+              result["policy_name"] = node.policy_name
+              result["policy_group"] = node.policy_group
+            end
+            result["run_list"] = node.run_list
+            result["normal"] = node.normal_attrs
+
+            if config[:long_output]
+              result["default"]   = node.default_attrs
+              result["override"]  = node.override_attrs
+              result["automatic"] = node.automatic_attrs
+            end
+
+            Chef::JSONCompat.to_json_pretty(result)
+          else
+            Chef::JSONCompat.to_json_pretty(data)
+          end
+        end
+
+        # Converts a Chef::Node object to a string suitable for output to a
+        # terminal. If config[:medium_output] or config[:long_output] are set
+        # the volume of output is adjusted accordingly. Uses colors if enabled
+        # in the ui object.
+        def summarize(data)
+          if data.is_a?(Chef::Node)
+            node = data
+            # special case clouds with their split horizon thing.
+            ip = (node[:cloud] && node[:cloud][:public_ipv4_addrs] && node[:cloud][:public_ipv4_addrs].first) || node[:ipaddress]
+
+            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}
+              POLICY
+            else
+              summarized << <<~ENV
+                #{key("Environment:")} #{node.chef_environment}
+              ENV
+            end
+            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(", ")}
+              ROLES
+            end
+            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)}
+              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)}
+              MOST
+            end
+            summarized
+          else
+            super
+          end
+        end
+
+        def key(key_text)
+          ui.color(key_text, :cyan)
+        end
+
+      end
+    end
+  end
+end