chef 0.9.0.rc01 → 0.9.0.rc02

data/distro/common/man/man8/knife.8

@@ -252,6 +252,10 @@ Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all
 .P
 \fBcookbook bulk delete REGEX\fR \fI(options)\fR
 .
+.TP
+\fB\-p\fR, \fB\-\-purge\fR
+Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+.
 .P
 Delete cookbooks on the Chef Server based on a regular expression. The regular expression (\fIREGEX\fR) should be in quotes, not in //'s.
 .
@@ -262,6 +266,10 @@ Delete cookbooks on the Chef Server based on a regular expression. The regular e
 \fB\-a\fR, \fB\-\-all\fR
 Delete all versions
 .
+.TP
+\fB\-p\fR, \fB\-\-purge\fR
+Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+.
 .P
 Delete the specified \fIVERSION\fR of the named \fICOOKBOOK\fR. If no version is specified, and only one version exists on the server, that version will be deleted. If multiple versions are available on the server, you will be prompted for a version to delete.
 .

data/distro/common/markdown/knife.mkd

@@ -161,6 +161,9 @@ Cookbooks are the fundamental unit of distribution in Chef. They encapsulate all
 
 __cookbook bulk delete REGEX__ _(options)_
 
+  * `-p`, `--purge`:
+    Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+
 Delete cookbooks on the Chef Server based on a regular expression. The regular expression (_REGEX_) should be in quotes, not in //'s.
 
 __cookbook delete COOKBOOK [VERSION]__ _(options)_
@@ -168,6 +171,9 @@ __cookbook delete COOKBOOK [VERSION]__ _(options)_
   * `-a`, `--all`:
     Delete all versions
 
+  * `-p`, `--purge`:
+    Purge files from backing store. This will disable any cookbook that contains any of the same files as the cookbook being purged.
+
 Delete the specified _VERSION_ of the named _COOKBOOK_. If no version is specified, and only one version exists on the server, that version will be deleted. If multiple versions are available on the server, you will be prompted for a version to delete.
 
 __cookbook download COOKBOOK [VERSION]__ _(options)_

data/lib/chef.rb

@@ -30,6 +30,7 @@ require 'chef/daemon'
 require 'chef/webui_user'
 require 'chef/openid_registration'
 
+require 'chef/run_status'
 require 'chef/handler'
 require 'chef/handler/json_file'
 

data/lib/chef/client.rb

@@ -74,12 +74,14 @@ class Chef
       build_node
       
       begin
-        start_time = Time.now
+        run_status = Chef::RunStatus.new(node)
+        run_status.start_clock
         Chef::Log.info("Starting Chef Run")
         
         if Chef::Config[:solo]
           Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest) }
           run_context = Chef::RunContext.new(node, Chef::CookbookCollection.new(Chef::CookbookLoader.new))
+          run_status.run_context = run_context
           assert_cookbook_path_not_empty(run_context)
           converge(run_context)
         else
@@ -98,7 +100,8 @@ class Chef
           Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::RemoteFileVendor.new(manifest, rest, valid_cache_entries) }
           cookbook_hash = sync_cookbooks(valid_cache_entries)
           run_context = Chef::RunContext.new(node, Chef::CookbookCollection.new(cookbook_hash))
-          
+          run_status.run_context = run_context
+
           assert_cookbook_path_not_empty(run_context)
           save_node
           
@@ -108,39 +111,35 @@ class Chef
           cleanup_file_cache(valid_cache_entries)
         end
         
-        end_time = Time.now
-        elapsed_time = end_time - start_time
-        Chef::Log.info("Chef Run complete in #{elapsed_time} seconds")
-        run_report_handlers(start_time, end_time, elapsed_time) 
+        run_status.stop_clock
+        Chef::Log.info("Chef Run complete in #{run_status.elapsed_time} seconds")
+        run_report_handlers(run_status)
         true
       rescue Exception => e
-        run_exception_handlers(node, runner ? runner : run_context, start_time, end_time, elapsed_time, e)
+        run_status.stop_clock
+        run_status.exception = e
+        run_exception_handlers(run_status)
         Chef::Log.error("Re-raising exception: #{e.class} - #{e.message}\n#{e.backtrace.join("\n  ")}")
         raise
+      ensure
+        run_status = nil
       end
     end
 
