knife-essentials 0.5.4 → 0.6

data/lib/chef_fs/file_system/base_fs_object.rb

@@ -40,10 +40,6 @@ module ChefFS
         true
       end
 
-      def content_type
-        :text
-      end
-
       def child(name)
         NonexistentFSObject.new(name, self)
       end
@@ -55,6 +51,43 @@ module ChefFS
         false
       end
 
+      # Override this if you have a special comparison algorithm that can tell
+      # you whether this entry is the same as another--either a quicker or a
+      # more reliable one.  Callers will use this to decide whether to upload,
+      # download or diff an object.
+      #
+      # You should not override this if you're going to do the standard
+      # +self.read == other.read+.  If you return +nil+, the caller will call
+      # +other.compare_to(you)+ instead.  Give them a chance :)
+      #
+      # ==== Parameters
+      #
+      # * +other+ - the entry to compare to
+      #
+      # ==== Returns
+      #
+      # * +[ are_same, value, other_value ]+
+      #   +are_same+ may be +true+, +false+ or +nil+ (which means "don't know").
+      #   +value+ and +other_value+ must either be the text of +self+ or +other+,
+      #   +:none+ (if the entry does not exist or has no value) or +nil+ if the
+      #   value was not retrieved.
+      # * +nil+ if a definitive answer cannot be had and nothing was retrieved.
+      #
+      # ==== Example
+      #
+      #     are_same, value, other_value = entry.compare_to(other)
+      #     if are_same.nil?
+      #       are_same, other_value, value = other.compare_to(entry)
+      #     end
+      #     if are_same.nil?
+      #       value = entry.read if value.nil?
+      #       other_value = entry.read if other_value.nil?
+      #       are_same = (value == other_value)
+      #     end
+      def compare_to(other)
+        return nil
+      end
+
       # Important directory attributes: name, parent, path, root
       # Overridable attributes: dir?, child(name), path_for_printing
       # Abstract: read, write, delete, children

data/lib/chef_fs/file_system/chef_repository_file_system_entry.rb

@@ -1,10 +1,17 @@
 require 'chef_fs/file_system/file_system_entry'
 require 'chef/cookbook/chefignore'
+require 'chef/cookbook/cookbook_version_loader'
+require 'chef/node'
+require 'chef/role'
+require 'chef/environment'
+require 'chef/data_bag_item'
+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
     class ChefRepositoryFileSystemEntry < FileSystemEntry
       def initialize(name, parent, file_path = nil)
         super(name, parent, file_path)
@@ -14,6 +21,24 @@ module ChefFS
         end
       end
 
+      attr_reader :chefignore
+
+      def chef_object
+        begin
+          if parent.path == "/cookbooks"
+            loader = Chef::Cookbook::CookbookVersionLoader.new(file_path, parent.chefignore)
+            loader.load_cookbooks
+            return loader.cookbook_version
+          end
+
+          # Otherwise the information to inflate the object, is in the file (json_class).
+          return Chef::JSONCompat.from_json(read)
+        rescue
+          Chef::Log.error("Could not read #{path_for_printing} into a Chef object: #{$!}")
+        end
+        nil
+      end
+
       def children
         @children ||= Dir.entries(file_path).select { |entry| entry != '.' && entry != '..' && !ignored?(entry) }
                                             .map { |entry| ChefRepositoryFileSystemEntry.new(entry, self) }

data/lib/chef_fs/file_system/cookbook_dir.rb

@@ -3,6 +3,7 @@ require 'chef_fs/file_system/cookbook_subdir'
 require 'chef_fs/file_system/cookbook_file'
 require 'chef_fs/file_system/not_found_error'
 require 'chef/cookbook_version'
+require 'chef/cookbook_uploader'
 
 module ChefFS
   module FileSystem
@@ -49,7 +50,8 @@ module ChefFS
       def can_have_child?(name, is_dir)
         # A cookbook's root may not have directories unless they are segment directories
         if is_dir
