knife-essentials 0.3.1 → 0.4

data/lib/chef/knife/diff.rb

@@ -12,12 +12,30 @@ class Chef
         :default => true,
         :description => "List directories recursively."
 
+      option :name_only,
+        :long => '--name-only',
+        :boolean => true,
+        :description => "Only show names of modified files."
+
+      option :name_status,
+        :long => '--name-status',
+        :boolean => true,
+        :description => "Only show names and statuses of modified files: Added, Deleted, Modified, and Type Changed."
+
+      common_options
+
       def run
+        if config[:name_only]
+          output_mode = :name_only
+        end
+        if config[:name_status]
+          output_mode = :name_status
+        end
         patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
 
         # Get the matches (recursively)
         patterns.each do |pattern|
-          ChefFS::CommandLine.diff(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1) do |diff|
+          ChefFS::CommandLine.diff(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, output_mode) do |diff|
             puts diff
           end
         end

data/lib/chef_fs/command_line.rb

@@ -2,11 +2,11 @@ require 'chef_fs/diff'
 
 module ChefFS
   module CommandLine
-    def self.diff(pattern, a_root, b_root, recurse_depth)
+    def self.diff(pattern, a_root, b_root, recurse_depth, output_mode)
       found_result = false
       ChefFS::Diff::diffable_leaves_from_pattern(pattern, a_root, b_root, recurse_depth) do |a_leaf, b_leaf|
         found_result = true
-        diff = diff_leaves(a_leaf, b_leaf)
+        diff = diff_leaves(a_leaf, b_leaf, output_mode)
         yield diff if diff != ''
       end
       if !found_result && pattern.exact_path
@@ -17,27 +17,53 @@ module ChefFS
     private
 
     # Diff two known leaves (could be files or dirs)
-    def self.diff_leaves(old_file, new_file)
+    def self.diff_leaves(old_file, new_file, output_mode)
       result = ''
       # If both are directories
       # If old is a directory and new is a file
       # If old is a directory and new does not exist
       if old_file.dir?
         if new_file.dir?
-          result << "Common subdirectories: #{old_file.path}\n"
+          if output_mode != :name_only && output_mode != :name_status
+            result << "Common subdirectories: #{old_file.path}\n"
+          end
         elsif new_file.exists?
-          result << "File #{new_file.path_for_printing} is a directory while file #{new_file.path_for_printing} is a regular file\n"
+          if output_mode == :name_only
+            result << "#{new_file.path_for_printing}\n"
+          elsif output_mode == :name_status
+            result << "T\t#{new_file.path_for_printing}\n"
+          else
+            result << "File #{new_file.path_for_printing} is a directory while file #{new_file.path_for_printing} is a regular file\n"
+          end
         elsif new_file.parent.can_have_child?(old_file.name, old_file.dir?)
-          result << "Only in #{old_file.parent.path_for_printing}: #{old_file.name}\n"
+          if output_mode == :name_only
+            result << "#{new_file.path_for_printing}\n"
+          elsif output_mode == :name_status
+            result << "D\t#{new_file.path_for_printing}\n"
+          else
+            result << "Only in #{old_file.parent.path_for_printing}: #{old_file.name}\n"
+          end
         end
 
       # If new is a directory and old does not exist
       # If new is a directory and old is a file
       elsif new_file.dir?
         if old_file.exists?
-          result << "File #{old_file.path_for_printing} is a regular file while file #{old_file.path_for_printing} is a directory\n"
+          if output_mode == :name_only
+            result << "#{new_file.path_for_printing}\n"
+          elsif output_mode == :name_status
+            result << "T\t#{new_file.path_for_printing}\n"
+          else
+            result << "File #{old_file.path_for_printing} is a regular file while file #{old_file.path_for_printing} is a directory\n"
+          end
         elsif old_file.parent.can_have_child?(new_file.name, new_file.dir?)
-          result << "Only in #{new_file.parent.path_for_printing}: #{new_file.name}\n"
+          if output_mode == :name_only
+            result << "#{new_file.path_for_printing}\n"
+          elsif output_mode == :name_status
+            result << "A\t#{new_file.path_for_printing}\n"
+          else
+            result << "Only in #{new_file.parent.path_for_printing}: #{new_file.name}\n"
+          end
         end
 
       else
@@ -45,7 +71,7 @@ module ChefFS
         different, old_value, new_value = ChefFS::Diff::diff_files(old_file, new_file)
         if different
           # If one of the files doesn't exist, we only want to print the diff if the
-          # other file *could be synced*.
+          # other file *could be uploaded/downloaded*.
           if !old_value && !old_file.parent.can_have_child?(new_file.name, new_file.dir?)
             return result
           end
@@ -53,20 +79,32 @@ module ChefFS
             return result
           end
 
