fiveruns-dash-ruby 0.7.0

data/test/metric_test.rb

@@ -0,0 +1,204 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+class MetricTest < Test::Unit::TestCase
+  
+  attr_reader :metric
+  
+  def self.time_me(val=0)
+    if val == 0
+      time_me(1)
+    end
+    sleep 0.01
+  end
+
+  context "Metric" do
+    
+    teardown do
+      # Hacked 'uninstrument' until it's built-in
+      ::Fiveruns::Dash::Instrument.handlers.each do |handler|
+        (class << MetricTest; self; end).class_eval <<-EOCE
+          remove_method :time_me_with_instrument_#{handler.hash}
+          alias_method :time_me, :time_me_without_instrument_#{handler.hash}
+          remove_method :time_me_without_instrument_#{handler.hash}
+        EOCE
+      end
+      ::Fiveruns::Dash::Instrument.handlers.clear
+    end
+    
+    context "should parse arguments for name, description and help_text" do
+      setup do
+        @options = Hash.new
+        @options[:method] = time_method
+        @metric = TimeMetric.new(:name, "Description", "HelpText", :method => time_method)
+      end
+      
+      should "interpret name" do
+        assert_equal "name", @metric.name
+      end
+
+      should "interpret description" do
+        assert_equal "Description", @metric.description
+      end
+
+      should "interpret help text" do
+        assert_equal "HelpText", @metric.help_text
+      end
+
+      should "interpret options" do
+        assert_equal @options, @metric.options
+      end
+    end
+    
+    context "should parse arguments for name, description using defaults" do
+      setup do
+        @options = Hash.new
+        @options[:method] = time_method
+        @metric = TimeMetric.new(:name, :method => time_method)
+      end
+      
+      should "interpret name" do
+        assert_equal "name", @metric.name
+      end
+
+      should "default description to titleized name" do
+        assert_equal "Name", @metric.description
+      end
+
+      should "default help text to nil" do
+        assert_nil @metric.help_text
+      end
+
+      should "interpret options" do
+        assert_equal @options, @metric.options
+      end
+    end
+
+    context "using reentrant time" do
+      setup do
+        @metric = TimeMetric.new(:time_mes, :method => time_method, :reentrant => true)
+        flexmock(@metric).should_receive(:info_id).and_return(1)
+      end
+      teardown do
+        # Hacked 'uninstrument' until it's built-in
+        ::Fiveruns::Dash::Instrument.handlers.each do |handler|
+          (class << MetricTest; self; end).class_eval <<-EOCE
+            remove_method :time_me_with_instrument_#{handler.hash}
+            alias_method :time_me, :time_me_without_instrument_#{handler.hash}
+            remove_method :time_me_without_instrument_#{handler.hash}
+          EOCE
+        end
+        ::Fiveruns::Dash::Instrument.handlers.clear
+      end
+      should "get correct number of invocations" do
+        invoke 4
+        assert_invocations_reported 4
+        invoke 1
+        assert_invocations_reported 1
+      end
+    end
+    
+    context "using time" do
+      setup do
+        @metric = TimeMetric.new(:time_mes, :method => time_method)
+        flexmock(@metric).should_receive(:info_id).and_return(1)
+      end
+      teardown do
+        # Hacked 'uninstrument' until it's built-in
+        ::Fiveruns::Dash::Instrument.handlers.each do |handler|
+          (class << MetricTest; self; end).class_eval <<-EOCE
+            remove_method :time_me_with_instrument_#{handler.hash}
+            alias_method :time_me, :time_me_without_instrument_#{handler.hash}
+            remove_method :time_me_without_instrument_#{handler.hash}
+          EOCE
+        end
+        ::Fiveruns::Dash::Instrument.handlers.clear
+      end
+      should "raise exception without :on option" do
+        assert_raises ArgumentError do
+          TimeMetric.new(:time_mes, 'A Name')
+        end
+      end
+      should "get correct number of invocations" do
+        invoke 4
+        assert_invocations_reported 8
+        invoke 1
+        assert_invocations_reported 2
+      end
+      should "time invocations" do
+        last_total = 0
+        4.times do |i|
+          invoke
+          assert_equal (i + 1)*2, current_invocations 
+          reported_total = current_time_total
+          assert(reported_total > last_total)
+          last_total = reported_total
+        end
+        metric.data # clears
+        assert_equal 0, current_time_total
+      end
+      should "have correct info" do
+        assert_equal 'time_mes', metric.info[:name]
+        assert_equal 'Time Mes', metric.info[:description]
+      end
+      should "be able to set context finder" do
+        finder = lambda { |obj, *args| [:class, obj.name] }
+        @metric.find_context_with(&finder)
+        invoke 4
+        assert_equal 8, metric.data[:values].select { |m| m[:context] == [:class, 'MetricTest'] }.first[:invocations]
+      end
+    end
+
+    context "using incremented counter" do
+      setup do
+        @metric = CounterMetric.new(:time_mes_counter, :incremented_by => time_method)
+        flexmock(@metric).should_receive(:info_id).and_return(1)
+      end
+      should "default to 0 before being incremented, and after reset" do
+        assert_counted 0
+        invoke 4
+        assert_counted 8
+        assert_counted 0
+      end
+      should "get correct number after being incremented" do
+        invoke 4
+        assert_counted 8
+      end
+    end
+
+  end
+  
+  #######
+  private
+  #######
+  
+  def current_time_total
+    metric.instance_eval { @data[[]][:value] }
+  end
+  
+  def current_invocations
+    metric.instance_eval { @data[[]][:invocations] }
+  end
+  
+  def time_method
+    'MetricTest.time_me'
+  end
+  
+  def assert_counted(number)
+    counted = nil
+    assert_nothing_raised do
+      # We fetch to ensure values aren't just being returned due to hash defaults
+      counted = metric.data[:values].detect { |m| m[:context] == [] }[:value]
+    end
+    assert_kind_of Numeric, counted
+    assert_equal number, counted
+  end
+  
+  def assert_invocations_reported(number = 1)
+    assert_equal number, metric.data[:values].detect { |m| m[:context] == [] }[:invocations]
+  end
+
+  def invoke(number = 1)
+    number.times { MetricTest.time_me }
+  end
+
+end

