knife-essentials 0.8.6 → 0.9.0

data/lib/chef_fs/data_handler/role_data_handler.rb

@@ -0,0 +1,38 @@
+require 'chef_fs/data_handler/data_handler_base'
+require 'chef/role'
+
+module ChefFS
+  module DataHandler
+    class RoleDataHandler < DataHandlerBase
+      def normalize(role, entry)
+        result = super(role, {
+          'name' => remove_dot_json(entry.name),
+          'description' => '',
+          'json_class' => 'Chef::Role',
+          'chef_type' => 'role',
+          'default_attributes' => {},
+          'override_attributes' => {},
+          'run_list' => [],
+          'env_run_lists' => {}
+        })
+        result['run_list'] = normalize_run_list(result['run_list'])
+        result['env_run_lists'].each_pair do |env, run_list|
+          result['env_run_lists'][env] = normalize_run_list(run_list)
+        end
+        result
+      end
+
+      def preserve_key(key)
+        return key == 'name'
+      end
+
+      def chef_class
+        Chef::Role
+      end
+
+      def to_ruby(object)
+        to_ruby_keys(object, %w(name description default_attributes override_attributes run_list env_run_lists))
+      end
+    end
+  end
+end

data/lib/chef_fs/data_handler/user_data_handler.rb

@@ -0,0 +1,20 @@
+require 'chef_fs/data_handler/data_handler_base'
+
+module ChefFS
+  module DataHandler
+    class UserDataHandler < DataHandlerBase
+      def normalize(user, entry)
+        super(user, {
+          'name' => remove_dot_json(entry.name),
+          'admin' => false
+        })
+      end
+
+      def preserve_key(key)
+        return key == 'name'
+      end
+
+      # There is no chef_class for users, nor does to_ruby work.
+    end
+  end
+end

data/lib/chef_fs/file_system.rb

@@ -18,6 +18,7 @@
 
 require 'chef_fs/path_utils'
 require 'chef_fs/file_system/default_environment_cannot_be_modified_error'
+require 'chef_fs/file_system/operation_failed_error'
 require 'chef_fs/file_system/operation_not_allowed_error'
 
 module ChefFS
@@ -350,6 +351,9 @@ module ChefFS
         end
       rescue DefaultEnvironmentCannotBeModifiedError => e
         ui.warn "#{format_path.call(e.entry)} #{e.reason}."
+      rescue OperationFailedError => e
+        ui.error "#{format_path.call(e.entry)} failed to #{e.operation}: #{e.message}"
+        error = true
       rescue OperationNotAllowedError => e
         ui.error "#{format_path.call(e.entry)} #{e.reason}."
         error = true

data/lib/chef_fs/file_system/chef_repository_file_system_entry.rb

@@ -24,9 +24,9 @@ module ChefFS
     # ChefRepositoryFileSystemEntry works just like FileSystemEntry,
     # except can inflate Chef objects
     class ChefRepositoryFileSystemEntry < FileSystemEntry
-      def initialize(name, parent, file_path = nil, json_class = nil)
+      def initialize(name, parent, file_path = nil, data_handler = nil)
         super(name, parent, file_path)
-        @json_class = json_class
+        @data_handler = data_handler
       end
 
       def chefignore
@@ -37,8 +37,8 @@ module ChefFS
         parent.ignore_empty_directories?
       end
 
-      def json_class
-        @json_class || parent.json_class
+      def data_handler
+        @data_handler || parent.data_handler
       end
 
       def chef_object
@@ -50,9 +50,7 @@ module ChefFS
           end
 
           # Otherwise, inflate the file using the chosen JSON class (if any)
-          if json_class
-            return json_class.json_create(JSON.parse(read, :create_additions => false))
-          end
+          return data_handler.chef_object(JSON.parse(read, :create_additions => false))
         rescue
           Chef::Log.error("Could not read #{path_for_printing} into a Chef object: #{$!}")
         end

data/lib/chef_fs/file_system/chef_repository_file_system_root_dir.rb

@@ -20,11 +20,12 @@ 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'
-require 'chef/api_client'
-require 'chef/data_bag_item'
-require 'chef/environment'
-require 'chef/node'
-require 'chef/role'
+require 'chef_fs/data_handler/client_data_handler'
+require 'chef_fs/data_handler/data_bag_item_data_handler'
+require 'chef_fs/data_handler/environment_data_handler'
+require 'chef_fs/data_handler/node_data_handler'
+require 'chef_fs/data_handler/role_data_handler'
+require 'chef_fs/data_handler/user_data_handler'
 
 module ChefFS
   module FileSystem
@@ -75,23 +76,23 @@ module ChefFS
         if name == 'cookbooks'
           dirs = paths.map { |path| ChefRepositoryFileSystemCookbooksDir.new(name, self, path) }
         else
