voxer-chef-formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b027873422ba551983712a16398b4673f839255
+  data.tar.gz: d336eba018d851b53f438d93f0c16867c0119302
+SHA512:
+  metadata.gz: fae1f919656196d6dea691c41619e8cffebfeeee9502716568c990f2724b1efcec6db6a3394821a34e415413ad46b691e0b051c92ae6fd29cadc36fce382a51e
+  data.tar.gz: ffacac1103de51b31e6a940ea340109d44ae0296834b017a05747f6c519bbac9cc6de53ba0ca1e6dfd9a05070ca6cee58f05dcce01ed1316ee4d19ecc3a01c1c

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voxer-chef-formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright 2007-2014, Voxer, Inc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+Voxer::Chef::Formatter
+======================
+
+Voxer's Chef Formatter improves the output of a chef-client or chef-solo run to be useful.
+
+Features
+--------
+
+Based on the chef [minimal formatter](https://github.com/opscode/chef/blob/master/lib/chef/formatters/minimal.rb)
+
+updates include
+
+- live updates as resources are updated (output isn't queued until the end of the run)
+- colorized diffs
+- file written to at the end with status information if `ENV['VOXER_FORMATTER_FILE']` is set
+- more verbose error messages
+
+Note: this formatter is best used with log_level :warn
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voxer-chef-formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voxer-chef-formatter
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/[my-github-username]/voxer-chef-formatter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/voxer-chef-formatter.rb

@@ -0,0 +1,279 @@
+#
+# Voxer Chef Formatter
+#
+# based on the chef `minimal` formatter
+# https://github.com/opscode/chef/blob/master/lib/chef/formatters/minimal.rb
+# updates include
+#  - live updates as resources are updated
+#  - colorized diff
+#  - file written to at the end with status information if `ENV['VOXER_FORMATTER_FILE']` is set
+#  - more verbose error messages
+#
+# This formatter is best used with log_level :warn
+#
+# Author:: Dave Eddy <dave@daveeddy.com>
+# Copyright:: Copyright (c) 2007-2014, Voxer LLC
+# License:: MIT
+#
+
+require 'chef/formatters/base'
+
+class Chef
+  module Formatters
+    class Voxer < Formatters::Base
+      cli_name(:voxer)
+
+      COLOR_RED = "\e[31m"
+      COLOR_GREEN = "\e[32m"
+      COLOR_MAGENTA = "\e[35m"
+      COLOR_RESET = "\e[0m"
+
+      def initialize(out, err)
+        super
+        @start_time = Time.now
+        @updated_resources = 0
+        @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, version #{version}"
+      end
+
+      # Called at the end of the Chef run.
+      def run_completed(node)
+        chef_dir = Chef::Config[:root_path]
+        now = Time.now
+        elapsed = (now - @start_time).round(2)
+        file = ENV['VOXER_FORMATTER_FILE']
+        unless file.nil?
+          data = {
+            :finished => now,
+            :elapsed => elapsed,
+            :dir => chef_dir,
+            :git => {
+              :branch => `git --git-dir #{chef_dir}/.git rev-parse --abbrev-ref HEAD 2>&1`.strip,
+              :commit => `git --git-dir #{chef_dir}/.git rev-parse HEAD 2>&1`.strip
+            }
+          }
+          IO.write(file, JSON.pretty_generate(data) + "\n")
+        end
+        puts "chef client finished. #{@updated_resources} resources updated, took #{elapsed} seconds"
+      end
+
+      # called at the end of a failed run
+      def run_failed(exception)
+        elapsed = (Time.now - @start_time).round(2)
+        puts "chef client failed. #{@updated_resources} resources updated, took #{elapsed} seconds"
+      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
+      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)
+        puts COLOR_RED
+        puts "failed to load file --> #{path}"
+        puts "                    --> #{exception}"
+        puts COLOR_RESET
+        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
+      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)
+        puts COLOR_RED
+        puts "failed to handle resource --> :#{action} #{resource}"
+        puts COLOR_RESET
+        puts "#{exception}"
+      end
+
+      # Called when a resource action has been skipped b/c of a conditional
+      def resource_skipped(resource, action, conditional)
+      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)
+      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)
+        @updates_by_resource[resource.name] << update
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        @updated_resources += 1
+
+        puts "* #{resource.to_s}"
+        @updates_by_resource[resource.name].each do |update|
+          u = Array(update)
+
+          # print what happened in green
+          puts "#{COLOR_GREEN}  - #{u[0]}#{COLOR_RESET}"
+
+          if u[1].is_a?(Array) then
+            # most likely a diff
+            puts ''
+            puts colorize_diff(u[1]).join("\n")
+          end
+        end
+        puts ''
+      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
+
+      # helper functions
+      def colorize_diff(diff)
+        diff.map do |l|
+          f = '        '
+          if l.start_with?('-') then
+            f += COLOR_RED
+          elsif l.start_with?('+') then
+            f += COLOR_GREEN
+          elsif l.start_with?('@') then
+            f += COLOR_MAGENTA
+          end
+          f += l
+          f += COLOR_RESET
+          f
+        end
+      end
+
+    end
+  end
+end

data/voxer-chef-formatter.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "voxer-chef-formatter"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Michael Burns"]
+  spec.email         = ["michael.burns@rackspace.com"]
+  spec.summary       = %q{Chef Formatter based on Minimal.}
+  spec.description   = %q{Improves the output of a chef run with colorized output and better error messages.}
+  spec.homepage      = "https://github.com/mburns/voxer-chef-formatter"
+  spec.license       = "MIT"
+
+  spec.rubyforge_project = "voxer-chef-formatter"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: voxer-chef-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Improves the output of a chef run with colorized output and better error
+  messages.
+email:
+- michael.burns@rackspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/voxer-chef-formatter.rb
+- voxer-chef-formatter.gemspec
+homepage: https://github.com/mburns/voxer-chef-formatter
+licenses:
+- MIT
+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: voxer-chef-formatter
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Chef Formatter based on Minimal.
+test_files: []