chef-handler-datadog 0.2.0 → 0.3.0

data/spec/datadog_spec.rb

@@ -0,0 +1,279 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Chef::Handler::Datadog, :vcr => :new_episodes do
+  # The #report method currently long and clunky, and we need to simulate a
+  # Chef run to test all aspects of this, as well as push values into the test.
+  before(:all) do
+    # This is used in validating that requests have actually been made,
+    # as in a 'Fucntional test'. We've recorded the tests with VCR, and use
+    # these to assert that the final product is correct. This is also
+    # exercising the API client, which may be helpful as well.
+    # There is a fair amount of duplication in the repsonse returned.
+    BASE_URL          = 'https://app.datadoghq.com'
+    EVENTS_ENDPOINT   = BASE_URL + '/api/v1/events'
+    HOST_TAG_ENDPOINT = BASE_URL + '/api/v1/tags/hosts/'
+    METRICS_ENDPOINT  = BASE_URL + '/api/v1/series'
+  end
+
+  before(:each) do
+    @handler = Chef::Handler::Datadog.new(
+      :api_key         => API_KEY,
+      :application_key => APPLICATION_KEY,
+    )
+  end
+
+  describe 'reports metrics event and sets tags' do
+    # Construct a good run_status
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test')
+      @node.send(:chef_environment, 'testing')
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+
+      # Run the report
+      @handler.run_report_unsafe(@run_status)
+    end
+
+    context 'emits metrics' do
+      it 'reports metrics' do
+        expect(a_request(:post, METRICS_ENDPOINT).with(
+          :query => { 'api_key' => @handler.config[:api_key] }
+        )).to have_been_made.times(3)
+      end
+    end
+
+    context 'emits events' do
+      it 'posts an event' do
+        expect(a_request(:post, EVENTS_ENDPOINT).with(
+          :query => { 'api_key' => @handler.config[:api_key] },
+          :body => hash_including(:msg_text => 'Chef updated 0 resources out of 0 resources total.'),
+          :body => hash_including(:msg_title => "Chef completed in 5 seconds on #{@node.name} "),
+        )).to have_been_made.times(1)
+      end
+
+      it 'sets priority correctly' do
+        expect(a_request(:post, EVENTS_ENDPOINT).with(
+          :query => { 'api_key' => @handler.config[:api_key] },
+          :body => hash_including(:priority => 'low'),
+        )).to have_been_made.times(1)
+      end
+    end
+
+    context 'get and set tags' do
+      it 'gets the tags for the current node' do
+        expect(a_request(:get, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key] },
+        )).to have_been_made.times(1)
+      end
+
+      it 'puts the tags for the current node' do
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key] },
+          :body => { 'tags' => ['env:testing'] },
+        )).to have_been_made.times(1)
+      end
+    end
+  end
+
+  describe 'reports correct hostname on an ec2 node' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-ec2')
+      @node.send(:chef_environment, 'testing')
+
+      @node.automatic_attrs['ec2'] = { :instance_id => 'i-123456' }
+
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+      @run_status.run_context = @run_context
+    end
+
+    it 'uses the instance id when no config specified' do
+      @handler.run_report_unsafe(@run_status)
+
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:msg_title => 'Chef completed in 5 seconds on i-123456 '),
+        :body => hash_including(:host => 'i-123456'),
+      )).to have_been_made.times(1)
+    end
+
+    it 'uses the instance id when config is specified' do
+      @handler.config[:use_ec2_instance_id] = true
+      @handler.run_report_unsafe(@run_status)
+
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:msg_title => 'Chef completed in 5 seconds on i-123456 '),
+        :body => hash_including(:host => 'i-123456'),
+      )).to have_been_made.times(1)
+    end
+
+    it 'does not use the instance id when config specified to false' do
+      @handler.config[:use_ec2_instance_id] = false
+      @handler.run_report_unsafe(@run_status)
+
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:msg_title => "Chef completed in 5 seconds on #{@node.name} "),
+        :body => hash_including(:host => @node.name),
+      )).to have_been_made.times(1)
+    end
+  end
+
+  describe 'handles tags correctly' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-tags')
+
+      @node.send(:chef_environment, 'hostile')
+      @node.send(:run_list, 'role[highlander]')
+      @node.normal.tags = ['the_one_and_only']
+
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+
+      # Run the report
+      @handler.run_report_unsafe(@run_status)
+    end
+
+    it 'sets the role and env and tags' do
+      expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+        :query => { 'api_key' => @handler.config[:api_key],
+                    'application_key' => @handler.config[:application_key] },
+        :body => hash_including(:tags => [
+          'env:hostile', 'role:highlander', 'tag:the_one_and_only'
+          ]),
+      )).to have_been_made.times(1)
+    end
+  end
+
+  describe 'handles no application_key' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-noapp')
+
+      @node.send(:chef_environment, 'hostile')
+      @node.send(:run_list, 'role[highlander]')
+      @node.normal.tags = ['the_one_and_only']
+
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+    end
+
+    it 'fails when no application key is provided' do
+      @handler.config[:application_key] = nil
+
+      # TODO: figure out how to capture output of Chef::Log
+      # Run the report, catch the error
+      expect { @handler.run_report_unsafe(@run_status) }.to raise_error
+    end
+  end
+
+  describe 'failed Chef run' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-failed')
+
+      @node.send(:chef_environment, 'hostile')
+      @node.send(:run_list, 'role[highlander]')
+      @node.normal.tags = ['the_one_and_only']
+
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 2)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+
+      # Construct an exception
+      exception = Chef::Exceptions::UnsupportedAction.new('Something awry.')
+      exception.set_backtrace(['file.rb:2', 'file.rb:1'])
+      @run_status.exception = exception
+
+      # Run the report
+      @handler.run_report_unsafe(@run_status)
+    end
+
+    it 'sets event title correctly' do
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:msg_title => "Chef failed in 2 seconds on #{@node.name} "),
+      )).to have_been_made.times(1)
+    end
+
+    it 'sets priority correctly' do
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:alert_type => 'success'),
+        :body => hash_including(:priority => 'normal'),
+      )).to have_been_made.times(1)
+    end
+  end
+
+  describe 'updated resources' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-resources')
+      @node.send(:chef_environment, 'resources')
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      all_resources = [Chef::Resource.new('whiskers'), Chef::Resource.new('paws')]
+      all_resources.first.updated_by_last_action(true)
+      @run_context.resource_collection.all_resources.replace(all_resources)
+
+      @expected_time = Time.now
+      Time.stub(:now).and_return(@expected_time, @expected_time + 8)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+
+      # Run the report
+      @handler.run_report_unsafe(@run_status)
+    end
+
+    it 'posts an event' do
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => hash_including(:msg_text => 'Chef updated 1 resources out of 2 resources total.'),
+        :body => hash_including(:msg_title => "Chef completed in 8 seconds on #{@node.name} "),
+      )).to have_been_made.times(1)
+    end
+  end
+
+    # TODO: test failures:
+    # @run_status.exception = Exception.new('Boy howdy!')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'simplecov'
+SimpleCov.start
+
+require 'dotenv'
+require 'rspec'
+require 'vcr'
+require 'webmock/rspec'
+
+# Include our code
+require 'chef/handler/datadog'
+
+# Load credentials from .env
+Dotenv.load
+
+API_KEY         = ENV['API_KEY']
+APPLICATION_KEY = ENV['APPLICATION_KEY']
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/cassettes'
+  c.configure_rspec_metadata!
+  c.default_cassette_options = {
+    :record => :once,
+    # :record => :new_episodes, # uncomment during development
+  }
+
+  # Remove any test-specific data
+  c.before_record do |i|
+    i.response.headers.delete('Set-Cookie')
+    i.response.headers.delete('X-Dd-Version')
+  end
+  c.filter_sensitive_data('<API_KEY>') { API_KEY }
+  c.filter_sensitive_data('<APPLICATION_KEY>') { APPLICATION_KEY }
+
+  c.hook_into :webmock
+end

