chef-rabbit 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTdjY2I2MWNjNDQ5NDg4ZWU1NDQ3OTQwYjFjZGQ3NmEwMGE4NDk3ZQ==
+    YjY4OWVkNTZiNDhjYzU3ZTIxZGJjNWJmNzc3NTUzMGE0YjhmYzEwMA==
   data.tar.gz: !binary |-
-    N2M4NDhlMzQ4N2FlMGFiMzk5MTI0MzU0MDEyYWJlODc1NTczZjdlYw==
+    MDk1NDI0YWMwMTI0YTZkYjMzY2NmY2NiNGRmOGU3NDMzZmQ1NDc1Yg==
 SHA512:
   metadata.gz: !binary |-
-    YWQ5ZGM0YzM5NTU2YmFjMWFmZWMwYjhhM2ZhZDRlODM5NzdiMzczZDQyNjU2
-    YzA3MjdhYzBkNDViZmFlOGQxNjY3NzQxMWM0NTk2ZTNmN2Y0NmVjZTJmM2Mw
-    ZWJiMzA0MzgzYWVmNDQ1ZGMzNWFjMjRhNGIyNGE2MzdkMzZjYTg=
+    YjZkNDkzNmE3NTRjNTcwNjBhNTJjMjI3NGQ0OTBmOTY3NzE3NmUwMmMxYjBj
+    MDIyOGNiODk1OTI0NDA4NjNjN2JmZjY0OTc0ZGJmOTkyYmIxNTQxZTg1YTk1
+    YTNhYTMyMGExOTBiNDNiNDIwYzRhZWFjNGJhM2I5ZDBkYzk2ZWQ=
   data.tar.gz: !binary |-
-    Y2JjNTQyNTM2YzRmMmZkNDQ2YTZjYTk4Mjc5MTU0OTAyMTRmMTQ5M2Q1MzYx
-    Yzk0NDJkOTUzODRmN2E0YjE0NjA1ZDE4YTUzNTM2NTUyOTNlZDc5MmQ1MjIy
-    YmNkMzRiYzUzYmNlZjM0ODVmZjYyMGE4YWMxYTNiOTRkMDBiMWY=
+    NTJkMzM1NWY0ZmY0ZWQ5OTkyZjZmZGQyYjMxZmMyYmFhMjk4NjJkMTc0NGYw
+    YTAwNGYwMWFhNmRmMWZjMmUxZmI4ZmMwOWQxNDAwMGNhZmM0NDI2MDJiZDFm
+    YjBkZmRiMGQ5OGJjM2Y0MTlmZmJkYWRhNTBjOTc4YzA5ZDMzMGQ=

data/README.md

@@ -0,0 +1,88 @@
+##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({
+      :connection => {
+        :host => "your_rabbit_server",
+        :user => "rabbit_user",
+        :pass => "rabbit_pass",
+        :vhost => "/stuff"
+      }
+      :queue => {
+        :name => "some_queue",
+        :params => {
+          :durable => true,
+          ...
+        }
+      },
+      :exchange => {
+        :name => "some_exchange",
+        :params => {
+          :durable => true,
+          ...
+        }
+      },
+      :timestamp_tag => "@timestamp"
+    })
+
+    supports :exception => true, :report => true
+  end.run_action(:enable)
+```
+
+Arguments take the form of an options hash, with the following options:
+
+* :connection             - http://rubybunny.info/articles/connecting.html
+* :queue                  - rabbit queue info to use. name is set to "chef-client" + durable = true by default
+* :exchange               - rabbit exchange to use .default_exchange + durable = true by default 
+* :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
+
+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.

data/README.rdoc

@@ -23,11 +23,26 @@ This example makes of the chef_handler cookbook, place some thing like this in c
   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,
+      :connection => {
+        :host => "your_rabbit_server",
+        :user => "rabbit_user",
+        :pass => "rabbit_pass",
+        :vhost => "/stuff"
+      }
+      :queue => {
+        :name => "some_queue",
+        :params => {
+          :durable => true,
+          ...
+        }
+      },
+      :exchange => {
+        :name => "some_exchange",
+        :params => {
+          :durable => true,
+          ...
+        }
+      },
       :timestamp_tag => "@timestamp"
     })
 
@@ -36,9 +51,9 @@ This example makes of the chef_handler cookbook, place some thing like this in c
 
 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
+* :connection             - http://rubybunny.info/articles/connecting.html
+* :queue                  - rabbit queue info to use. name is set to "chef-client" + durable = true by default
+* :exchange               - rabbit exchange to use .default_exchange + durable = true by default 
 * :timestamp_tag          - tag for timestamp "timestamp" by default
 * :blacklist ({})         - A hash of cookbooks, resources and actions to ignore in the change list.
 
@@ -63,20 +78,9 @@ Some resources report themselves as having updated on every run even if nothing
 
 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.
+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.

data/lib/chef/rabbit.rb

@@ -1,24 +1,11 @@
 #--
-
 # 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.
+# 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 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.
 #++
 
 require "chef/rabbit/version"
@@ -33,23 +20,30 @@ class Chef
       
       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
+          :connection => {
+            :host => "127.0.0.1",
+            :port => 5672,
+            :ssl => false,
+            :vhost => "/",
+            :user => "guest",
+            :pass => "guest",
+            :heartbeat => :server, # will use RabbitMQ setting
+            :frame_max => 131072
+          },
+          :queue => {
+            :name => "chef-rabbit",
+            :params => {
+              :durable => true
+            }
+          }
         }.merge(value)
       end
 
       def initialize(options = {})
-        self.options = options
+        self.options = symbolize_keys(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)
+        Chef::Log.debug "Initialised RABBIT handler for amqp://#{self.options[:connection][:user]}:#{self.options[:connection][:pass]}@#{self.options[:connection][:host]}:#{self.options[:connection][:port]}/#{self.options[:connection][:vhost]}"
+        @connection = Bunny.new(self.options[:connection])
         @connection.start
       end
 
@@ -57,7 +51,9 @@ class Chef
         Chef::Log.debug "Reporting #{run_status.inspect}"
 
         channel = @connection.create_channel
-        exchange = (@options[:exchange] == nil) ? channel.default_echange : channel.direct(@options[:exchange])
+        exchange = (@options[:exchange] == nil) ? channel.default_echange : channel.direct(@options[:exchange][:name], @options[:exchange][:params])
+        channel.queue(@options[:queue][:name], @options[:queue][:params]).bind(exch)
+
         timestamp = (@options[:timestamp_tag] == nil) ? "timestamp" : @options[:timestamp_tag]
 
         if run_status.failed?
@@ -68,7 +64,7 @@ class Chef
               :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])
+            :routing_key => @options[:queue][:name])
         else
           Chef::Log.debug "Notifying Rabbit server of success."
           exchange.publish(
@@ -77,7 +73,7 @@ class Chef
               :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])
+            :routing_key => @options[:queue][:name])
         end
       end
       
@@ -99,6 +95,21 @@ class Chef
         @changes = { :lines => lines, :count => count, :message => message }
       end
 
+      def symbolize_keys(hash)
+        hash.inject({}) {|result, (key, value)|
+          new_key = case key
+                    when String then key.to_sym
+                    else key
+                    end
+          new_value = case value
+                      when Hash then symbolize_keys(value)
+                      else value
+                      end
+          result[new_key] = new_value
+          result
+        }
+      end
+
       def sanitised_changes
         run_status.updated_resources.reject do |updated|
           cookbook = @options[:blacklist][updated.cookbook_name]

data/lib/chef/rabbit/version.rb

@@ -23,6 +23,6 @@
 
 class Chef
   module RABBIT
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-rabbit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - MTN Satellite Communications
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -48,36 +48,34 @@ description: ! "= DESCRIPTION:\n\nProvides a Chef handler which can report run s
   \ 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\"
+  \   arguments({\n      :connection => {\n        :host => \"your_rabbit_server\",\n
+  \       :user => \"rabbit_user\",\n        :pass => \"rabbit_pass\",\n        :vhost
+  => \"/stuff\"\n      }\n      :queue => {\n        :name => \"some_queue\",\n        :params
+  => {\n          :durable => true,\n          ...\n        }\n      },\n      :exchange
+  => {\n        :name => \"some_exchange\",\n        :params => {\n          :durable
+  => true,\n          ...\n        }\n      },\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* :connection             -
+  http://rubybunny.info/articles/connecting.html\n* :queue                  - rabbit
+  queue info to use. name is set to \"chef-client\" + durable = true by default\n*
+  :exchange               - rabbit exchange to use .default_exchange + durable = true
+  by default \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"
+  AUTHOR:\n\nCopyright 2014 by MTN Sattelite Communications\n\nLicensed 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 \n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless
+  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. \nSee the License for the specific language
+  governing permissions and limitations under the License.\n"
 email:
 - marat.garafutdinov@mtnsart.com
 executables: []