-          json_class = case name
+          data_handler = case name
             when 'clients'
-              Chef::ApiClient
+              ChefFS::DataHandler::ClientDataHandler.new
             when 'data_bags'
-              Chef::DataBagItem
+              ChefFS::DataHandler::DataBagItemDataHandler.new
             when 'environments'
-              Chef::Environment
+              ChefFS::DataHandler::EnvironmentDataHandler.new
             when 'nodes'
-              Chef::Node
+              ChefFS::DataHandler::NodeDataHandler.new
             when 'roles'
-              Chef::Role
+              ChefFS::DataHandler::RoleDataHandler.new
             when 'users'
-              nil
+              ChefFS::DataHandler::UserDataHandler.new
             else
               raise "Unknown top level path #{name}"
             end
-          dirs = paths.map { |path| ChefRepositoryFileSystemEntry.new(name, self, path, json_class) }
+          dirs = paths.map { |path| ChefRepositoryFileSystemEntry.new(name, self, path, data_handler) }
         end
         MultiplexedDir.new(dirs)
       end

data/lib/chef_fs/file_system/chef_server_root_dir.rb

@@ -23,6 +23,9 @@ require 'chef_fs/file_system/data_bags_dir'
 require 'chef_fs/file_system/nodes_dir'
 require 'chef_fs/file_system/environments_dir'
 require 'chef/rest'
+require 'chef_fs/data_handler/client_data_handler'
+require 'chef_fs/data_handler/role_data_handler'
+require 'chef_fs/data_handler/user_data_handler'
 
 module ChefFS
   module FileSystem
@@ -65,13 +68,13 @@ module ChefFS
             CookbooksDir.new(self),
             DataBagsDir.new(self),
             EnvironmentsDir.new(self),
-            RestListDir.new("roles", self)
+            RestListDir.new("roles", self, nil, ChefFS::DataHandler::RoleDataHandler.new)
           ]
           if repo_mode == 'everything'
             result += [
-              RestListDir.new("clients", self),
+              RestListDir.new("clients", self, nil, ChefFS::DataHandler::ClientDataHandler.new),
               NodesDir.new(self),
-              RestListDir.new("users", self)
+              RestListDir.new("users", self, nil, ChefFS::DataHandler::UserDataHandler.new)
             ]
           end
           result.sort_by { |child| child.name }

data/lib/chef_fs/file_system/cookbook_file.rb

@@ -71,11 +71,7 @@ module ChefFS
       private
 
       def calc_checksum(value)
-        begin
-          Digest::MD5.hexdigest(value)
-        rescue ChefFS::FileSystem::NotFoundError
-          nil
-        end
+        Digest::MD5.hexdigest(value)
       end
     end
   end

data/lib/chef_fs/file_system/data_bag_dir.rb

@@ -20,12 +20,13 @@ require 'chef_fs/file_system/rest_list_dir'
 require 'chef_fs/file_system/data_bag_item'
 require 'chef_fs/file_system/not_found_error'
 require 'chef_fs/file_system/must_delete_recursively_error'
+require 'chef_fs/data_handler/data_bag_item_data_handler'
 
 module ChefFS
   module FileSystem
     class DataBagDir < RestListDir
       def initialize(name, parent, exists = nil)
-        super(name, parent)
+        super(name, parent, nil, ChefFS::DataHandler::DataBagItemDataHandler.new)
         @exists = nil
       end
 
@@ -45,14 +46,8 @@ module ChefFS
         @exists
       end
 
-      def create_child(name, file_contents)
-        json = Chef::JSONCompat.from_json(file_contents).to_hash
-        id = name[0,name.length-5]
-        if json.include?('id') && json['id'] != id
-          raise "ID in #{path_for_printing}/#{name} must be '#{id}' (is '#{json['id']}')"
-        end
-        rest.post_rest(api_path, json)
-        _make_child_entry(name, true)
+      def identity_key
+        'id'
       end
 
       def _make_child_entry(name, exists = nil)

data/lib/chef_fs/file_system/data_bag_item.rb

@@ -52,6 +52,12 @@ module ChefFS
           end
         end
       end
+
+      def normalize_value(value)
+        data_handler.minimize(
+          data_handler.normalize(value, parent.name, api_child_name),
+          parent.name, api_child_name)
+      end
     end
   end
 end

data/lib/chef_fs/file_system/environments_dir.rb

@@ -20,12 +20,13 @@ require 'chef_fs/file_system/base_fs_dir'
 require 'chef_fs/file_system/rest_list_entry'
 require 'chef_fs/file_system/not_found_error'
 require 'chef_fs/file_system/default_environment_cannot_be_modified_error'
