tylerrick-chef 0.10.8

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

@@ -0,0 +1,136 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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/knife/core/text_formatter'
+require 'chef/knife/core/generic_presenter'
+
+class Chef
+  class Knife
+    module Core
+
+      # This module may be included into a knife subcommand class to automatically
+      # add configuration options used by the NodePresenter
+      module NodeFormattingOptions
+        # :nodoc:
+        # 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'
+
+            option :long_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
+
+        def format(data)
+          if parse_format_option == :json
+            summarize_json(data)
+          else
+            super
+          end
+        end
+
+        def summarize_json(data)
+          if data.kind_of?(Chef::Node)
+            node = data
+            result = {}
+
+            result["name"] = node.name
+            result["chef_environment"] = node.chef_environment
+            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 the ui object.
+        def summarize(data)
+          if data.kind_of?(Chef::Node)
+            node = data
+            # 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)}
+#{key('Environment:')} #{node.chef_environment}
+#{key('FQDN:')}        #{node[:fqdn]}
+#{key('IP:')}          #{ip}
+#{key('Run List:')}    #{node.run_list}
+#{key('Roles:')}       #{Array(node[:roles]).join(', ')}
+#{key('Recipes:')}     #{Array(node[:recipes]).join(', ')}
+#{key('Platform:')}    #{node[:platform]} #{node[:platform_version]}
+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
+

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

