harness 0.0.1 → 0.1.0

data/test/integration/instrumentation_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class ActiveSupportTestCase < IntegrationTest
+  def test_a_gauge_is_logged
+    ActiveSupport::Notifications.instrument "gauge_test.harness", :gauge => true do |args|
+      # do nothing
+    end
+
+    assert_gauge_logged "gauge_test.harness"
+  end
+
+  def test_a_counter_is_logged
+    ActiveSupport::Notifications.instrument "counter_test.harness", :counter => { :value => 5 } do |args|
+      # do nothing
+    end
+
+    assert_counter_logged "counter_test.harness"
+  end
+
+  def test_can_log_both
+    ActiveSupport::Notifications.instrument "test.harness", :gauge => { :id => "test-gauge" }, :counter => {:id => 'test-counter', :value => 5 } do |args|
+      # do nothing
+    end
+
+    assert_counter_logged "test-counter"
+    assert_gauge_logged "test-gauge"
+  end
+end

data/test/integration/integrations/action_controller_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class ActionControllerIntegration < IntegrationTest
+  def test_logs_write_fragment
+    instrument "write_fragment"
+
+    assert_gauge_logged "write_fragment.action_controller"
+  end
+
+  def test_logs_read_fragment
+    instrument "read_fragment"
+
+    assert_gauge_logged "read_fragment.action_controller"
+  end
+
+  def test_logs_expire_fragment
+    instrument "expire_fragment"
+
+    assert_gauge_logged "expire_fragment.action_controller"
+  end
+
+  def test_logs_write_page
+    instrument "write_page"
+
+    assert_gauge_logged "write_page.action_controller"
+  end
+
+  def test_logs_expire_page
+    instrument "expire_page"
+
+    assert_gauge_logged "expire_page.action_controller"
+  end
+
+  def test_logs_process_action
+    instrument "process_action"
+
+    assert_gauge_logged "process_action.action_controller"
+  end
+
+  def test_logs_send_file
+    instrument "send_file"
+
+    assert_gauge_logged "send_file.action_controller"
+  end
+
+  def instrument(event)
+    ActiveSupport::Notifications.instrument "#{event}.action_controller" do |*args|
+      # nada
+    end
+  end
+end

data/test/integration/integrations/action_mailer_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class ActionMailerIntegration < IntegrationTest
+  def test_logs_mail_received
+    instrument "receive"
+
+    assert_gauge_logged "receive.action_mailer"
+  end
+
+  def test_logs_mail_delivered
+    instrument "deliver"
+
+    assert_gauge_logged "deliver.action_mailer"
+  end
+
+  private
+  def instrument(event)
+    ActiveSupport::Notifications.instrument "#{event}.action_mailer" do |*args|
+      # nada
+    end
+  end
+end

data/test/integration/integrations/action_view_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class ActionViewIntegration < IntegrationTest
+  def test_logs_render_template
+    instrument "render_template"
+
+    assert_gauge_logged "render_template.action_view"
+  end
+
+  def test_logs_render_partial
+    instrument "render_partial"
+
+    assert_gauge_logged "render_partial.action_view"
+  end
+
+  private
+  def instrument(event)
+    ActiveSupport::Notifications.instrument "#{event}.action_view" do |*args|
+      # nada
+    end
+  end
+end

data/test/integration/integrations/active_support_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class ActiveSupportIntegration < IntegrationTest
+  def test_logs_cache_read
+    instrument "cache_read"
+
+    assert_gauge_logged "cache_read.active_support"
+  end
+
+  def test_logs_cache_generate
+    instrument "cache_generate"
+
+    assert_gauge_logged "cache_generate.active_support"
+  end
+
+  def test_logs_cache_fetch_hit
+    instrument "cache_fetch_hit"
+
+    assert_gauge_logged "cache_fetch_hit.active_support"
+  end
+
+  def test_logs_cache_write
+    instrument "cache_write"
+
+    assert_gauge_logged "cache_write.active_support"
+  end
+
+  def test_logs_cache_delete
+    instrument "cache_delete"
+
+    assert_gauge_logged "cache_delete.active_support"
+  end
+
+  private
+  def instrument(event)
+    ActiveSupport::Notifications.instrument "#{event}.active_support" do |*args|
+      # nada
+    end
+  end
+end

