appoptics_apm 4.0.2

data/test/mocked/rest_client_mocked_test.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+unless defined?(JRUBY_VERSION)
+  require 'minitest_helper'
+  require 'webmock/minitest'
+  require 'mocha/mini_test'
+  WebMock.allow_net_connect!
+
+  class RestClientMockedTest < Minitest::Test
+
+    def setup
+      WebMock.enable!
+      WebMock.disable_net_connect!
+      AppOpticsAPM.config_lock.synchronize do
+        @sample_rate = AppOpticsAPM::Config[:sample_rate]
+      end
+    end
+
+    def teardown
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = @sample_rate
+        AppOpticsAPM::Config[:blacklist] = []
+      end
+      WebMock.reset!
+      WebMock.allow_net_connect!
+      WebMock.disable!
+    end
+
+    def test_tracing_sampling
+      stub_request(:get, "http://127.0.0.1:8101/").to_return(status: 200, body: "", headers: {})
+
+      AppOpticsAPM::API.start_trace('rest_client_tests') do
+        RestClient::Resource.new('http://127.0.0.1:8101').get
+      end
+
+      assert_requested :get, "http://127.0.0.1:8101/", headers: {'X-Trace'=>/^2B[0-9,A-F]*01$/}, times: 1
+    end
+
+    def test_tracing_not_sampling
+      stub_request(:get, "http://127.0.0.2:8101/").to_return(status: 200, body: "", headers: {})
+
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::API.start_trace('rest_client_tests') do
+          RestClient::Resource.new('http://127.0.0.2:8101').get
+        end
+      end
+
+      assert_requested :get, "http://127.0.0.2:8101/", headers: {'X-Trace'=>/^2B[0-9,A-F]*00$/}, times: 1
+      assert_not_requested :get, "http://127.0.0.2:8101/", headers: {'X-Trace'=>/^2B0*$/}
+    end
+
+    def test_no_xtrace
+      stub_request(:get, "http://127.0.0.3:8101/").to_return(status: 200, body: "", headers: {})
+
+      RestClient::Resource.new('http://127.0.0.3:8101').get
+
+      assert_requested :get, "http://127.0.0.3:8101/", times: 1
+      assert_not_requested :get, "http://127.0.0.3:8101/", headers: {'X-Trace'=>/^.*$/}
+    end
+
+    def test_blacklisted
+      stub_request(:get, "http://127.0.0.4:8101/").to_return(status: 200, body: "", headers: {})
+
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config.blacklist << '127.0.0.4'
+        AppOpticsAPM::API.start_trace('rest_client_tests') do
+          RestClient::Resource.new('http://127.0.0.4:8101').get
+        end
+      end
+
+      assert_requested :get, "http://127.0.0.4:8101/", times: 1
+      assert_not_requested :get, "http://127.0.0.4:8101/", headers: {'X-Trace'=>/^.*$/}
+    end
+
+    def test_not_sampling_blacklisted
+      stub_request(:get, "http://127.0.0.5:8101/").to_return(status: 200, body: "", headers: {})
+
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::Config.blacklist << '127.0.0.5'
+        AppOpticsAPM::API.start_trace('rest_client_tests') do
+          RestClient::Resource.new('http://127.0.0.5:8101').get
+        end
+      end
+
+      assert_requested :get, "http://127.0.0.5:8101/", times: 1
+      assert_not_requested :get, "http://127.0.0.5:8101/", headers: {'X-Trace'=>/^.*$/}
+    end
+
+    def test_preserves_custom_headers
+      stub_request(:get, "http://127.0.0.6:8101/").to_return(status: 200, body: "", headers: {})
+
+      AppOpticsAPM::API.start_trace('rest_client_tests') do
+        RestClient::Resource.new('http://127.0.0.6:8101', headers: { 'Custom' => 'specialvalue' }).get
+      end
+
+      assert_requested :get, "http://127.0.0.6:8101/", headers: {'Custom'=>'specialvalue'}, times: 1
+    end
+
+  end
+end

data/test/mocked/typhoeus_mocked_test.rb

