chef-handler-sns 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bfcb555c086dcc166d90531da24483459f72e83
-  data.tar.gz: 4ff9d560ba54be282c9efeb9595a6ad12b471fbe
+  metadata.gz: bc3b47ba35513e1fa3c1d7df3ac62d95feaa396d
+  data.tar.gz: c3936aaa918435c64cd476f51f05c8c78e1ba4d2
 SHA512:
-  metadata.gz: 4fe21997780eebbda502e774c179c2e11fef890c4f5506bbeb39b4c81b2cf68357493909d32983779ce7715d5c5c637c3b417fabc3f6ebe7a579967eb0210cfa
-  data.tar.gz: 378efacd20133aad1373579a8307f9b963a39f443560d58534a113811a87a8d35b49bfd2a3a5414da15e76eead051e1e2160ba8d3ea6f435bc23b3260f730dd4
+  metadata.gz: a36d6e4ff9da8f1a5d502e4d02510ac78793d7c7863c3acd9587bd7a991c7ecb123e3522f2dcae236f7df1a46fadf140205bb632664d26ad70ed5d3bf5971b7d
+  data.tar.gz: f1a242ae00a139aea03b43432143e0dcbf5c052d086d040f1c8e8d9e48bddb49b818c244848ff5e796085e4e666f6ded83f2561cd1ca2f005ba9a60ad33939d9

data/README.md

@@ -4,6 +4,8 @@ A simple Chef report handler that reports status of a Chef run through [Amazon S
 
 [Amazon SNS](http://aws.amazon.com/sns/) can send notifications by SMS, email, [Amazon SQS](http://aws.amazon.com/sqs/) queues or to any HTTP endpoint.
 
+We recommend using the [chef_handler_sns cookbook](http://community.opscode.com/cookbooks/chef_handler_sns) for easy installation.
+
 This Chef Handler is heavily based on [Joshua Timberman](https://github.com/jtimberman) examples.
 
 * http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
@@ -158,6 +160,16 @@ chef_handler "Chef::Handler::Sns" do
 end
 ```
 
+##### Opsworks: Filter Notifications by Activity
+An optional array of opsworks activities can be supplied. If the array is set, notifications will
+only be triggered for the activities in the array, everything else will be discarded.
+
+```ruby
+argument_array = [
+  :filter_opsworks_activities => ['deploy','configure']
+]
+```
+
 ## Handler Configuration Options
 
 The following options are available to configure the handler:
@@ -281,7 +293,8 @@ Minitest tests can be run as usual:
 
 |                      |                                          |
 |:---------------------|:-----------------------------------------|
-| **Author:**          | Xabier de Zuazo (<xabier@onddo.com>)
+| **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@onddo.com>)
+| **Contributor:**     | [Florian Holzhauer](https://github.com/fh)
 | **Copyright:**       | Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
 | **License:**         | Apache License, Version 2.0
 

data/lib/chef/handler/sns.rb

@@ -33,10 +33,12 @@ class Chef
 
       def report
         config_check(node)
-        sns.topics[topic_arn].publish(
-          sns_body,
-          { :subject => sns_subject }
-        )
+        if allow_publish(node)
+          sns.topics[topic_arn].publish(
+            sns_body,
+            { :subject => sns_subject }
+          )
+        end
       end
 
       def get_region
@@ -45,6 +47,19 @@ class Chef
 
       protected
 
+      def allow_publish(node)
+        if filter_opsworks_activity.nil?
+          return true
+        end
+
+        if node.attribute?('opsworks') && node['opsworks'].attribute?('activity')
+          return filter_opsworks_activity.include?(node['opsworks']['activity'])
+        end
+
+        Chef::Log.debug('You supplied opsworks activity filters, but node attr was not found. Returning false')
+        return false
+      end
+
       def sns
         @sns ||= begin
           params = {

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

@@ -122,6 +122,14 @@ class Chef
           )
         end
 
+        def filter_opsworks_activity(arg=nil)
+          arg = Array(arg) if arg.is_a? String
+          set_or_return(
+            :filter_opsworks_activity,
+            arg,
+            :kind_of => Array
+          )
+        end
       end
     end
   end

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

@@ -2,7 +2,7 @@
 class Chef
   class Handler
     class Sns < ::Chef::Handler
-      VERSION = '1.0.0'
+      VERSION = '1.1.0'
     end
   end
 end

data/test/test_chef_handler_sns.rb

@@ -175,4 +175,37 @@ describe Chef::Handler::Sns do
     assert_equal @fake_sns_handler.get_sns_body, body_msg
   end
 
+  it 'should publish messages if node["opsworks"]["activity"] does not exist' do
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    AWS::SNS::Topic.any_instance.expects(:publish).once
+
+    @sns_handler.run_report_safely(@run_status)
+  end
+
+  it 'should publish messages if node["opsworks"]["activity"] matches allowed acvities' do
+    @node.set['opsworks']['activity'] = 'deploy'
+    @config[:filter_opsworks_activity] = ['deploy', 'setup']
+
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    AWS::SNS::Topic.any_instance.expects(:publish).once
+    @sns_handler.run_report_safely(@run_status)
+  end
+
+  it 'should not publish messages if node["opsworks"]["activity"] differs from allowed acvities' do
+    @node.set['opsworks']['activity'] = 'configure'
+    @config[:filter_opsworks_activity] = ['deploy', 'setup']
+
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    AWS::SNS::Topic.any_instance.expects(:publish).never
+    @sns_handler.run_report_safely(@run_status)
+  end
+
+  it 'should not publish messages if node["opsworks"]["activity"] is set, but the node attribute is missing' do
+    @config[:filter_opsworks_activity] = ['deploy', 'setup']
+
+    @sns_handler = Chef::Handler::Sns.new(@config)
+    AWS::SNS::Topic.any_instance.expects(:publish).never
+    @sns_handler.run_report_safely(@run_status)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-sns
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Onddo Labs, SL.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk