traceview 3.0.0

data/test/minitest_helper.rb

@@ -0,0 +1,187 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "minitest/reporters"
+require "minitest/debugger" if ENV['DEBUG']
+
+ENV["RACK_ENV"] = "test"
+ENV["TRACEVIEW_GEM_TEST"] = "true"
+ENV["TRACEVIEW_GEM_VERBOSE"] = "true"
+
+# FIXME: Temp hack to fix padrino-core calling RUBY_ENGINE when it's
+# not defined under Ruby 1.8.7 and 1.9.3
+RUBY_ENGINE = "ruby" unless defined?(RUBY_ENGINE)
+
+Minitest::Spec.new 'pry'
+
+unless RUBY_VERSION =~ /^1.8/
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end
+
+if defined?(JRUBY_VERSION)
+  ENV['JAVA_OPTS'] = "-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar"
+end
+
+require 'rubygems'
+require 'bundler'
+
+# Preload memcache-client
+require 'memcache'
+
+Bundler.require(:default, :test)
+
+@trace_dir = "/tmp/"
+$trace_file = @trace_dir + "trace_output.bson"
+
+# Configure TraceView
+TraceView::Config[:verbose] = true
+TraceView::Config[:tracing_mode] = "always"
+TraceView::Config[:sample_rate] = 1000000
+TraceView.logger.level = Logger::DEBUG
+
+# Our background Rack-app for http client testing
+require "./test/servers/rackapp_8101"
+
+##
+# clear_all_traces
+#
+# Truncates the trace output file to zero
+#
+def clear_all_traces
+  TraceView::Reporter.clear_all_traces
+end
+
+##
+# get_all_traces
+#
+# Retrieves all traces written to the trace file
+#
+def get_all_traces
+  TraceView::Reporter.get_all_traces
+end
+
+##
+# validate_outer_layers
+#
+# Validates that the KVs in kvs are present
+# in event
+#
+def validate_outer_layers(traces, layer)
+  traces.first['Layer'].must_equal layer
+  traces.first['Label'].must_equal 'entry'
+  traces.last['Layer'].must_equal layer
+  traces.last['Label'].must_equal 'exit'
+end
+
+##
+# validate_event_keys
+#
+# Validates that the KVs in kvs are present
+# in event
+#
+def validate_event_keys(event, kvs)
+  kvs.each do |k, v|
+    event.has_key?(k).must_equal true
+    event[k].must_equal v
+  end
+end
+
+##
+# has_edge?
+#
+# Searches the array of <tt>traces</tt> for
+# <tt>edge</tt>
+#
+def has_edge?(edge, traces)
+  traces.each do |t|
+    if TraceView::XTrace.edge_id(t["X-Trace"]) == edge
+      return true
+    end
+  end
+  TraceView.logger.debug "[oboe/debug] edge #{edge} not found in traces."
+  false
+end
+
+##
+# valid_edges?
+#
+# Runs through the array of <tt>traces</tt> to validate
+# that all edges connect.
+#
+# Not that this won't work for external cross-app tracing
+# since we won't have those remote traces to validate
+# against.
+#
+def valid_edges?(traces)
+  traces.reverse.each do  |t|
+    if t.key?("Edge")
+      return false unless has_edge?(t["Edge"], traces)
+    end
+  end
+  true
+end
+
+##
+# layer_has_key
+#
+# Checks an array of trace events if a specific layer (regardless of event type)
+# has he specified key
+#
+def layer_has_key(traces, layer, key)
+  return false if traces.empty?
+  has_key = false
+
+  traces.each do |t|
+    if t["Layer"] == layer and t.has_key?(key)
+      has_key = true
+
+      (t["Backtrace"].length > 0).must_equal true
+    end
+  end
+
+  has_key.must_equal true
+end
+
+##
+# layer_doesnt_have_key
+#
+# Checks an array of trace events to assure that a specific layer
+# (regardless of event type) doesn't have the specified key
+#
+def layer_doesnt_have_key(traces, layer, key)
+  return false if traces.empty?
+  has_key = false
+
+  traces.each do |t|
+    has_key = true if t["Layer"] == layer and t.has_key?(key)
+  end
+
+  has_key.must_equal false
+end
+
+##
+# Sinatra and Padrino Related Helpers
+#
+# Taken from padrino-core gem
+#
+
+class Sinatra::Base
+  # Allow assertions in request context
+  include MiniTest::Assertions
+end
+
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=Padrino::Application, &block)
+    @app = Sinatra.new(base, &block)
+  end
+
+  def app
+    Rack::Lint.new(@app)
+  end
+end
+

data/test/profiling/method_test.rb

@@ -0,0 +1,198 @@
+require 'minitest_helper'
+
+describe "TraceViewMethodProfiling" do
+  before do
+    clear_all_traces
+    # Conditionally Undefine TestWorker
+    # http://stackoverflow.com/questions/11503558/how-to-undefine-class-in-ruby
+    Object.send(:remove_const, :TestWorker) if defined?(TestWorker)
+  end
+
+  it 'should be loaded, defined and ready' do
+    defined?(::TraceViewMethodProfiling).wont_match nil
+  end
+
+  it 'should trace Class methods' do
+    class TestWorker
+      def self.do_work
+        sleep 1
+      end
+
+      class << self
+        include TraceViewMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::TraceView::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Class"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("Layer").must_equal false
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+
+    validate_event_keys(traces[2], kvs)
+    traces[2].has_key?("Layer").must_equal false
+  end
+
+  it 'should trace Instance methods' do
+    class TestWorker
+      def do_work
+        sleep 1
+      end
+
+      include TraceViewMethodProfiling
+      profile_method :do_work, 'do_work'
+    end
+
+    ::TraceView::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      tw = TestWorker.new
+      tw.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Class"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("Layer").must_equal false
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+
+    validate_event_keys(traces[2], kvs)
+    traces[2].has_key?("Layer").must_equal false
+  end
+
+  it 'should trace Module class methods' do
+    module TestWorker
+      def self.do_work
+        sleep 1
+      end
+
+      class << self
+        include TraceViewMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::TraceView::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Module"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("Layer").must_equal false
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+
+    validate_event_keys(traces[2], kvs)
+    traces[2].has_key?("Layer").must_equal false
+  end
+
+  it 'should not store arguments and return value by default' do
+    class TestWorker
+      def self.do_work(s, i, a, h)
+        sleep 1
+        return "the zebra is loose"
+      end
+
+      class << self
+        include TraceViewMethodProfiling
+        # Default call method
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::TraceView::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    traces[1].has_key?("Args").must_equal false
+    traces[2].has_key?("ReturnValue").must_equal false
+  end
+
+  it 'should store arguments and return value when asked' do
+    class TestWorker
+      def self.do_work(s, i, a, h)
+        sleep 1
+        return "the zebra is loose"
+      end
+
+      class << self
+        include TraceViewMethodProfiling
+        profile_method :do_work, 'do_work', true, true
+      end
+    end
+
+    ::TraceView::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    traces[1].has_key?("Args").must_equal true
+    traces[1]["Args"].must_equal "\"String Argument\"\n203984\n[\"1\", \"2\", 3]\n{:color=>:black}\n"
+
+    traces[2].has_key?("ReturnValue").must_equal true
+    traces[2]["ReturnValue"].must_equal "\"the zebra is loose\"\n"
+  end
+end

data/test/servers/rackapp_8101.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+require 'rack/handler/puma'
+require 'traceview/inst/rack'
+
+TraceView.logger.info "[oboe/info] Starting background utility rack app on localhost:8101."
+
+Thread.new do
+  app = Rack::Builder.new {
+    use TraceView::Rack
+    run Proc.new { |env|
+      [200, {"Content-Type" => "text/html"}, ['Hello TraceView!']]
+    }
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 8101})
+end
+
+# Allow Thin to boot.
+sleep(2)
+

data/test/support/backcompat_test.rb

