knife-essentials 0.7.6 → 0.8

data/lib/chef_fs/file_system/not_found_error.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_error'
 
 module ChefFS

data/lib/chef_fs/file_system/rest_list_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_dir'
 require 'chef_fs/file_system/rest_list_entry'
 require 'chef_fs/file_system/not_found_error'

data/lib/chef_fs/file_system/rest_list_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/base_fs_object'
 require 'chef_fs/file_system/not_found_error'
 require 'chef/role'

data/lib/chef_fs/knife.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/chef_server_root_dir'
 require 'chef_fs/file_system/chef_repository_file_system_root_dir'
 require 'chef_fs/file_pattern'
@@ -13,36 +31,124 @@ module ChefFS
         :description => "Specifies the local repository layout.  Values: default or full"
     end
 
-    def base_path
-      @base_path ||= begin
-        relative_to_base = ChefFS::PathUtils::relative_to(File.expand_path(Dir.pwd), chef_repo)
-        relative_to_base == '.' ? '/' : "/#{relative_to_base}"
+    def chef_fs
+      @chef_fs ||= ChefFS::FileSystem::ChefServerRootDir.new("remote", Chef::Config, config[:repo_mode])
+    end
+
+    def chef_repo_path
+      @chef_repo_path ||= begin
+        if Chef::Config.chef_repo_path
+          File.expand_path(Chef::Config.chef_repo_path)
+        elsif Chef::Config.cookbook_path
+          File.expand_path('..', Array(Chef::Config.cookbook_path).flatten.first)
+        else
+          nil
+        end
       end
     end
 
-    def chef_fs
-      @chef_fs ||= ChefFS::FileSystem::ChefServerRootDir.new("remote", Chef::Config, config[:repo_mode])
+    # Smooth out some inappropriate (for know) variable defaults in Chef.
+    def config_var(name)
+      case name
+      when :data_bag_path
+        Chef::Config[name] == Chef::Config.platform_specific_path('/var/chef/data_bags') ? nil : Chef::Config[name]
+      when :node_path
+        Chef::Config[name] == '/var/chef/node' ? nil : Chef::Config[name]
+      when :role_path
+        Chef::Config[name] == Chef::Config.platform_specific_path('/var/chef/roles') ? nil : Chef::Config[name]
+      when :chef_repo_path
+        chef_repo_path
+      else
+        Chef::Config[name]
+      end
+    end
+
+    def object_paths
+      @object_paths ||= begin
+        result = {}
+        %w(clients cookbooks data_bags environments nodes roles users).each do |object_name|
+          variable_name = "#{object_name[0..-2]}_path" # cookbooks -> cookbook_path
+          paths = config_var(variable_name.to_sym)
+          if !paths
+            if !chef_repo_path
+              # TODO if chef_repo is not specified and repo_mode does not require
+              # clients/users/nodes, don't require them to be specified.
+              Chef::Log.error("Must specify either chef_repo_path or #{variable_name} in Chef config file")
+              exit(1)
+            end
+            paths = File.join(chef_repo_path, object_name)
+          end
+          paths = Array(paths).flatten.map { |path| File.expand_path(path) }
+          result[object_name] = paths
+        end
+        result
+      end
+    end
+
+    # Returns the given real path's location relative to the server root.
+    #
+    # If chef_repo is /home/jkeiser/chef_repo,
+    # and pwd is /home/jkeiser/chef_repo/cookbooks,
+    # server_path('blah') == '/cookbooks/blah'
+    # server_path('../roles/blah.json') == '/roles/blah'
+    # server_path('../../readme.txt') == nil
+    # server_path('*/*ab*') == '/cookbooks/*/*ab*'
+    # server_path('/home/jkeiser/chef_repo/cookbooks/blah') == '/cookbooks/blah'
+    # server_path('/home/*/chef_repo/cookbooks/blah') == nil
+    #
+    # If there are multiple paths (cookbooks, roles, data bags, etc. can all
+    # have separate paths), and cwd+the path reaches into one of them, we will
+    # return a path relative to that.  Otherwise we will return a path to
+    # chef_repo.
+    #
+    # Globs are allowed as well, but globs outside server paths are NOT
+    # (presently) supported.  See above examples.  TODO support that.
+    #
+    # If the path does not reach into ANY specified directory, nil is returned.
+    def server_path(file_path)
+      pwd = File.expand_path(Dir.pwd)
+      absolute_path = File.expand_path(file_path, pwd)
+
+      # Check all object paths (cookbooks_dir, data_bags_dir, etc.)
+      object_paths.each_pair do |name, paths|
+        paths.each do |path|
+          if absolute_path[0,path.length] == path
+            relative_path = ChefFS::PathUtils::relative_to(path, absolute_path)
+            return relative_path == '.' ? "/#{name}" : "/#{name}/#{relative_path}"
+          end
+        end
+      end
+
+      # Check chef_repo_path
+      if chef_repo_path[0,absolute_path.length] == absolute_path
+        relative_path = ChefFS::PathUtils::relative_to(chef_repo_path, absolute_path)
+        return relative_path == '.' ? '/' : "/#{relative_path}"
+      end
+
+      nil
     end
 