-          return name != 'root_files' && COOKBOOK_SEGMENT_INFO.keys.any? { |segment| segment.to_s == name }
+          return name != 'root_files' &&
+                 COOKBOOK_SEGMENT_INFO.keys.any? { |segment| segment.to_s == name }
         end
         true
       end
@@ -57,6 +59,7 @@ module ChefFS
       def children
         if @children.nil?
           @children = []
+          manifest = chef_object.manifest
           COOKBOOK_SEGMENT_INFO.each do |segment, segment_info|
             next unless manifest.has_key?(segment)
 
@@ -99,32 +102,63 @@ module ChefFS
         !!@versions
       end
 
+      def compare_to(other)
+        are_same = true
+        ChefFS::CommandLine::diff_entries(self, other, nil, :name_only) do
+          are_same = false
+        end
+        [ are_same, nil, nil ]
+      end
+
+      def copy_from(other)
+        other_cookbook_version = other.chef_object
+        # TODO this only works on the file system.  And it can't be broken into
+        # pieces.
+        begin
+          Chef::CookbookUploader.new(other_cookbook_version, other.parent.file_path).upload_cookbook
+        rescue Net::HTTPServerException => e
+          case e.response.code
+          when "409"
+            ui.error "Version #{cookbook.version} of cookbook #{cookbook.name} is frozen. Use --force to override."
+            Log.debug(e)
+            raise Exceptions::CookbookFrozen
+          else
+            raise
+          end
+        end
+      end
+
       def rest
         parent.rest
       end
 
-      private
+      def chef_object
+        # We cheat and cache here, because it seems like a good idea to keep
+        # the cookbook view consistent with the directory structure.
+        return @chef_object if @chef_object
 
-      def manifest
         # The negative (not found) response is cached
-        if @could_not_get_manifest
-          raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_manifest), "#{path_for_printing} not found"
+        if @could_not_get_chef_object
+          raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_chef_object), "#{path_for_printing} not found"
         end
 
         begin
           # We want to fail fast, for now, because of the 500 issue :/
-          # This will make things worse for parallelism, a little.
+          # This will make things worse for parallelism, a little, because
+          # Chef::Config is global and this could affect other requests while
+          # this request is going on.  (We're not parallel yet, but we will be.)
+          # Chef bug http://tickets.opscode.com/browse/CHEF-3066
           old_retry_count = Chef::Config[:http_retry_count]
           begin
             Chef::Config[:http_retry_count] = 0
-            @manifest ||= rest.get_rest(api_path).manifest
+            @chef_object ||= rest.get_rest(api_path)
           ensure
             Chef::Config[:http_retry_count] = old_retry_count
           end
         rescue Net::HTTPServerException
           if $!.response.code == "404"
-            @could_not_get_manifest = $!
-            raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_manifest), "#{path_for_printing} not found"
+            @could_not_get_chef_object = $!
+            raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_chef_object), "#{path_for_printing} not found"
           else
             raise
           end
@@ -133,8 +167,8 @@ module ChefFS
         # Remove this when that bug is fixed.
         rescue Net::HTTPFatalError
           if $!.response.code == "500"
-            @could_not_get_manifest = $!
-            raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_manifest), "#{path_for_printing} not found"
+            @could_not_get_chef_object = $!
+            raise ChefFS::FileSystem::NotFoundError.new(@could_not_get_chef_object), "#{path_for_printing} not found"
           else
             raise
           end

data/lib/chef_fs/file_system/cookbook_file.rb

@@ -1,4 +1,5 @@
 require 'chef_fs/file_system/base_fs_object'
+require 'digest/md5'
 
 module ChefFS
   module FileSystem
@@ -27,6 +28,31 @@ module ChefFS
       def rest
         parent.rest
       end
+
+      def compare_to(other)
+        other_value = nil
+        if other.respond_to?(:checksum)
+          other_checksum = other.checksum
+        else
+          begin
+            other_value = other.read
+          rescue ChefFS::FileSystem::NotFoundError
+            other_value = :none
+          end
+          other_checksum = calc_checksum(other_value)
+        end
+        [ checksum == other_checksum, nil, other_value ]
+      end
+
+      private
+
+      def calc_checksum(value)
+        begin
+          Digest::MD5.hexdigest(value)
+        rescue ChefFS::FileSystem::NotFoundError
+          nil
+        end
+      end
     end
   end
 end