data/test/recipe_test.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+class RecipeTest < Test::Unit::TestCase
+  
+  attr_reader :config
+  
+  context "Recipe" do
+
+    setup do
+      mock_streams!
+      Fiveruns::Dash.recipes.clear
+      @config = Fiveruns::Dash::Configuration.new
+    end
+    
+    teardown do
+      restore_streams!
+    end
+        
+    context "when registering" do
+      context "with valid metadata" do
+        setup do
+          assert_nothing_raised do
+            recipe do |metrics|
+              metrics.counter :foo do
+                1
+              end
+            end
+          end
+        end
+        should "is added to available recipes" do
+          assert_equal 1, Fiveruns::Dash.recipes.size
+          assert_kind_of Array, Fiveruns::Dash.recipes[:test]
+          assert_kind_of Fiveruns::Dash::Recipe, Fiveruns::Dash.recipes[:test].first
+        end
+      end
+      context "without url" do
+        should "raise error" do
+          assert_raises Fiveruns::Dash::Recipe::ConfigurationError do
+            recipe(:test, {}) do |metrics|
+              metrics.counter :foo do
+                1
+              end
+            end
+          end
+        end
+      end
+
+    end
+    
+    context "when adding" do
+      context "with single matching recipe" do
+        setup do
+          recipe :test, :url => 'http://test1.com' do |r|
+            r.counter(:test1) { }
+          end
+          config.add_recipe :test
+        end
+        should "description" do
+          assert_metrics(*%w(test1))
+        end
+      end
+      context "with multiple similiarly-named recipes" do
+        setup do
+          recipe :test, :url => 'http://test1.com' do |r|
+            r.counter(:test1) { }
+          end
+          recipe :test, :url => 'http://test2.com' do |r|
+            r.counter(:test2) { }
+          end
+        end
+        should "load all by default" do
+          config.add_recipe :test
+          assert_equal 2, config.metrics.size
+          assert_metrics(*%w(test1 test2))
+        end
+        should "allow specific recipe to be loaded" do
+          config.add_recipe :test, :url => 'http://test2.com'
+          assert_equal 1, config.metrics.size
+          assert_metrics(*%w(test2))
+        end
+      end
+    end
+    
+    context "when added" do
+      setup do
+        @fired = false
+        recipe :test, :url => 'http://test.com' do |recipe|
+          recipe.added do
+            @fired = true
+          end
+          recipe.counter(:countme) { }
+        end
+      end
+      should "fire recipe hook" do
+        config.add_recipe :test
+        assert @fired
+      end
+      should "allow metrics with same name and different recipes" do
+        config.counter(:countme) { }
+        config.add_recipe :test
+        assert_metrics(*%w(countme countme))
+      end
+      context "modifying existing metrics" do
+        setup do
+          recipe :test3 do |r|
+            r.modify :name => :countme do |metric|
+              metric.find_context_with do |obj, *args|
+                [:modified, true]
+              end
+            end
+          end
+        end
+        should "only occur on addition" do
+          config.metrics.each do |metric|
+            if metric.name == 'countme'
+              assert_nil metric.instance_eval { @metric_finder }
+            end
+          end
+        end
+        should "change context finder" do
+          config.add_recipe :test3
+          config.metrics.each do |metric|
+            if metric.name == 'countme'
+              assert_kind_of Proc, metric.instance_eval { @metric_finder }
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+  
+  #######
+  private
+  #######
+  
+  def assert_metrics(*names)
+    assert_equal names.sort, config.metrics.map(&:name).map(&:to_s).sort
+  end
+  
+  def recipe(name = :test, options = {:url => 'http://test.com'}, &block)
+    Fiveruns::Dash.register_recipe(name, options, &block)
+  end  
+
+end