-    def chef_repo
-      @chef_repo ||= File.expand_path(File.join(Chef::Config.cookbook_path, ".."))
+    # The current directory, relative to server root
+    def base_path
+      @base_path ||= server_path(File.expand_path(Dir.pwd))
     end
 
-    def format_path(path)
-      if path[0,base_path.length] == base_path
-        if path == base_path
+    # 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 server_path == base_path
           return "."
-        elsif path[base_path.length] == "/"
-          return path[base_path.length + 1, path.length - base_path.length - 1]
-        elsif base_path == "/" && path[0] == "/"
-          return path[1, path.length - 1]
+        elsif server_path[base_path.length] == "/"
+          return server_path[base_path.length + 1, server_path.length - base_path.length - 1]
+        elsif base_path == "/" && server_path[0] == "/"
+          return server_path[1, server_path.length - 1]
         end
       end
-      path
+      server_path
     end
 
     def local_fs
-      @local_fs ||= ChefFS::FileSystem::ChefRepositoryFileSystemRootDir.new(chef_repo)
+      @local_fs ||= ChefFS::FileSystem::ChefRepositoryFileSystemRootDir.new(object_paths)
     end
 
     def pattern_args
@@ -50,7 +156,11 @@ module ChefFS
     end
 
     def pattern_args_from(args)
-      args.map { |arg| ChefFS::FilePattern::relative_to(base_path, arg) }.to_a
+      # TODO support absolute file paths and not just patterns?  Too much?
+      # Could be super useful in a world with multiple repo paths
+      args.map do |arg|
+        ChefFS::FilePattern::relative_to(base_path, arg)
+      end
     end
 
   end

data/lib/chef_fs/path_utils.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'
 
 module ChefFS
@@ -5,7 +23,7 @@ module ChefFS
 
     # If you are in 'source', this is what you would have to type to reach 'dest'
     # relative_to('/a/b/c/d/e', '/a/b/x/y') == '../../c/d/e'
-    # relative_to('/a/b', '/a/b') == ''
+    # relative_to('/a/b', '/a/b') == '.'
     def self.relative_to(dest, source)
       # Skip past the common parts
       source_parts = ChefFS::PathUtils.split(source)

data/lib/chef_fs/version.rb

@@ -1,4 +1,4 @@
 module ChefFS
-  VERSION = "0.7.6"
+  VERSION = "0.8"
 end
 

data/spec/chef_fs/diff_spec.rb

@@ -1,69 +1,94 @@
+#
+# 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 'support/spec_helper'
 require 'chef_fs/file_pattern'
 require 'chef_fs/command_line'
 
-describe 'diff' do
+# Removes the date stamp from the diff and replaces it with ' DATE'
+# example match: "/dev/null\t2012-10-16 16:15:54.000000000 +0000"
+# windows match: "--- /dev/null\tTue Oct 16 18:04:34 2012"
+def remove_date(diff)
+  diff.gsub(/([+-]{3}.*)\t.*/, '\1 DATE')
+end
+
+describe 'diff', :uses_diff => true do
   include FileSystemSupport
 
