chef-handler-opsmatic 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6bd4b0a5519d114752f04bf2228ac0726d75e39
-  data.tar.gz: beebb4d1a59d060f61a15768940248f4835a3c19
+  metadata.gz: 111a2d25c05ff91ddc37660487d6cf37d1dd9ad1
+  data.tar.gz: d3e54a7e30a4332c724176812477bbf56f9d9740
 SHA512:
-  metadata.gz: e9047c220213d19a83f33514e379145613472020e167c4d12ea162d417ea935621ea09fbd49b17e1e6700c7bbb9536dbaa3bd09a4c26d2bf53be3d5fc95e5fd3
-  data.tar.gz: 12725561dac8c31e4844f6b22fe76d33d8de47dc12b7cb9f5bd2a633023868b84d4eaac784aa824643025907d00bce799525ca5a944ce25c9fd243a2d50438eb
+  metadata.gz: 6a3fa5c15a7292e89e242d30aa5cba0acb2e3eac471620055691d8a8d9c42e7969eaa619345c318cfe9a36cf2623342c978902d80bbef06bba2aa49101305198
+  data.tar.gz: c5fed53a6e356fe2d1baae07455afc214b66672e3bdc13ed42f5a933b0380c66d4fbdd21b083aa9231022dd1f3e2a151c5263b17001e0461d2204d7499bf9c6f

data/README.md

@@ -7,6 +7,12 @@ The chef-handler-opsmatic gem is a Chef report and exception handler
 The easiest way to install this handler in your Chef environment is with the `handler`
 recipe in the [opsmatic-cookbook](https://github.com/opsmatic/opsmatic-cookbook) cookbook.
 
+## Changelog
+
+#### 0.0.9 (2014-08-19)
+* adds support for generating a list of chef managed files for the Opsmatic agent to watch for changes
+* adds sending chef-handler-opsmatic version in the user-agent string
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/chef-handler-opsmatic/fork )

data/chef-handler-opsmatic.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chef/handler/version'
+require 'chef/handler/opsmatic'
 
 Gem::Specification.new do |spec|
   spec.name          = "chef-handler-opsmatic"

data/lib/chef/handler/opsmatic.rb

@@ -7,10 +7,15 @@ require 'json'
 class Chef
   class Handler
     class Opsmatic < ::Chef::Handler
+      VERSION = "0.0.9"
+
       def initialize(config = {})
         @config = config
+        @config[:agent_dir] ||= "/var/db/opsmatic-agent"
+        @watch_files = {}
       end
 
+      # prepares a report of the current chef run
       def report
         if @config[:integration_token].nil? || @config[:integration_token].empty?
           Chef::Log.warn("Opsmatic integraton integration_token missing, report handler disabled")
@@ -60,9 +65,48 @@ class Chef
           opsmatic_event[:data][:exception] = clean_exception
         end
 
+        # analyze and collect any potentially monitorable resources
+        collect_resources run_status.all_resources
+
+        # submit our event
         submit opsmatic_event
       end
 
+      # collects up details on file resources managed by chef on the host and writes
+      # the list to a directory for the opsmatic-agent to consume to hint at interesting
+      # files the agent can watch
+      def collect_resources(all_resources)
+        return unless File.directory?(@config[:agent_dir])
+
+        all_resources.each do |resource|
+          case resource
+          when Chef::Resource::CookbookFile
+            @watch_files[resource.path] = true
+          when Chef::Resource::Template
+            @watch_files[resource.path] = true
+          when Chef::Resource::RemoteFile
+            @watch_files[resource.path] = true
+          end
+        end
+
+        begin
+          data_dir = "#{@config[:agent_dir]}/external.d"
+          if not File.directory?(data_dir)
+            Dir.mkdir(data_dir)
+          end
+          File.open("#{data_dir}/chef_resources.json", "w") do |f|
+            watchlist = []
+            @watch_files.keys.each do |k|
+              watchlist << { "path" => k } 
+            end
+            f.write({ "files" => watchlist }.to_json)
+          end
+        rescue Exception => msg
+          Chef::Log.warn("Unable to save opsmatic agent file watch list: #{msg}")
+        end
+      end
+
+      # submit report to the opsmatic collector
       def submit(event) 
         Chef::Log.info("Posting chef run report to Opsmatic")
         
