knife-essentials 0.8.1 → 0.8.2

data/lib/chef/knife/delete_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    remove_const(:Delete) if const_defined?(:Delete) # override Chef's version
+    remove_const(:Delete) if const_defined?(:Delete) && Delete.name == 'Chef::Knife::Delete' # override Chef's version
     class Delete < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife delete [PATTERN1 ... PATTERNn]"
@@ -67,9 +67,9 @@ class Chef
           end
         end
         if deleted_any
-          puts "Deleted #{format_path(results[0].path)}"
+          output("Deleted #{format_path(results[0].path)}")
         else
-          STDERR.puts "#{format_path(results[0].path)}: No such file or directory"
+          ui.error "#{format_path(results[0].path)}: No such file or directory"
         end
       end
     end

data/lib/chef/knife/deps_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    remove_const(:Deps) if const_defined?(:Deps) # override Chef's version
+    remove_const(:Deps) if const_defined?(:Deps) && Deps.name == 'Chef::Knife::Deps' # override Chef's version
     class Deps < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife deps PATTERN1 [PATTERNn]"
@@ -23,9 +23,11 @@ class Chef
         :boolean => true,
         :description => "List dependencies on the server instead of the local filesystem"
 
+      attr_accessor :exit_code
+
       def run
-        if config[:tree] && config[:recurse]
-          STDERR.puts "--recurse requires --tree"
+        if config[:recurse] == false && !config[:tree]
+          ui.error "--no-recurse requires --tree"
           exit(1)
         end
         config[:recurse] = true if config[:recurse].nil?
@@ -41,6 +43,7 @@ class Chef
             end
           end
         end
+        exit exit_code if exit_code
       end
 
       def print_flattened_dependencies(entry, dependencies)
@@ -50,14 +53,14 @@ class Chef
             child_entry = ChefFS::FileSystem.resolve_path(@root, child)
             print_flattened_dependencies(child_entry, dependencies)
           end
-          puts format_path(entry.path)
+          output format_path(entry.path)
         end
       end
 
       def print_dependencies_tree(entry, dependencies, printed = {}, depth = 0)
         dependencies[entry.path] = get_dependencies(entry) if !dependencies[entry.path]
-        puts "#{'  '*depth}#{format_path(entry.path)}"
-        if !printed[entry.path] && (config[:recurse] || depth <= 1)
+        output "#{'  '*depth}#{format_path(entry.path)}"
+        if !printed[entry.path] && (config[:recurse] || depth == 0)
           printed[entry.path] = true
           dependencies[entry.path].each do |child|
             child_entry = ChefFS::FileSystem.resolve_path(@root, child)
@@ -70,18 +73,25 @@ class Chef
         begin
           object = entry.chef_object
         rescue ChefFS::FileSystem::NotFoundError
-          STDERR.puts "#{result.path_for_printing}: No such file or directory"
+          ui.error "#{format_path(entry.path)}: No such file or directory"
+          self.exit_code = 2
           return []
         end
         if !object
-          STDERR.puts "ERROR: #{entry} is not a Chef object!"
+          # If it's not a Chef object, it has no deps
           return []
         end
 
         if object.is_a?(Chef::CookbookVersion)
           return object.metadata.dependencies.keys.map { |cookbook| "/cookbooks/#{cookbook}"}
         elsif object.is_a?(Chef::Node)
-          return [ "/environments/#{object.chef_environment}.json" ] + dependencies_from_runlist(object.run_list)
+          result = []
+          # /environments/_default.json is an annoying dependency, since you
+          # can't upload it anyway
+          if object.chef_environment != '_default'
+            result << "/environments/#{object.chef_environment}.json"
+          end
+          return result + dependencies_from_runlist(object.run_list)
         elsif object.is_a?(Chef::Role)
           result = []
           object.env_run_lists.each_pair do |env,run_list|

data/lib/chef/knife/diff_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    remove_const(:Diff) if const_defined?(:Diff) # override Chef's version
+    remove_const(:Diff) if const_defined?(:Diff) && Diff.name == 'Chef::Knife::Diff' # override Chef's version
     class Diff < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife diff PATTERNS"
@@ -38,7 +38,7 @@ class Chef
         # Get the matches (recursively)
         patterns.each do |pattern|
           ChefFS::CommandLine.diff(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, output_mode) do |diff|
-            puts diff
+            output diff
           end
         end
       end

data/lib/chef/knife/download_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    remove_const(:Download) if const_defined?(:Download) # override Chef's version
+    remove_const(:Download) if const_defined?(:Download) && Download.name == 'Chef::Knife::Download' # override Chef's version
     class Download < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife download PATTERNS"
@@ -43,7 +43,7 @@ class Chef
         end
 
         pattern_args.each do |pattern|
-          ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config)
+          ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config, ui)
         end
       end
     end

data/lib/chef/knife/list_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    remove_const(:List) if const_defined?(:List) # override Chef's version
+    remove_const(:List) if const_defined?(:List) && List.name == 'Chef::Knife::List' # override Chef's version
     class List < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife list [-dR] [PATTERN1 ... PATTERNn]"
@@ -13,15 +13,29 @@ class Chef
       option :recursive,
         :short => '-R',
         :boolean => true,
-        :description => "List directories recursively."
+        :description => "List directories recursively"
       option :bare_directories,
         :short => '-d',
         :boolean => true,
-        :description => "When directories match the pattern, do not show the directories' children."
+        :description => "When directories match the pattern, do not show the directories' children"
       option :local,
         :long => '--local',
         :boolean => true,
         :description => "List local directory instead of remote"
+      option :flat,
+        :long => '--flat',
+        :boolean => true,
+        :description => "Show a list of filenames rather than the prettified ls-like output normally produced"
+      option :one_column,
+        :short => '-1',
+        :boolean => true,
+        :description => "Show only one column of results"
+      option :trailing_slashes,
+        :short => '-p',
+        :boolean => true,
+        :description => "Show trailing slashes after directories"
+
+      attr_accessor :exit_code
 
       def run
         patterns = name_args.length == 0 ? [""] : name_args
@@ -36,11 +50,19 @@ class Chef
             elsif result.exists?
               results << result
             elsif pattern.exact_path
-              STDERR.puts "#{format_path(result.path)}: No such file or directory"
+              ui.error "#{format_path(result.path)}: No such file or directory"
+              self.exit_code = 1
             end
           end
         end
 
+        if config[:flat]
+          dir_results.each do |result, children|
+            results += children
+          end
+          dir_results = []
+        end
+
         results = results.sort_by { |result| result.path }
         dir_results = dir_results.sort_by { |result| result[0].path }
 
@@ -50,18 +72,25 @@ class Chef
         end
 
         print_result_paths results
+        printed_something = results.length > 0
         dir_results.each do |result, children|
-          puts ""
-          puts "#{format_path(result.path)}:"
-          print_results(children.map { |result| result.name }.sort, "")
+          if printed_something
+            output ""
+          else
+            printed_something = true
+          end
+          output "#{format_path(result.path)}:"
+          print_results(children.map { |result| maybe_add_slash(result.name, result.dir?) }.sort, "")
         end
+
+        exit self.exit_code if self.exit_code
       end
 
       def add_dir_result(result)
         begin
           children = result.children.sort_by { |child| child.name }
         rescue ChefFS::FileSystem::NotFoundError
-          STDERR.puts "#{format_path(result.path)}: No such file or directory"
+          ui.error "#{format_path(result.path)}: No such file or directory"
           return []
         end
 
@@ -76,38 +105,41 @@ class Chef
         result
       end
 
-      def list_dirs_recursive(children)
-        results = children.select { |child| child.dir? }.to_a
-        results.each do |child|
-          results += list_dirs_recursive(child.children)
-        end
-        results
-      end
-
       def print_result_paths(results, indent = "")
-        print_results(results.map { |result| format_path(result.path) }, indent)
+        print_results(results.map { |result| maybe_add_slash(format_path(result.path), result.dir?) }, indent)
       end
 
       def print_results(results, indent)
         return if results.length == 0
 
         print_space = results.map { |result| result.length }.max + 2
