knife-essentials 0.8.1 → 0.8.2

data/lib/chef_fs/file_system/base_fs_object.rb

@@ -108,7 +108,12 @@ module ChefFS
       #       are_same = (value == other_value)
       #     end
       def compare_to(other)
-        return nil
+        nil
+      end
+
+      def chef_object
+        raise ChefFS::FileSystem::NotFoundError, "Nonexistent #{path_for_printing}" if !exists?
+        nil
       end
 
       # Important directory attributes: name, parent, path, root

data/lib/chef_fs/file_system/chef_repository_file_system_cookbooks_dir.rb

@@ -0,0 +1,37 @@
+#
+# Author:: John Keiser (<jkeiser@opscode.com>)
+# Copyright:: Copyright (c) 2013 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/chef_repository_file_system_entry'
+require 'chef/cookbook/chefignore'
+
+module ChefFS
+  module FileSystem
+    class ChefRepositoryFileSystemCookbooksDir < ChefRepositoryFileSystemEntry
+      def initialize(name, parent, file_path)
+        super(name, parent, file_path)
+        @chefignore = Chef::Cookbook::Chefignore.new(self.file_path)
+      end
+
+      attr_reader :chefignore
+
+      def ignore_empty_directories?
+        true
+      end
+    end
+  end
+end

data/lib/chef_fs/file_system/chef_repository_file_system_entry.rb

@@ -17,7 +17,6 @@
 #
 
 require 'chef_fs/file_system/file_system_entry'
-require 'chef/cookbook/chefignore'
 require 'chef/cookbook/cookbook_version_loader'
 require 'chef/node'
 require 'chef/role'
@@ -30,23 +29,16 @@ module ChefFS
     # ChefRepositoryFileSystemEntry works just like FileSystemEntry,
     # except can inflate Chef objects
     class ChefRepositoryFileSystemEntry < FileSystemEntry
-      def initialize(name, parent, file_path = nil)
+      def initialize(name, parent, file_path = nil, ignore_empty_directories = nil, chefignore = nil)
         super(name, parent, file_path)
-        # Load /cookbooks/chefignore
-        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 chefignore
+        nil
+      end
 
       def ignore_empty_directories?
-        @ignore_empty_directories
+        parent.ignore_empty_directories?
       end
 
       def chef_object
@@ -68,43 +60,36 @@ module ChefFS
       def children
         @children ||=
           Dir.entries(file_path).
-              select { |entry| entry != '.' && entry != '..' && !ignored?(entry) }.
-              map { |entry| ChefRepositoryFileSystemEntry.new(entry, self) }
+              select { |entry| entry != '.' && entry != '..' }.
+              map { |entry| ChefRepositoryFileSystemEntry.new(entry, self) }.
+              select { |entry| !ignored?(entry) }
       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)
-        # 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) == [ '.', '..' ]
+      def ignored?(child_entry)
+        if child_entry.dir?
+          # empty cookbooks and cookbook directories are ignored
+          if ignore_empty_directories? && child_entry.children.size == 0
             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.parent != ignorer
-              path_to_child = PathUtils.join(child.name, path_to_child)
-              child = child.parent
+        else
+          ignorer = parent
+          begin
+            if ignorer.chefignore
+              # Grab the path from entry to child
+              path_to_child = child_entry.name
+              child = self
+              while child.parent != ignorer
+                path_to_child = PathUtils.join(child.name, path_to_child)
+                child = child.parent
+              end
+              # Check whether that relative path is ignored
+              return ignorer.chefignore.ignored?(path_to_child)
             end
-            # Check whether that relative path is ignored
-            return ignorer.chefignore.ignored?(path_to_child)
-          end
-          ignorer = ignorer.parent
-        end while ignorer
+            ignorer = ignorer.parent
+          end while ignorer
+        end
       end
 
     end

data/lib/chef_fs/file_system/chef_repository_file_system_root_dir.rb