@@ -80,6 +124,7 @@ class Chef
 
         request = Net::HTTP::Post.new(url.request_uri)
         request["Content-Type"] = "application/json"
+        request["User-Agent"] = "Opsmatic Chef Handler #{Chef::Handler::Opsmatic::VERSION}"
         request.body = event.to_json
 
         begin

data/spec/opsmatic_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-
 require 'pp'
 
 describe "Chef::Handler::Opsmatic" do
@@ -7,20 +6,36 @@ describe "Chef::Handler::Opsmatic" do
     COLLECTOR_URL = "http://api.opsmatic.com/webhooks/events/chef"
     INTEGRATION_TOKEN = "xxxxx-yyyyy"
     HOSTNAME = "foo.example.com"
+    AGENT_DIR = "/var/tmp/opsmatic"
+    WATCHLIST_PATH = "external.d/chef_resources.json"
 
     @handler = Chef::Handler::Opsmatic.new(
       :integration_token => INTEGRATION_TOKEN,
-      :collector_url => COLLECTOR_URL
+      :collector_url => COLLECTOR_URL,
+      :agent_dir => "/var/tmp/opsmatic"
     )
 
     @node = Chef::Node.build(HOSTNAME)
     @node.attributes.default[:fqdn] = HOSTNAME
+
+    unless File.directory?(AGENT_DIR)
+      Dir.mkdir(AGENT_DIR)
+    end
   end
 
   before (:each) do
     @events = Chef::EventDispatch::Dispatcher.new
     @run_context = Chef::RunContext.new(@node, {}, @events)
     @run_status = Chef::RunStatus.new(@node, @events)
+
+    # mock some resources
+    template = Chef::Resource::Template.new "/etc/sudoers.d/deploy_user"
+    cookbook = Chef::Resource::CookbookFile.new "/etc/nginx/conf.d/ssl.conf"
+    remote_file = Chef::Resource::RemoteFile.new "/var/db/translations.db"
+
+    @all_resources = [ template, cookbook, remote_file ]
+    @run_context.resource_collection.all_resources.replace(@all_resources)
+
     @run_status.start_clock
     @run_status.stop_clock
     @run_status.run_context = @run_context
@@ -37,4 +52,37 @@ describe "Chef::Handler::Opsmatic" do
     @handler.run_report_unsafe(@run_status)
     expect a_request(:post, COLLECTOR_URL)
   end
+
+  it "should write a list of resources for the opsmatic agent to watch" do
+    @handler.run_report_unsafe(@run_status)
+    expect a_request(:post, COLLECTOR_URL)
+    expect(File.exists?("#{AGENT_DIR}/#{WATCHLIST_PATH}")).to be true
+  end
+
+  it "should write a list of resources for the opsmatic agent to watch" do
+    @handler.run_report_unsafe(@run_status)
+    expect a_request(:post, COLLECTOR_URL)
+    expect(File.exists?("#{AGENT_DIR}/#{WATCHLIST_PATH}")).to be true
+  end
+
+  it "should be valid json containing all the resources" do
+    @handler.run_report_unsafe(@run_status)
+    expect a_request(:post, COLLECTOR_URL)
+
+    watched_files = {}
+    result = JSON.parse(File.read("#{AGENT_DIR}/#{WATCHLIST_PATH}"))
+    result["files"].each do |file|
+      watched_files[file["path"]] = true
+    end
+
+    @all_resources.each do |resource|
+      watched_files.delete(resource.path)
+    end
+
+    expect(watched_files.length).to equal(0)
+  end
+
+  after(:all) do
+    FileUtils.rmtree(AGENT_DIR)
+  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'chef/handler/opsmatic'
 require 'webmock/rspec'
+require 'chef'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-handler-opsmatic
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Marcus Barczak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,6 @@ files:
 - Rakefile
 - chef-handler-opsmatic.gemspec
 - lib/chef/handler/opsmatic.rb
-- lib/chef/handler/version.rb
 - spec/opsmatic_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/opsmatic/chef-handler-opsmatic

data/lib/chef/handler/version.rb

@@ -1,7 +0,0 @@
-module Chef
-  module Handler
-    module Opsmatic
-      VERSION = "0.0.7"
-    end
-  end
-end