-        # TODO: tput cols is not cross platform
-        columns = $stdout.isatty ? Integer(`tput cols`) : 0
-        current_column = 0
+        if config[:one_column] || !stdout.isatty
+          columns = 0
+        else
+          # TODO: tput cols is not cross platform
+          columns = Integer(`tput cols`)
+        end
+        current_line = ''
         results.each do |result|
-          if current_column != 0 && current_column + print_space > columns
-            puts ""
-            current_column = 0
+          if current_line.length > 0 && current_line.length + print_space > columns
+            output current_line.rstrip
+            current_line = ''
           end
-          if current_column == 0
-            print indent
-            current_column += indent.length
+          if current_line.length == 0
+            current_line << indent
           end
-          print result + (' ' * (print_space - result.length))
-          current_column += print_space
+          current_line << result
+          current_line << (' ' * (print_space - result.length))
+        end
+        output current_line.rstrip if current_line.length > 0
+      end
+
+      def maybe_add_slash(path, is_dir)
+        if config[:trailing_slashes] && is_dir
+          "#{path}/"
+        else
+          path
         end
-        puts ""
       end
     end
   end

data/lib/chef/knife/raw_essentials.rb

@@ -2,7 +2,7 @@ require 'json'
 
 class Chef
   class Knife
-    remove_const(:Raw) if const_defined?(:Raw) # override Chef's version
+    remove_const(:Raw) if const_defined?(:Raw) && Raw.name == 'Chef::Knife::Raw' # override Chef's version
     class Raw < Chef::Knife
       ChefFS = ::ChefFS
       banner "knife raw REQUEST_PATH"
@@ -11,13 +11,13 @@ class Chef
         :long => '--method METHOD',
         :short => '-m METHOD',
         :default => "GET",
-        :description => "Request method (GET, POST, PUT or DELETE)"
+        :description => "Request method (GET, POST, PUT or DELETE).  Default: GET"
 
       option :pretty,
         :long => '--[no-]pretty',
         :boolean => true,
         :default => true,
-        :description => "Pretty-print JSON output"
+        :description => "Pretty-print JSON output.  Default: true"
 
       option :input,
         :long => '--input FILE',
@@ -41,7 +41,7 @@ class Chef
           data = IO.read(config[:input])
         end
         chef_rest = Chef::REST.new(Chef::Config[:chef_server_url])
-        puts api_request(chef_rest, config[:method].to_sym, chef_rest.create_url(name_args[0]), {}, data)
+        output api_request(chef_rest, config[:method].to_sym, chef_rest.create_url(name_args[0]), {}, data)
       end
 
       ACCEPT_ENCODING = "Accept-Encoding".freeze
@@ -87,7 +87,7 @@ class Chef
               msg << (exception["error"].respond_to?(:join) ? exception["error"].join(", ") : exception["error"].to_s)
               Chef::Log.info(msg)
             end
-            puts response.body
+            output response.body
             response.error!
           end
         end

data/lib/chef/knife/show_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    remove_const(:Show) if const_defined?(:Show) # override Chef's version
+    remove_const(:Show) if const_defined?(:Show) && Show.name == 'Chef::Knife::Show' # override Chef's version
     class Show < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife show [PATTERN1 ... PATTERNn]"
@@ -20,14 +20,14 @@ class Chef
         pattern_args.each do |pattern|
           ChefFS::FileSystem.list(config[:local] ? local_fs : chef_fs, pattern) do |result|
             if result.dir?
-              STDERR.puts "#{result.path_for_printing}: is a directory" if pattern.exact_path
+              ui.error "#{result.path_for_printing}: is a directory" if pattern.exact_path
             else
               begin
                 value = result.read
-                puts "#{result.path_for_printing}:"
+                output "#{result.path_for_printing}:"
                 output(format_for_display(value))
               rescue ChefFS::FileSystem::NotFoundError
-                STDERR.puts "#{result.path_for_printing}: No such file or directory"
+                ui.error "#{result.path_for_printing}: No such file or directory"
               end
             end
           end

data/lib/chef/knife/upload_essentials.rb

