knife-essentials 0.7.6 → 0.8

data/Rakefile

@@ -1,8 +1,8 @@
 require 'bundler'
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rspec/core/rake_task'
+require 'rubygems/package_task'
 require 'rdoc/task'
+require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
 

data/lib/chef/knife/{delete.rb → delete_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    class Delete < ChefFS::Knife
+    remove_const(:Delete) if const_defined?(:Delete) # override Chef's version
+    class Delete < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife delete [PATTERN1 ... PATTERNn]"
 
       common_options
@@ -15,6 +17,12 @@ class Chef
         :description => "Delete directories recursively."
 
       def run
+        if name_args.length == 0
+          show_usage
+          ui.fatal("Must specify at least one argument.  If you want to delete everything in this directory, type \"knife delete --recurse .\"")
+          exit 1
+        end
+
         # Get the matches (recursively)
         pattern_args.each do |pattern|
           ChefFS::FileSystem.list(chef_fs, pattern) do |result|
@@ -22,7 +30,7 @@ class Chef
               result.delete(config[:recurse])
               puts "Deleted #{result.path_for_printing}"
             rescue ChefFS::FileSystem::NotFoundError
-              STDERR.puts "result.path_for_printing}: No such file or directory"
+              STDERR.puts "#{result.path_for_printing}: No such file or directory"
             end
           end
         end

data/lib/chef/knife/dependencies_essentials.rb

@@ -0,0 +1,117 @@
+require 'chef_fs/knife'
+require 'chef_fs/file_system'
+
+class Chef
+  class Knife
+    remove_const(:Dependencies) if const_defined?(:Dependencies) # override Chef's version
+    class Dependencies < ::ChefFS::Knife
+      ChefFS = ::ChefFS
+      banner "knife dependencies PATTERN1 [PATTERNn]"
+
+      common_options
+
+      option :recurse,
+        :long => '--[no-]recurse',
+        :boolean => true,
+        :description => "List dependencies recursively (default: true).  Only works with --tree."
+      option :tree,
+        :long => '--tree',
+        :boolean => true,
+        :description => "Show dependencies in a visual tree.  May show duplicates."
+      option :remote,
+        :long => '--remote',
+        :boolean => true,
+        :description => "List dependencies on the server instead of the local filesystem"
+
+      def run
+        if config[:tree] && config[:recurse]
+          STDERR.puts "--recurse requires --tree"
+          exit(1)
+        end
+        config[:recurse] = true if config[:recurse].nil?
+
+        @root = config[:remote] ? chef_fs : local_fs
+        dependencies = {}
+        pattern_args.each do |pattern|
+          ChefFS::FileSystem.list(@root, pattern) do |entry|
+            if config[:tree]
+              print_dependencies_tree(entry, dependencies)
+            else
+              print_flattened_dependencies(entry, dependencies)
+            end
+          end
+        end
+      end
+
+      def print_flattened_dependencies(entry, dependencies)
+        if !dependencies[entry.path]
+          dependencies[entry.path] = get_dependencies(entry)
+          dependencies[entry.path].each do |child|
+            child_entry = ChefFS::FileSystem.resolve_path(@root, child)
+            print_flattened_dependencies(child_entry, dependencies)
+          end
+          puts 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)
+          printed[entry.path] = true
+          dependencies[entry.path].each do |child|
+            child_entry = ChefFS::FileSystem.resolve_path(@root, child)
+            print_dependencies_tree(child_entry, dependencies, printed, depth+1)
+          end
+        end
+      end
+
+      def get_dependencies(entry)
+        begin
+          object = entry.chef_object
+        rescue ChefFS::FileSystem::NotFoundError
+          STDERR.puts "#{result.path_for_printing}: No such file or directory"
+          return []
+        end
+        if !object
+          STDERR.puts "ERROR: #{entry} is not a Chef object!"
+          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)
+        elsif object.is_a?(Chef::Role)
+          result = []
+          object.env_run_lists.each_pair do |env,run_list|
+            dependencies_from_runlist(run_list).each do |dependency|
+              result << dependency if !result.include?(dependency)
+            end
+          end
+          return result
+        else
+          return []
+        end
+      end
+
+      def dependencies_from_runlist(run_list)
+        result = run_list.map do |run_list_item|
+          case run_list_item.type
+          when :role
+            "/roles/#{run_list_item.name}.json"
+          when :recipe
+            if run_list_item.name =~ /(.+)::[^:]*/
+              "/cookbooks/#{$1}"
+            else
+              "/cookbooks/#{run_list_item.name}"
+            end
+          else
+            raise "Unknown run list item type #{run_list_item.type}"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/{diff.rb → diff_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    class Diff < ChefFS::Knife
+    remove_const(:Diff) if const_defined?(:Diff) # override Chef's version
+    class Diff < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife diff PATTERNS"
 
       common_options

data/lib/chef/knife/{download.rb → download_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    class Download < ChefFS::Knife
+    remove_const(:Download) if const_defined?(:Download) # override Chef's version
+    class Download < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife download PATTERNS"
 
       common_options
@@ -34,10 +36,13 @@ class Chef
         :description => "Don't take action, only print what would happen"
 
       def run
-        patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
+        if name_args.length == 0
+          show_usage
+          ui.fatal("Must specify at least one argument.  If you want to download everything in this directory, type \"knife download .\"")
+          exit 1
+        end
 
-        # Get the matches (recursively)
-        patterns.each do |pattern|
+        pattern_args.each do |pattern|
           ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config)
         end
       end

data/lib/chef/knife/{list.rb → list_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    class List < ChefFS::Knife
+    remove_const(:List) if const_defined?(:List) # override Chef's version
+    class List < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife list [-dR] [PATTERN1 ... PATTERNn]"
 
       common_options
@@ -16,6 +18,10 @@ class Chef
         :short => '-d',
         :boolean => true,
         :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"
 
       def run
         patterns = name_args.length == 0 ? [""] : name_args
@@ -24,7 +30,7 @@ class Chef
         results = []
         dir_results = []
         pattern_args_from(patterns).each do |pattern|
-          ChefFS::FileSystem.list(chef_fs, pattern) do |result|
+          ChefFS::FileSystem.list(config[:local] ? local_fs : chef_fs, pattern) do |result|
             if result.dir? && !config[:bare_directories]
               dir_results += add_dir_result(result)
             elsif result.exists?

data/lib/chef/knife/{raw.rb → raw_essentials.rb}

@@ -2,7 +2,9 @@ require 'json'
 
 class Chef
   class Knife
+    remove_const(:Raw) if const_defined?(:Raw) # override Chef's version
     class Raw < Chef::Knife
+      ChefFS = ::ChefFS
       banner "knife raw REQUEST_PATH"
 
       option :method,

data/lib/chef/knife/{show.rb → show_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/file_system'
 
 class Chef
   class Knife
-    class Show < ChefFS::Knife
+    remove_const(:Show) if const_defined?(:Show) # override Chef's version
+    class Show < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife show [PATTERN1 ... PATTERNn]"
 
       common_options

data/lib/chef/knife/{upload.rb → upload_essentials.rb}

@@ -3,7 +3,9 @@ require 'chef_fs/command_line'
 
 class Chef
   class Knife
-    class Upload < ChefFS::Knife
+    remove_const(:Upload) if const_defined?(:Upload) # override Chef's version
+    class Upload < ::ChefFS::Knife
+      ChefFS = ::ChefFS
       banner "knife upload PATTERNS"
 
       common_options
@@ -34,10 +36,13 @@ class Chef
         :description => "Don't take action, only print what would happen"
 
       def run
-        patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
+        if name_args.length == 0
+          show_usage
+          ui.fatal("Must specify at least one argument.  If you want to upload everything in this directory, type \"knife upload .\"")
+          exit 1
+        end
 
-        # Get the matches (recursively)
-        patterns.each do |pattern|
+        pattern_args.each do |pattern|
           ChefFS::FileSystem.copy_to(pattern, local_fs, chef_fs, config[:recurse] ? nil : 1, config)
         end
       end

data/lib/chef_fs/command_line.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs/file_system'
 
 module ChefFS

data/lib/chef_fs/file_pattern.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs'
 require 'chef_fs/path_utils'
 

data/lib/chef_fs/file_system.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs/path_utils'
 
 module ChefFS
@@ -336,4 +354,3 @@ module ChefFS
 
   end
 end
-

data/lib/chef_fs/file_system/base_fs_dir.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs/file_system/base_fs_object'
 require 'chef_fs/file_system/nonexistent_fs_object'
 

data/lib/chef_fs/file_system/base_fs_object.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs/path_utils'
 
 module ChefFS
@@ -95,7 +113,7 @@ module ChefFS
 
       # Important directory attributes: name, parent, path, root
       # Overridable attributes: dir?, child(name), path_for_printing
-      # Abstract: read, write, delete, children
+      # Abstract: read, write, delete, children, can_have_child?, create_child, compare_to
     end
   end
 end

data/lib/chef_fs/file_system/chef_repository_file_system_entry.rb

@@ -1,3 +1,21 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2012 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_fs/file_system/file_system_entry'
 require 'chef/cookbook/chefignore'
 require 'chef/cookbook/cookbook_version_loader'
@@ -10,22 +28,30 @@ require 'chef/client'
 module ChefFS
   module FileSystem
     # ChefRepositoryFileSystemEntry works just like FileSystemEntry,
-    # except it pretends files in /cookbooks/chefignore don't exist
-    # and it can inflate Chef objects
+    # except can inflate Chef objects
     class ChefRepositoryFileSystemEntry < FileSystemEntry
       def initialize(name, parent, file_path = nil)
         super(name, parent, file_path)
         # Load /cookbooks/chefignore
-        if name == "cookbooks" && path == "/cookbooks" # We check name first because it's a faster fail than path
+        if path == '/cookbooks'
           @chefignore = Chef::Cookbook::Chefignore.new(self.file_path)
+          @ignore_empty_directories = true
+        # If we are a cookbook or a cookbook subdirectory, empty directories
+        # underneath us are ignored (since they cannot be uploaded)
+        elsif parent && parent.ignore_empty_directories?
+          @ignore_empty_directories = true
         end
       end
 
       attr_reader :chefignore
 
+      def ignore_empty_directories?
+        @ignore_empty_directories
+      end
+
       def chef_object
         begin
-          if parent.path == "/cookbooks"
+          if parent.path == '/cookbooks'
             loader = Chef::Cookbook::CookbookVersionLoader.new(file_path, parent.chefignore)
             loader.load_cookbooks
             return loader.cookbook_version
@@ -40,22 +66,37 @@ module ChefFS
       end
 
       def children
-        @children ||= Dir.entries(file_path).select { |entry| entry != '.' && entry != '..' && !ignored?(entry) }.
-                                             map { |entry| ChefRepositoryFileSystemEntry.new(entry, self) }
+        @children ||=
+          Dir.entries(file_path).
+              select { |entry| entry != '.' && entry != '..' && !ignored?(entry) }.
+              map { |entry| ChefRepositoryFileSystemEntry.new(entry, self) }
       end
 
       attr_reader :chefignore
 
       private
 
+      def is_cookbooks_dir?
+        # We check name first because it's a faster fail than path
+        path == "/cookbooks"
+      end
+
       def ignored?(child_name)
-        ignorer = self
+        # empty directories inside a cookbook are ignored
+        if ignore_empty_directories?
+          child_path = PathUtils.join(file_path, child_name)
+          if File.directory?(child_path) && Dir.entries(child_path) == [ '.', '..' ]
+            return true
+          end
+        end
+
+        ignorer = parent
         begin
           if ignorer.chefignore
             # Grab the path from entry to child
             path_to_child = child_name
             child = self
-            while child != ignorer
+            while child.parent != ignorer
               path_to_child = PathUtils.join(child.name, path_to_child)
               child = child.parent
             end