chef-rabbit 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTdjY2I2MWNjNDQ5NDg4ZWU1NDQ3OTQwYjFjZGQ3NmEwMGE4NDk3ZQ==
+  data.tar.gz: !binary |-
+    N2M4NDhlMzQ4N2FlMGFiMzk5MTI0MzU0MDEyYWJlODc1NTczZjdlYw==
+SHA512:
+  metadata.gz: !binary |-
+    YWQ5ZGM0YzM5NTU2YmFjMWFmZWMwYjhhM2ZhZDRlODM5NzdiMzczZDQyNjU2
+    YzA3MjdhYzBkNDViZmFlOGQxNjY3NzQxMWM0NTk2ZTNmN2Y0NmVjZTJmM2Mw
+    ZWJiMzA0MzgzYWVmNDQ1ZGMzNWFjMjRhNGIyNGE2MzdkMzZjYTg=
+  data.tar.gz: !binary |-
+    Y2JjNTQyNTM2YzRmMmZkNDQ2YTZjYTk4Mjc5MTU0OTAyMTRmMTQ5M2Q1MzYx
+    Yzk0NDJkOTUzODRmN2E0YjE0NjA1ZDE4YTUzNTM2NTUyOTNlZDc5MmQ1MjIy
+    YmNkMzRiYzUzYmNlZjM0ODVmZjYyMGE4YWMxYTNiOTRkMDBiMWY=

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in chef-rabbit.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,82 @@
+= DESCRIPTION:
+
+Provides a Chef handler which can report run status, including any changes that were made, to a rabbit server. In the case of failed runs a backtrace will be included in the details reported. Based on the Graylog Gelf handler by Jon Wood (<jon@blankpad.net>) https://github.com/jellybob/chef-gelf
+
+= REQUIREMENTS:
+
+* A Rabbit server running somewhere.
+
+= USAGE:
+
+This example makes of the chef_handler cookbook, place some thing like this in cookbooks/chef_handler/recipes/rabbit.rb and add it to your run list. 
+
+  include_recipe "chef_handler::default"
+
+  gem_package "chef-rabbit" do
+    action :nothing
+  end.run_action(:install)
+  
+  # Make sure the newly installed Gem is loaded.
+  Gem.clear_paths
+  require 'chef/rabbit'
+  
+  chef_handler "Chef::RABBIT::Handler" do
+    source "chef/rabbit"
+    arguments({
+      :host => your_rabbit_server,
+      :user => rabbit_user,
+      :pass => rabbit_pass,
+      :queue => your_queue,
+      :exchange => your_exchange,
+      :timestamp_tag => "@timestamp"
+    })
+
+    supports :exception => true, :report => true
+  end.run_action(:enable)
+
+Arguments take the form of an options hash, with the following options:
+
+* bunny client attributes - http://rubybunny.info/articles/connecting.html
+* :queue                  - name of the rabbit queue to use. "chef-client" by default
+* :exchange               - name of exchange to use .default_exchange otherwise
+* :timestamp_tag          - tag for timestamp "timestamp" by default
+* :blacklist ({})         - A hash of cookbooks, resources and actions to ignore in the change list.
+
+= BLACKLISTING:
+
+Some resources report themselves as having updated on every run even if nothing changed, or are just things you don't care about. To reduce the amount of noise in your logs these can be ignored by providing a blacklist. In this example we don't want to be told about the GELF handler being activated:
+
+    chef_handler "Chef::RABBIT::Handler" do
+      source "chef/rabbit"
+      arguments({
+        :blacklist => {
+          "chef_handler" => {
+            "chef_handler" => [ "nothing", "enable" ]
+          }
+        }
+      })
+
+      supports :exception => true, :report => true
+    end.run_action(:enable)
+
+= LICENSE and AUTHOR:
+
+Copyright 2014 by MTN Sattelite Communications
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/chef-rabbit.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "chef/rabbit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "chef-rabbit"
+  s.version     = Chef::RABBIT::VERSION
+  s.authors     = ["MTN Satellite Communications"]
+  s.email       = ["marat.garafutdinov@mtnsart.com"]
+  s.homepage    = "https://github.com/MTNSatelliteComm/chef-rabbit"
+  s.summary     = %q{Provides a Chef handler which reports run failures and changes to a Rabbit server.}
+  s.description = File.read("README.rdoc")
+
+  s.rubyforge_project = "chef-rabbit"
+
+  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_dependency "bunny"
+  s.add_dependency "chef"
+end