@@ -0,0 +1,192 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+unless defined?(JRUBY_VERSION)
+  require 'minitest_helper'
+  require 'mocha/mini_test'
+
+  class TyphoeusMockedTest < Minitest::Test
+
+    def setup
+      AppOpticsAPM.config_lock.synchronize do
+        @sample_rate = AppOpticsAPM::Config[:sample_rate]
+      end
+    end
+
+    def teardown
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = @sample_rate
+        AppOpticsAPM::Config[:blacklist] = []
+      end
+    end
+
+    ############# Typhoeus::Request ##############################################
+
+    def test_tracing_sampling
+      AppOpticsAPM::API.start_trace('typhoeus_tests') do
+        request = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+        request.run
+
+        assert request.options[:headers]['X-Trace']
+        assert_match /^2B[0-9,A-F]*01$/,request.options[:headers]['X-Trace']
+      end
+    end
+
+    def test_tracing_not_sampling
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          request = Typhoeus::Request.new("http://127.0.0.1:8101/", {:method=>:get})
+          request.run
+
+          assert request.options[:headers]['X-Trace']
+          assert_match /^2B[0-9,A-F]*00$/, request.options[:headers]['X-Trace']
+          refute_match /^2B0*$/, request.options[:headers]['X-Trace']
+        end
+      end
+    end
+
+    def test_no_xtrace
+      request = Typhoeus::Request.new("http://127.0.0.1:8101/", {:method=>:get})
+      request.run
+
+      refute request.options[:headers]['X-Trace']
+    end
+
+    def test_blacklisted
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config.blacklist << '127.0.0.1'
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          request = Typhoeus::Request.new("http://127.0.0.1:8101/", {:method=>:get})
+          request.run
+
+          refute request.options[:headers]['X-Trace']
+        end
+      end
+    end
+
+    def test_not_sampling_blacklisted
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::Config.blacklist << '127.0.0.1'
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          request = Typhoeus::Request.new("http://127.0.0.1:8101/", {:method=>:get})
+          request.run
+
+          refute request.options[:headers]['X-Trace']
+        end
+      end
+    end
+
+    def test_preserves_custom_headers
+      AppOpticsAPM::API.start_trace('typhoeus_tests') do
+        request = Typhoeus::Request.new('http://127.0.0.6:8101', headers: { 'Custom' => 'specialvalue' }, :method => :get)
+        request.run
+
+        assert request.options[:headers]['Custom']
+        assert_match /specialvalue/, request.options[:headers]['Custom']
+      end
+    end
+
+
+    ############# Typhoeus::Hydra ##############################################
+
+    def test_hydra_tracing_sampling
+      AppOpticsAPM::API.start_trace('typhoeus_tests') do
+        hydra = Typhoeus::Hydra.hydra
+        request_1 = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+        request_2 = Typhoeus::Request.new("http://127.0.0.2:8101/counting_sheep", {:method=>:get})
+        hydra.queue(request_1)
+        hydra.queue(request_2)
+        hydra.run
+
+        assert request_1.options[:headers]['X-Trace'], "There is an X-Trace header"
+        assert_match /^2B[0-9,A-F]*01$/, request_1.options[:headers]['X-Trace']
+        assert request_2.options[:headers]['X-Trace'], "There is an X-Trace header"
+        assert_match /^2B[0-9,A-F]*01$/, request_2.options[:headers]['X-Trace']
+      end
+    end
+
+    def test_hydra_tracing_not_sampling
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          hydra = Typhoeus::Hydra.hydra
+          request_1 = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+          request_2 = Typhoeus::Request.new("http://127.0.0.2:8101/counting_sheep", {:method=>:get})
+          hydra.queue(request_1)
+          hydra.queue(request_2)
+          hydra.run
+
+          assert request_1.options[:headers]['X-Trace'], "There is an X-Trace header"
+          assert_match /^2B[0-9,A-F]*00$/, request_1.options[:headers]['X-Trace']
+          refute_match /^2B0*$/, request_1.options[:headers]['X-Trace']
+          assert request_2.options[:headers]['X-Trace'], "There is an X-Trace header"
+          assert_match /^2B[0-9,A-F]*00$/, request_2.options[:headers]['X-Trace']
+          refute_match /^2B0*$/, request_2.options[:headers]['X-Trace']
+        end
+      end
+    end
+
+    def test_hydra_no_xtrace
+      hydra = Typhoeus::Hydra.hydra
+      request_1 = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+      request_2 = Typhoeus::Request.new("http://127.0.0.2:8101/counting_sheep", {:method=>:get})
+      hydra.queue(request_1)
+      hydra.queue(request_2)
+      hydra.run
+
+      refute request_1.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+      refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+    end
+
+    def test_hydra_blacklisted
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config.blacklist << '127.0.0.2'
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          hydra = Typhoeus::Hydra.hydra
+          request_1 = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+          request_2 = Typhoeus::Request.new("http://127.0.0.2:8101/counting_sheep", {:method=>:get})
+          hydra.queue(request_1)
+          hydra.queue(request_2)
+          hydra.run
+
+          refute request_1.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+          refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+        end
+      end
+    end
+
+    def test_hydra_not_sampling_blacklisted
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        AppOpticsAPM::Config.blacklist << '127.0.0.2'
+        AppOpticsAPM::API.start_trace('typhoeus_tests') do
+          hydra = Typhoeus::Hydra.hydra
+          request_1 = Typhoeus::Request.new("http://127.0.0.2:8101/", {:method=>:get})
+          request_2 = Typhoeus::Request.new("http://127.0.0.2:8101/counting_sheep", {:method=>:get})
+          hydra.queue(request_1)
+          hydra.queue(request_2)
+          hydra.run
+
+          refute request_1.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+          refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+        end
+      end
+    end
+
+
+    def test_hydra_preserves_custom_headers
+      AppOpticsAPM::API.start_trace('typhoeus_tests') do
+        hydra = Typhoeus::Hydra.hydra
+        request = Typhoeus::Request.new('http://127.0.0.6:8101', headers: { 'Custom' => 'specialvalue' }, :method => :get)
+        hydra.queue(request)
+        hydra.run
+
+        assert request.options[:headers]['Custom']
+        assert_match /specialvalue/, request.options[:headers]['Custom']
+      end
+    end
+
+  end
+end