data/lib/chef_fs/file_system/file_system_entry.rb

@@ -50,14 +50,14 @@ module ChefFS
 
       def read
         begin
-          IO.read(file_path)
+          File.open(file_path, "rb") {|f| f.read}
         rescue Errno::ENOENT
           raise ChefFS::FileSystem::NotFoundError.new($!), "#{file_path} not found"
         end
       end
 
       def write(content)
-        File.open(file_path, 'w') do |file|
+        File.open(file_path, 'wb') do |file|
           file.write(content)
         end
       end

data/lib/chef_fs/file_system/rest_list_entry.rb

@@ -43,8 +43,13 @@ module ChefFS
       end
 
       def read
+        Chef::JSONCompat.to_json_pretty(chef_object.to_hash)
+      end
+
+      def chef_object
         begin
-          Chef::JSONCompat.to_json_pretty(rest.get_rest(api_path).to_hash)
+          # REST will inflate the Chef object using json_class
+          rest.get_rest(api_path)
         rescue Net::HTTPServerException
           if $!.response.code == "404"
             raise ChefFS::FileSystem::NotFoundError.new($!), "#{path_for_printing} not found"
@@ -54,12 +59,19 @@ module ChefFS
         end
       end
 
-      def rest
-        parent.rest
+      def compare_to(other)
+        begin
+          other_value = other.read
+        rescue ChefFS::FileSystem::NotFoundError
+          return [ nil, nil, :none ]
+        end
+        value = chef_object.to_hash
+        are_same = (value == Chef::JSONCompat.from_json(other_value, :create_additions => false))
+        [ are_same, Chef::JSONCompat.to_json_pretty(value), other_value ]
       end
 
-      def content_type
-        :json
+      def rest
+        parent.rest
       end
 
       def write(file_contents)

data/lib/chef_fs/version.rb

@@ -1,4 +1,4 @@
 module ChefFS
-  VERSION = "0.5.4"
+  VERSION = "0.6"
 end
 

data/spec/chef_fs/diff_spec.rb

@@ -1,9 +1,8 @@
-require 'support/file_system_support'
-require 'chef_fs/diff'
+require 'support/spec_helper'
 require 'chef_fs/file_pattern'
 require 'chef_fs/command_line'
 
-describe ChefFS::Diff do
+describe 'diff' do
   include FileSystemSupport
 
 	context 'with two filesystems with all types of difference' do
@@ -61,79 +60,6 @@ describe ChefFS::Diff do
 				:file_in_a_dir_in_b => {}
 			}, /cannot_be_in_b/)
 		}