-          old_path = old_file.path_for_printing
-          new_path = new_file.path_for_printing
-          result << "diff --knife #{old_path} #{new_path}\n"
-          if !old_value
-            result << "new file\n"
-            old_path = "/dev/null"
-            old_value = ''
-          end
-          if !new_value
-            result << "deleted file\n"
-            new_path = "/dev/null"
-            new_value = ''
+          if output_mode == :name_only
+            result << "#{new_file.path_for_printing}\n"
+          elsif output_mode == :name_status
+            if !old_value
+              result << "A\t#{new_file.path_for_printing}\n"
+            elsif !new_value
+              result << "D\t#{new_file.path_for_printing}\n"
+            else
+              result << "M\t#{new_file.path_for_printing}\n"
+            end
+          else
+            old_path = old_file.path_for_printing
+            new_path = new_file.path_for_printing
+            result << "diff --knife #{old_path} #{new_path}\n"
+            if !old_value
+              result << "new file\n"
+              old_path = "/dev/null"
+              old_value = ''
+            end
+            if !new_value
+              result << "deleted file\n"
+              new_path = "/dev/null"
+              new_value = ''
+            end
+            result << diff_text(old_path, new_path, old_value, new_value)
           end
-          result << diff_text(old_path, new_path, old_value, new_value)
         end
       end
       return result

data/lib/chef_fs/diff.rb

@@ -61,20 +61,20 @@ module ChefFS
       new_value = read_file_value(new_file) if new_value == :not_retrieved
 
       return false if old_value == new_value
-      return false if old_value && new_value && !context_aware_diff(old_file, new_file, old_value, new_value)
+      return false if old_value && new_value && context_aware_diff(old_file, new_file, old_value, new_value) == false
       return [ true, old_value, new_value ]
     end
 
     def self.context_aware_diff(old_file, new_file, old_value, new_value)
-      # TODO handle errors in reading JSON
       if old_file.content_type == :json || new_file.content_type == :json
-        new_value = Chef::JSONCompat.from_json(new_value).to_hash
-        old_value = Chef::JSONCompat.from_json(old_value).to_hash
-
-        old_value != new_value
-      else
-        true
+        begin
+          new_value = Chef::JSONCompat.from_json(new_value).to_hash
+          old_value = Chef::JSONCompat.from_json(old_value).to_hash
+          return old_value != new_value
+        rescue JSON::ParserError
+        end
       end
+      return nil
     end
 
     # Gets all common leaves, recursively, starting from the results of

data/lib/chef_fs/file_system/chef_server_root_dir.rb

@@ -7,12 +7,13 @@ require 'chef_fs/file_system/nodes_dir'
 module ChefFS
   module FileSystem
     class ChefServerRootDir < BaseFSDir
-      def initialize(root_name, config)
+      def initialize(root_name, chef_config, repo_mode)
         super("", nil)
-        @chef_server_url = config[:chef_server_url]
-        @chef_username = config[:node_name]
-        @chef_private_key = config[:client_key]
-        @environment = config[:environment]
+        @chef_server_url = chef_config[:chef_server_url]
+        @chef_username = chef_config[:node_name]
+        @chef_private_key = chef_config[:client_key]
+        @environment = chef_config[:environment]
+        @repo_mode = repo_mode
         @root_name = root_name
       end
 
@@ -20,6 +21,7 @@ module ChefFS
       attr_reader :chef_username
       attr_reader :chef_private_key
       attr_reader :environment
+      attr_reader :repo_mode
 
       def rest
         Chef::REST.new(chef_server_url, chef_username, chef_private_key)
@@ -38,15 +40,21 @@ module ChefFS
       end
 
       def children
-        @children ||= [
-          RestListDir.new("clients", self),
-          CookbooksDir.new(self),
-          DataBagsDir.new(self),
-          RestListDir.new("environments", self),
-          NodesDir.new(self),
-          RestListDir.new("roles", self),
-  #        RestListDir.new("sandboxes", self)
-        ]
+        @children ||= begin
+          result = [
+            CookbooksDir.new(self),
+            DataBagsDir.new(self),
+            RestListDir.new("environments", self),
+            RestListDir.new("roles", self)
+          ]
+          if repo_mode == 'everything'
+            result += [
+              RestListDir.new("clients", self),
+              NodesDir.new(self)
+            ]
+          end
+          result.sort_by { |child| child.name }
+        end
       end
     end
   end

data/lib/chef_fs/file_system/cookbook_subdir.rb

@@ -1,7 +1,5 @@
 require 'chef_fs/file_system/base_fs_dir'
 
-# TODO: take environment into account
-
 module ChefFS
   module FileSystem
     class CookbookSubdir < BaseFSDir

data/lib/chef_fs/knife.rb

@@ -6,12 +6,19 @@ require 'chef/config'
 
 module ChefFS
   class Knife < Chef::Knife