@@ -18,6 +18,7 @@
 
 require 'chef_fs/file_system/base_fs_dir'
 require 'chef_fs/file_system/chef_repository_file_system_entry'
+require 'chef_fs/file_system/chef_repository_file_system_cookbooks_dir'
 require 'chef_fs/file_system/multiplexed_dir'
 
 module ChefFS
@@ -62,7 +63,11 @@ module ChefFS
         if paths.size == 0
           return nil
         end
-        dirs = paths.map { |path| ChefRepositoryFileSystemEntry.new(name, self, path) }
+        if name == 'cookbooks'
+          dirs = paths.map { |path| ChefRepositoryFileSystemCookbooksDir.new(name, self, path) }
+        else
+          dirs = paths.map { |path| ChefRepositoryFileSystemEntry.new(name, self, path) }
+        end
         MultiplexedDir.new(dirs)
       end
     end

data/lib/chef_fs/knife.rb

@@ -47,7 +47,7 @@ module ChefFS
       end
     end
 
-    # Smooth out some inappropriate (for know) variable defaults in Chef.
+    # Smooth out some inappropriate (for now) variable defaults in Chef.
     def config_var(name)
       case name
       when :data_bag_path
@@ -66,7 +66,12 @@ module ChefFS
     def object_paths
       @object_paths ||= begin
         result = {}
-        %w(clients cookbooks data_bags environments nodes roles users).each do |object_name|
+        if config[:repo_mode] == 'everything'
+          object_names = %w(clients cookbooks data_bags environments nodes roles users)
+        else
+          object_names = %w(cookbooks data_bags environments roles)
+        end
+        object_names.each do |object_name|
           variable_name = "#{object_name[0..-2]}_path" # cookbooks -> cookbook_path
           paths = config_var(variable_name.to_sym)
           if !paths
@@ -135,7 +140,7 @@ module ChefFS
 
     # Print the given server path, relative to the current directory
     def format_path(server_path)
-      if server_path[0,base_path.length] == base_path
+      if base_path && server_path[0,base_path.length] == base_path
         if server_path == base_path
           return "."
         elsif server_path[base_path.length] == "/"

data/lib/chef_fs/version.rb

@@ -1,4 +1,4 @@
 module ChefFS
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end
 

data/spec/chef_fs/file_system_spec.rb

@@ -34,7 +34,7 @@ describe ChefFS::FileSystem do
         list_should_yield_paths(fs, '/a', '/a')
       end
       it '/a/b' do
-        list_should_yield_paths(fs, '/a/b')
+        list_should_yield_paths(fs, '/a/b', '/a/b')
       end
       it '/*' do
         list_should_yield_paths(fs, '/*', '/')
@@ -104,7 +104,7 @@ describe ChefFS::FileSystem do
       end
       it 'nonexistent /a/ab/blah/bjork' do
         no_blocking_calls_allowed
-        list_should_yield_paths(fs, '/a/ab/blah/bjork')
+        list_should_yield_paths(fs, '/a/ab/blah/bjork', '/a/ab/blah/bjork')
       end
     end
 

data/spec/integration/chef_repository_file_system_spec.rb