@@ -3,7 +3,7 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    remove_const(:Upload) if const_defined?(:Upload) # override Chef's version
+    remove_const(:Upload) if const_defined?(:Upload) && Upload.name == 'Chef::Knife::Upload' # override Chef's version
     class Upload < ::ChefFS::Knife
       ChefFS = ::ChefFS
       banner "knife upload PATTERNS"
@@ -43,7 +43,7 @@ class Chef
         end
 
         pattern_args.each do |pattern|
-          ChefFS::FileSystem.copy_to(pattern, local_fs, chef_fs, config[:recurse] ? nil : 1, config)
+          ChefFS::FileSystem.copy_to(pattern, local_fs, chef_fs, config[:recurse] ? nil : 1, config, ui)
         end
       end
     end

data/lib/chef_fs/file_system.rb

@@ -34,7 +34,7 @@ module ChefFS
         block.call(entry)
       end
 
-      if entry.dir? && pattern.could_match_children?(entry.path)
+      if pattern.could_match_children?(entry.path)
         # If it's possible that our children could match, descend in and add matches.
         exact_child_name = pattern.exact_child_name_under(entry.path)
 
@@ -47,7 +47,7 @@ module ChefFS
           end
 
         # Otherwise, go through all children and find any matches
-        else
+        elsif entry.dir?
           entry.children.each do |child|
             list(child, pattern, &block)
           end
@@ -112,15 +112,15 @@ module ChefFS
     #       puts message
     #     end
     #
-    def self.copy_to(pattern, src_root, dest_root, recurse_depth, options)
+    def self.copy_to(pattern, src_root, dest_root, recurse_depth, options, ui)
       found_result = false
       list_pairs(pattern, src_root, dest_root) do |src, dest|
         found_result = true
-        new_dest_parent = get_or_create_parent(dest, options)
-        copy_entries(src, dest, new_dest_parent, recurse_depth, options)
+        new_dest_parent = get_or_create_parent(dest, options, ui)
+        copy_entries(src, dest, new_dest_parent, recurse_depth, options, ui)
       end
       if !found_result && pattern.exact_path
-        puts "#{pattern}: No such file or directory on remote or local"
+        ui.error "#{pattern}: No such file or directory on remote or local"
       end
     end
 
@@ -215,7 +215,7 @@ module ChefFS
     private
 
     # Copy two entries (could be files or dirs)
-    def self.copy_entries(src_entry, dest_entry, new_dest_parent, recurse_depth, options)
+    def self.copy_entries(src_entry, dest_entry, new_dest_parent, recurse_depth, options, ui)
       # A NOTE about this algorithm:
       # There are cases where this algorithm does too many network requests.
       # knife upload with a specific filename will first check if the file
@@ -232,10 +232,10 @@ module ChefFS
           # If we would not have uploaded it, we will not purge it.
           if src_entry.parent.can_have_child?(dest_entry.name, dest_entry.dir?)
             if options[:dry_run]
-              puts "Would delete #{dest_entry.path_for_printing}"
+              ui.output "Would delete #{dest_entry.path_for_printing}"
             else
               dest_entry.delete(true)
-              puts "Deleted extra entry #{dest_entry.path_for_printing} (purge is on)"
+              ui.output "Deleted extra entry #{dest_entry.path_for_printing} (purge is on)"
             end
           else
             Chef::Log.info("Not deleting extra entry #{dest_entry.path_for_printing} (purge is off)")
@@ -247,35 +247,35 @@ module ChefFS
           # If the entry can do a copy directly from filesystem, do that.
           if new_dest_parent.respond_to?(:create_child_from)
             if options[:dry_run]
-              puts "Would create #{dest_entry.path_for_printing}"
+              ui.output "Would create #{dest_entry.path_for_printing}"
             else
               new_dest_parent.create_child_from(src_entry)
-              puts "Created #{dest_entry.path_for_printing}"
+              ui.output "Created #{dest_entry.path_for_printing}"
             end
             return
           end
 
           if src_entry.dir?
             if options[:dry_run]
