nice-chef-formatter 0.0.1

data/README.md

@@ -0,0 +1,42 @@
+Nice Chef Formatter
+===================
+
+Formatter for chef with execution times for every cookbook/recipe and simplified output.
+
+Color codes:
+- Green, resource had nothing to do. It was already applied
+- Yellow, resource has done work. Applied
+- Blue, resource was skipped due to conditional (only_if, not_if, ...)
+
+Usage
+=====
+
+Install the gem:
+
+    gem install nice-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 nice-chef-formatter
+
+Or write a cookbook to install it using the `chef_gem` resource, if that's
+how you roll.
+
+Then add the following to your `/etc/chef/client.rb` file:
+
+    gem 'nice-chef-formatter'
+    require 'nice-chef-formatter'
+
+This enables the formatter, but doesn't use it by default.
+
+Acknowledgements
+================
+
+* Andrea Campi (@andreacampi) for the [nyan-cat-chef-formatter](https://github.com/andreacampi/nyan-cat-chef-formatter) that was the original inspiration
+
+License and Authors
+===================
+
+Author:: Nadir Lloret (<nadir.lloret@gmail.com>)
+License:: Apache 2.0

data/lib/chef/formatters/coloredputter.rb

@@ -0,0 +1,76 @@
+require 'chef/formatters/base'
+
+
+class Chef
+  module Formatters
+    class Coloredputter < Outputter
+      def initialize(out, err)
+        super(out, err)
+        if OS.windows?
+          require 'Win32API'
+          get_std_handle = Win32API.new("kernel32", "GetStdHandle", ['L'], 'L')
+          @stdout = get_std_handle.call(-11)
+          @set_console_txt_attrb = Win32API.new("kernel32", "SetConsoleTextAttribute", ['L','N'], 'I')
+        elsif OS.linux?
+          require 'rainbow'
+        end
+      end
+
+      def puts(string, *color)
+        if OS.linux?
+            case color[0]
+              when 'green'
+                @out.puts Rainbow(string).color(:green)
+              when 'yellow'
+                @out.puts Rainbow(string).color(:yellow)
+              when 'red'
+                @out.puts Rainbow(string).color(:red)
+              when 'blue'
+                @out.puts Rainbow(string).color(:blue)
+              else
+                @out.puts string
+            end
+        elsif OS.windows?
+          case color[0]
+            when 'green'
+              @set_console_txt_attrb.call(@stdout, 90)
+              @out.puts string
+            when 'yellow'
+              @set_console_txt_attrb.call(@stdout, 94)
+              @out.puts string
+            when 'red'
+              @set_console_txt_attrb.call(@stdout, 92)
+              @out.puts string
+            when 'blue'
+              @set_console_txt_attrb.call(@stdout, 91)
+              @out.puts string
+            else
+              @set_console_txt_attrb.call(@stdout, 95)
+              @out.puts string
+          end
+          @set_console_txt_attrb.call(@stdout, 95)
+        else
+          @out.puts string
+        end
+      end
+    end
+  end
+
+  module OS
+    def OS.windows?
+      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def OS.mac?
+      (/darwin/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def OS.unix?
+      !OS.windows?
+    end
+
+    def OS.linux?
+      OS.unix? and not OS.mac?
+    end
+  end
+end

data/lib/nice-chef-formatter.rb

@@ -0,0 +1,110 @@
+require 'chef/formatters/minimal'
+require 'chef/formatters/coloredputter'
+
+class Chef
+  module Formatters
+    class Nice < Formatters::Base
+
+      cli_name(:nice)
+
+      # Override parent class
+      def initialize(out, err)
+        super
+        @output = Coloredputter.new(out, err)
+        livedrive_title = "
+=====================================================================
+=====================================================================
+
+     dP\"\"b8 88  88 888888 888888     88\"\"Yb 88   88 88b 88
+    dP   `I 88  88 88__   88__       88__dP 88   88 88Yb88
+    Yb      888888 88\"\"   88\"\"       88\"Yb  Y8   8P 88 Y88
+     YboodP 88  88 888888 88         88  Yb `YbodP' 88  Y8
+
+=====================================================================
+=====================================================================
+"
+        puts livedrive_title
+      end
+
+      # Called at the very start of a Chef Run
+      def run_start(version)
+        puts "Starting Chef Client, version #{version}"
+        @initial_time = Time.now.to_f
+      end
+
+      # Called before the cookbook collection is fetched from the server.
+      def cookbook_resolution_start(expanded_run_list)
+        puts "Very run list: #{expanded_run_list.inspect}"
+      end
+
+      def cookbook_sync_start(cookbook_count)
+        puts "Cookbook synchronization"
+      end
+
+      # Called when cookbook +cookbook_name+ has been sync'd
+      def synchronized_cookbook(cookbook_name)
+        puts "  - #{cookbook_name}"
+      end
+
+      # Called after all cookbooks have been sync'd.
+      def cookbook_sync_complete
+        puts "Finish cookbook synchronization"
+      end
+
+      def converge_start(run_context)
+        puts "Converge #{run_context.resource_collection.all_resources.size} resources"
+      end
+
+      def converge_complete
+        total_exec_time = Time.now.to_f - @initial_time
+        puts "System converged in #{total_exec_time.round(2)}"
+      end
+
+      # Called when cookbook loading starts.
+      def library_load_start(file_count)
+        puts "Compilation"
+      end
+
+      def resource_action_start(resource, action, notification_type=nil, notifier=nil)
+        if resource.cookbook_name && resource.recipe_name
+          resource_recipe = "#{resource.cookbook_name}::#{resource.recipe_name}"
+        else
+          puts "#{resource.cookbook_name}::#{resource.recipe_name}"
+          resource_recipe = "<wow, so much LWRP>"
+        end
+
+        if resource_recipe != @current_recipe
+          if @recipe_start_time
+            recipe_exec_time = Time.now.to_f - @recipe_start_time
+            puts "(#{recipe_exec_time.round(3)} secs)"
+          end
+          puts "Recipe: #{resource_recipe}"
+          @current_recipe = resource_recipe
+          @recipe_start_time = Time.now.to_f
+        end
+        @resource_start_time = Time.now.to_f
+      end
+
+      # Called when a resource action has been skipped b/c of a conditional
+      def resource_skipped(resource, action, conditional)
+        # Output should be blue (Skipped)
+        resource_exec_time = Time.now.to_f - @resource_start_time
+        puts("  * #{resource} action #{action} (#{resource_exec_time.round(3)} secs)", 'blue')
+      end
+
+      # Called when a resource has no converge actions, e.g., it was already correct.
+      def resource_up_to_date(resource, action)
+        # Output should be green
+        resource_exec_time = Time.now.to_f - @resource_start_time
+        puts("  * #{resource} action #{action} (#{resource_exec_time.round(3)} secs)", 'green')
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        # Output should be yellow (changes are applied)
+        resource_exec_time = Time.now.to_f - @resource_start_time
+        puts("  * #{resource} action #{action} (#{resource_exec_time.round(3)} secs)", 'yellow')
+      end
+    end
+  end
+end

data/nice-chef-formatter.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nice-chef-formatter"
+  s.version     = "0.0.1"
+  s.authors     = ["Nadir Lloret"]
+  s.email       = ["nadir.lloret@livedrive.com"]
+  s.homepage    = "https://github.com/nadirollo/nice-chef-formatter"
+  s.summary     = %q{Nice Chef log formatter}
+  s.description = %q{Simple formatted output for chef with execution times and color for resource action results}
+
+  s.rubyforge_project = "nice-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"]
+  s.add_runtime_dependency "rainbow"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: nice-chef-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nadir Lloret
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple formatted output for chef with execution times and color for resource
+  action results
+email:
+- nadir.lloret@livedrive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/chef/formatters/coloredputter.rb
+- lib/nice-chef-formatter.rb
+- nice-chef-formatter.gemspec
+homepage: https://github.com/nadirollo/nice-chef-formatter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nice-chef-formatter
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Nice Chef log formatter
+test_files: []