data/spec/support/cassettes/Chef_Handler_Datadog/failed_Chef_run/sets_event_title_correctly.yml

@@ -0,0 +1,218 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
+    body:
+      encoding: UTF-8
+      string: ! '{"series":[{"metric":"chef.resources.total","points":[[1390096494,0.0]],"type":"gauge","host":"chef.handler.datadog.test-failed","device":null}]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Content-Type:
+      - text/json; charset=UTF-8
+      Date:
+      - Sun, 19 Jan 2014 01:54:44 GMT
+      Server:
+      - dogdispatcher/4.10.0
+      Content-Length:
+      - '15'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok"}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
+    body:
+      encoding: UTF-8
+      string: ! '{"series":[{"metric":"chef.resources.updated","points":[[1390096494,0.0]],"type":"gauge","host":"chef.handler.datadog.test-failed","device":null}]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Content-Type:
+      - text/json; charset=UTF-8
+      Date:
+      - Sun, 19 Jan 2014 01:54:48 GMT
+      Server:
+      - dogdispatcher/4.10.0
+      Content-Length:
+      - '15'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok"}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/series?api_key=<API_KEY>
+    body:
+      encoding: UTF-8
+      string: ! '{"series":[{"metric":"chef.resources.elapsed_time","points":[[1390096494,2.0]],"type":"gauge","host":"chef.handler.datadog.test-failed","device":null}]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Content-Type:
+      - text/json; charset=UTF-8
+      Date:
+      - Sun, 19 Jan 2014 01:54:48 GMT
+      Server:
+      - dogdispatcher/4.10.0
+      Content-Length:
+      - '15'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok"}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+- request:
+    method: post
+    uri: https://app.datadoghq.com/api/v1/events?api_key=<API_KEY>
+    body:
+      encoding: UTF-8
+      string: ! '{"msg_text":"Chef updated 0 resources out of 0 resources total.\n@@@\nChef::Exceptions::UnsupportedAction:
+        Something awry.\n@@@\n\n@@@\nfile.rb:2\nfile.rb:1\n@@@\n","date_happened":1390096494,"msg_title":"Chef
+        failed in 2 seconds on chef.handler.datadog.test-failed ","priority":"normal","parent":null,"tags":[],"aggregation_key":"chef.handler.datadog.test-failed","alert_type":"error","event_type":"config_management.run","source_type_name":"chef","title":"Chef
+        failed in 2 seconds on chef.handler.datadog.test-failed ","text":"Chef updated
+        0 resources out of 0 resources total.\n@@@\nChef::Exceptions::UnsupportedAction:
+        Something awry.\n@@@\n\n@@@\nfile.rb:2\nfile.rb:1\n@@@\n","host":"chef.handler.datadog.test-failed","device":null}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Content-Type:
+      - text/json; charset=UTF-8
+      Date:
+      - Sun, 19 Jan 2014 01:54:48 GMT
+      Server:
+      - dogdispatcher/4.10.0
+      Content-Length:
+      - '474'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"status": "ok", "event": {"priority": "normal", "date_happened":
+        1390096494, "handle": null, "title": "Chef failed in 2 seconds on chef.handler.datadog.test-failed
+        ", "url": "https://app.datadoghq.com/event/jump_to?event_id=2111137870265175278",
+        "text": "Chef updated 0 resources out of 0 resources total.\n@@@\nChef::Exceptions::UnsupportedAction:
+        Something awry.\n@@@\n\n@@@\nfile.rb:2\nfile.rb:1\n@@@\n", "tags": [], "related_event_id":
+        null, "id": 2111137870265175278}}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+- request:
+    method: get
+    uri: https://app.datadoghq.com/api/v1/tags/hosts/chef.handler.datadog.test-failed?api_key=<API_KEY>&application_key=<APPLICATION_KEY>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 19 Jan 2014 01:54:49 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Content-Length:
+      - '44'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"tags": ["env:hostile", "role:highlander"]}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+- request:
+    method: put
+    uri: https://app.datadoghq.com/api/v1/tags/hosts/chef.handler.datadog.test-failed?api_key=<API_KEY>&application_key=<APPLICATION_KEY>
+    body:
+      encoding: UTF-8
+      string: ! '{"tags":["env:hostile","role:highlander","tag:the_one_and_only"]}'
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 19 Jan 2014 01:54:49 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - gunicorn/0.17.4
+      Content-Length:
+      - '88'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"host": "chef.handler.datadog.test-failed", "tags": ["env:hostile",
+        "role:highlander"]}'
+    http_version: 
+  recorded_at: Sun, 19 Jan 2014 01:54:54 GMT
+recorded_with: VCR 2.8.0