+    def self.common_options
+      option :repo_mode,
+        :long => '--repo-mode MODE',
+        :default => "default",
+        :description => "Specifies the local repository layout.  Values: default or full"
+    end
+
     def base_path
       @base_path ||= "/" + ChefFS::PathUtils::relative_to(File.absolute_path(Dir.pwd), chef_repo)
     end
 
     def chef_fs
-      @chef_fs ||= ChefFS::FileSystem::ChefServerRootDir.new("remote", Chef::Config)
+      @chef_fs ||= ChefFS::FileSystem::ChefServerRootDir.new("remote", Chef::Config, config[:repo_mode])
     end
 
     def chef_repo

data/lib/chef_fs/version.rb

@@ -1,4 +1,4 @@
 module ChefFS
-  VERSION = "0.3.1"
+  VERSION = "0.4"
 end
 

data/spec/chef_fs/diff_spec.rb

@@ -136,7 +136,7 @@ describe ChefFS::Diff do
     end
     it 'ChefFS::CommandLine.diff(/)' do
       results = []
-      ChefFS::CommandLine.diff(pattern('/'), a, b, nil) do |diff|
+      ChefFS::CommandLine.diff(pattern('/'), a, b, nil, nil) do |diff|
         results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
       end
       results.should =~ [
@@ -212,7 +212,7 @@ new file
     end
     it 'ChefFS::CommandLine.diff(/both_dirs)' do
       results = []
-      ChefFS::CommandLine.diff(pattern('/both_dirs'), a, b, nil) do |diff|
+      ChefFS::CommandLine.diff(pattern('/both_dirs'), a, b, nil, nil) do |diff|
         results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
       end
       results.should =~ [
@@ -254,7 +254,7 @@ new file
     end
     it 'ChefFS::CommandLine.diff(/) with depth 1' do
       results = []
-      ChefFS::CommandLine.diff(pattern('/'), a, b, 1) do |diff|
+      ChefFS::CommandLine.diff(pattern('/'), a, b, 1, nil) do |diff|
         results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
       end
       results.should =~ [
@@ -288,7 +288,7 @@ new file
     end
     it 'ChefFS::CommandLine.diff(/*_*) with depth 0' do
       results = []
-      ChefFS::CommandLine.diff(pattern('/*_*'), a, b, 0) do |diff|
+      ChefFS::CommandLine.diff(pattern('/*_*'), a, b, 0, nil) do |diff|
         results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
       end
       results.should =~ [
@@ -320,5 +320,57 @@ new file
 +b_only_file
 ' ]
     end
+    it 'ChefFS::CommandLine.diff(/) in name-only mode' do
+      results = []
+      ChefFS::CommandLine.diff(pattern('/'), a, b, nil, :name_only) do |diff|
+        results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
+      end
+      results.should =~ [
+          "b/both_dirs/sub_both_files_different\n",
+          "b/both_dirs/sub_dirs_empty_in_b_filled_in_a/subsub\n",
+          "b/both_dirs/sub_dirs_empty_in_a_filled_in_b/subsub\n",
+          "b/both_dirs/sub_a_only_dir\n",
+          "b/both_dirs/sub_a_only_file\n",
+          "b/both_dirs/sub_b_only_dir\n",
+          "b/both_dirs/sub_b_only_file\n",
+          "b/both_dirs/sub_dir_in_a_file_in_b\n",
+          "b/both_dirs/sub_file_in_a_dir_in_b\n",
+          "b/both_files_different\n",
+          "b/dirs_empty_in_b_filled_in_a/subsub\n",
+          "b/dirs_empty_in_a_filled_in_b/subsub\n",
+          "b/a_only_dir\n",
+          "b/a_only_file\n",
+          "b/b_only_dir\n",
+          "b/b_only_file\n",
+          "b/dir_in_a_file_in_b\n",
+          "b/file_in_a_dir_in_b\n"
+      ]
+    end
+    it 'ChefFS::CommandLine.diff(/) in name-status mode' do
+      results = []
+      ChefFS::CommandLine.diff(pattern('/'), a, b, nil, :name_status) do |diff|
+        results << diff.gsub(/\s+\d\d\d\d-\d\d-\d\d\s\d?\d:\d\d:\d\d\.\d{9} -\d\d\d\d/, ' DATE')
+      end
+      results.should =~ [
+          "M\tb/both_dirs/sub_both_files_different\n",
+          "D\tb/both_dirs/sub_dirs_empty_in_b_filled_in_a/subsub\n",
+          "A\tb/both_dirs/sub_dirs_empty_in_a_filled_in_b/subsub\n",
+          "D\tb/both_dirs/sub_a_only_dir\n",
+          "D\tb/both_dirs/sub_a_only_file\n",
+          "A\tb/both_dirs/sub_b_only_dir\n",
+          "A\tb/both_dirs/sub_b_only_file\n",
+          "T\tb/both_dirs/sub_dir_in_a_file_in_b\n",
+          "T\tb/both_dirs/sub_file_in_a_dir_in_b\n",
+          "M\tb/both_files_different\n",
+          "D\tb/dirs_empty_in_b_filled_in_a/subsub\n",
+          "A\tb/dirs_empty_in_a_filled_in_b/subsub\n",
+          "D\tb/a_only_dir\n",
+          "D\tb/a_only_file\n",
+          "A\tb/b_only_dir\n",
+          "A\tb/b_only_file\n",
+          "T\tb/dir_in_a_file_in_b\n",
+          "T\tb/file_in_a_dir_in_b\n"
+      ]
+    end
   end
 end

data/spec/chef_fs/file_system/chef_server_root_dir_spec.rb

@@ -22,7 +22,7 @@ describe ChefFS::FileSystem::ChefServerRootDir do
       endpoint_leaf.exists?.should be_true
     end
     it 'read returns content' do
-      @rest.should_receive(:get_rest).with("#{endpoint_name}/#{endpoint_leaf_name}/environments/env").once.and_return(
+      @rest.should_receive(:get_rest).with("#{endpoint_name}/#{endpoint_leaf_name}").once.and_return(
         {
           'a' => 'b'
         })
@@ -101,7 +101,7 @@ describe ChefFS::FileSystem::ChefServerRootDir do
         nonexistent_child.dir?.should be_false
       end
       it 'read returns NotFoundError' do
-        @rest.should_receive(:get_rest).with("#{endpoint_name}/blah/environments/env").once.and_raise(Net::HTTPServerException.new(nil,Net::HTTPResponse.new(nil,'404',nil)))
+        @rest.should_receive(:get_rest).with("#{endpoint_name}/blah").once.and_raise(Net::HTTPServerException.new(nil,Net::HTTPResponse.new(nil,'404',nil)))
         expect { nonexistent_child.read }.to raise_error(ChefFS::FileSystem::NotFoundError)
       end
     end
@@ -112,9 +112,8 @@ describe ChefFS::FileSystem::ChefServerRootDir do
     {
       :chef_server_url => 'url',
       :node_name => 'username',
-      :client_key => 'key',
-      :environment => 'env'
-    })
+      :client_key => 'key'
+    }, 'everything')
   }
   before(:each) do
     @rest = double("rest")

data/spec/chef_fs/file_system/cookbooks_dir_spec.rb

@@ -7,9 +7,9 @@ describe ChefFS::FileSystem::CookbooksDir do
     {
       :chef_server_url => 'url',
       :node_name => 'username',
-      :client_key => 'key',
-      :environment => 'env'
-    })
+      :client_key => 'key'
+    },
+    'everything')
   }
   let(:cookbooks_dir) { root_dir.child('cookbooks') }
   let(:should_list_cookbooks) do

