chef-handler-zookeeper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d3f5a10dbeae85b908d204ef9b02f2f524899bd
+  data.tar.gz: 1f8ec4afa53f87d2b477d5a9759fba6ac0aa4ff0
+SHA512:
+  metadata.gz: 413a42ca2f042ca0cff07fdd26813f4fd6def7b0835506a50e6764ecc992ca3265dafb76cc1cb8a01455d68ef59c58b1068a59b5c67d72eb23401cde22457a8b
+  data.tar.gz: c079075e75cb5c5ca693e22fa60b36a331af49f776463f520cd9cd9a373b3d53abf15289b35a1fa10b268017f712f7d25093d782cdaf62f0f588c8bcb78e06e7

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.md

@@ -0,0 +1,248 @@
+# Chef Handler Zookeeper
+
+A simple Chef report handler to send notifications to Zookeeper about Chef runs.
+
+This Chef Handler is heavily based on [Chef Handler SNS](https://github.com/onddo/chef-handler-sns) code.
+
+* http://wiki.opscode.com/display/chef/Exception+and+Report+Handlers
+
+## Requirements
+
+* A Zookeeper server.
+* Uses the `zk` Ruby gem.
+
+## Usage
+
+You can install this handler in two ways:
+
+### Method 1: In the Chef config file
+
+You can install the RubyGem and configure Chef to use it:
+
+    gem install chef-handler-zookeeper
+
+Then add to the configuration (`/etc/chef/solo.rb` for chef-solo or `/etc/chef/client.rb` for chef-client):
+
+```ruby
+require "chef/handler/zookeeper"
+
+# Create the handler
+zookeeper_handler = Chef::Handler::ZookeeperHandler.new
+
+# Some Zookeeper configurations
+zookeeper_handler.server "zookeeper.mydomain.com"
+zookeeper_handler.znode "/chef/#{`hostname`.chomp}/chef_status"
+
+# Add your handler
+start_handlers << zookeeper_handler
+exception_handlers << zookeeper_handler
+report_handlers << zookeeper_handler
+```
+
+### Method 2: In a recipe with the chef_handler LWRP
+
+Use the [chef_handler LWRP](http://community.opscode.com/cookbooks/chef_handler), creating a recipe with the following:
+
+```ruby
+# A compiler is required for the `zk` gem
+node.default['build_essential']['compiletime'] = true
+include_recipe 'build-essential'
+
+# Handler configuration options
+argument_array = [
+  :server => "zookeeper.mydomain.com:2181",
+  :znode => "/chef/somepath/chef_status",
+]
+
+# Install the `chef-handler-zookeeper` RubyGem during the compile phase
+chef_gem "chef-handler-zookeeper"
+
+# Then activate the handler with the `chef_handler` LWRP
+chef_handler "Chef::Handler::ZookeeperHandler" do
+  source "#{Gem::Specification.find_by_name("chef-handler-zookeeper").lib_dirs_glob}/chef/handler/zookeeper"
+  arguments argument_array
+  supports :report => true, :exception => true
+  action :enable
+end
+```
+
+If you have an old version of gem package (< 1.8.6) without `find_by_name` or old chef-client (< 0.10.10) without `chef_gem`, you can try creating a recipe similar to the following:
+
+```ruby
+# A compiler is required for the `zk` gem
+node.default['build_essential']['compiletime'] = true
+include_recipe 'build-essential'
+
+# Handler configuration options
+argument_array = [
+  :server => "zookeeper.mydomain.com:2181",
+  :znode => "/chef/somepath/chef_status",
+]
+
+# Install the `chef-handler-zookeeper` RubyGem during the compile phase
+if defined?(Chef::Resource::ChefGem)
+  chef_gem "chef-handler-zookeeper"
+else
+  gem_package("chef-handler-zookeeper") do
+    action :nothing
+  end.run_action(:install)
+end
+
+# Get the installed `chef-handler-zookeeper` gem path
+zookeeper_handler_path = Gem::Specification.respond_to?("find_by_name") ?
+  Gem::Specification.find_by_name("chef-handler-zookeeper").lib_dirs_glob :
+  Gem.all_load_paths.grep(/chef-handler-zookeeper/).first
+
+# Then activate the handler with the `chef_handler` LWRP
+chef_handler "Chef::Handler::ZookeeperHandler" do
+  source "#{zookeeper_handler_path}/chef/handler/zookeeper"
+  arguments argument_array
+  supports :report => true, :exception => true
+  action :enable
+end
+```
+
+#### start_handler
+
+If you want to run also as a *start handler* using `chef_handler` cookbook, you can use a recipe similar to the following:
+
+```ruby
+# [...]
+
+# We will need to install the chef handler at compile time
+chef_handler "Chef::Handler::ZookeeperHandler" do
+# [...]
+  action :nothing
+end.run_action(:enable)
+
+# based on code from chef-sensu-handler cookbook: https://github.com/needle-cookbooks/chef-sensu-handler/blob/master/recipes/default.rb
+ruby_block 'trigger_start_handlers' do
+  block do
+    require 'chef/run_status'
+    require 'chef/handler'
+
+    # a bit tricky, required by the default start.json.erb template to have access to node
+    Chef::Handler.run_start_handlers(self)
+  end
+  action :nothing
+end.run_action(:create)
+```
+
+## Handler Configuration Options
+
+The following options are available to configure the handler:
+
+* `server` - The Zookeeper server hostname and port (required).
+* `znode` - Path of the znode to write to (required). **The znode must already exist**.
+* `start_template` - Full path of an erubis template file to use for the znode body on Chef run start (optional).
+* `end_template` - Full path of an erubis template file to use for the znode body when Chef run ended (optional).
+
+### start_template and end_template
+
+This configuration options need to contain the full path of an erubis template. For example:
+
+```ruby
+# recipe "myapp::zookeeper_handler"
+
+cookbook_file "chef_handler_zookeeper_body.erb" do
+  path "/tmp/chef_handler_zookeeper_body.erb"
+  # [...]
+end
+
+argument_array = [
+  :server => "zookeeper.mydomain.com:2181",
+  :znode => "/chef/somepath/chef_status",
+  :end_template => "/tmp/chef_handler_zookeeper_body.erb",
+]
+chef_handler "Chef::Handler::ZookeeperHandler" do
+  # [...]
+  arguments argument_array
+end
+```
+
+```erb
+<%# file "myapp/files/default/chef_handler_zookeeper_body.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 -%>
+```
+
+The following variables are accessible 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.
+
+Default templates are in the [templates](https://github.com/onddo/chef-handler-zookeeper/tree/master/lib/chef/handler/zookeeper/templates) directory.
+
+**Note:** When using `start_template` with the **chef_handler cookbook**, only the `node` variable will be accesible from the template.
+
+## Running the tests
+
+Minitest tests can be run as usual:
+
+    rake test
+
+# TODO
+
+* Support for znode creation:
+  * Including *:create* boolean, *:acl* for the ACL and *:recursive*.
+* Add digest authentication support.
+* Add tests.
+
+## Contributing
+
+[Pull Requests](http://github.com/onddo/chef-handler-zookeeper/pulls) are welcome.
+
+## License and Author
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Author:**          | Xabier de Zuazo (<xabier@onddo.com>)
+| **Copyright:**       | Copyright (c) 2013 Onddo Labs, SL. (www.onddo.com)
+| **License:**         | Apache License, Version 2.0
+
+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/handler/zookeeper/config.rb

@@ -0,0 +1,92 @@
+#
+# Author:: Xabier de Zuazo (<xabier@onddo.com>)
+# Copyright:: Copyright (c) 2013 Onddo Labs, SL.
+# License:: Apache License, Version 2.0
+#
+# 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 'chef/mixin/params_validate'
+require 'chef/exceptions'
+
+class Chef
+  class Handler
+    class ZookeeperHandler < ::Chef::Handler
+      module Config
+        Config.extend Config # let Config use the methods it contains as instance methods
+        include ::Chef::Mixin::ParamsValidate
+
+        REQUIRED = [ 'server', 'znode' ]
+      
+        def config_init(config={})
+          config.each do |key, value|
+            if Config.respond_to?(key) and not /^config_/ =~ key.to_s
+              self.send(key, value)
+            else
+              Chef::Log.warn("#{self.class.to_s}: configuration method not found: #{key}.")
+            end
+          end
+        end
+      
+        def config_check
+          REQUIRED.each do |key|
+            if self.send(key).nil?
+              raise Exceptions::ValidationFailed,
+                "Required argument #{key.to_s} is missing!"
+            end
+          end
+      
+          [ start_template, end_template ].each do |template|
+            if template and not ::File.exists?(template)
+              raise Exceptions::ValidationFailed,
+                "Template file not found: #{template}."
+            end
+          end
+        end
+      
+        def server(arg=nil)
+          set_or_return(
+            :server,
+            arg,
+            :kind_of => String
+          )
+        end
+      
+        def znode(arg=nil)
+          set_or_return(
+            :znode,
+            arg,
+            :kind_of => String
+          )
+        end
+      
+        def start_template(arg=nil)
+          set_or_return(
+            :start_template,
+            arg,
+            :kind_of => String
+          )
+        end
+      
+        def end_template(arg=nil)
+          set_or_return(
+            :end_template,
+            arg,
+            :kind_of => String
+          )
+        end
+      
+      end
+    end 
+  end 
+end 

data/lib/chef/handler/zookeeper/templates/end.json.erb

@@ -0,0 +1,20 @@
+<%= require 'json'
+data = {
+  "chef_version" => Chef::VERSION,
+  "ohai_version" => Ohai::VERSION,
+  "run_list" => node.run_list.to_s,
+  "environment" => node.chef_environment,
+  "start_time" => start_time.to_s,
+  "end_time" => end_time.to_s,
+  "elapsed_time" => elapsed_time.to_s,
+  "updated_resources" => updated_resources.kind_of?(Array) ? updated_resources.count : 0,
+  "status" => success? ? "success" : "failure",
+}
+
+if exception
+  data['exception'] = run_status.formatted_exception
+  data['backtrace'] = Array(backtrace).join("\n")
+end
+
+data.to_json
+%>

data/lib/chef/handler/zookeeper/templates/start.json.erb

@@ -0,0 +1,14 @@
+<%= require 'json'
+data = {
+  "chef_version" => Chef::VERSION,
+  "ohai_version" => Ohai::VERSION,
+  "start_time" => run_status.kind_of?(Chef::RunStatus) ? start_time.to_s : Time.now.to_s,
+  "status" => "running",
+}
+
+if self.respond_to?(:node)
+  data['environment'] = self.node.chef_environment
+end
+
+data.to_json
+%>

data/lib/chef/handler/zookeeper/templates/txt.erb

@@ -0,0 +1,39 @@
+Node Name: <%= node.name %>
+<% if node.attribute?('fqdn') -%>
+Hostname: <%= node.fqdn %>
+<% end -%>
+
+Chef Version: <%= Chef::VERSION %>
+Ohai Version: <%= Ohai::VERSION %>
+
+Chef Run List: <%= node.run_list.to_s %>
+Chef Environment: <%= node.chef_environment %>
+
+<% if node.attribute?('ec2') -%>
+<%   if node.ec2.attribute?('instance_id') -%>
+Instance Id: <%= node.ec2.instance_id %>
+<%   end -%>
+<%   if node.ec2.attribute?('public_hostname') -%>
+Instance Public Hostname: <%= node.ec2.public_hostname %>
+<%   end -%>
+<%   if node.ec2.attribute?('hostname') -%>
+Instance Hostname: <%= node.ec2.hostname %>
+<%   end -%>
+<%   if node.ec2.attribute?('public_ipv4') -%>
+Instance Public IPv4: <%= node.ec2.public_ipv4 %>
+<%   end -%>
+<%   if node.ec2.attribute?('local_ipv4') -%>
+Instance Local IPv4: <%= node.ec2.local_ipv4 %>
+<%   end -%>
+<% 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 -%>

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

@@ -0,0 +1,9 @@
+
+class Chef
+  class Handler
+    class ZookeeperHandler < ::Chef::Handler
+      VERSION = '0.1.0'
+    end
+  end
+end
+

data/lib/chef/handler/zookeeper.rb

@@ -0,0 +1,69 @@
+#
+# Author:: Xabier de Zuazo (<xabier@onddo.com>)
+# Copyright:: Copyright (c) 2013 Onddo Labs, SL.
+# License:: Apache License, Version 2.0
+#
+# 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 'chef/handler'
+require 'chef/handler/zookeeper/config'
+require 'zk'
+require 'erubis'
+
+class Chef
+  class Handler
+    class ZookeeperHandler < ::Chef::Handler
+      include ::Chef::Handler::ZookeeperHandler::Config
+
+      def initialize(config={})
+        Chef::Log.debug("#{self.class.to_s} initialized.")
+        config_init(config)
+      end
+
+      def report
+        if !run_status.kind_of?(Chef::RunStatus) or elapsed_time.nil?
+          zk.set(znode, start_template_body)
+        else
+          zk.set(znode, end_template_body)
+        end
+      end
+
+      protected
+
+      def zk
+        @zk ||= begin
+          ZK.logger = Chef::Log
+          ZK.new(server)
+        end
+      end
+
+      def start_template_body
+        znode_body(start_template || "#{File.dirname(__FILE__)}/zookeeper/templates/start.json.erb")
+      end
+
+      def end_template_body
+        znode_body(end_template || "#{File.dirname(__FILE__)}/zookeeper/templates/end.json.erb")
+      end
+
+      def znode_body(body_template)
+        config_check
+        template = IO.read(body_template)
+        context = self
+        eruby = Erubis::Eruby.new(template)
+        eruby.evaluate(context)
+      end
+
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'simplecov'
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+SimpleCov.start
+
+gem 'minitest' # ensures you're using the gem, and not the built in MT
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'chef/handler/zookeeper'

data/test/test_chef_handler_zookeeper.rb

@@ -0,0 +1,193 @@
+require 'helper'
+require 'chef/node'
+require 'chef/run_status'
+
+class ZK::Client::Fake
+  attr_reader :zk_client_new, :server, :znode
+
+  def initialize(host, opts={}, &b)
+  end
+
+  def set(path, data, opts={})
+    return true
+  end
+
+  def fake_new
+    @zk_client_new = true
+    return self
+  end
+
+end
+
+class Chef::Handler::FakeZookeeperHandler < Chef::Handler::ZookeeperHandler
+
+  def get_zookeeper_start_template_body
+    start_template_body
+  end
+
+  def get_zookeeper_end_template_body
+    end_template_body
+  end
+
+end
+
+def run_status_new
+  @run_status = if Gem.loaded_specs['chef'].version > Gem::Version.new('0.12.0')
+    Chef::RunStatus.new(@node, {})
+  else
+    Chef::RunStatus.new(@node)
+  end
+end
+
+describe Chef::Handler::ZookeeperHandler do
+  before do
+    @config = {
+      :server => '127.0.0.1:2181',
+      :znode => '/chef/1.2.3.4',
+    }
+
+    zk = ZK::Client::Threaded.new(@config[:server], { :connect => false })
+    ZK::Client::Threaded.stubs(:new).returns(zk) # return a no connecting instance
+    ZK::Client::Threaded.any_instance.stubs(:set).returns(true)
+
+    @node = Chef::Node.new
+    @node.name('test')
+    Chef::Handler::ZookeeperHandler.any_instance.stubs(:node).returns(@node)
+
+    @run_status = run_status_new
+    @run_status.start_clock
+    @run_status.stop_clock
+  end
+
+  it 'should read the configuration options on initialization' do
+    @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+    assert_equal @zookeeper_handler.server, @config[:server]
+    assert_equal @zookeeper_handler.znode, @config[:znode]
+  end
+
+  it 'should be able to change configuration options using method calls' do
+    @zookeeper_handler = Chef::Handler::ZookeeperHandler.new
+    @zookeeper_handler.server(@config[:server])
+    @zookeeper_handler.znode(@config[:znode])
+    assert_equal @zookeeper_handler.server, @config[:server]
+    assert_equal @zookeeper_handler.znode, @config[:znode]
+  end
+
+  it 'should try to set the znode message at the beginning and end when properly configured' do
+    @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+    ZK::Client::Threaded.any_instance.expects(:set).once
+
+    @zookeeper_handler.run_report_safely(@run_status)
+  end
+
+  it 'should create a ZK::Client::Threaded object' do
+    @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+    fake_zookeeper = ZK::Client::Fake.new(@config[:server])
+    ZK::Client::Threaded.any_instance.stubs(:new).returns(fake_zookeeper.fake_new)
+
+    @zookeeper_handler.run_report_safely(@run_status)
+
+    assert_equal fake_zookeeper.zk_client_new, true
+  end
+
+  describe '#report' do
+    before do
+      @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+      @run_status = run_status_new
+    end
+
+    describe 'when chef run is not over' do
+      before do
+        @run_status.start_clock
+      end
+
+      it 'should use the start_template when the run is not over' do
+        @zookeeper_handler.stubs(:start_template_body).once
+        @zookeeper_handler.stubs(:end_template_body).never
+
+        @zookeeper_handler.run_report_unsafe(@run_status)
+      end
+
+      it 'should be able to generate the default start_template' do
+        @fake_zookeeper_handler = Chef::Handler::FakeZookeeperHandler.new(@config)
+        Chef::Handler::FakeZookeeperHandler.any_instance.stubs(:node).returns(@node)
+        @fake_zookeeper_handler.run_report_unsafe(@run_status)
+
+        @fake_zookeeper_handler.get_zookeeper_start_template_body.must_match Regexp.new('"start_time":')
+      end
+
+      it 'should throw an exception when the start_template file does not exist' do
+        @config[:start_template] = '/tmp/nonexistent-template.erb'
+        @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+
+        assert_raises(Chef::Exceptions::ValidationFailed) { @zookeeper_handler.run_report_unsafe(@run_status) }
+      end
+
+      it 'should be able to generate the start_template when configured as an option' do
+        body_msg = 'My Template'
+        @config[:start_template] = '/tmp/existing-template.erb'
+        ::File.stubs(:exists?).with(@config[:start_template]).returns(true)
+        IO.stubs(:read).with(@config[:start_template]).returns(body_msg)
+        @fake_zookeeper_handler = Chef::Handler::FakeZookeeperHandler.new(@config)
+        Chef::Handler::FakeZookeeperHandler.any_instance.stubs(:node).returns(@node)
+        @fake_zookeeper_handler.run_report_unsafe(@run_status)
+
+        assert_equal @fake_zookeeper_handler.get_zookeeper_start_template_body, body_msg
+      end
+
+    end # describe when chef run is not over
+
+    describe 'when chef run is over' do
+      before do
+        @run_status.start_clock
+        @run_status.stop_clock
+      end
+
+      it 'should use the end_template when the run is over' do
+        @zookeeper_handler.stubs(:end_template_body).once
+        @zookeeper_handler.stubs(:start_template_body).never
+
+        @zookeeper_handler.run_report_unsafe(@run_status)
+      end
+
+      it 'should be able to generate the default end_template' do
+        @fake_zookeeper_handler = Chef::Handler::FakeZookeeperHandler.new(@config)
+        Chef::Handler::FakeZookeeperHandler.any_instance.stubs(:node).returns(@node)
+        @fake_zookeeper_handler.run_report_unsafe(@run_status)
+
+        @fake_zookeeper_handler.get_zookeeper_end_template_body.must_match Regexp.new('"end_time":')
+      end
+
+      it 'should throw an exception when the end_template file does not exist' do
+        @config[:end_template] = '/tmp/nonexistent-template.erb'
+        @zookeeper_handler = Chef::Handler::ZookeeperHandler.new(@config)
+
+        assert_raises(Chef::Exceptions::ValidationFailed) { @zookeeper_handler.run_report_unsafe(@run_status) }
+      end
+
+      it 'should be able to generate the end_template when configured as an option' do
+        body_msg = 'My Template'
+        @config[:end_template] = '/tmp/existing-template.erb'
+        ::File.stubs(:exists?).with(@config[:end_template]).returns(true)
+        IO.stubs(:read).with(@config[:end_template]).returns(body_msg)
+        @fake_zookeeper_handler = Chef::Handler::FakeZookeeperHandler.new(@config)
+        Chef::Handler::FakeZookeeperHandler.any_instance.stubs(:node).returns(@node)
+        @fake_zookeeper_handler.run_report_unsafe(@run_status)
+
+        assert_equal @fake_zookeeper_handler.get_zookeeper_end_template_body, body_msg
+      end
+
+    end # describe when chef run is over
+
+    describe 'when called without run_status (chef_handler LWRP)' do
+      it 'should use the start_template when the run is not over' do
+        @zookeeper_handler.stubs(:start_template_body).once
+        @zookeeper_handler.stubs(:end_template_body).never
+
+        @zookeeper_handler.run_report_unsafe(Object.new)
+      end
+    end
+
+  end # describe #report
+
+end

data/test/test_chef_handler_zookeeper_config.rb

@@ -0,0 +1,90 @@
+require 'helper'
+require 'chef/exceptions'
+
+class ZookeeperConfig
+  include Chef::Handler::ZookeeperHandler::Config
+end
+
+describe Chef::Handler::ZookeeperHandler::Config do
+  before do
+    @config_params = {
+      :server => '127.0.0.1:2181',
+      :znode => '/chef/1.2.3.4',
+    }
+    @zookeeper_config = ZookeeperConfig.new
+  end
+
+  it 'should read the configuration options on config initialization' do
+    @zookeeper_config.config_init(@config_params)
+
+    assert_equal @zookeeper_config.server, @config_params[:server]
+    assert_equal @zookeeper_config.znode, @config_params[:znode]
+  end
+
+  it 'should be able to change configuration options using method calls' do
+    @zookeeper_config.server(@config_params[:server])
+    @zookeeper_config.znode(@config_params[:znode])
+
+    assert_equal @zookeeper_config.server, @config_params[:server]
+    assert_equal @zookeeper_config.znode, @config_params[:znode]
+  end
+
+  [ :server, :znode ].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| @zookeeper_config.send(key, value) }
+
+      assert_raises(Chef::Exceptions::ValidationFailed) { @zookeeper_config.config_check }
+    end
+  end
+
+  [ :server, :znode, :start_template, :end_template ].each do |option|
+
+    it "should accept string values in '#{option}' option" do
+      @zookeeper_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) { @zookeeper_config.send(option, bad_value) }
+      end
+    end
+  end
+
+  [ :start_template, :end_template ].each do |template|
+    it "should throw an exception when the #{template} file does not exist" do
+      @zookeeper_config.send(template, '/tmp/nonexistent-template.erb')
+      ::File.stubs(:exists?).with(@zookeeper_config.send(template)).returns(false)
+
+      assert_raises(Chef::Exceptions::ValidationFailed) { @zookeeper_config.config_check }
+    end
+  end
+
+  describe 'config_init' do
+
+    it 'should accept valid config options' do
+      option = :server
+      Chef::Log.expects(:warn).never
+
+      @zookeeper_config.config_init({ option => 'valid' })
+    end
+
+    it 'should not accept invalid config options' do
+      option = :invalid_option
+      assert !@zookeeper_config.respond_to?(option)
+      Chef::Log.expects(:warn).once
+
+      @zookeeper_config.config_init({ option => 'none' })
+    end
+
+    it 'should not accept config options starting by "config_"' do
+      option = :config_check
+      assert @zookeeper_config.respond_to?(option)
+      Chef::Log.expects(:warn).once
+
+      @zookeeper_config.config_init({ option => 'exists but not configurable' })
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: chef-handler-zookeeper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Onddo Labs, SL.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  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.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Chef report handler to send notifications to Zookeeper about Chef runs.
+email: team@onddo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/chef/handler/zookeeper/templates/end.json.erb
+- lib/chef/handler/zookeeper/templates/txt.erb
+- lib/chef/handler/zookeeper/templates/start.json.erb
+- lib/chef/handler/zookeeper/config.rb
+- lib/chef/handler/zookeeper/version.rb
+- lib/chef/handler/zookeeper.rb
+- test/test_chef_handler_zookeeper_config.rb
+- test/helper.rb
+- test/test_chef_handler_zookeeper.rb
+homepage: http://github.com/onddo/chef-handler-zookeeper
+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: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Send Chef reports to Zookeeper
+test_files:
+- test/test_chef_handler_zookeeper_config.rb
+- test/helper.rb
+- test/test_chef_handler_zookeeper.rb