data/test/reliability_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+class Gizmo
+  
+  def oops!
+    raise 'I made an oopsie!'
+  end
+    
+end
+
+class ReliabilityTest < Test::Unit::TestCase
+  
+  context "FiveRuns Dash" do
+    
+    should 'not swallow user-created exceptions' do
+      dash do |metrics|
+        metrics.time(:oops, 'Time spent messing up', 'Ooops!', 
+                     :method => 'Gizmo#oops!')
+      end
+      
+      assert_raises(RuntimeError) { Gizmo.new.oops! }
+    end
+    
+    should 'report an exception if instrumentation cannot proceed' do
+      assert_raises(Fiveruns::Dash::Instrument::Error) do
+        dash do |metrics|
+          metrics.time(:wheee, 'Time spent having fun', 'Wheeee!',
+                       :method => 'Gizmo.wheeeeeeee!')
+          metrics.time(:oops, 'Time spent messing up', 'Ooops!', 
+                       :method => 'Gizmo#oops!')
+        end
+      end
+    end
+    
+    should 'not proceed with instrumentation if an error occurs' do
+      begin
+        dash do |metrics|
+          metrics.time(:wheee, 'Time spent having fun', 'Wheeee!',
+                       :method => 'Gizmo.wheeeeeeee!')
+          metrics.time(:oops, 'Time spent messing up', 'Ooops!', 
+                       :method => 'Gizmo#oops!')
+        end
+      rescue Fiveruns::Dash::Instrument::Error
+      end
+      assert_equal 0, Fiveruns::Dash.configuration.metrics.length
+    end
+    
+    should 'not modify Thread.abort_on_exception if the user has set it' do
+      assert !Thread.abort_on_exception
+    end
+    
+  end
+  
+  def dash(&block)
+    Fiveruns::Dash.configure({:app => ENV['DASH_APP']}, &block)
+    Fiveruns::Dash.session.reporter.interval = 10
+    Fiveruns::Dash.session.start
+  end
+  
+end

data/test/reporter_test.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+class ReporterTest < Test::Unit::TestCase
+  
+  include Fiveruns::Dash
+  
+  attr_reader :reporter
+
+  context "Reporter" do
+
+    setup do
+      mock!
+    end
+    
+    context "instance" do
+      setup do
+        @reporter = Reporter.new(@session)
+      end
+      should "start normally" do
+        assert !@reporter.started?
+        assert !@reporter.background?
+        @reporter.start
+        assert_kind_of Time, @reporter.started_at
+        assert @reporter.started?
+        assert @reporter.background?
+        assert !@restarted
+      end
+      should "allow restart" do
+        @reporter.start
+        time = @reporter.started_at
+        assert_kind_of Time, time
+        assert !@restarted
+        @reporter.start
+        assert @restarted
+        assert_equal time.to_f, @reporter.started_at.to_f
+      end
+    end
+
+  end
+  
+  #######
+  private
+  #######
+  
+
+end