data/lib/chef/rabbit.rb

@@ -0,0 +1,115 @@
+#--
+
+# Copyright 2014 by MTN Sattelite Communications
+#
+# 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.
+#++
+
+require "chef/rabbit/version"
+require 'bunny'
+require 'chef/log'
+
+class Chef
+  module RABBIT
+    class Handler < Chef::Handler
+      attr_reader :connection
+      attr_reader :options
+      
+      def options=(value = {})
+        @options = {
+          :host => "127.0.0.1",
+          :port => 5672,
+          :ssl => false,
+          :vhost => "/",
+          :user => "guest",
+          :pass => "guest",
+          :queue => "chef-rabbit",
+          :heartbeat => :server, # will use RabbitMQ setting
+          :frame_max => 131072
+        }.merge(value)
+      end
+
+      def initialize(options = {})
+        self.options = options
+        
+        Chef::Log.debug "Initialised RABBIT handler for amqp://#{self.options[:server]}:#{self.options[:server]}@#{self.options[:server]}:#{self.options[:port]}/#{self.options[:vhost]}"
+        @connection = Bunny.new(self.options)
+        @connection.start
+      end
+
+      def report
+        Chef::Log.debug "Reporting #{run_status.inspect}"
+
+        channel = @connection.create_channel
+        exchange = (@options[:exchange] == nil) ? channel.default_echange : channel.direct(@options[:exchange])
+        timestamp = (@options[:timestamp_tag] == nil) ? "timestamp" : @options[:timestamp_tag]
+
+        if run_status.failed?
+          Chef::Log.debug "Notifying Rabbit server of failure."
+          exchange.publish( 
+            { 
+              timestamp.to_sym => Time.now.getutc.to_s,
+              :short_message => "Chef run failed on #{node.name}. Updated #{changes[:count]} resources.",
+              :full_message => run_status.formatted_exception + "\n" + Array(backtrace).join("\n") + changes[:message]
+            }.to_json, 
+            :routing_key => @options[:queue])
+        else
+          Chef::Log.debug "Notifying Rabbit server of success."
+          exchange.publish(
+            {
+              timestamp.to_sym => Time.now.getutc.to_s,
+              :short_message => "Chef run completed on #{node.name} in #{elapsed_time}. Updated #{changes[:count]} resources.",
+              :full_message => changes[:message]
+            }.to_json,
+            :routing_key => @options[:queue])
+        end
+      end
+      
+      def changes
+        @changes unless @changes.nil?
+        
+        lines = sanitised_changes.collect do |resource|
+          "recipe[#{resource.cookbook_name}::#{resource.recipe_name}] ran '#{resource.action}' on #{resource.resource_name} '#{resource.name}'"
+        end
+
+        count = lines.size
+
+        message = if count > 0
+          "Updated #{count} resources:\n\n#{lines.join("\n")}"
+        else
+          "No changes made."
+        end
+
+        @changes = { :lines => lines, :count => count, :message => message }
+      end
+
+      def sanitised_changes
+        run_status.updated_resources.reject do |updated|
+          cookbook = @options[:blacklist][updated.cookbook_name]
+          if cookbook
+            resource = cookbook[updated.resource_name.to_s] || []
+          else
+            resource = []
+          end
+          cookbook && resource.include?(updated.action.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/chef/rabbit/version.rb

@@ -0,0 +1,28 @@
+#--
+
+# Copyright 2014 by MTN Sattelite Communications
+#
+# 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.
+#++
+
+class Chef
+  module RABBIT
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: chef-rabbit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MTN Satellite Communications
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "= DESCRIPTION:\n\nProvides a Chef handler which can report run status,
+  including any changes that were made, to a rabbit server. In the case of failed
+  runs a backtrace will be included in the details reported. Based on the Graylog
+  Gelf handler by Jon Wood (<jon@blankpad.net>) https://github.com/jellybob/chef-gelf\n\n=
+  REQUIREMENTS:\n\n* A Rabbit server running somewhere.\n\n= USAGE:\n\nThis example
+  makes of the chef_handler cookbook, place some thing like this in cookbooks/chef_handler/recipes/rabbit.rb
+  and add it to your run list. \n\n  include_recipe \"chef_handler::default\"\n\n
+  \ gem_package \"chef-rabbit\" do\n    action :nothing\n  end.run_action(:install)\n
+  \ \n  # Make sure the newly installed Gem is loaded.\n  Gem.clear_paths\n  require
+  'chef/rabbit'\n  \n  chef_handler \"Chef::RABBIT::Handler\" do\n    source \"chef/rabbit\"\n
+  \   arguments({\n      :host => your_rabbit_server,\n      :user => rabbit_user,\n
+  \     :pass => rabbit_pass,\n      :queue => your_queue,\n      :exchange => your_exchange,\n
+  \     :timestamp_tag => \"@timestamp\"\n    })\n\n    supports :exception => true,
+  :report => true\n  end.run_action(:enable)\n\nArguments take the form of an options
+  hash, with the following options:\n\n* bunny client attributes - http://rubybunny.info/articles/connecting.html\n*
+  :queue                  - name of the rabbit queue to use. \"chef-client\" by default\n*
+  :exchange               - name of exchange to use .default_exchange otherwise\n*
+  :timestamp_tag          - tag for timestamp \"timestamp\" by default\n* :blacklist
+  ({})         - A hash of cookbooks, resources and actions to ignore in the change
+  list.\n\n= BLACKLISTING:\n\nSome resources report themselves as having updated on
+  every run even if nothing changed, or are just things you don't care about. To reduce
+  the amount of noise in your logs these can be ignored by providing a blacklist.
+  In this example we don't want to be told about the GELF handler being activated:\n\n
+  \   chef_handler \"Chef::RABBIT::Handler\" do\n      source \"chef/rabbit\"\n      arguments({\n
+  \       :blacklist => {\n          \"chef_handler\" => {\n            \"chef_handler\"
+  => [ \"nothing\", \"enable\" ]\n          }\n        }\n      })\n\n      supports
+  :exception => true, :report => true\n    end.run_action(:enable)\n\n= LICENSE and
+  AUTHOR:\n\nCopyright 2014 by MTN Sattelite Communications\n\nPermission is hereby
+  granted, free of charge, to any person obtaining a copy\nof this software and associated
+  documentation files (the \"Software\"), to\ndeal in the Software without restriction,
+  including without limitation the\nrights to use, copy, modify, merge, publish, distribute,
+  sublicense, and/or\nsell copies of the Software, and to permit persons to whom the
+  Software is\nfurnished to do so, subject to the following conditions:\n\nThe above
+  copyright notice and this permission notice shall be included in\nall copies or
+  substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT
+  WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+  OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+  EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+  OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\nIN THE SOFTWARE.\n"
+email:
+- marat.garafutdinov@mtnsart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- README.rdoc
+- Rakefile
+- chef-rabbit.gemspec
+- lib/chef/rabbit.rb
+- lib/chef/rabbit/version.rb
+homepage: https://github.com/MTNSatelliteComm/chef-rabbit
+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: chef-rabbit
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a Chef handler which reports run failures and changes to a Rabbit
+  server.
+test_files: []