cycle_chef_handler 1.2.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.2.0 / 2011-08-30
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/cycle_chef_handler
+lib/cycle_chef_handler.rb
+test/test_cycle_chef_handler.rb

data/README.txt

@@ -0,0 +1,86 @@
+= cycle_chef_handler
+
+* http://github.com/cyclecomputing/cycle_chef_handler
+* http://www.cyclecomputing.com
+
+== DESCRIPTION:
+
+This extension of Chef::Handler creates reports in Condor class ad format and posts
+them to an amqp-complient message broker. This report handler was created to produce
+reports for the CycleServer Chef Dashboard available from Cycle Computing LLC.
+
+== REQUIREMENTS:
+
+* chef
+* classad
+* bunny
+
+== INSTALL:
+
+* sudo gem install cycle_chef_handler
+* edit /etc/chef/client.rb on client nodes:
+
+  require 'cycle_chef_handler'
+
+  handler = CycleChefHandler.new(:amqp_config => {:host => 'my_amqp_hostname'})
+
+  report_handlers    << handler
+  exception_handlers << handler
+
+== ADVANCED USAGE:
+
+The constructor takes a hash with the following keys:
+
+:amqp_config
+This key should point to a configuration hash suitable for Bunny.new(), including:
+
+* :host Host name of amqp broker
+* :port Port of amqp borker, default value = 5672
+* :vhost Name of virtual host on amqp broker, default value = '/'
+* :user User name on amqp broker, default value = 'guest'
+* :pass Password for :user on amqp broker, default value = 'guest'
+* :queue Queue name to be used to read report messages, default value = 'chef.converges'
+* :exchange Exchange name to be used to post report messages, default value = 'chef.converges'
+
+:extras
+This optional key may be used to pass arbitrary key, value pairs to the chef report classad.
+It may be used to tag chef clients to make it easier to slice and dice the report information.
+I use it (along with the ec2_metadata gem) to add Amazon Web Services EC2 instance data to
+the report.
+
+  :extras => {'InstanceId'       => Ec2Metadata[:instance_id],
+              'AvailabilityZone' => Ec2Metadata[:placement][:availability_zone],
+              'PublicHostName'   => Ec2Metadata[:public_hostname]}
+
+:converge_index_file
+This should point to a file where CycleChefHandler will keep track of the number of
+converges that have been attempted. Its default value is /var/run/chef/converge_index.
+
+:failed_converge_count_file
+This should point to a file where CycleChefHandler will keep track of the number of 
+consecutive failed converges. Its default value is /var/run/chef/failed_converge_count.
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+Copyright 2011 Cycle Computing LLC
+
+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/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'fileutils'
+require File.join(File.dirname(__FILE__), 'lib', 'cycle_chef_handler')
+
+# copy README.rdoc to README.txt
+FileUtils.cp File.join(File.dirname(__FILE__), 'README.rdoc'), File.join(File.dirname(__FILE__), 'README.txt') 
+
+# we don't use rubyforge
+Hoe.plugins.delete :rubyforge
+
+Hoe.spec 'cycle_chef_handler' do
+  developer('Chris Chalfant', 'chris.chalfant@cyclecomputing.com')
+  extra_deps << ['chef']
+  extra_deps << ['bunny']
+  extra_deps << ['classad']
+end
+

data/bin/cycle_chef_handler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/cycle_chef_handler.rb