-    def run_report_handlers(start_time, end_time, elapsed_time)
-      if Chef::Config[:report_handlers].length > 0
-        Chef::Log.info("Running report handlers")
-        Chef::Config[:report_handlers].each do |handler|
-          handler.report(node, runner, start_time, end_time, elapsed_time)
-        end
-        Chef::Log.info("Report handlers complete")
+    def run_report_handlers(run_status)
+      Chef::Log.info("Running report handlers")
+      Array(Chef::Config[:report_handlers]).each do |handler|
+        handler.run_report_safely(handler)
       end
+      Chef::Log.info("Report handlers complete")
     end
 
-    def run_exception_handlers(node, runner, start_time, end_time, elapsed_time, exception)
-      if Chef::Config[:exception_handlers].length > 0
-        end_time   ||= Time.now
-        elapsed_time ||= end_time - start_time 
-        Chef::Log.error("Received exception: #{exception.message}")
-        Chef::Log.error("Running exception handlers")
-        Chef::Config[:exception_handlers].each do |handler|
-          handler.report(node, runner, start_time, end_time, elapsed_time, exception)
-        end
-        Chef::Log.error("Exception handlers complete")
+    def run_exception_handlers(run_status)
+      Chef::Log.error("Running exception handlers")
+      Array(Chef::Config[:exception_handlers]).each do |handler|
+        handler.run_report_safely(run_status)
       end
+      Chef::Log.error("Exception handlers complete")
     end
     
     def run_ohai
@@ -331,7 +330,7 @@ class Chef
     # true:: Always returns true
     def converge(run_context)
       Chef::Log.debug("Converging node #{node_name}")
-      self.runner = Chef::Runner.new(run_context)
+      @runner = Chef::Runner.new(run_context)
       runner.converge
       true
     end

data/lib/chef/couchdb.rb

@@ -160,9 +160,11 @@ class Chef
       end
       response = @rest.delete_rest("#{couchdb_database}/#{uuid}?rev=#{rev}")
       response.couchdb = self if response.respond_to?(:couchdb=)
-      Chef::Log.info("Sending #{obj_type}(#{uuid}) to the index queue for deletion..")
       
-      object.delete_from_index(:database => couchdb_database, :id => uuid, :type => obj_type)
+      if object.respond_to?(:delete_from_index)
+        Chef::Log.info("Sending #{obj_type}(#{uuid}) to the index queue for deletion..")
+        object.delete_from_index(:database => couchdb_database, :id => uuid, :type => obj_type)
+      end
 
       response
     end

data/lib/chef/handler.rb

@@ -15,47 +15,106 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require 'forwardable'
 
 class Chef
   class Handler
 
-    attr_accessor :config
+    extend Forwardable
 
-    def initialize(config={})
-      @config = config
-      @config[:path] ||= "/var/chef/reports"
-      @config
+    attr_reader :run_status
+
+    ##
+    # :method: start_time
+    #
+    # The time the chef run started
+    def_delegator :@run_status, :start_time
+
+    ##
+    # :method: end_time
+    #
+    # The time the chef run ended
+    def_delegator :@run_status, :end_time
+
+    ##
+    # :method: run_context
+    #
+    # The Chef::RunContext object used by the chef run
+    def_delegator :@run_status, :run_context
+
+    ##
+    # :method: exception
+    #
+    # The uncaught Exception that terminated the chef run, or nil if the run
+    # completed successfully
+    def_delegator :@run_status, :exception
+
+    ##
+    # :method: backtrace
+    #
+    # The backtrace captured by the uncaught exception that terminated the chef
+    # run, or nil if the run completed successfully
+    def_delegator :@run_status, :backtrace
+
+    ##
+    # :method: node
+    #
+    # The Chef::Node for this client run
+    def_delegator :@run_status, :node
+
+    ##
+    # :method: all_resources
+    #
+    # An Array containing all resources in the chef run's resource_collection
+    def_delegator :@run_status, :all_resources
+
+    ##
+    # :method: updated_resources
+    #
+    # An Array containing all resources that were updated during the chef run
+    def_delegator :@run_status, :updated_resources
+
+    ##
+    # :method: success?
+    #
+    # Was the chef run successful? True if the chef run did not raise an
+    # uncaught exception
+    def_delegator :@run_status, :success?
+
+    ##
+    # :method: failed?
+    #
+    # Did the chef run fail? True if the chef run raised an uncaught exception
+    def_delegator :@run_status, :failed?
+
+    # The main entry point for report handling. Subclasses should override this
+    # method with their own report handling logic.
+    def report
+    end
+
+    # Runs the report handler, rescuing and logging any errors it may cause.
+    # This ensures that all handlers get a chance to run even if one fails.
+    # This method should not be overridden by subclasses unless you know what
+    # you're doing.
+    def run_report_safely(run_status)
+      run_report_unsafe(run_status)
+    rescue Exception => e
+      Chef::Log.error("Report handler #{self.class.name} raised #{e.inspect}")
+      Array(e.backtrace).each { |line| Chef::Log.error(line) }
+    ensure
+      @run_status = nil
     end
 
-    def build_report_data(node, runner, start_time, end_time, elapsed_time, exception=nil)
-      data = Hash.new
-      data[:node] = node if node
-      if runner
-        data[:resources] = {
-          :all => runner.run_context.resource_collection.all_resources,
-          :updated => runner.run_context.resource_collection.inject([]) { |m, r| m << r if r.updated; m }
-        }
-      end
-      if exception
-        data[:success] = false 
-        data[:exception] = {
-          :message => exception.message,
-          :backtrace => exception.backtrace
-        }
-      else
-        data[:success] = true
-      end
-      data[:elapsed_time] = elapsed_time 
-      data[:start_time] = start_time
-      data[:end_time] = end_time
-      data
+    # Runs the report handler without any error handling. This method should
+    # not be used directly except in testing.
+    def run_report_unsafe(run_status)
+      @run_status = run_status
+      report
     end
 
-    def build_report_dir
-      unless File.exists?(config[:path])
-        FileUtils.mkdir_p(config[:path])
-        File.chmod(octal_mode("0700"), config[:path])
-      end
+    # Return the Hash representation of the run_status
+    def data
+      @run_status.to_hash
     end
 
   end

data/lib/chef/handler/json_file.rb

@@ -23,18 +23,21 @@ class Chef
   class Handler
     class JsonFile < ::Chef::Handler
 
+      attr_reader :config
+
       def initialize(config={})
-        super(config)
+        @config = config
+        @config[:path] ||= "/var/chef/reports"
+        @config
       end
 
-      def report(node, runner, start_time, end_time, elapsed_time, exception)
+      def report
         if exception
           Chef::Log.error("Creating JSON exception report")
         else
           Chef::Log.info("Creating JSON run report")
         end
 
-        data = build_report_data(node, runner, start_time, end_time, elapsed_time, exception)
         build_report_dir
         savetime = Time.now.strftime("%Y%m%d%H%M%S")
         File.open(File.join(config[:path], "chef-run-report-#{savetime}.json"), "w") do |file|
@@ -42,6 +45,14 @@ class Chef
         end
       end
 
+      def build_report_dir
+        unless File.exists?(config[:path])
+          FileUtils.mkdir_p(config[:path])
+          File.chmod(00700, config[:path])
+        end
+      end
+
+
     end
   end
 end

data/lib/chef/knife/cookbook_bulk_delete.rb

@@ -24,6 +24,8 @@ class Chef
   class Knife
     class CookbookBulkDelete < Knife
 
+      option :purge, :short => '-p', :long => '--purge', :boolean => true, :description => 'Permanently remove files from backing data store'
+      
       banner "Sub-Command: cookbook bulk delete REGEX (options)"
 
       def run
@@ -41,10 +43,12 @@ class Chef
 
         confirm("Do you really want to delete these cookbooks? All versions will be deleted. (Y/N) ", false)
         
+        confirm("Files that are common to multiple cookbooks are shared, so purging the files may disable other cookbooks. Are you sure you want to purge files instead of just deleting the cookbooks") if config[:purge]
+        
         cookbooks_names.each do |cookbook_name|
           versions = rest.get_rest("cookbooks/#{cookbook_name}").values.flatten
           versions.each do |version|
-            object = rest.delete_rest("cookbooks/#{cookbook_name}/#{version}")
+            object = rest.delete_rest("cookbooks/#{cookbook_name}/#{version}#{config[:purge] ? "?purge=true" : ""}")
             Chef::Log.info("Deleted cookbook  #{cookbook_name.ljust(25)} [#{version}]")
           end
         end
@@ -52,10 +56,3 @@ class Chef
     end
   end
 end
-
-
-
-
-
-
-

data/lib/chef/knife/cookbook_delete.rb

@@ -24,9 +24,12 @@ class Chef
       
       option :all, :short => '-a', :long => '--all', :boolean => true, :description => 'delete all versions'
 
+      option :purge, :short => '-p', :long => '--purge', :boolean => true, :description => 'Permanently remove files from backing data store'
+
       banner "Sub-Command: cookbook delete COOKBOOK VERSION (options)"
 
       def run
+        confirm("Files that are common to multiple cookbooks are shared, so purging the files may disable other cookbooks. Are you sure you want to purge files instead of just deleting the cookbook") if config[:purge]
         @cookbook_name, @version = name_args
         if @cookbook_name && @version
           delete_explicit_version
@@ -43,7 +46,7 @@ class Chef
 
       def delete_explicit_version
         delete_object(Chef::CookbookVersion, "#{@cookbook_name} version #{@version}", "cookbook") do
-          rest.delete_rest("cookbooks/#{@cookbook_name}/#{@version}")
+          delete_request("cookbooks/#{@cookbook_name}/#{@version}", config[:purge])
         end
       end
 
@@ -112,7 +115,7 @@ class Chef
       end
 
       def delete_version_without_confirmation(version)
-        object = rest.delete_rest("cookbooks/#{@cookbook_name}/#{version}")
+        object = delete_request("cookbooks/#{@cookbook_name}/#{version}", config[:purge])
         output(format_for_display(object)) if config[:print_after]
         Chef::Log.info("Deleted cookbook[#{@cookbook_name}][#{version}]")
       end
@@ -127,6 +130,13 @@ class Chef
           end
         end
       end
+      
+      private
+      
+      def delete_request(path, purge)
+        url = "cookbooks/#{@cookbook_name}/#{@version}#{purge ? "?purge=true" : ""}"
+        rest.delete_rest(url)
+      end
 
     end
   end

data/lib/chef/run_status.rb

@@ -0,0 +1,94 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2010 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.
+#
+
+class Chef::RunStatus
+
+  attr_reader :run_context
+
+  attr_writer :run_context
+
+  attr_reader :start_time
+
+  attr_reader :end_time
+
+  attr_reader :exception
+
+  attr_writer :exception
+
+  def initialize(node)
+    @node = node
+  end
+
+  def node
+    @node
+  end
+
+  def start_clock
+    @start_time = Time.now
+  end
+
+  def stop_clock
+    @end_time = Time.now
+  end
+
+  def elapsed_time
+    if @start_time && @end_time
+      @end_time - @start_time
+    else
+      nil
+    end
+  end
+
+  def all_resources
+    @run_context && @run_context.resource_collection.all_resources
+  end
+
+  def updated_resources
+    @run_context && @run_context.resource_collection.select { |r| r.updated }
+  end
+
+  def backtrace
+    @exception && @exception.backtrace
+  end
+
+  def failed?
+    !success?
+  end
+
+  def success?
+    @exception.nil?
+  end
+
+  def to_hash
+    # use a flat hash here so we can't errors from intermediate values being nil
+    { :node => node,
+      :success => success?,
+      :start_time => start_time,
+      :end_time => end_time,
+      :elapsed_time => elapsed_time,
+      :all_resources => all_resources,
+      :updated_resources => updated_resources,
+      :exception => formatted_exception,
+      :backtrace => backtrace}
+  end
+
+  def formatted_exception
+    @exception && "#{@exception.class.name}: #{@exception.message}"
+  end
+
+end

data/lib/chef/version.rb

@@ -16,5 +16,5 @@
 # limitations under the License.
 
 class Chef
-  VERSION = '0.9.0.rc01'
+  VERSION = '0.9.0.rc02'
 end

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 9
   - 0
-  - rc01
-  version: 0.9.0.rc01
+  - rc02
+  version: 0.9.0.rc02
 platform: ruby
 authors: 
 - Adam Jacob
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 -07:00
+date: 2010-06-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -509,6 +509,7 @@ files:
 - lib/chef/run_list/run_list_expansion.rb
 - lib/chef/run_list/run_list_item.rb
 - lib/chef/run_list.rb
+- lib/chef/run_status.rb
 - lib/chef/runner.rb
 - lib/chef/sandbox.rb
 - lib/chef/search/query.rb