data/test/integration/logging_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class HarnessTest < IntegrationTest
+  def test_gauges_are_logged
+    gauge = Harness::Gauge.new :name => 'minitest'
+    gauge.log
+
+    assert_includes gauges, gauge
+  end
+
+  def test_counters_are_logged
+    counter = Harness::Counter.new :name => 'minitest'
+    counter.log
+
+    assert_includes counters, counter
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'harness'
+
+require 'minitest/unit'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+require 'webmock/minitest'
+
+WebMock.disable_net_connect!
+
+Thread.abort_on_exception = true
+
+Harness.config.test_mode = true
+
+Harness.logger = Logger.new '/dev/null'
+
+Harness.redis = Redis::Namespace.new 'harness-test', :redis => Redis.connect(:host => 'localhost', :port => '6379')
+
+class IntegrationTest < MiniTest::Unit::TestCase
+  def setup
+    Harness.config.adapter = :memory
+    gauges.clear ; counters.clear
+    redis.flushall
+  end
+
+  def assert_gauge_logged(name)
+    refute_empty gauges.select {|g| g.name = name }, "Expected #{gauges.inspect} to contain a #{name} result"
+  end
+
+  def assert_counter_logged(name)
+    refute_empty counters.select {|c| c.name = name }, "Expected #{counters.inspect} to contain a #{name} result"
+  end
+
+  def gauges
+    Harness::MemoryAdapter.gauges
+  end
+
+  def counters
+    Harness::MemoryAdapter.counters
+  end
+
+  def redis
+    Harness.redis
+  end
+
+  def instrument(name, data = {})
+    ActiveSupport::Notifications.instrument name, data do 
+      # nothing
+    end
+  end
+end

data/test/unit/adapters/librato_adapter_test.rb