@@ -0,0 +1,167 @@
+# cycle_chef_handler.rb
+#
+# Report handler for chef clients to be used with CycleServer Chef Dashboard
+#
+# Author: Chris Chalfant (chris.chalfant@cyclecomputing.com)
+#
+# Copyright 2010 Cycle Computing LLC
+#
+# 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.
+
+require 'rubygems'
+require 'chef'
+require 'bunny'
+require 'classad'
+require 'fileutils'
+require 'uri'
+
+class CycleChefHandler < Chef::Handler
+  VERSION = '1.2.0'
+
+  def initialize(params)
+    defaults = {:queue       => 'chef.converges',
+                :exchange    => 'chef.converges'}
+
+    @amqp_config = defaults.merge(params[:amqp_config])
+    check_amqp_config
+
+    @extras = params[:extras]
+    @converge_index_file = params[:converge_index_file] || '/var/run/chef/converge_index'
+    @failed_converge_file = params[:failed_converge_count_file] || '/var/run/chef/failed_converge_count'
+  end
+
+  def check_amqp_config
+    [:host, :queue, :exchange].each do |i|
+      if not @amqp_config[i]
+        raise ArgumentError, ":amqp_config missing value for #{i}"
+      end
+    end
+  end
+
+  def report
+
+    ## Create and Post a classad
+    ad = create_ad
+    payload = "<classads>" + ad.to_xml + "</classads>"
+    
+    begin
+
+      b = Bunny.new(@amqp_config)
+
+      b.start
+      e = b.exchange(@amqp_config[:exchange], 
+                     :type => :topic, 
+                     :durable => true, 
+                     :auto_delete => false)
+
+      # declare and bind a non-auto-delete queue here to make sure we don't
+      # lose any messages posted to an exchange w/o a bound queue
+      # make the queue non-durable so we can drop it with a broker reboot
+      q = b.queue(@amqp_config[:queue], :auto_delete => false)
+      q.bind(@amqp_config[:exchange], :key => @amqp_config[:queue])
+
+      e.publish(payload, :key => @amqp_config[:queue])
+
+    rescue Exception => e
+
+      # log any exceptions, but don't throw one.
+      trace = e.backtrace.join("\n")
+      Chef::Log.error("Failed to post converge history report: #{e.message} #{trace}")
+      return
+
+    ensure
+
+      b.stop
+
+    end
+
+    Chef::Log.info("Posted converge history report")
+
+  end
+
+  def create_ad
+    ad = ClassAd.new
+    ad['AdType']              = 'Chef.Host'
+    ad['ChefNode']            = Chef::Config[:node_name]
+    ad['ConvergeStartTime']   = start_time
+    ad['ConvergeEndTime']     = end_time
+    ad['ConvergeElapsedTime'] = RelativeTime.new(elapsed_time)
+
+    updated = []
+    if not updated_resources.nil?
+      updated = updated_resources.map {|x| x.to_s}
+    end
+
+    ad['UpdatedResources']      = updated
+    ad['UpdatedResourcesCount'] = updated.size
+    ad['ConvergeIndex']         = increment_count_file(@converge_index_file)
+    ad['ChefServerUrl']         = Chef::Config[:chef_server_url]
+    ad['ChefServerHostName']    = URI.parse(Chef::Config[:chef_server_url]).host
+    ad['ChefClientVersion']     = Chef::VERSION
+    ad['CycleChefHandlerVersion'] = CycleChefHandler::VERSION
+    ad['Success']               = success?
+
+    exception = nil
+    backtrace = nil
+    if failed?
+      exception = run_status.formatted_exception
+      backtrace = run_status.backtrace
+      ad['FailedConvergeCount'] = increment_count_file(@failed_converge_file)
+    else
+      clear_count_file(@failed_converge_file)
+      ad['FailedConvergeCount'] = 0
+    end
+
+    ad['Exception']             = exception
+    ad['Backtrace']             = backtrace
+
+    @extras.each do |k,v|
+      ad[k] = v
+    end
+
+    ad
+  end
+
+  def increment_count_file(count_file)
+    file_dir = File.dirname(count_file)
+    if not File.directory? file_dir
+      FileUtils.mkdir_p file_dir
+    end
+   
+    count = nil
+    if File.exists? count_file
+      File.open(count_file) do |file|
+        count = file.readline.chomp.to_i
+      end
+    end
+
+    if count.nil?
+      count = 1
+    else
+      count += 1
+    end
+
+    File.open(count_file, "w") do |file|
+      file.puts(count)
+    end
+      
+    count
+  end
+
+  def clear_count_file(count_file)
+    if File.exist? count_file
+      FileUtils.rm count_file
+    end
+  end
+
+end

data/test/test_cycle_chef_handler.rb

@@ -0,0 +1,27 @@
+require "test/unit"
+require "cycle_chef_handler"
+
+class TestCycleChefHandler < Test::Unit::TestCase
+  
+  def setup
+    @index_file = File.join(File.dirname(__FILE__), 'index')
+    @handler = CycleChefHandler.new(:amqp_config => {:host=> 'h'},
+                                    :converge_index_file => @index_file )
+  end
+
+  def teardown
+    File.unlink @index_file if File.exist? @index_file
+  end
+
+  def test_increment
+    assert_equal(1, @handler.increment_count_file(@index_file))
+    assert_equal(2, @handler.increment_count_file(@index_file))
+  end
+
+  def test_reset
+    assert_equal(1, @handler.increment_count_file(@index_file))
+    assert_equal(2, @handler.increment_count_file(@index_file))
+    @handler.clear_count_file(@index_file)
+    assert_equal(1, @handler.increment_count_file(@index_file))
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: cycle_chef_handler
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
+platform: ruby
+authors: 
+- Chris Chalfant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: chef
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bunny
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: classad
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id004
+description: |-
+  This extension of Chef::Handler creates reports in Condor class ad format and posts
+  them to an amqp-complient message broker. This report handler was created to produce
+  reports for the CycleServer Chef Dashboard available from Cycle Computing LLC.
+email: 
+- chris.chalfant@cyclecomputing.com
+executables: 
+- cycle_chef_handler
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/cycle_chef_handler
+- lib/cycle_chef_handler.rb
+- test/test_cycle_chef_handler.rb
+homepage: http://github.com/cyclecomputing/cycle_chef_handler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cycle_chef_handler
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: This extension of Chef::Handler creates reports in Condor class ad format and posts them to an amqp-complient message broker
+test_files: 
+- test/test_cycle_chef_handler.rb