+require 'chef_fs/data_handler/environment_data_handler'
 
 module ChefFS
   module FileSystem
     class EnvironmentsDir < RestListDir
       def initialize(parent)
-        super("environments", parent)
+        super("environments", parent, nil, ChefFS::DataHandler::EnvironmentDataHandler.new)
       end
 
       def _make_child_entry(name, exists = nil)

data/lib/chef_fs/file_system/file_system_error.rb

@@ -19,10 +19,12 @@
 module ChefFS
   module FileSystem
     class FileSystemError < StandardError
-      def initialize(cause = nil)
+      def initialize(entry, cause = nil)
+        @entry = entry
         @cause = cause
       end
 
+      attr_reader :entry
       attr_reader :cause
     end
   end

data/lib/chef_fs/file_system/must_delete_recursively_error.rb

@@ -22,11 +22,8 @@ module ChefFS
   module FileSystem
     class MustDeleteRecursivelyError < FileSystemError
       def initialize(entry, cause = nil)
-        super(cause)
-        @entry = entry
+        super(entry, cause)
       end
-
-      attr_reader :entry
     end
   end
 end

data/lib/chef_fs/file_system/nodes_dir.rb

@@ -19,12 +19,13 @@
 require 'chef_fs/file_system/base_fs_dir'
 require 'chef_fs/file_system/rest_list_entry'
 require 'chef_fs/file_system/not_found_error'
+require 'chef_fs/data_handler/node_data_handler'
 
 module ChefFS
   module FileSystem
     class NodesDir < RestListDir
       def initialize(parent)
-        super("nodes", parent)
+        super("nodes", parent, nil, ChefFS::DataHandler::NodeDataHandler.new)
       end
 
       # Override children to respond to environment

data/lib/chef_fs/file_system/not_found_error.rb

@@ -22,11 +22,8 @@ module ChefFS
   module FileSystem
     class NotFoundError < FileSystemError
       def initialize(entry, cause = nil)
-        super(cause)
-        @entry = entry
+        super(entry, cause)
       end
-
-      attr_reader :entry
     end
   end
 end

data/lib/chef_fs/file_system/operation_failed_error.rb

@@ -0,0 +1,32 @@
+#
+# 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_error'
+
+module ChefFS
+  module FileSystem
+    class OperationFailedError < FileSystemError
+      def initialize(operation, entry, cause = nil)
+        super(entry, cause)
+        @operation = operation
+      end
+
+      attr_reader :operation
+    end
+  end
+end

data/lib/chef_fs/file_system/operation_not_allowed_error.rb

@@ -22,9 +22,8 @@ module ChefFS
   module FileSystem
     class OperationNotAllowedError < FileSystemError
       def initialize(operation, entry, cause = nil)
-        super(cause)
+        super(entry, cause)
         @operation = operation
-        @entry = entry
       end
 
       attr_reader :operation

data/lib/chef_fs/file_system/rest_list_dir.rb

@@ -23,12 +23,14 @@ require 'chef_fs/file_system/not_found_error'
 module ChefFS
   module FileSystem
     class RestListDir < BaseFSDir
-      def initialize(name, parent, api_path = nil)
+      def initialize(name, parent, api_path = nil, data_handler = nil)
         super(name, parent)
         @api_path = api_path || (parent.api_path == "" ? name : "#{parent.api_path}/#{name}")
+        @data_handler = data_handler
       end
 
       attr_reader :api_path
+      attr_reader :data_handler
 
       def child(name)
         result = @children.select { |child| child.name == name }.first if @children
@@ -54,16 +56,41 @@ module ChefFS
         end
       end
 
+      def identity_key
+        'name'
+      end
+
       # NOTE if you change this significantly, you will likely need to change
       # DataBagDir.create_child as well.
       def create_child(name, file_contents)
-        json = Chef::JSONCompat.from_json(file_contents).to_hash
+        begin
+          object = Chef::JSONCompat.from_json(file_contents).to_hash
+        rescue JSON::ParserError => e
+          raise ChefFS::FileSystem::OperationFailedError.new(:create_child, self, e), "Parse error reading JSON creating child '#{name}': #{e}"
+        end
+
+        result = _make_child_entry(name, true)
+
+        if data_handler
+          object = data_handler.normalize(object, result)
+        end
+
         base_name = name[0,name.length-5]
-        if json.include?('name') && json['name'] != base_name
-          raise "Name in #{path_for_printing}/#{name} must be '#{base_name}' (is '#{json['name']}')"
+        if object[identity_key] != base_name
+          raise ChefFS::FileSystem::OperationFailedError.new(:create_child, self), "Name in #{path_for_printing}/#{name} must be '#{base_name}' (is '#{object[identity_key]}')"
         end