@@ -0,0 +1,176 @@
+require 'test_helper'
+
+class LibratoAdapterTest < MiniTest::Unit::TestCase
+  def setup
+    @adapter = Harness::LibratoAdapter
+
+    @gauge = Harness::Gauge.new
+    @gauge.id = "fake-gauge"
+    @gauge.name = "Fake Gauge"
+    @gauge.source = "minitest"
+    @gauge.time = Time.now
+    @gauge.value = 55
+
+    @counter = Harness::Counter.new
+    @counter.id = "fake-counter"
+    @counter.name = "Fake Counter"
+    @counter.source = "minitest"
+    @counter.time = Time.now
+    @counter.value = 55
+    @counter.units = :bytes
+
+    Harness::LibratoAdapter.config.email = email
+    Harness::LibratoAdapter.config.token = token
+  end
+
+  def teardown
+    WebMock.reset!
+
+    Harness::LibratoAdapter.config.email = nil
+    Harness::LibratoAdapter.config.token = nil
+  end
+
+  def test_gauge_is_logged
+    json = {
+      :gauges => [{
+        :name => @gauge.id,
+        :display_name => @gauge.name,
+        :value => @gauge.value,
+        :measure_time => @gauge.time.to_i,
+        :source => @gauge.source,
+        :attributes => { :display_units_short => @gauge.units }
+      }]
+    }.to_json
+
+    expected_request = stub_request(:post, "https://#{email}:#{token}@metrics-api.librato.com/v1/metrics").
+      with(:body => json, :headers => {"Content-Type" => "application/json"}).
+      to_return(:status => 200)
+
+    assert @adapter.log_gauge(@gauge)
+    assert_requested expected_request
+  end
+
+  def test_gauge_id_is_sanitized
+    @gauge.id = "process_action.action_controller"
+
+    json = {
+      :gauges => [{
+        :name => "process_action-action_controller",
+        :display_name => @gauge.name,
+        :value => @gauge.value,
+        :measure_time => @gauge.time.to_i,
+        :source => @gauge.source,
+        :attributes => { :display_units_short => @gauge.units }
+      }]
+    }.to_json
+
+    expected_request = stub_request(:post, "https://#{email}:#{token}@metrics-api.librato.com/v1/metrics").
+      with(:body => json, :headers => {"Content-Type" => "application/json"}).
+      to_return(:status => 200)
+
+    assert @adapter.log_gauge(@gauge)
+    assert_requested expected_request
+  end
+
+
+  def test_logging_gague_raises_an_exception
+    stub_request(:post, %r{metrics}).to_return(:status => 500, :body => "message")
+
+    assert_raises Harness::LoggingError do
+      @adapter.log_gauge @gauge
+    end
+  end
+
+  def test_logging_gauge_raises_an_exception_when_id_is_too_long
+    @gauge.id = "f" * 64
+
+    assert_raises Harness::LoggingError do
+      @adapter.log_gauge @gauge
+    end
+  end
+
+  def test_logging_gauge_raises_an_exception_when_not_configured
+    Harness::LibratoAdapter.config.email = nil
+    Harness::LibratoAdapter.config.token = nil
+
+    assert_raises RuntimeError do
+      @adapter.log_gauge @gauge
+    end
+  end
+
+  def test_counter_is_logged
+    json = {
+      :counters => [{
+        :name => @counter.id,
+        :display_name => @counter.name,
+        :value => @counter.value,
+        :measure_time => @counter.time.to_i,
+        :source => @counter.source,
+        :attributes => { :display_units_short => @counter.units }
+      }]
+    }.to_json
+
+    expected_request = stub_request(:post, "https://#{email}:#{token}@metrics-api.librato.com/v1/metrics").
+      with(:body => json, :headers => {"Content-Type" => "application/json"}).
+      to_return(:status => 200)
+
+    assert @adapter.log_counter(@counter)
+    assert_requested expected_request
+  end
+
+  def test_counter_id_is_sanitized
+    @counter.id = "total_requests.action_controller"
+
+    json = {
+      :counters => [{
+        :name => "total_requests-action_controller",
+        :display_name => @counter.name,
+        :value => @counter.value,
+        :measure_time => @counter.time.to_i,
+        :source => @counter.source,
+        :attributes => { :display_units_short => @counter.units }
+      }]
+    }.to_json
+
+    expected_request = stub_request(:post, "https://#{email}:#{token}@metrics-api.librato.com/v1/metrics").
+      with(:body => json, :headers => {"Content-Type" => "application/json"}).
+      to_return(:status => 200)
+
+    assert @adapter.log_counter(@counter)
+    assert_requested expected_request
+  end
+
+  def test_logging_counter_raises_an_exception
+    stub_request(:post, %r{metrics}).to_return(:status => 500, :body => "message")
+
+    assert_raises Harness::LoggingError do
+      @adapter.log_counter @counter
+    end
+  end
+
+  def test_logging_counter_raises_an_exception_when_not_configured
+    Harness::LibratoAdapter.config.email = nil
+    Harness::LibratoAdapter.config.token = nil
+
+    assert_raises RuntimeError do
+      @adapter.log_counter @counter
+    end
+  end
+
+  def test_logging_counter_raises_an_exception_when_id_is_too_long
+    @counter.id = "f" * 64
+
+    assert_raises Harness::LoggingError do
+      @adapter.log_counter @counter
+    end
+  end
+
+  private
+  def email
+    'example@example.com'
+  end
+
+  def token
+    'a-complete-api-token'
+  end
+end

data/test/unit/adapters/memory_adapter_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class MemoryAdapterTest < MiniTest::Unit::TestCase
+  def setup
+    Harness::MemoryAdapter.counters.clear
+    Harness::MemoryAdapter.gauges.clear
+
+    @adapter = Harness::MemoryAdapter
+  end
+
+  def test_log_gauge_adds_to_gauges
+    @adapter.log_gauge :foo
+
+    assert_includes @adapter.gauges, :foo
+  end
+
+  def test_log_counter_adds_to_counters
+    @adapter.log_counter :bar
+
+    assert_includes @adapter.counters, :bar
+  end
+end