-	context 'with two filesystems with all types of difference' do
-		let(:a) {
-			memory_fs('a', {
-				:both_dirs => {
-					:sub_both_dirs => { :subsub => nil },
+  context 'with two filesystems with all types of difference' do
+    let(:a) {
+      memory_fs('a', {
+        :both_dirs => {
+          :sub_both_dirs => { :subsub => nil },
           :sub_both_files => nil,
           :sub_both_files_different => "a\n",
-					:sub_both_dirs_empty => {},
+          :sub_both_dirs_empty => {},
           :sub_dirs_empty_in_a_filled_in_b => {},
           :sub_dirs_empty_in_b_filled_in_a => { :subsub => nil },
-					:sub_a_only_dir => { :subsub => nil },
-					:sub_a_only_file => nil,
-					:sub_dir_in_a_file_in_b => {},
-					:sub_file_in_a_dir_in_b => nil
-				},
-				:both_files => nil,
+          :sub_a_only_dir => { :subsub => nil },
+          :sub_a_only_file => nil,
+          :sub_dir_in_a_file_in_b => {},
+          :sub_file_in_a_dir_in_b => nil
+        },
+        :both_files => nil,
         :both_files_different => "a\n",
         :both_dirs_empty => {},
         :dirs_empty_in_a_filled_in_b => {},
         :dirs_empty_in_b_filled_in_a => { :subsub => nil },
         :dirs_in_a_cannot_be_in_b => {},
         :file_in_a_cannot_be_in_b => nil,
-				:a_only_dir => { :subsub => nil },
-				:a_only_file => nil,
-				:dir_in_a_file_in_b => {},
-				:file_in_a_dir_in_b => nil
-			}, /cannot_be_in_a/)
-		}
-		let(:b) {
-			memory_fs('b', {
-				:both_dirs => {
-					:sub_both_dirs => { :subsub => nil },
-					:sub_both_files => nil,
+        :a_only_dir => { :subsub => nil },
+        :a_only_file => nil,
+        :dir_in_a_file_in_b => {},
+        :file_in_a_dir_in_b => nil
+      }, /cannot_be_in_a/)
+    }
+    let(:b) {
+      memory_fs('b', {
+        :both_dirs => {
+          :sub_both_dirs => { :subsub => nil },
+          :sub_both_files => nil,
           :sub_both_files_different => "b\n",
-					:sub_both_dirs_empty => {},
+          :sub_both_dirs_empty => {},
           :sub_dirs_empty_in_a_filled_in_b => { :subsub => nil },
           :sub_dirs_empty_in_b_filled_in_a => {},
-					:sub_b_only_dir => { :subsub => nil },
-					:sub_b_only_file => nil,
-					:sub_dir_in_a_file_in_b => nil,
-					:sub_file_in_a_dir_in_b => {}
-				},
-				:both_files => nil,
+          :sub_b_only_dir => { :subsub => nil },
+          :sub_b_only_file => nil,
+          :sub_dir_in_a_file_in_b => nil,
+          :sub_file_in_a_dir_in_b => {}
+        },
+        :both_files => nil,
         :both_files_different => "b\n",
-				:both_dirs_empty => {},
+        :both_dirs_empty => {},
         :dirs_empty_in_a_filled_in_b => { :subsub => nil },
         :dirs_empty_in_b_filled_in_a => {},
         :dirs_in_b_cannot_be_in_a => {},
         :file_in_b_cannot_be_in_a => nil,
-				:b_only_dir => { :subsub => nil },
-				:b_only_file => nil,
-				:dir_in_a_file_in_b => nil,
-				:file_in_a_dir_in_b => {}
-			}, /cannot_be_in_b/)
-		}
+        :b_only_dir => { :subsub => nil },
+        :b_only_file => nil,
+        :dir_in_a_file_in_b => nil,
+        :file_in_a_dir_in_b => {}
+      }, /cannot_be_in_b/)
+    }
     it 'ChefFS::CommandLine.diff(/)' do
       results = []
       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')
+        results << remove_date(diff)
       end
       results.should =~ [
         'diff --knife a/both_dirs/sub_both_files_different b/both_dirs/sub_both_files_different
@@ -139,7 +164,7 @@ new file
     it 'ChefFS::CommandLine.diff(/both_dirs)' do
       results = []
       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')
+        results << remove_date(diff)
       end
       results.should =~ [
         'diff --knife a/both_dirs/sub_both_files_different b/both_dirs/sub_both_files_different
@@ -181,7 +206,7 @@ new file
     it 'ChefFS::CommandLine.diff(/) with depth 1' do
       results = []
       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')
+        results << remove_date(diff)
       end
       results.should =~ [
 'Common subdirectories: /both_dirs
@@ -215,7 +240,7 @@ new file
     it 'ChefFS::CommandLine.diff(/*_*) with depth 0' do
       results = []
       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')
+        results << remove_date(diff)
       end
       results.should =~ [
 'Common subdirectories: /both_dirs
@@ -249,7 +274,7 @@ new file
     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')
+        results << remove_date(diff)
       end
       results.should =~ [
           "b/both_dirs/sub_both_files_different\n",
@@ -275,7 +300,7 @@ new file
     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')
+        results << remove_date(diff)
       end
       results.should =~ [
           "M\tb/both_dirs/sub_both_files_different\n",