@@ -0,0 +1,75 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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.
+#
+
+class Chef
+  class Knife
+    module Core
+      class ObjectLoader
+
+        attr_reader :ui
+        attr_reader :klass
+
+        def initialize(klass, ui)
+          @klass = klass
+          @ui = ui
+        end
+
+        def load_from(repo_location, *components)
+          unless object_file = find_file(repo_location, *components)
+            ui.error "Could not find or open file for #{components.join(' ')}"
+            exit 1
+          end
+          object_from_file(object_file)
+        end
+
+        def find_file(repo_location, *components)
+          if file_exists_and_is_readable?(File.expand_path( components.last ))
+            File.expand_path( components.last )
+          else
+            relative_path = File.join(Dir.pwd, repo_location, *components)
+            if file_exists_and_is_readable?(relative_path)
+              relative_path
+            else
+              nil
+            end
+          end
+        end
+
+        def object_from_file(filename)
+          case filename
+          when /\.(js|json)$/
+            Chef::JSONCompat.from_json(IO.read(filename))
+          when /\.rb$/
+            r = klass.new
+            r.from_file(filename)
+            r
+          else
+            ui.fatal("File must end in .js, .json, or .rb")
+            exit 30
+          end
+        end
+
+        def file_exists_and_is_readable?(file)
+          File.exists?(file) && File.readable?(file)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,112 @@
+# Author:: Christopher Brown (<cb@opscode.com>)
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2009, 2011 Opscode, 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/version'
+class Chef
+  class Knife
+    class SubcommandLoader
+
+      CHEF_FILE_IN_GEM = /chef-[\d]+\.[\d]+\.[\d]+/
+      CURRENT_CHEF_GEM = /chef-#{Regexp.escape(Chef::VERSION)}/
+
+      attr_reader :chef_config_dir
+      attr_reader :env
+
+      def initialize(chef_config_dir, env=ENV)
+        @chef_config_dir, @env = chef_config_dir, env
+        @forced_activate = {}
+      end
+
+      # Load all the sub-commands
+      def load_commands
+        subcommand_files.each { |subcommand| Kernel.load subcommand }
+        true
+      end
+
+      # Returns an Array of paths to knife commands located in chef_config_dir/plugins/knife/
+      # and ~/.chef/plugins/knife/
+      def site_subcommands
+        user_specific_files = []
+
+        if chef_config_dir
+          user_specific_files.concat Dir.glob(File.expand_path("plugins/knife/*.rb", chef_config_dir))
+        end
+
+        # finally search ~/.chef/plugins/knife/*.rb
+        user_specific_files.concat Dir.glob(File.join(env['HOME'], '.chef', 'plugins', 'knife', '*.rb'))
+
+        user_specific_files
+      end
+
+      # Returns a Hash of paths to knife commands built-in to chef, or installed via gem.
+      # If rubygems is not installed, falls back to globbing the knife directory.
+      # The Hash is of the form {"relative/path" => "/absolute/path"}
+      #--
+      # Note: the "right" way to load the plugins is to require the relative path, i.e.,
+      #   require 'chef/knife/command'
+      # but we're getting frustrated by bugs at every turn, and it's slow besides. So
+      # subcommand loader has been modified to load the plugins by using Kernel.load
+      # with the absolute path.
+      def gem_and_builtin_subcommands
+        # search all gems for chef/knife/*.rb
+        require 'rubygems'
+        find_subcommands_via_rubygems
+      rescue LoadError
+        find_subcommands_via_dirglob
+      end
+
+      def subcommand_files
+        @subcommand_files ||= (gem_and_builtin_subcommands.values + site_subcommands).flatten.uniq
+      end
+
+      def find_subcommands_via_dirglob
+        # The "require paths" of the core knife subcommands bundled with chef
+        files = Dir[File.expand_path('../../../knife/*.rb', __FILE__)]
+        subcommand_files = {}
+        files.each do |knife_file|
+          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 = Gem.find_files 'chef/knife/*.rb'
+        files.reject! {|f| from_old_gem?(f) }
+        subcommand_files = {}
+        files.each do |file|
+          rel_path = file[/(#{Regexp.escape File.join('chef', 'knife', '')}.*)\.rb/, 1]
+          subcommand_files[rel_path] = file
+        end
+
+        subcommand_files.merge(find_subcommands_via_dirglob)
+      end
+
+      private
+
+      # wow, this is a sad hack :(
+      # Gem.find_files finds files in all versions of a gem, which
+      # means that if chef 0.10 and 0.9.x are installed, we'll try to
+      # require, e.g., chef/knife/ec2_server_create, which will cause
+      # a gem activation error. So remove files from older chef gems.
+      def from_old_gem?(path)
+        path =~ CHEF_FILE_IN_GEM && path !~ CURRENT_CHEF_GEM
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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.
+#
+
+class Chef
+  class Knife
+    module Core
+      class TextFormatter
+
+        attr_reader :data
+        attr_reader :ui
+
+        def initialize(data, ui)
+          @ui = ui
+          @data = if data.respond_to?(:display_hash)
+            data.display_hash
+          elsif data.kind_of?(Array)
+            data
+          elsif data.respond_to?(:to_hash)
+            data.to_hash
+          else
+            data
+          end
+        end
+
+        def formatted_data
+          @formatted_data ||= text_format(data)
+        end
+
+        def text_format(data, indent=0)
+          buffer = ''
+
+          if data.respond_to?(:keys)
+            justify_width = data.keys.map {|k| k.to_s.size }.max.to_i + 2
+            data.sort.each do |key, value|
+              justified_key = ui.color("#{key}:".ljust(justify_width), :cyan)
+              if should_enumerate?(value)
+                buffer << indent_line(justified_key, indent)
+                buffer << text_format(value, indent + 1)
+              else
+                buffer << indent_key_value(justified_key, value, justify_width, indent)
+              end
+            end
+          elsif data.kind_of?(Array)
+            data.each do |item|
+              if should_enumerate?(data)
+                buffer << text_format(item, indent + 1)
+              else
+                buffer << indent_line(item, indent)
+              end
+            end
+          else
+            buffer << indent_line(stringify_value(data), indent)
+          end
+          buffer
+        end
+
+        # Ruby 1.8 Strings include enumberable, which is not what we want. So
+        # we have this heuristic to detect hashes and arrays instead.
+        def should_enumerate?(value)
+          ((value.respond_to?(:keys) && !value.empty? ) || ( value.kind_of?(Array) && (value.size > 1 || should_enumerate?(value.first) )))
+        end
+
+        def indent_line(string, indent)
+          ("  " * indent) << "#{string}\n"
+        end
+
+        def indent_key_value(key, value, justify_width, indent)
+          lines = value.to_s.split("\n")
+          if lines.size > 1
+            total_indent = (2 * indent) + justify_width + 1
+            indent_line("#{key} #{lines.shift}", indent) << lines.map {|l| (" " * total_indent) + l << "\n" }.join("")
+          else
+            indent_line("#{key} #{stringify_value(value)}", indent)
+          end
+        end
+
+        def stringify_value(data)
+          data.kind_of?(String) ? data : data.to_s
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,216 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Christopher Brown (<cb@opscode.com>)
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2009, 2011 Opscode, 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 'forwardable'
+require 'chef/knife/core/generic_presenter'
+
+class Chef
+  class Knife
+
+    #==Chef::Knife::UI
+    # The User Interaction class used by knife.
+    class UI
+
+      extend Forwardable
+
+      attr_reader :stdout
+      attr_reader :stderr
+      attr_reader :stdin
+      attr_reader :config
+
+      def_delegator :@presenter, :format_list_for_display
+      def_delegator :@presenter, :format_for_display
+      def_delegator :@presenter, :format_cookbook_list_for_display
+
+      def initialize(stdout, stderr, stdin, config)
+        @stdout, @stderr, @stdin, @config = stdout, stderr, stdin, config
+        @presenter = Chef::Knife::Core::GenericPresenter.new(self, config)
+      end
+
+      # Creates a new +presenter_class+ object and uses it to format structured
+      # data for display. By default, a Chef::Knife::Core::GenericPresenter
+      # object is used.
+      def use_presenter(presenter_class)
+        @presenter = presenter_class.new(self, config)
+      end
+
+      def highline
+        @highline ||= begin
+          require 'highline'
+          HighLine.new
+        end
+      end
+
+      # Prints a message to stdout. Aliased as +info+ for compatibility with
+      # the logger API.
+      def msg(message)
+        stdout.puts message
+      end
+
+      alias :info :msg
+
+      # Prints a msg to stderr. Used for warn, error, and fatal.
+      def err(message)
+        stderr.puts message
+      end
+
+      # Print a warning message
+      def warn(message)
+        err("#{color('WARNING:', :yellow, :bold)} #{message}")
+      end
+
+      # Print an error message
+      def error(message)
+        err("#{color('ERROR:', :red, :bold)} #{message}")
+      end
+
+      # Print a message describing a fatal error.
+      def fatal(message)
+        err("#{color('FATAL:', :red, :bold)} #{message}")
+      end
+
+      def color(string, *colors)
+        if color?
+          highline.color(string, *colors)
+        else
+          string
+        end
+      end
+
+      # Should colored output be used? For output to a terminal, this is
+      # determined by the value of `config[:color]`. When output is not to a
+      # terminal, colored output is never used
+      def color?
+        Chef::Config[:color] && stdout.tty? && (RUBY_PLATFORM !~ /mswin|mingw32|windows/)
+      end
+
+      def ask(*args, &block)
+        highline.ask(*args, &block)
+      end
+
+      def list(*args)
+        highline.list(*args)
+      end
+
+      # Formats +data+ using the configured presenter and outputs the result
+      # via +msg+. Formatting can be customized by configuring a different
+      # presenter. See +use_presenter+
+      def output(data)
+        msg @presenter.format(data)
+      end
+
+      # Determines if the output format is a data interchange format, i.e.,
+      # JSON or YAML
+      def interchange?
+        @presenter.interchange?
+      end
+
+      def ask_question(question, opts={})
+        question = question + "[#{opts[:default]}] " if opts[:default]
+
+        if opts[:default] and config[:defaults]
+          opts[:default]
+        else
+          stdout.print question
+          a = stdin.readline.strip
+
+          if opts[:default]
+            a.empty? ? opts[:default] : a
+          else
+            a
+          end
+        end
+      end
+
+      def pretty_print(data)
+        stdout.puts data
+      end
+
+      def edit_data(data, parse_output=true)
+        output = Chef::JSONCompat.to_json_pretty(data)
+
+        if (!config[:no_editor])
+          filename = "knife-edit-"
+          0.upto(20) { filename += rand(9).to_s }
+          filename << ".js"
+          filename = File.join(Dir.tmpdir, filename)
+          tf = File.open(filename, "w")
+          tf.sync = true
+          tf.puts output
+          tf.close
+          raise "Please set EDITOR environment variable" unless system("#{config[:editor]} #{tf.path}")
+          tf = File.open(filename, "r")
+          output = tf.gets(nil)
+          tf.close
+          File.unlink(filename)
+        end
+
+        parse_output ? Chef::JSONCompat.from_json(output) : output
+      end
+
+      def edit_object(klass, name)
+        object = klass.load(name)
+
+        output = edit_data(object)
+
+        # Only make the save if the user changed the object.
+        #
+        # Output JSON for the original (object) and edited (output), then parse
+        # them without reconstituting the objects into real classes
+        # (create_additions=false). Then, compare the resulting simple objects,
+        # which will be Array/Hash/String/etc.
+        #
+        # We wouldn't have to do these shenanigans if all the editable objects
+        # implemented to_hash, or if to_json against a hash returned a string
+        # with stable key order.
+        object_parsed_again = Chef::JSONCompat.from_json(Chef::JSONCompat.to_json(object), :create_additions => false)
+        output_parsed_again = Chef::JSONCompat.from_json(Chef::JSONCompat.to_json(output), :create_additions => false)
+        if object_parsed_again != output_parsed_again
+          output.save
+          self.msg("Saved #{output}")
+        else
+          self.msg("Object unchanged, not saving")
+        end
+        output(format_for_display(object)) if config[:print_after]
+      end
+
+      def confirm(question, append_instructions=true)
+        return true if config[:yes]
+
+        stdout.print question
+        stdout.print "? (Y/N) " if append_instructions
+        answer = stdin.readline
+        answer.chomp!
+        case answer
+        when "Y", "y"
+          true
+        when "N", "n"
+          self.msg("You said no, so I'm done here.")
+          exit 3
+        else
+          self.msg("I have no idea what to do with #{answer}")
+          self.msg("Just say Y or N, please.")
+          confirm(question)
+        end
+      end
+
+    end
+  end
+end