data/spec/chef_fs/file_system/data_bags_dir_spec.rb

@@ -6,9 +6,8 @@ describe ChefFS::FileSystem::DataBagsDir do
     {
       :chef_server_url => 'url',
       :node_name => 'username',
-      :client_key => 'key',
-      :environment => 'env'
-    })
+      :client_key => 'key'
+    }, 'everything')
   }
   let(:data_bags_dir) { root_dir.child('data_bags') }
   let(:should_list_data_bags) do
@@ -73,7 +72,7 @@ describe ChefFS::FileSystem::DataBagsDir do
       data_bag_item.path_for_printing.should == "remote/data_bags/#{data_bag_dir_name}/#{data_bag_item_name}"
     end
     it 'reads correctly' do
-      @rest.should_receive(:get_rest).with("data/#{data_bag_dir_name}/#{data_bag_item_short_name}/environments/env").once.and_return({
+      @rest.should_receive(:get_rest).with("data/#{data_bag_dir_name}/#{data_bag_item_short_name}").once.and_return({
         'a' => 'b'
       })
       data_bag_item.read.should == '{
@@ -155,7 +154,7 @@ describe ChefFS::FileSystem::DataBagsDir do
         nonexistent_child.dir?.should be_false
       end
       it 'read returns NotFoundError' do
-        @rest.should_receive(:get_rest).with("data/#{data_bag_dir_name}/blah/environments/env").once.and_raise(Net::HTTPServerException.new(nil,Net::HTTPResponse.new(nil,'404',nil)))
+        @rest.should_receive(:get_rest).with("data/#{data_bag_dir_name}/blah").once.and_raise(Net::HTTPServerException.new(nil,Net::HTTPResponse.new(nil,'404',nil)))
         expect { nonexistent_child.read }.to raise_error(ChefFS::FileSystem::NotFoundError)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-essentials
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors: