minimal-diff-chef-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df15d16527e8b79e0810b6512398d9b145aba2f7
+  data.tar.gz: fa40bc8ec40866a4644d58b2538bd52ed6c472a7
+SHA512:
+  metadata.gz: d807c2a4535d321adace9e181730278e858a9e44c9ac37bfc453629e8d5253d85324f5a9a54c50a5a07388573c35eeb655320773d33b046447a5a90c6932c0cd
+  data.tar.gz: db0a4e3cc2924b778ea130d35b8c9cddcb5112249fdadbac57c6168816b76a09cb2dd9e474a3326ffe8a71270bff4b32b1e8d3d1fc3726d86de11baf4a5649af

data/README.md

@@ -0,0 +1,54 @@
+Minimal-diff formatter
+======================
+
+A formatter for [Chef](http://getchef.com) to keep the output of chef-client 
+as small as possible. Unlike default minimal formatter it shows more info about
+updated resources.
+
+This formatter will display the total number of processed resources, as the
+number of unchanged, updated and failed resources.
+
+This is inspired by [Nyan Cat <3 Chef Formatter](https://github.com/andreacampi/nyan-cat-chef-formatter).
+Actually no, scratch that: this is basically a ripoff. So sue me second after @andreacampi.
+
+Usage
+=====
+
+Install the gem: 
+
+    gem install minimal-diff-chef-formatter
+
+If you are using Omnibus Chef you need to specify the full path to the `gem`
+binary:
+
+    /opt/chef/embedded/bin/gem install minimal-diff-chef-formatter
+
+Or write a cookbook to install it using the `chef_gem` resource, if that's
+how you roll. See http://community.opscode.com/cookbooks/nyan-cat for inspiration.
+
+Then add the following to your `/etc/chef/client.rb` file:
+
+    gem 'minimal-diff-chef-formatter'
+    require 'minimal-diff-chef-formatter'
+
+This enables the formatter, but doesn't use it by default. To see Nyan in all its
+glory, run:
+
+    chef-client -Fmindiff -lfatal
+
+Enjoy!
+
+For serious Nyan addicts only!
+------------------------------
+
+To enable the Nyan formatter by default, add the following line to
+`/etc/chef/client.rb`:
+
+    formatter :mindiff
+
+
+Author
+----------
+[Vyacheslav Kuznetsov](https://www.github.com/smith3v) :: @smith3v
+[Andrea Campi](https://www.github.com/andreacampi) :: @andreacampi
+[Matt Sears](https://wwww.mattsears.com) :: @mattsears

data/lib/minimal-diff-chef-formatter.rb

@@ -0,0 +1,248 @@
+require 'chef/formatters/base'
+
+class Chef
+
+  module Formatters
+
+
+    # == Formatters::MinimalDiff
+    # Shows the progress of the chef run by printing single characters, and
+    # displays a summary of updates at the conclusion of the run. For events
+    # that don't have meaningful status information (loading a file, syncing a
+    # cookbook) a dot is printed. For resources, a dot, 'S' or 'U' is printed
+    # if the resource is up to date, skipped by not_if/only_if, or updated,
+    # respectively.
+
+    #Unlike the Formatters::Minimal it shows diff for updated resources.
+
+    class MinimalDiff < Formatters::Base
+
+      cli_name(:mindiff)
+
+      attr_reader :updated_resources
+      attr_reader :updates_by_resource
+
+
+      def initialize(out, err)
+        super
+        @updated_resources = []
+        @updates_by_resource = Hash.new {|h, k| h[k] = []}
+      end
+
+      # Called at the very start of a Chef Run
+      def run_start(version)
+        puts "Starting Chef Client, version #{version}"
+      end
+
+      # Called at the end of the Chef run.
+      def run_completed(node)
+        puts "chef client finished, #{@updated_resources.size} resources updated"
+      end
+
+      # called at the end of a failed run
+      def run_failed(exception)
+        puts "chef client failed. #{@updated_resources.size} resources updated"
+      end
+
+      # Called right after ohai runs.
+      def ohai_completed(node)
+      end
+
+      # Already have a client key, assuming this node has registered.
+      def skipping_registration(node_name, config)
+      end
+
+      # About to attempt to register as +node_name+
+      def registration_start(node_name, config)
+      end
+
+      def registration_completed
+      end
+
+      # Failed to register this client with the server.
+      def registration_failed(node_name, exception, config)
+        super
+      end
+
+      def node_load_start(node_name, config)
+      end
+
+      # Failed to load node data from the server
+      def node_load_failed(node_name, exception, config)
+      end
+
+      # Default and override attrs from roles have been computed, but not yet applied.
+      # Normal attrs from JSON have been added to the node.
+      def node_load_completed(node, expanded_run_list, config)
+      end
+
+      # Called before the cookbook collection is fetched from the server.
+      def cookbook_resolution_start(expanded_run_list)
+        puts "resolving cookbooks for run list: #{expanded_run_list.inspect}"
+      end
+
+      # Called when there is an error getting the cookbook collection from the
+      # server.
+      def cookbook_resolution_failed(expanded_run_list, exception)
+      end
+
+      # Called when the cookbook collection is returned from the server.
+      def cookbook_resolution_complete(cookbook_collection)
+      end
+
+      # Called before unneeded cookbooks are removed
+      #--
+      # TODO: Should be called in CookbookVersion.sync_cookbooks
+      def cookbook_clean_start
+      end
+
+      # Called after the file at +path+ is removed. It may be removed if the
+      # cookbook containing it was removed from the run list, or if the file was
+      # removed from the cookbook.
+      def removed_cookbook_file(path)
+      end
+
+      # Called when cookbook cleaning is finished.
+      def cookbook_clean_complete
+      end
+
+      # Called before cookbook sync starts
+      def cookbook_sync_start(cookbook_count)
+        puts "Synchronizing cookbooks"
+      end
+
+      # Called when cookbook +cookbook_name+ has been sync'd
+      def synchronized_cookbook(cookbook_name)
+        print "."
+      end
+
+      # Called when an individual file in a cookbook has been updated
+      def updated_cookbook_file(cookbook_name, path)
+      end
+
+      # Called after all cookbooks have been sync'd.
+      def cookbook_sync_complete
+        puts "done."
+      end
+
+      # Called when cookbook loading starts.
+      def library_load_start(file_count)
+        puts "Compiling cookbooks"
+      end
+
+      # Called after a file in a cookbook is loaded.
+      def file_loaded(path)
+        print '.'
+      end
+
+      def file_load_failed(path, exception)
+        super
+      end
+
+      # Called when recipes have been loaded.
+      def recipe_load_complete
+        puts "done."
+      end
+
+      # Called before convergence starts
+      def converge_start(run_context)
+        puts "Converging #{run_context.resource_collection.all_resources.size} resources"
+      end
+
+      # Called when the converge phase is finished.
+      def converge_complete
+        puts "\n"
+        puts "System converged."
+        if updated_resources.empty?
+          puts "no resources updated"
+        else
+          puts "\n"
+          puts "resources updated this run:"
+          updated_resources.each do |resource|
+            puts "* #{resource.to_s}"
+            updates_by_resource[resource.name].flatten.each do |update|
+              puts "  #{update}"
+            end
+          end
+        end
+      end
+
+      # Called before action is executed on a resource.
+      def resource_action_start(resource, action, notification_type=nil, notifier=nil)
+      end
+
+      # Called when a resource fails, but will retry.
+      def resource_failed_retriable(resource, action, retry_count, exception)
+      end
+
+      # Called when a resource fails and will not be retried.
+      def resource_failed(resource, action, exception)
+      end
+
+      # Called when a resource action has been skipped b/c of a conditional
+      def resource_skipped(resource, action, conditional)
+        print "S"
+      end
+
+      # Called after #load_current_resource has run.
+      def resource_current_state_loaded(resource, action, current_resource)
+      end
+
+      # Called when a resource has no converge actions, e.g., it was already correct.
+      def resource_up_to_date(resource, action)
+        print "."
+      end
+
+      ## TODO: callback for assertion failures
+
+      ## TODO: callback for assertion fallback in why run
+
+      # Called when a change has been made to a resource. May be called multiple
+      # times per resource, e.g., a file may have its content updated, and then
+      # its permissions updated.
+      def resource_update_applied(resource, action, update)
+	prefix = Chef::Config[:why_run] ? "Would " : ""
+        Array(update).each do |line|
+          next if line.nil?
+          if line.kind_of? String
+            @updates_by_resource[resource.name] << "    - #{prefix}#{line}"
+          elsif line.kind_of? Array
+            # Expanded output - delta
+            # @todo should we have a resource_update_delta callback?
+            line.each do |detail|
+              @updates_by_resource[resource.name] << "        #{detail}"
+            end
+          end
+        end
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        updated_resources << resource
+        print "U"
+      end
+
+      # Called before handlers run
+      def handlers_start(handler_count)
+      end
+
+      # Called after an individual handler has run
+      def handler_executed(handler)
+      end
+
+      # Called after all handlers have executed
+      def handlers_completed
+      end
+
+      # An uncategorized message. This supports the case that a user needs to
+      # pass output that doesn't fit into one of the callbacks above. Note that
+      # there's no semantic information about the content or importance of the
+      # message. That means that if you're using this too often, you should add a
+      # callback for it.
+      def msg(message)
+      end
+
+    end
+  end
+end
+

data/minimal-diff-chef-formatter.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "minimal-diff-chef-formatter"
+  s.version     = "0.1.0"
+  s.authors     = ["Vyacheslav Kuznetsov"]
+  s.email       = ["kuznetsovvv@gmail.com"]
+  s.homepage    = "https://github.com/smith3v/minimal-diff-chef-formatter"
+  s.summary     = %q{Minimal Chef formatter with diffs}
+  s.description = %q{Minimal Chef formatter with diffs}
+
+  s.rubyforge_project = "minimal-diff-chef-formatter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: minimal-diff-chef-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vyacheslav Kuznetsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies: []
+description: Minimal Chef formatter with diffs
+email:
+- kuznetsovvv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/minimal-diff-chef-formatter.rb
+- minimal-diff-chef-formatter.gemspec
+homepage: https://github.com/smith3v/minimal-diff-chef-formatter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: minimal-diff-chef-formatter
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Minimal Chef formatter with diffs
+test_files: []