chef-handler-sns 0.2.1 → 0.2.2

data/README.md

@@ -9,6 +9,7 @@ This Chef Handler is heavily based on [Joshua Timberman](https://github.com/jtim
 [![Gem Version](https://badge.fury.io/rb/chef-handler-sns.png)](http://badge.fury.io/rb/chef-handler-sns)
 [![Dependency Status](https://gemnasium.com/onddo/chef-handler-sns.png)](https://gemnasium.com/onddo/chef-handler-sns)
 [![Code Climate](https://codeclimate.com/github/onddo/chef-handler-sns.png)](https://codeclimate.com/github/onddo/chef-handler-sns)
+[![Build Status](https://travis-ci.org/onddo/chef-handler-sns.png)](https://travis-ci.org/onddo/chef-handler-sns)
 
 ## Requirements
 
@@ -110,17 +111,113 @@ The following options are available to configure the handler:
 * `secret_key` - AWS secret key (required).
 * `topic_arn` - AWS topic ARN name (required).
 * `region` - AWS region (optional).
-* `subject` - Message subject string in erubis format (optional). Example:
-```
+* `subject` - Message subject string in erubis format (optional).
+* `body_template` - Full path of an erubis template file to use for the message body (optional).
+
+### subject
+
+Here is an example of the `subject` configuration option using the ruby configuration file (`solo.rb` or `client.rb`):
+
+```ruby
 sns_handler.subject: "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>"
 ```
-* `body_template` - Full path of an erubis template file to use for the message body (optional).
 
-## Roadmap
+Using the [chef_handler LWRP](http://community.opscode.com/cookbooks/chef_handler):
+```ruby
+argument_array = [
+  :access_key => "***AMAZON-KEY***",
+  :secret_key => "***AMAZON-SECRET***",
+  :topic_arn => "arn:aws:sns:***",
+  :subject => "Chef-run: <%= node.name %> - <%= run_status.success? ? 'ok' : 'error' %>",
+  # [...]
+]
+chef_handler "Chef::Handler::Sns" do
+  # [...]
+  arguments argument_array
+end
+```
+
+The following variables are accesible inside the template:
+
+* `start_time` - The time the chef run started.
+* `end_time` - The time the chef run ended.
+* `elapsed_time` - The time elapsed between the start and finish of the chef run.
+* `run_context` - The Chef::RunContext object used by the chef run.
+* `exception` - The uncaught Exception that terminated the chef run, or nil if the run completed successfully.
+* `backtrace` - The backtrace captured by the uncaught exception that terminated the chef run, or nil if the run completed successfully.
+* `node` - The Chef::Node for this client run.
+* `all_resources` - An Array containing all resources in the chef run's resource_collection.
+* `updated_resources` - An Array containing all resources that were updated during the chef run.
+* `success?` - Was the chef run successful? True if the chef run did not raise an uncaught exception.
+* `failed?` - Did the chef run fail? True if the chef run raised an uncaught exception.
+
+### body_template
+
+This configuration option needs to contain the full path of an erubis template. For example:
+
+```ruby
+# recipe "myapp::sns_handler"
+
+template "/tmp/chef_handler_sns_body.erb" do
+  source "chef_handler_sns_body_erb.erb"
+  # [...]
+end
+
+argument_array = [
+  :access_key => "***AMAZON-KEY***",
+  :secret_key => "***AMAZON-SECRET***",
+  :topic_arn => "arn:aws:sns:***",
+  :body_template => "/tmp/chef_handler_sns_body.erb",
+  # [...]
+]
+chef_handler "Chef::Handler::Sns" do
+  # [...]
+  arguments argument_array
+end
+```
+
+```erb
+<%# template "myapp/templates/default/chef_handler_sns_body_erb.erb" %>
+
+Node Name: <%= node.name %>
+<% if node.attribute?("fqdn") -%>
+Hostname: <%= node.fqdn %>
+<% end -%>
+
+Chef Run List: <%= node.run_list.to_s %>
+Chef Environment: <%= node.chef_environment %>
+
+<% if node.attribute?("ec2") -%>
+Instance Id: <%= node.ec2.instance_id %>
+Instance Public Hostname: <%= node.ec2.public_hostname %>
+Instance Hostname: <%= node.ec2.hostname %>
+Instance Public IPv4: <%= node.ec2.public_ipv4 %>
+Instance Local IPv4: <%= node.ec2.local_ipv4 %>
+<% end -%>
+
+Chef Client Elapsed Time: <%= elapsed_time.to_s %>
+Chef Client Start Time: <%= start_time.to_s %>
+Chef Client Start Time: <%= end_time.to_s %>
+
+<% if exception -%>
+Exception: <%= run_status.formatted_exception %>
+Stacktrace:
+<%= Array(backtrace).join("\n") %>
+
+<% end -%>
+```
+
+See the [subject](#subject) documentation for more details on the variables accesible inside the template.
+
+## Running the tests
+
+Minitest tests can be run as usual:
+
+    rake test
 
-* rspec tests.
+## Contributing
 
-Pull requests are welcome.
+[Pull Requests](http://github.com/onddo/chef-handler-sns/pulls) are welcome.
 
 ## License and Author
 

data/lib/chef/handler/sns.rb

@@ -17,13 +17,13 @@
 #
 
 require 'chef/handler'
+require 'chef/handler/sns/config'
 require 'right_aws'
 require 'erubis'
 
 class Chef
   class Handler
     class Sns < ::Chef::Handler
-      require 'chef/handler/sns/config'
       include ::Chef::Handler::Sns::Config
   
       def initialize(config={})
@@ -35,15 +35,23 @@ class Chef
         config_check
         sns.publish(topic_arn, sns_body, sns_subject)
       end
-  
+
+      def server
+        @sns.params[:server]
+      end
+
       protected
 
       def sns
         @sns ||= begin
           params = {
-            :logger => Chef::Log,
-            :region => region || node.ec2.placement_availability_zone.chop
+            :logger => Chef::Log
           }
+          if (region)
+            params[:region] = region
+          elsif node.attribute?('ec2') and node.ec2.attribute?('placement_availability_zone')
+            params[:region] = node.ec2.placement_availability_zone.chop
+          end
           params[:token] = token if token
           RightAws::SnsInterface.new(access_key, secret_key, params)
         end

data/lib/chef/handler/sns/config.rb

@@ -21,29 +21,30 @@ require 'chef/exceptions'
 
 class Chef
   class Handler
-    class Sns
+    class Sns < ::Chef::Handler
       module Config
+        Config.extend Config # let Config use the methods it contains as instance methods
         include ::Chef::Mixin::ParamsValidate
+
+        REQUIRED = [ 'access_key', 'secret_key', 'topic_arn' ]
       
         def config_init(config={})
           config.each do |key, value|
-            if self.respond_to?(key)
+            if Config.respond_to?(key) and not /^config_/ =~ key.to_s
               self.send(key, value)
             else
-              Chef::Log.warn("#{self.class.to_s}: cnofiguration method not found: #{key}.")
+              Chef::Log.warn("#{self.class.to_s}: configuration method not found: #{key}.")
             end
           end
         end
       
         def config_check
-          required = [ 'access_key', 'secret_key', 'topic_arn' ]
-          opts = {}
-          map = {}
-          required.each do |key|
-            opts[key] = self.send(key)
-            map[key] = { :required => true }
+          REQUIRED.each do |key|
+            if self.send(key).nil?
+              raise Exceptions::ValidationFailed,
+                "Required argument #{key.to_s} is missing!"
+            end
           end
-          validate(opts, map)
       
           if body_template and not ::File.exists?(body_template)
             raise Exceptions::ValidationFailed,

data/lib/chef/handler/sns/version.rb

@@ -1,7 +1,8 @@
+
 class Chef
   class Handler
-    class Sns
-      VERSION = '0.2.1'
+    class Sns < ::Chef::Handler
+      VERSION = '0.2.2'
     end
   end
 end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+gem 'minitest' # ensures you're using the gem, and not the built in MT
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'chef/handler/sns'

data/test/test_chef_handler_sns.rb

@@ -0,0 +1,151 @@
+require 'helper'
+require 'chef/node'
+require 'chef/run_status'
+
+class RightAws::FakeSnsInterface < RightAws::SnsInterface
+  attr_reader :sns_interface_new, :topic_arn, :message, :subject
+
+  def fake_new
+    @sns_interface_new = true
+    return self
+  end
+
+end
+
+class Chef::Handler::FakeSns < Chef::Handler::Sns
+
+  def get_sns_subject
+    sns_subject
+  end
+
+  def get_sns_body
+    sns_body
+  end
+
+end
+
+describe Chef::Handler::Sns do
+  before do
+    RightAws::SnsInterface.any_instance.stubs(:publish).returns(true)
+
+    @node = Chef::Node.new
+    @node.name('test')
+    Chef::Handler::Sns.any_instance.stubs(:node).returns(@node)
+
+    @run_status = if Gem.loaded_specs['chef'].version > Gem::Version.new('0.12.0')
+      Chef::RunStatus.new(@node, {})
+    else
+      Chef::RunStatus.new(@node)
+    end
+    @run_status.start_clock
+    @run_status.stop_clock
+
+    @config = {
+      :access_key => '***AMAZON-KEY***',
+      :secret_key => '***AMAZON-SECRET***',
+      :topic_arn => 'arn:aws:sns:***',
+    }
+  end
+
+  it 'should read the configuration options on initialization' do
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    assert_equal @sns_handler.access_key, @config[:access_key]
+    assert_equal @sns_handler.secret_key, @config[:secret_key]
+  end
+
+  it 'should be able to change configuration options using method calls' do
+    @sns_handler = Chef::Handler::Sns.new
+    @sns_handler.access_key(@config[:access_key])
+    @sns_handler.secret_key(@config[:secret_key])
+    assert_equal @sns_handler.access_key, @config[:access_key]
+    assert_equal @sns_handler.secret_key, @config[:secret_key]
+  end
+
+  it 'should try to send a SNS message when properly configured' do
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    RightAws::SnsInterface.any_instance.expects(:publish).once
+
+    @sns_handler.run_report_safely(@run_status)
+  end
+
+  it 'should create a RightAws::SnsInterface object' do
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    fake_sns = RightAws::FakeSnsInterface.new(@config[:access_key], @config[:secret_key], {:logger => Chef::Log})
+    RightAws::SnsInterface.any_instance.stubs(:new).returns(fake_sns.fake_new)
+    @sns_handler.run_report_safely(@run_status)
+
+    assert_equal fake_sns.sns_interface_new, true
+  end
+
+  it 'should detect the AWS region automatically' do
+    @node.set['ec2']['placement_availability_zone'] = 'eu-west-1a'
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    @sns_handler.run_report_safely(@run_status)
+
+    @sns_handler.server.must_match Regexp.new('eu-west-1')
+  end
+
+  it 'should not detect AWS region automatically whan manually set' do
+    @node.set['ec2']['placement_availability_zone'] = 'eu-west-1a'
+    @config[:region] = 'us-east-1'
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    @sns_handler.run_report_safely(@run_status)
+
+    @sns_handler.server.must_match Regexp.new('us-east-1')
+  end
+
+  it 'should be able to generate the default subject in chef-client' do
+    Chef::Config[:solo] = false
+    @fake_sns_handler = Chef::Handler::FakeSns.new(@config)
+    Chef::Handler::FakeSns.any_instance.stubs(:node).returns(@node)
+    @fake_sns_handler.run_report_unsafe(@run_status)
+
+    assert_equal @fake_sns_handler.get_sns_subject, 'Chef Client success in test'
+  end
+
+  it 'should be able to generate the default subject in chef-solo' do
+    Chef::Config[:solo] = true
+    @fake_sns_handler = Chef::Handler::FakeSns.new(@config)
+    Chef::Handler::FakeSns.any_instance.stubs(:node).returns(@node)
+    @fake_sns_handler.run_report_unsafe(@run_status)
+
+    assert_equal @fake_sns_handler.get_sns_subject, 'Chef Solo success in test'
+  end
+
+  it 'should use the configured subject when set' do
+    @config[:subject] = 'My Subject'
+    @fake_sns_handler = Chef::Handler::FakeSns.new(@config)
+    Chef::Handler::FakeSns.any_instance.stubs(:node).returns(@node)
+    @fake_sns_handler.run_report_unsafe(@run_status)
+
+    assert_equal @fake_sns_handler.get_sns_subject, 'My Subject'
+  end
+
+  it 'should be able to generate the default message body' do
+    @fake_sns_handler = Chef::Handler::FakeSns.new(@config)
+    Chef::Handler::FakeSns.any_instance.stubs(:node).returns(@node)
+    @fake_sns_handler.run_report_unsafe(@run_status)
+
+    @fake_sns_handler.get_sns_body.must_match Regexp.new('Node Name: test')
+  end
+
+  it 'should throw an exception when the body template file does not exist' do
+    @config[:body_template] = '/tmp/nonexistent-template.erb'
+    @sns_handler = Chef::Handler::Sns.new(@config)
+
+    assert_raises(Chef::Exceptions::ValidationFailed) { @sns_handler.run_report_unsafe(@run_status) }
+  end
+
+  it 'should be able to generate the body template when configured as an option' do
+    body_msg = 'My Template'
+    @config[:body_template] = '/tmp/existing-template.erb'
+    ::File.stubs(:exists?).with(@config[:body_template]).returns(true)
+    IO.stubs(:read).with(@config[:body_template]).returns(body_msg)
+    @fake_sns_handler = Chef::Handler::FakeSns.new(@config)
+    Chef::Handler::FakeSns.any_instance.stubs(:node).returns(@node)
+    @fake_sns_handler.run_report_unsafe(@run_status)
+
+    assert_equal @fake_sns_handler.get_sns_body, body_msg
+  end
+
+end

data/test/test_chef_handler_sns_config.rb

@@ -0,0 +1,63 @@
+require 'helper'
+require 'chef/exceptions'
+
+class SnsConfig
+  include Chef::Handler::Sns::Config
+end
+
+describe Chef::Handler::Sns::Config do
+  before do
+    @config_params = {
+      :access_key => '***AMAZON-KEY***',
+      :secret_key => '***AMAZON-SECRET***',
+      :topic_arn => 'arn:aws:sns:***',
+    }
+    @sns_config = SnsConfig.new
+  end
+
+  it 'should read the configuration options on config initialization' do
+    @sns_config.config_init(@config_params)
+
+    assert_equal @sns_config.access_key, @config_params[:access_key]
+    assert_equal @sns_config.secret_key, @config_params[:secret_key]
+  end
+
+  it 'should be able to change configuration options using method calls' do
+    @sns_config.access_key(@config_params[:access_key])
+    @sns_config.secret_key(@config_params[:secret_key])
+
+    assert_equal @sns_config.access_key, @config_params[:access_key]
+    assert_equal @sns_config.secret_key, @config_params[:secret_key]
+  end
+
+  [ :access_key, :secret_key, :topic_arn ].each do |required|
+    it "should throw an exception when '#{required}' required field is not set" do
+      @config_params.delete(required)
+      @config_params.each { |key, value| @sns_config.send(key, value) }
+
+      assert_raises(Chef::Exceptions::ValidationFailed) { @sns_config.config_check }
+    end
+  end
+
+  [ :access_key, :secret_key, :region, :token, :topic_arn ].each do |option|
+
+    it "should accept string values in '#{option}' option" do
+      @sns_config.send(option, "test")
+    end
+
+    [ true, false, 25, Object.new ].each do |bad_value|
+      it "should throw and exception wen '#{option}' option is set to #{bad_value.to_s}" do
+        assert_raises(Chef::Exceptions::ValidationFailed) { @sns_config.send(option, bad_value) }
+      end
+    end
+  end
+
+  it 'should throw an exception when the body template file does not exist' do
+    @sns_config.body_template('/tmp/nonexistent-template.erb')
+    ::File.stubs(:exists?).with(@sns_config.body_template).returns(false)
+
+    assert_raises(Chef::Exceptions::ValidationFailed) { @sns_config.config_check }
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-sns
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_aws
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Chef report handler to send SNS notifications on failures or changes
 email: team@onddo.com
 executables: []
@@ -55,6 +119,9 @@ files:
 - lib/chef/handler/sns/templates/body.erb
 - lib/chef/handler/sns/version.rb
 - lib/chef/handler/sns.rb
+- test/test_chef_handler_sns_config.rb
+- test/test_chef_handler_sns.rb
+- test/helper.rb
 homepage: http://github.com/onddo/chef-handler-sns
 licenses: []
 post_install_message: 
@@ -79,4 +146,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Chef SNS reports
-test_files: []
+test_files:
+- test/test_chef_handler_sns_config.rb
+- test/test_chef_handler_sns.rb
+- test/helper.rb