@@ -0,0 +1,269 @@
+require 'minitest_helper'
+
+describe "BackwardCompatibility" do
+
+  it 'should still respond to Oboe::Config' do
+    @verbose = Oboe::Config[:verbose]
+    @dalli_enabled = Oboe::Config[:dalli][:enabled]
+    @tm = Oboe::Config[:tracing_mode]
+    @sr = Oboe::Config[:sample_rate]
+
+    Oboe::Config[:verbose] = true
+    Oboe::Config[:verbose].must_equal true
+    Oboe::Config.verbose.must_equal true
+    TraceView::Config[:verbose].must_equal true
+    TraceView::Config.verbose.must_equal true
+
+    Oboe::Config[:dalli][:enabled] = false
+    Oboe::Config[:dalli][:enabled].must_equal false
+    TraceView::Config[:dalli][:enabled].must_equal false
+
+    Oboe::Config[:sample_rate] = 8e5
+    Oboe::Config.sample_rate.must_equal 8e5
+    TraceView::Config.sample_rate.must_equal 8e5
+
+    Oboe::Config[:tracing_mode] = 'always'
+    Oboe::Config.tracing_mode.must_equal 'always'
+    TraceView::Config.tracing_mode.must_equal 'always'
+
+    Oboe::Config[:sample_rate] = @sr
+    Oboe::Config[:tracing_mode] = @tm
+    Oboe::Config[:dalli][:enabled] = @dalli_enabled
+    Oboe::Config[:verbose] = @verbose
+  end
+
+  it 'should still support Oboe::API.log calls' do
+    clear_all_traces
+
+    Oboe::API.log_start('rack', nil, {})
+    Oboe::API.log_end('rack')
+
+    traces = get_all_traces
+    traces.count.must_equal 2
+  end
+
+  it 'should still support Oboe::API.trace calls' do
+    clear_all_traces
+
+    Oboe::API.start_trace('api_test', '', {}) do
+      sleep 1
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 2
+
+    validate_outer_layers(traces, 'api_test')
+  end
+
+  it 'should still support Oboe.profile'do
+    clear_all_traces
+
+    Oboe::API.start_trace('outer_profile_test') do
+      Oboe::API.profile('profile_test', {}, false) do
+        sleep 1
+      end
+   end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+  end
+
+  # Pasted in from test/profiling/method_test.rb
+  # Modified to use OboeMethodProfiling
+  describe "OboeMethodProfiling" do
+    before do
+      clear_all_traces
+      # Conditionally Undefine TestWorker
+      # http://stackoverflow.com/questions/11503558/how-to-undefine-class-in-ruby
+      Object.send(:remove_const, :TestWorker) if defined?(TestWorker)
+    end
+
+    it 'should be loaded, defined and ready' do
+      defined?(::OboeMethodProfiling).wont_match nil
+    end
+
+    it 'should trace Class methods' do
+      class TestWorker
+        def self.do_work
+          sleep 1
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Class"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should trace Instance methods' do
+      class TestWorker
+        def do_work
+          sleep 1
+        end
+
+        include OboeMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        tw = TestWorker.new
+        tw.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Class"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should trace Module class methods' do
+      module TestWorker
+        def self.do_work
+          sleep 1
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Module"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should not store arguments and return value by default' do
+      class TestWorker
+        def self.do_work(s, i, a, h)
+          sleep 1
+          return "the zebra is loose"
+        end
+
+        class << self
+          include OboeMethodProfiling
+          # Default call method
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      traces[1].has_key?("Args").must_equal false
+      traces[2].has_key?("ReturnValue").must_equal false
+    end
+
+    it 'should store arguments and return value when asked' do
+      class TestWorker
+        def self.do_work(s, i, a, h)
+          sleep 1
+          return "the zebra is loose"
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work', true, true
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      traces[1].has_key?("Args").must_equal true
+      traces[1]["Args"].must_equal "\"String Argument\"\n203984\n[\"1\", \"2\", 3]\n{:color=>:black}\n"
+
+      traces[2].has_key?("ReturnValue").must_equal true
+      traces[2]["ReturnValue"].must_equal "\"the zebra is loose\"\n"
+    end
+  end
+end