data/test/unit/counter_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class CounterTest < MiniTest::Unit::TestCase
+  def setup
+    @counter = Harness::Counter.new
+    Harness.redis.flushall
+  end
+
+  def test_sets_id_from_event
+    event = ActiveSupport::Notifications::Event.new "name", Time.now, Time.now, nil, {}
+
+    counter = Harness::Counter.from_event event
+
+    assert_equal "name", counter.id
+  end
+
+  def tests_sets_source_from_event_payload
+    event = ActiveSupport::Notifications::Event.new "name", Time.now, Time.now, nil, :counter => { :source => 'box1' }
+
+    counter = Harness::Counter.from_event event
+
+    assert_equal "box1", counter.source
+  end
+
+  def test_sets_value_from_event_payload
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :counter => {:value => 5 }
+
+    counter = Harness::Counter.from_event event
+
+    assert_equal 5, counter.value
+  end
+
+  def test_sets_value_from_event_payload_with_number
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :counter => 5
+
+    counter = Harness::Counter.from_event event
+
+    assert_equal 5, counter.value
+  end
+
+  def test_sets_name_from_event
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :counter => { :name => 'foo' }
+
+    counter = Harness::Counter.from_event event
+
+    assert_equal 'foo', counter.name
+  end
+
+end

data/test/unit/gauge_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class GaugeTest < MiniTest::Unit::TestCase
+  def setup
+    @gauge = Harness::Gauge.new
+  end
+
+  def test_initializes_units
+    assert_equal :ms, @gauge.units
+  end
+
+  def test_sets_name_id_event
+    event = ActiveSupport::Notifications::Event.new "name", Time.now, Time.now, nil, {}
+
+    gauge = Harness::Gauge.from_event event
+
+    assert_equal "name", gauge.id
+  end
+
+  def tests_sets_source_from_event_payload
+    event = ActiveSupport::Notifications::Event.new "name", Time.now, Time.now, nil, :gauge => { :source => 'box1' }
+
+    gauge = Harness::Gauge.from_event event
+
+    assert_equal "box1", gauge.source
+  end
+
+  def test_sets_duration_from_event
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, {}
+
+    gauge = Harness::Gauge.from_event event
+
+    assert_in_delta 1000, 0.01, gauge.value
+  end
+
+  def test_sets_name_from_event
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :gauge => { :name => 'foo' }
+
+    gauge = Harness::Gauge.from_event event
+
+    assert_equal 'foo', gauge.name
+  end
+
+  def test_initializes_time_if_not_set
+    gauge = Harness::Gauge.new
+
+    assert gauge.time
+  end
+end

data/test/unit/harness_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class HarnessModuleTest < MiniTest::Unit::TestCase
+  def test_can_set_the_adapter_with_a_symbol
+    Harness.config.adapter = :memory
+
+    assert_equal Harness::MemoryAdapter, Harness.config.adapter
+  end
+
+  def test_can_set_the_adapter_with_a_class
+    Harness.config.adapter = Harness::MemoryAdapter
+
+    assert_equal Harness::MemoryAdapter, Harness.config.adapter
+  end
+
+  def test_uses_method_missing_to_configure_adapters
+    Harness.config.librato.email = 'foo'
+
+    assert_equal 'foo', Harness.config.librato.email
+  end
+
+  def test_blows_up_when_calling_an_unknown_adapter
+    assert_raises NoMethodError do
+      Harness.config.foo_bar
+    end
+  end
+end

data/test/unit/measurement_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class MeasurementTest < MiniTest::Unit::TestCase
+  def setup
+    @measurement = Harness::Measurement.new
+  end
+
+  def test_has_an_id_attribute
+    assert @measurement.respond_to?(:id)
+    assert @measurement.respond_to?(:id=)
+  end
+
+  def test_has_a_source_attribute
+    assert @measurement.respond_to?(:source)
+    assert @measurement.respond_to?(:source=)
+  end
+
+  def test_has_a_time_attribute
+    assert @measurement.respond_to?(:time)
+    assert @measurement.respond_to?(:time=)
+  end
+
+  def test_has_a_value_attribute
+    assert @measurement.respond_to?(:value)
+    assert @measurement.respond_to?(:value=)
+  end
+
+  def test_has_a_name_attribute
+    assert @measurement.respond_to?(:name)
+    assert @measurement.respond_to?(:name=)
+  end
+
+  def test_initializes_time
+    assert @measurement.time
+  end
+end