chef-handler-datadog-demo 0.1.0

data/lib/chef_handler_datadog_demo.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# Helper module for version number only.
+# Real deal in 'chef/handler/datadog.rb'
+module ChefHandlerDatadogDemo
+  VERSION = '0.1.0'
+end

data/spec/datadog_spec.rb

@@ -0,0 +1,495 @@
+# 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 'initialize' do
+    it 'should allow config hash to have string keys' do
+      Chef::Handler::Datadog.new(
+        'api_key'         => API_KEY,
+        'application_key' => APPLICATION_KEY,
+        'tag_prefix'      => 'tag',
+      )
+    end
+  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
+      allow(Time).to receive(: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(4)
+      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} "),
+          :body => hash_including(:tags => ['env:testing']),
+        )).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 'sets tags' do
+      it 'puts the tags for the current node' do
+        # We no longer need to query the tag api for current tags,
+        # rather udpate only the tags for the designated source type
+        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(0)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :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
+      allow(Time).to receive(: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
+
+  context 'hostname' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-hostname')
+      @node.send(:chef_environment, 'testing')
+
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+      @expected_time = Time.now
+      allow(Time).to receive(: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 node.name 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 #{@node.name}"),
+        :body => hash_including(:host => @node.name),
+      )).to have_been_made.times(1)
+    end
+
+    it 'uses the specified hostname when provided' do
+      @handler.config[:hostname] = 'my-imaginary-hostname.local'
+      @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 my-imaginary-hostname.local'),
+        :body => hash_including(:host => 'my-imaginary-hostname.local'),
+      )).to have_been_made.times(1)
+    end
+  end
+
+  context 'tags' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-tags')
+
+      @node.send(:chef_environment, 'hostile')
+      @node.send(:run_list, 'role[highlander]')
+
+      @events = Chef::EventDispatch::Dispatcher.new
+      @run_context = Chef::RunContext.new(@node, {}, @events)
+      @run_status = Chef::RunStatus.new(@node, @events)
+
+      @expected_time = Time.now
+      allow(Time).to receive(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+    end
+
+    describe 'when specified' do
+      it 'sets the role and env and tags' do
+        @node.normal.tags = ['the_one_and_only', 'datacenter:my-cloud']
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'tag:the_one_and_only', 'tag:datacenter:my-cloud'
+            ]),
+        )).to have_been_made.times(1)
+      end
+
+      it 'allows for user-specified tag prefix' do
+        @node.normal.tags = ['the_one_and_only', 'datacenter:my-cloud']
+        @handler.config[:tag_prefix] = 'custom-prefix-'
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'custom-prefix-the_one_and_only', 'custom-prefix-datacenter:my-cloud'
+            ]),
+         )).to have_been_made.times(1)
+      end
+
+      it 'allows for empty tag prefix' do
+        @node.normal.tags = ['the_one_and_only', 'datacenter:my-cloud']
+        @handler.config[:tag_prefix] = ''
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'the_one_and_only', 'datacenter:my-cloud'
+            ]),
+         )).to have_been_made.times(1)
+      end
+    end
+
+    describe 'when unspecified' do
+      it 'sets role, env and nothing else' do
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander'
+            ]),
+        )).to have_been_made.times(1)
+      end
+    end
+  end
+
+  context 'tags submission retries' do
+    before(:each) do
+      @node = Chef::Node.build('chef.handler.datadog.test-tags-retries')
+
+      @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
+      allow(Time).to receive(:now).and_return(@expected_time, @expected_time + 5)
+      @run_status.start_clock
+      @run_status.stop_clock
+
+      @run_status.run_context = @run_context
+    end
+
+    describe 'when specified as 2 retries' do
+      before(:each) do
+        @handler.config[:tags_submission_retries] = 2
+        # Stub `sleep` to avoid slowing down the execution
+        allow_any_instance_of(DatadogChefTags).to receive(:sleep)
+      end
+
+      it 'retries no more than twice' do
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'tag:the_one_and_only'
+            ]),
+        )).to have_been_made.times(3)
+      end
+
+      it 'stops retrying once submission is successful' do
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'tag:the_one_and_only'
+            ]),
+        )).to have_been_made.times(2)
+      end
+    end
+
+    describe 'when not specified' do
+      it 'does not retry after a failed submission'  do
+        @handler.run_report_unsafe(@run_status)
+
+        expect(a_request(:put, HOST_TAG_ENDPOINT + @node.name).with(
+          :query => { 'api_key' => @handler.config[:api_key],
+                      'application_key' => @handler.config[:application_key],
+                      'source' => 'chef' },
+          :body => hash_including(:tags => [
+            'env:hostile', 'role:highlander', 'tag:the_one_and_only'
+            ]),
+        )).to have_been_made.times(1)
+      end
+    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
+      allow(Time).to receive(: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)
+
+      all_resources = [
+        Chef::Resource.new('whiskers'),
+        Chef::Resource.new('paws'),
+        Chef::Resource.new('ears'),
+        Chef::Resource.new('nose'),
+        Chef::Resource.new('tail'),
+        Chef::Resource.new('fur')
+        ]
+      all_resources.map { |r| r.updated_by_last_action(true) }
+      @run_context.resource_collection.all_resources.replace(all_resources)
+
+      @expected_time = Time.now
+      allow(Time).to receive(: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(['whiskers.rb:2', 'paws.rb:1', '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
+
+    it 'sets alert handles when specified' do
+      @handler.config[:notify_on_failure] = ['@alice', '@bob']
+      @handler.run_report_unsafe(@run_status)
+
+      expect(a_request(:post, EVENTS_ENDPOINT).with(
+        :query => { 'api_key' => @handler.config[:api_key] },
+        :body => /Alerting: @alice @bob/
+      )).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
+      allow(Time).to receive(: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
+
+  describe '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)
+    end
+
+    context 'failure during compile phase' do
+      before(:each) do
+        @handler.run_report_unsafe(@run_status)
+      end
+
+      it 'only emits a failure metric' do
+        expect(a_request(:post, METRICS_ENDPOINT).with(
+          :query => { 'api_key' => @handler.config[:api_key] }
+        )).to have_been_made.times(1)
+      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 was unable to complete a run, an error during compilation may have occured.'),
+          :body => hash_including(:msg_title => "Chef failed during compile phase on #{@node.name} "),
+        )).to have_been_made.times(1)
+      end
+    end
+  end
+
+    # TODO: test failures:
+    # @run_status.exception = Exception.new('Boy howdy!')
+end