-		it 'diffable_leaves' do
-			diffable_leaves_should_yield_paths(a, b, nil,
-        %w(
-          /both_dirs/sub_both_dirs/subsub
-          /both_dirs/sub_both_files
-          /both_dirs/sub_both_files_different
-          /both_dirs/sub_dirs_empty_in_b_filled_in_a/subsub
-          /both_dirs/sub_dirs_empty_in_a_filled_in_b/subsub
-          /both_dirs/sub_a_only_dir
-          /both_dirs/sub_a_only_file
-          /both_dirs/sub_b_only_dir
-          /both_dirs/sub_b_only_file
-          /both_dirs/sub_dir_in_a_file_in_b
-          /both_dirs/sub_file_in_a_dir_in_b
-          /both_files
-          /both_files_different
-          /dirs_empty_in_b_filled_in_a/subsub
-          /dirs_empty_in_a_filled_in_b/subsub
-          /dirs_in_a_cannot_be_in_b
-          /dirs_in_b_cannot_be_in_a
-          /file_in_a_cannot_be_in_b
-          /file_in_b_cannot_be_in_a
-          /a_only_dir
-          /a_only_file
-          /b_only_dir
-          /b_only_file
-          /dir_in_a_file_in_b
-          /file_in_a_dir_in_b
-        ))
-		end
-    it 'diffable_leaves_from_pattern(/**file*)' do
-      diffable_leaves_from_pattern_should_yield_paths(pattern('/**file*'), a, b, nil,
-        %w(
-          /both_dirs/sub_both_files
-          /both_dirs/sub_both_files_different
-          /both_dirs/sub_a_only_file
-          /both_dirs/sub_b_only_file
-          /both_dirs/sub_dir_in_a_file_in_b
-          /both_dirs/sub_file_in_a_dir_in_b
-          /both_files
-          /both_files_different
-          /file_in_a_cannot_be_in_b
-          /file_in_b_cannot_be_in_a
-          /a_only_file
-          /b_only_file
-          /dir_in_a_file_in_b
-          /file_in_a_dir_in_b
-        ))
-    end
-    it 'diffable_leaves_from_pattern(/*dir*)' do
-      diffable_leaves_from_pattern_should_yield_paths(pattern('/*dir*'), a, b, nil,
-        %w(
-          /both_dirs/sub_both_dirs/subsub
-          /both_dirs/sub_both_files
-          /both_dirs/sub_both_files_different
-          /both_dirs/sub_dirs_empty_in_b_filled_in_a/subsub
-          /both_dirs/sub_dirs_empty_in_a_filled_in_b/subsub
-          /both_dirs/sub_a_only_dir
-          /both_dirs/sub_a_only_file
-          /both_dirs/sub_b_only_dir
-          /both_dirs/sub_b_only_file
-          /both_dirs/sub_dir_in_a_file_in_b
-          /both_dirs/sub_file_in_a_dir_in_b
-          /dirs_empty_in_b_filled_in_a/subsub
-          /dirs_empty_in_a_filled_in_b/subsub
-          /dirs_in_a_cannot_be_in_b
-          /dirs_in_b_cannot_be_in_a
-          /a_only_dir
-          /b_only_dir
-          /dir_in_a_file_in_b
-          /file_in_a_dir_in_b
-        ))
-    end
     it 'ChefFS::CommandLine.diff(/)' do
       results = []
       ChefFS::CommandLine.diff(pattern('/'), a, b, nil, nil) do |diff|
@@ -373,4 +299,4 @@ new file
       ]
     end
   end
-end
+end

data/spec/chef_fs/file_pattern_spec.rb

@@ -1,3 +1,4 @@
+require 'support/spec_helper'
 require 'chef_fs/file_pattern'
 
 describe ChefFS::FilePattern do
@@ -487,7 +488,7 @@ describe ChefFS::FilePattern do
 	#  - ?, *, characters, **
 
 	# could_match_children?
-	# 
+	#
 	#
 	#
 	#
@@ -504,4 +505,4 @@ describe ChefFS::FilePattern do
 	end
 
 	# Exercise the different methods to their maximum
-end
+end

data/spec/chef_fs/file_system/chef_server_root_dir_spec.rb

@@ -1,3 +1,4 @@
+require 'support/spec_helper'
 require 'chef_fs/file_system/chef_server_root_dir'
 
 describe ChefFS::FileSystem::ChefServerRootDir do

data/spec/chef_fs/file_system/cookbooks_dir_spec.rb

@@ -1,3 +1,4 @@
+require 'support/spec_helper'
 require 'chef_fs/file_system/chef_server_root_dir'
 require 'chef_fs/file_system'
 
@@ -546,4 +547,4 @@ describe ChefFS::FileSystem::CookbooksDir do
     end
   end
 
-end
+end

data/spec/chef_fs/file_system/data_bags_dir_spec.rb

@@ -1,3 +1,4 @@
+require 'support/spec_helper'
 require 'chef_fs/file_system/chef_server_root_dir'
 
 describe ChefFS::FileSystem::DataBagsDir do
@@ -198,4 +199,4 @@ describe ChefFS::FileSystem::DataBagsDir do
     end
   end
 
-end
+end