@@ -0,0 +1,650 @@
+require 'support/integration_helper'
+require 'chef/knife/list_essentials'
+
+describe 'knife list' do
+  extend IntegrationSupport
+  include KnifeSupport
+
+  context 'directories and files that should/should not be ignored' do
+    when_the_repository "has empty roles, environments and data bag item directories" do
+      directory "roles"
+      directory "environments"
+      directory "data_bags/bag1"
+
+      it "knife list --local -R / returns them" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+data_bags
+environments
+roles
+
+/data_bags:
+bag1
+
+/data_bags/bag1:
+
+/environments:
+
+/roles:
+EOM
+      end
+    end
+
+    when_the_repository "has an empty data_bags directory" do
+      directory "data_bags"
+
+      it "knife list --local / returns it" do
+        knife('list --local /').should_succeed "/data_bags\n"
+      end
+    end
+
+    when_the_repository "has an empty cookbook directory" do
+      directory 'cookbooks/cookbook1'
+
+      it "knife list --local -R / does not return it" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+EOM
+      end
+    end
+
+    when_the_repository "has only empty cookbook subdirectories" do
+      directory 'cookbooks/cookbook1/recipes'
+
+      it "knife list --local -R / does not return it" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+EOM
+      end
+    end
+
+    when_the_repository "has empty and non-empty cookbook subdirectories" do
+      directory 'cookbooks/cookbook1/recipes'
+      file 'cookbooks/cookbook1/templates/default/x.txt', ''
+
+      it "knife list --local -R / does not return the empty ones" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+cookbook1
+
+/cookbooks/cookbook1:
+templates
+
+/cookbooks/cookbook1/templates:
+default
+
+/cookbooks/cookbook1/templates/default:
+x.txt
+EOM
+      end
+    end
+
+    when_the_repository "has only empty cookbook sub-sub-directories" do
+      directory 'cookbooks/cookbook1/templates/default'
+
+      it "knife list --local -R / does not return it" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+EOM
+      end
+    end
+
+    when_the_repository "has empty cookbook sub-sub-directories alongside non-empty ones" do
+      file 'cookbooks/cookbook1/templates/default/x.txt', ''
+      directory 'cookbooks/cookbook1/templates/rhel'
+      directory 'cookbooks/cookbook1/files/default'
+
+      it "knife list --local -R / does not return the empty ones" do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+cookbook1
+
+/cookbooks/cookbook1:
+templates
+
+/cookbooks/cookbook1/templates:
+default
+
+/cookbooks/cookbook1/templates/default:
+x.txt
+EOM
+      end
+    end
+
+    when_the_repository "has an extra schmenvironments directory" do
+      directory "schmenvironments" do
+        file "_default.json", {}
+      end
+
+      it "knife list --local -R / should NOT return it" do
+        knife('list --local -R /').should_succeed ""
+      end
+    end
+
+    when_the_repository "has extra subdirectories and files under data bag items, roles, and environments" do
+      directory "data_bags/bag1" do
+        file "item1.json", {}
+        file "item2.xml", ""
+        file "another_subdir/item.json", {}
+      end
+      directory "roles" do
+        file "role1.json", {}
+        file "role2.xml", ""
+        file "subdir/role.json", {}
+      end
+      directory "environments" do
+        file "environment1.json", {}
+        file "environment2.xml", ""
+        file "subdir/environment.json", {}
+      end
+
+      it "knife list --local -R / should NOT return them" do
+        pending "Decide whether this is a good/bad idea" do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+data_bags
+environments
+roles
+
+/data_bags:
+bag1
+
+/data_bags/bag1:
+item1.json
+
+/environments:
+environment1.json
+
+/roles:
+role1.json
+EOM
+        end
+      end
+    end
+
+    when_the_repository "has extraneous subdirectories and files under cookbooks" do
+      directory 'cookbooks/cookbook1' do
+        file 'a.rb', ''
+        file 'blarghle/blah.rb', ''
+        directory 'attributes' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'definitions' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'recipes' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'libraries' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'templates' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'files' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'resources' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+        directory 'providers' do
+          file 'a.rb', ''
+          file 'b.json', {}
+          file 'c/d.rb', ''
+          file 'c/e.json', {}
+        end
+      end
+
+      it "knife list --local -R / should NOT return them" do
+        pending "Decide whether this is a good idea" do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+cookbook1
+
+/cookbooks/cookbook1:
+a.rb
+attributes
+definitions
+files
+libraries
+providers
+recipes
+resources
+templates
+
+/cookbooks/cookbook1/attributes:
+a.rb
+
+/cookbooks/cookbook1/definitions:
+a.rb
+
+/cookbooks/cookbook1/files:
+a.rb
+b.json
+c
+
+/cookbooks/cookbook1/files/c:
+d.rb
+e.json
+
+/cookbooks/cookbook1/libraries:
+a.rb
+
+/cookbooks/cookbook1/providers:
+a.rb
+c
+
+/cookbooks/cookbook1/providers/c:
+d.rb
+
+/cookbooks/cookbook1/recipes:
+a.rb
+
+/cookbooks/cookbook1/resources:
+a.rb
+c
+
+/cookbooks/cookbook1/resources/c:
+d.rb
+
+/cookbooks/cookbook1/templates:
+a.rb
+b.json
+c
+
+/cookbooks/cookbook1/templates/c:
+d.rb
+e.json
+EOM
+        end
+      end
+    end
+
+    when_the_repository "has a file in cookbooks/" do
+      file 'cookbooks/file', ''
+      it 'does not show up in list -R' do
+        pending "don't show files when only directories are allowed" do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+EOM
+        end
+      end
+    end
+
+    when_the_repository "has a file in data_bags/" do
+      file 'data_bags/file', ''
+      it 'does not show up in list -R' do
+        pending "don't show files when only directories are allowed" do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+data_bags
+
+/data_bags:
+EOM
+        end
+      end
+    end
+  end
+
+  context 'chefignore tests' do
+    when_the_repository "has lots of stuff in it" do
+      file 'roles/x.json', {}
+      file 'environments/x.json', {}
+      file 'data_bags/bag1/x.json', {}
+      file 'cookbooks/cookbook1/x.json', {}
+
+      context "and has a chefignore everywhere except cookbooks" do
+        chefignore = "x.json\nroles/x.json\nenvironments/x.json\ndata_bags/bag1/x.json\nbag1/x.json\ncookbooks/cookbook1/x.json\ncookbook1/x.json\n"
+        file 'chefignore', chefignore
+        file 'roles/chefignore', chefignore
+        file 'environments/chefignore', chefignore
+        file 'data_bags/chefignore', chefignore
+        file 'data_bags/bag1/chefignore', chefignore
+        file 'cookbooks/cookbook1/chefignore', chefignore
+
+        it 'nothing is ignored' do
+          # NOTE: many of the "chefignore" files should probably not show up
+          # themselves, but we have other tests that talk about that
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+data_bags
+environments
+roles
+
+/cookbooks:
+cookbook1
+
+/cookbooks/cookbook1:
+chefignore
+x.json
+
+/data_bags:
+bag1
+chefignore
+
+/data_bags/bag1:
+chefignore
+x.json
+
+/environments:
+chefignore
+x.json
+
+/roles:
+chefignore
+x.json
+EOM
+        end
+      end
+    end
+
+    when_the_repository 'has a cookbook with only chefignored files' do
+      file 'cookbooks/cookbook1/templates/default/x.rb', ''
+      file 'cookbooks/cookbook1/libraries/x.rb', ''
+      file 'cookbooks/chefignore', "libraries/x.rb\ntemplates/default/x.rb\n"
+
+      it 'the cookbook is not listed' do
+        knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+EOM
+      end
+    end
+
+    when_the_repository "has multiple cookbooks" do
+      file 'cookbooks/cookbook1/x.json', {}
+      file 'cookbooks/cookbook1/y.json', {}
+      file 'cookbooks/cookbook2/x.json', {}
+      file 'cookbooks/cookbook2/y.json', {}
+
+      context 'and has a chefignore with filenames' do
+        file 'cookbooks/chefignore', "x.json\n"
+
+        it 'matching files and directories get ignored in all cookbooks' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+y.json
+
+/cookbooks/cookbook2:
+y.json
+EOM
+        end
+      end
+
+      context "and has a chefignore with wildcards" do
+        file 'cookbooks/chefignore', "x.*\n"
+        file 'cookbooks/cookbook1/x.rb', ''
+
+        it 'matching files and directories get ignored in all cookbooks' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+y.json
+
+/cookbooks/cookbook2:
+y.json
+EOM
+        end
+      end
+
+      context "and has a chefignore with relative paths" do
+        file 'cookbooks/cookbook1/recipes/x.rb', ''
+        file 'cookbooks/cookbook2/recipes/y.rb', ''
+        file 'cookbooks/chefignore', "recipes/x.rb\n"
+
+        it 'matching directories get ignored' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+x.json
+y.json
+
+/cookbooks/cookbook2:
+recipes
+x.json
+y.json
+
+/cookbooks/cookbook2/recipes:
+y.rb
+EOM
+        end
+      end
+
+      context "and has a chefignore with subdirectories" do
+        file 'cookbooks/cookbook1/recipes/y.rb', ''
+        file 'cookbooks/chefignore', "recipes\n"
+
+        it 'matching directories do NOT get ignored' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+recipes
+x.json
+y.json
+
+/cookbooks/cookbook1/recipes:
+y.rb
+
+/cookbooks/cookbook2:
+x.json
+y.json
+EOM
+        end
+      end
+
+      context "and has a chefignore that ignores all files in a subdirectory" do
+        file 'cookbooks/cookbook1/templates/default/x.rb', ''
+        file 'cookbooks/cookbook1/libraries/x.rb', ''
+        file 'cookbooks/chefignore', "libraries/x.rb\ntemplates/default/x.rb\n"
+
+        it 'ignores the subdirectory entirely' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+x.json
+y.json
+
+/cookbooks/cookbook2:
+x.json
+y.json
+EOM
+        end
+      end
+
+      context "and has an empty chefignore" do
+        file 'cookbooks/chefignore', "\n"
+
+        it 'nothing is ignored' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+x.json
+y.json
+
+/cookbooks/cookbook2:
+x.json
+y.json
+EOM
+        end
+      end
+
+      context "and has a chefignore with comments and empty lines" do
+        file 'cookbooks/chefignore', "\n\n # blah\n#\nx.json\n\n"
+
+        it 'matching files and directories get ignored in all cookbooks' do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+cookbook1
+cookbook2
+
+/cookbooks/cookbook1:
+y.json
+
+/cookbooks/cookbook2:
+y.json
+EOM
+        end
+      end
+    end
+
+    when_the_repository "has multiple cookbook paths" do
+      before :each do
+        Chef::Config.cookbook_path = [
+          File.join(Chef::Config.chef_repo_path, 'cookbooks1'),
+          File.join(Chef::Config.chef_repo_path, 'cookbooks2')
+        ]
+      end
+
+      file 'cookbooks1/mycookbook/metadata.rb', ''
+      file 'cookbooks1/mycookbook/x.json', {}
+      file 'cookbooks2/yourcookbook/metadata.rb', ''
+      file 'cookbooks2/yourcookbook/x.json', ''
+
+      context "and multiple chefignores" do
+        file 'cookbooks1/chefignore', "metadata.rb\n"
+        file 'cookbooks2/chefignore', "x.json\n"
+        it "chefignores apply only to the directories they are in" do
+          knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+mycookbook
+yourcookbook
+
+/cookbooks/mycookbook:
+x.json
+
+/cookbooks/yourcookbook:
+metadata.rb
+EOM
+        end
+
+        context "and conflicting cookbooks" do
+          file 'cookbooks1/yourcookbook/metadata.rb', ''
+          file 'cookbooks1/yourcookbook/x.json', ''
+          file 'cookbooks1/yourcookbook/onlyincookbooks1.rb', ''
+          file 'cookbooks2/yourcookbook/onlyincookbooks2.rb', ''
+
+          it "chefignores apply only to the winning cookbook" do
+            knife('list --local -R /').should_succeed <<EOM
+/:
+cookbooks
+
+/cookbooks:
+chefignore
+mycookbook
+yourcookbook
+
+/cookbooks/mycookbook:
+x.json
+
+/cookbooks/yourcookbook:
+onlyincookbooks1.rb
+x.json
+EOM
+          end
+        end
+      end
+    end
+  end
+
+  # TODO alternate repo_path / *_path
+  # TODO multiple *_path
+  # TODO nonexistent repo_path / *_path
+  # TODO empty *_path
+end