-              puts "Would create #{dest_entry.path_for_printing}"
+              ui.output "Would create #{dest_entry.path_for_printing}"
               new_dest_dir = new_dest_parent.child(src_entry.name)
             else
               new_dest_dir = new_dest_parent.create_child(src_entry.name, nil)
-              puts "Created #{dest_entry.path_for_printing}/"
+              ui.output "Created #{dest_entry.path_for_printing}/"
             end
             # Directory creation is recursive.
             if recurse_depth != 0
               src_entry.children.each do |src_child|
                 new_dest_child = new_dest_dir.child(src_child.name)
-                copy_entries(src_child, new_dest_child, new_dest_dir, recurse_depth ? recurse_depth - 1 : recurse_depth, options)
+                copy_entries(src_child, new_dest_child, new_dest_dir, recurse_depth ? recurse_depth - 1 : recurse_depth, options, ui)
               end
             end
           else
             if options[:dry_run]
-              puts "Would create #{dest_entry.path_for_printing}"
+              ui.output "Would create #{dest_entry.path_for_printing}"
             else
               new_dest_parent.create_child(src_entry.name, src_entry.read)
-              puts "Created #{dest_entry.path_for_printing}"
+              ui.output "Created #{dest_entry.path_for_printing}"
             end
           end
         end
@@ -287,10 +287,10 @@ module ChefFS
         if dest_entry.respond_to?(:copy_from)
           if options[:force] || compare(src_entry, dest_entry)[0] == false
             if options[:dry_run]
-              puts "Would update #{dest_entry.path_for_printing}"
+              ui.output "Would update #{dest_entry.path_for_printing}"
             else
               dest_entry.copy_from(src_entry)
-              puts "Updated #{dest_entry.path_for_printing}"
+              ui.output "Updated #{dest_entry.path_for_printing}"
             end
           end
           return
@@ -302,17 +302,17 @@ module ChefFS
             # If both are directories, recurse into their children
             if recurse_depth != 0
               child_pairs(src_entry, dest_entry).each do |src_child, dest_child|
-                copy_entries(src_child, dest_child, dest_entry, recurse_depth ? recurse_depth - 1 : recurse_depth, options)
+                copy_entries(src_child, dest_child, dest_entry, recurse_depth ? recurse_depth - 1 : recurse_depth, options, ui)
               end
             end
           else
             # If they are different types.
-            Chef::Log.error("File #{dest_entry.path_for_printing} is a directory while file #{dest_entry.path_for_printing} is a regular file\n")
+            ui.error("File #{dest_entry.path_for_printing} is a directory while file #{dest_entry.path_for_printing} is a regular file\n")
             return
           end
         else
           if dest_entry.dir?
-            Chef::Log.error("File #{dest_entry.path_for_printing} is a directory while file #{dest_entry.path_for_printing} is a regular file\n")
+            ui.error("File #{dest_entry.path_for_printing} is a directory while file #{dest_entry.path_for_printing} is a regular file\n")
             return
           else
 
@@ -326,11 +326,11 @@ module ChefFS
             end
             if should_copy
               if options[:dry_run]
-                puts "Would update #{dest_entry.path_for_printing}"
+                ui.output "Would update #{dest_entry.path_for_printing}"
               else
                 src_value = src_entry.read if src_value.nil?
                 dest_entry.write(src_value)
-                puts "Updated #{dest_entry.path_for_printing}"
+                ui.output "Updated #{dest_entry.path_for_printing}"
               end
             end
           end
@@ -338,15 +338,15 @@ module ChefFS
       end
     end
 
-    def self.get_or_create_parent(entry, options)
+    def self.get_or_create_parent(entry, options, ui)
       parent = entry.parent
       if parent && !parent.exists?
-        parent_parent = get_or_create_parent(entry.parent, options)
+        parent_parent = get_or_create_parent(entry.parent, options, ui)
         if options[:dry_run]
-          puts "Would create #{parent.path_for_printing}"
+          ui.output "Would create #{parent.path_for_printing}"
         else
           parent = parent_parent.create_child(parent.name, true)
-          puts "Created #{parent.path_for_printing}"
+          ui.output "Created #{parent.path_for_printing}"
         end
       end
       return parent