data/test/models/widget.rb

@@ -0,0 +1,36 @@
+# Somehow the Padrino::Reloader v14 is detecting and loading
+# this file when it shouldn't.  Block it from loading for
+# Padrino for now.
+unless defined?(Padrino)
+  class Widget < ActiveRecord::Base
+    def do_work(*args)
+      Widget.first
+    end
+
+    def do_error(*args)
+      raise "FakeTestError"
+    end
+  end
+
+  if Rails.version >= '5.1'
+    class CreateWidgets < ActiveRecord::Migration[5.1]
+      def change
+        create_table :widgets do |t|
+          t.string :name
+          t.text :description
+          t.timestamps
+        end
+      end
+    end
+  else
+    class CreateWidgets < ActiveRecord::Migration
+      def change
+        create_table :widgets do |t|
+          t.string :name
+          t.text :description
+          t.timestamps
+        end
+      end
+    end
+  end
+end

data/test/profiling/legacy_method_profiling_test.rb

@@ -0,0 +1,201 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+describe "LegacyAppOpticsAPMMethodProfiling" 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?(::AppOpticsAPMMethodProfiling).wont_match nil
+  end
+
+  it 'should trace Class methods' do
+    class TestWorker
+      def self.do_work
+        sleep 1
+      end
+
+      class << self
+        include AppOpticsAPMMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::AppOpticsAPM::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 AppOpticsAPMMethodProfiling
+      profile_method :do_work, 'do_work'
+    end
+
+    ::AppOpticsAPM::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 AppOpticsAPMMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::AppOpticsAPM::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 AppOpticsAPMMethodProfiling
+        # Default call method
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::AppOpticsAPM::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 AppOpticsAPMMethodProfiling
+        profile_method :do_work, 'do_work', true, true
+      end
+    end
+
+    ::AppOpticsAPM::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