-        rest.post_rest(api_path, json)
-        _make_child_entry(name, true)
+
+        begin
+          rest.post_rest(api_path, object)
+        rescue Net::HTTPServerException => e
+          if e.response.code == "404"
+            raise ChefFS::FileSystem::NotFoundError.new(self, e)
+          else
+            raise ChefFS::FileSystem::OperationFailedError.new(:create_child, self, e), "Failure creating '#{name}': #{e.message}"
+          end
+        end
+
+        result
       end
 
       def environment

data/lib/chef_fs/file_system/rest_list_entry.rb

@@ -18,6 +18,7 @@
 
 require 'chef_fs/file_system/base_fs_object'
 require 'chef_fs/file_system/not_found_error'
+require 'chef_fs/file_system/operation_failed_error'
 require 'chef/role'
 require 'chef/node'
 
@@ -29,11 +30,18 @@ module ChefFS
         @exists = exists
       end
 
-      def api_path
+      def data_handler
+        parent.data_handler
+      end
+
+      def api_child_name
         if name.length < 5 || name[-5,5] != ".json"
           raise "Invalid name #{path}: must end in .json"
         end
-        api_child_name = name[0,name.length-5]
+        name[0,name.length-5]
+      end
+
+      def api_path
         "#{parent.api_path}/#{api_child_name}"
       end
 
@@ -65,7 +73,8 @@ module ChefFS
       end
 
       def read
-        Chef::JSONCompat.to_json_pretty(chef_object.to_hash)
+        # Minimize the value so the results don't look terrible
+        Chef::JSONCompat.to_json_pretty(minimize_value(chef_object.to_hash))
       end
 
       def chef_object
@@ -81,19 +90,38 @@ module ChefFS
         end
       end
 
+      def minimize_value(value)
+        data_handler.minimize(data_handler.normalize(value, self), self)
+      end
+
       def compare_to(other)
+        # Grab the other value
         begin
-          other_value = other.read
+          other_value_json = other.read
         rescue ChefFS::FileSystem::NotFoundError
           return [ nil, nil, :none ]
         end
+
+        # Grab this value
         begin
           value = chef_object.to_hash
         rescue ChefFS::FileSystem::NotFoundError
-          return [ false, :none, other_value ]
+          return [ false, :none, other_value_json ]
+        end
+
+        # Minimize (and normalize) both values for easy and beautiful diffs
+        value = minimize_value(value)
+        value_json = Chef::JSONCompat.to_json_pretty(value)
+        begin
+          other_value = Chef::JSONCompat.from_json(other_value_json, :create_additions => false)
+        rescue JSON::ParserError => e
+          Chef::Log.warn("Parse error reading #{other.path_for_printing} as JSON: #{e}")
+          return [ nil, value_json, other_value_json ]
         end
-        are_same = (value == Chef::JSONCompat.from_json(other_value, :create_additions => false))
-        [ are_same, Chef::JSONCompat.to_json_pretty(value), other_value ]
+        other_value = minimize_value(other_value)
+        other_value_json = Chef::JSONCompat.to_json_pretty(other_value)
+
+        [ value == other_value, value_json, other_value_json ]
       end
 
       def rest
@@ -101,18 +129,28 @@ module ChefFS
       end
 
       def write(file_contents)
-        json = Chef::JSONCompat.from_json(file_contents).to_hash
+        begin
+          object = Chef::JSONCompat.from_json(file_contents).to_hash
+        rescue JSON::ParserError => e
+          raise ChefFS::FileSystem::OperationFailedError.new(:write, self, e), "Parse error reading JSON: #{e}"
+        end
+
+        if data_handler
+          object = data_handler.normalize(object, self)
+        end
+
         base_name = name[0,name.length-5]
-        if json['name'] != base_name
-          raise "Name in #{path_for_printing}/#{name} must be '#{base_name}' (is '#{json['name']}')"
+        if object['name'] != base_name
+          raise ChefFS::FileSystem::OperationFailedError.new(:write, self), "Name in #{path_for_printing}/#{name} must be '#{base_name}' (is '#{object['name']}')"
         end
+
         begin
-          rest.put_rest(api_path, json)
-        rescue Net::HTTPServerException
-          if $!.response.code == "404"
-            raise ChefFS::FileSystem::NotFoundError.new(self, $!)
+          rest.put_rest(api_path, object)
+        rescue Net::HTTPServerException => e
+          if e.response.code == "404"
+            raise ChefFS::FileSystem::NotFoundError.new(self, e)
           else
-            raise
+            raise ChefFS::FileSystem::OperationFailedError.new(:write, self, e)
           end
         end
       end