appoptics_apm 4.0.2

data/test/support/dnt_test.rb

@@ -0,0 +1,98 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require 'rack/test'
+require 'rack/lobster'
+require 'appoptics_apm/inst/rack'
+
+class RackTestApp < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use AppOpticsAPM::Rack
+      map "/lobster" do
+        use Rack::Lint
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_custom_do_not_trace
+    clear_all_traces
+
+    dnt_original = AppOpticsAPM::Config[:dnt_regexp]
+    AppOpticsAPM::Config[:dnt_regexp] = "lobster$"
+
+    get "/lobster"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    AppOpticsAPM::Config[:dnt_regexp] = dnt_original
+  end
+
+  def test_do_not_trace_static_assets
+    clear_all_traces
+
+    get "/assets/static_asset.png"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    assert last_response.status == 404
+  end
+
+  def test_do_not_trace_static_assets_with_param
+    clear_all_traces
+
+    get "/assets/static_asset.png?body=1"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    assert last_response.status == 404
+  end
+
+  def test_do_not_trace_static_assets_with_multiple_params
+    clear_all_traces
+
+    get "/assets/static_asset.png?body=1&head=0"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    assert last_response.status == 404
+  end
+
+  def test_complex_do_not_trace
+    skip "not supported" if RUBY_VERSION < '1.9'
+
+    clear_all_traces
+
+    dnt_original = AppOpticsAPM::Config[:dnt_regexp]
+
+    # Do not trace .js files _except for_ show.js
+    AppOpticsAPM::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
+
+    # First: We shouldn't trace general .js files
+    get "/javascripts/application.js"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    # Second: We should trace show.js
+    clear_all_traces
+
+    get "/javascripts/show.js"
+
+    traces = get_all_traces
+    assert !traces.empty?
+
+    AppOpticsAPM::Config[:dnt_regexp] = dnt_original
+  end
+end
+

data/test/support/init_report_test.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class InitReportTest  < Minitest::Test
+  def test_report_format
+    init_kvs = ::AppOpticsAPM::Util.build_init_report
+    init_kvs.is_a?(Hash)
+  end
+
+  def test_report_kvs
+    init_kvs = ::AppOpticsAPM::Util.build_init_report
+    init_kvs.has_key?("__Init").must_equal true
+    init_kvs.has_key?("Force").must_equal true
+    init_kvs.has_key?("Ruby.AppContainer.Version").must_equal true
+    init_kvs["Ruby.AppOpticsAPM.Version"].must_equal AppOpticsAPM::Version::STRING
+    init_kvs["Ruby.TraceMode.Version"].must_equal AppOpticsAPM::Config[:tracing_mode]
+  end
+
+  def test_legacy_report_format
+    init_kvs = ::AppOpticsAPM::Util.legacy_build_init_report
+    init_kvs.is_a?(Hash)
+  end
+end

data/test/support/liboboe_settings_test.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'set'
+require 'minitest_helper'
+require 'rack/test'
+require 'rack/lobster'
+require 'appoptics_apm/inst/rack'
+
+unless defined?(JRUBY_VERSION)
+  AppOpticsAPM::Config[:tracing_mode] = 'always'
+  AppOpticsAPM::Config[:sample_rate] = 1e6
+
+  class RackTestApp < Minitest::Test
+    include Rack::Test::Methods
+
+    def app
+      @app = Rack::Builder.new {
+        use Rack::CommonLogger
+        use Rack::ShowExceptions
+        use AppOpticsAPM::Rack
+        map "/lobster" do
+          use Rack::Lint
+          run Rack::Lobster.new
+        end
+      }
+    end
+
+    def test_localset_sample_source
+      skip("FIXME: broken on travis only") if ENV['TRAVIS'] == "true"
+
+      # We make an initial call here which will force the appoptics_apm gem to retrieve
+      # the sample_rate and sample_source from liboboe (via sample? method)
+      get "/lobster"
+
+      clear_all_traces
+
+      get "/lobster"
+
+      traces = get_all_traces
+      traces.count.must_equal 3
+
+      validate_outer_layers(traces, 'rack')
+
+      kvs = {}
+      kvs["SampleRate"] = 1000000
+      kvs["SampleSource"] = OBOE_SAMPLE_RATE_SOURCE_FILE
+      validate_event_keys(traces[0], kvs)
+    end
+
+    # Test logging of all Ruby datatypes against the SWIG wrapper
+    # of addInfo which only has four overloads.
+    def test_swig_datatypes_conversion
+      event = AppOpticsAPM::Context.createEvent
+      report_kvs = {}
+
+      # Array
+      report_kvs[:TestData] = [0, 1, 2, 5, 7.0]
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Class
+      report_kvs[:TestData] = AppOpticsAPM::Reporter
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # FalseClass
+      report_kvs[:TestData] = false
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Fixnum
+      report_kvs[:TestData] = 1_873_293_293
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Float
+      report_kvs[:TestData] = 1.0001
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Hash
+      report_kvs[:TestData] = Hash.new
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Integer
+      report_kvs[:TestData] = 1
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Module
+      report_kvs[:TestData] = AppOpticsAPM
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # NilClass
+      report_kvs[:TestData] = nil
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Set
+      report_kvs[:TestData] = Set.new(1..10)
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # String
+      report_kvs[:TestData] = 'test value'
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # Symbol
+      report_kvs[:TestData] = :TestValue
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+
+      # TrueClass
+      report_kvs[:TestData] = true
+      AppOpticsAPM::API.log('test_layer', 'entry', report_kvs, event)
+    end
+  end
+end

data/test/support/logging_test.rb

@@ -0,0 +1,130 @@
+# Copyright (c) 2017 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require 'mocha/mini_test'
+
+describe AppOpticsAPM::API::Logging do
+  describe "when there is no xtrace" do
+    before do
+      AppOpticsAPM::Context.clear
+    end
+
+    it "log should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log(:test, 'test_label')
+    end
+
+    it "log_exception should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_exception(:test, StandardError.new('no worries - testing error'))
+    end
+
+    it "log_end should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_end(:test)
+    end
+
+    it "log_entry should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_entry(:test)
+    end
+
+    it "log_info should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_info(:test)
+    end
+
+    it "log_exit should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_exit(:test)
+    end
+
+    it "log_multi_exit should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_multi_exit(:test, [])
+    end
+  end
+
+  describe "when we are not sampling" do
+    before do
+      AppOpticsAPM::Context.fromString('2BA462ADE6CFE479081764CC476AA983351DC51B1BCB3468DA6F06EEFA00')
+    end
+
+    it "log should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log(:test, 'test_label')
+    end
+
+    it "log_exception should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_exception(:test, StandardError.new('no worries - testing error'))
+    end
+
+    it "log_end should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_end(:test)
+    end
+
+    it "log_entry should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_entry(:test)
+    end
+
+    it "log_info should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_info(:test)
+    end
+
+    it "log_exit should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_exit(:test)
+    end
+
+    it "log_multi_exit should not log an event" do
+      AppOpticsAPM::API.expects(:log_event).never
+      AppOpticsAPM::API.log_multi_exit(:test, [])
+    end
+  end
+
+  describe "when we are sampling" do
+    before do
+      AppOpticsAPM::Context.fromString('2BA462ADE6CFE479081764CC476AA983351DC51B1BCB3468DA6F06EEFA01')
+    end
+
+    it "log should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log(:test, 'test_label')
+    end
+
+    it "log_exception should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_exception(:test, StandardError.new('no worries - testing error'))
+    end
+
+    it "log_end should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_end(:test)
+    end
+
+    it "log_entry should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_entry(:test)
+    end
+
+    it "log_info should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_info(:test)
+    end
+
+    it "log_exit should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_exit(:test)
+    end
+
+    it "log_multi_exit should log an event" do
+      AppOpticsAPM::API.expects(:log_event)
+      AppOpticsAPM::API.log_multi_exit(:test, [])
+    end
+  end
+end

data/test/support/noop_test.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require 'rack/test'
+require 'rack/lobster'
+require 'appoptics_apm/inst/rack'
+require 'net/http'
+
+class NoopTest < Minitest::Test
+  include Rack::Test::Methods
+
+  class ArrayTest < Array; end
+
+  def setup
+    AppOpticsAPM.loaded = false
+  end
+
+  def teardown
+    AppOpticsAPM.loaded = true
+  end
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use AppOpticsAPM::Rack
+      map "/lobster" do
+        use Rack::Lint
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_requests_still_work
+    clear_all_traces
+
+    get "/lobster"
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"
+  end
+
+  def test_tracing_api_doesnt_barf
+    AppOpticsAPM::API.start_trace('noop_test')  do
+      AppOpticsAPM::API.trace('blah_block') do
+        "this block should not be traced"
+      end
+    end
+
+    AppOpticsAPM::API.log_start('noop_test')
+    AppOpticsAPM::API.log_info(nil, {:ok => :yeah })
+    AppOpticsAPM::API.log_exception(nil, Exception.new("yeah ok"))
+    AppOpticsAPM::API.log_end('noop_test')
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"
+  end
+
+  def test_method_profiling_doesnt_barf
+    AppOpticsAPM::API.profile_method(ArrayTest, :sort)
+
+    x = ArrayTest.new
+    x.push(1).push(3).push(2)
+    assert_equal [1, 2, 3], x.sort
+  end
+
+  def test_appoptics_config_doesnt_barf
+    tm = AppOpticsAPM::Config[:tracing_mode]
+    vb = AppOpticsAPM::Config[:verbose]
+    la = AppOpticsAPM::Config[:rack][:log_args]
+
+    # Test that we can set various things into AppOpticsAPM::Config still
+    AppOpticsAPM::Config[:tracing_mode] = :always
+    AppOpticsAPM::Config[:verbose] = false
+    AppOpticsAPM::Config[:rack][:log_args] = true
+
+    assert_equal :always, AppOpticsAPM::Config[:tracing_mode]
+    assert_equal false, AppOpticsAPM::Config[:verbose]
+    assert_equal true, AppOpticsAPM::Config[:rack][:log_args]
+
+    # Restore the originals
+    AppOpticsAPM::Config[:tracing_mode] = tm
+    AppOpticsAPM::Config[:verbose] = vb
+    AppOpticsAPM::Config[:rack][:log_args] = la
+  end
+end
+

data/test/support/sql_sanitize_test.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class SQLSanitizeTest < Minitest::Test
+  def test_sanitize_sql1
+    AppOpticsAPM::Config[:sanitize_sql] = true
+
+    sql = "INSERT INTO `queries` (`asdf_id`, `asdf_prices`, `created_at`, `updated_at`, `blue_pill`, `yearly_tax`, `rate`, `steam_id`, `red_pill`, `dimitri`, `origin`) VALUES (19231, 3, 'cat', 'dog', 111.0, 126.0, 116.0, 79.0, 72.0, 73.0, ?, 1, 3, 229.284, ?, ?, 100, ?, 0, 3, 1, ?, NULL, NULL, ?, 4, ?)"
+    result = AppOpticsAPM::Util.sanitize_sql(sql)
+    result.must_equal "INSERT INTO `queries` (`asdf_id`, `asdf_prices`, `created_at`, `updated_at`, `blue_pill`, `yearly_tax`, `rate`, `steam_id`, `red_pill`, `dimitri`, `origin`) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"
+
+    AppOpticsAPM::Config[:sanitize_sql] = false
+  end
+
+  def test_sanitize_sql2
+    AppOpticsAPM::Config[:sanitize_sql] = true
+
+    sql = "SELECT \"game_types\".* FROM \"game_types\" WHERE \"game_types\".\"game_id\" IN (1162)"
+    result = AppOpticsAPM::Util.sanitize_sql(sql)
+    result.must_equal "SELECT \"game_types\".* FROM \"game_types\" WHERE \"game_types\".\"game_id\" IN (?)"
+
+    AppOpticsAPM::Config[:sanitize_sql] = false
+  end
+
+  def test_sanitize_sql3
+    AppOpticsAPM::Config[:sanitize_sql] = true
+
+    sql = "SELECT \"comments\".* FROM \"comments\" WHERE \"comments\".\"commentable_id\" = 2798 AND \"comments\".\"commentable_type\" = 'Video' AND \"comments\".\"parent_id\" IS NULL ORDER BY comments.created_at DESC"
+    result = AppOpticsAPM::Util.sanitize_sql(sql)
+    result.must_equal "SELECT \"comments\".* FROM \"comments\" WHERE \"comments\".\"commentable_id\" = ? AND \"comments\".\"commentable_type\" = ? AND \"comments\".\"parent_id\" IS ? ORDER BY comments.created_at DESC"
+
+    AppOpticsAPM::Config[:sanitize_sql] = false
+  end
+
+  def test_sanitize_sql4
+    AppOpticsAPM::Config[:sanitize_sql] = true
+
+    sql = "SELECT `assets`.* FROM `assets` WHERE `assets`.`type` IN ('Picture') AND (updated_at >= '2015-07-08 19:22:00') AND (updated_at <= '2015-07-08 19:23:00') LIMIT 31 OFFSET 0"
+    result = AppOpticsAPM::Util.sanitize_sql(sql)
+    result.must_equal "SELECT `assets`.* FROM `assets` WHERE `assets`.`type` IN (?) AND (updated_at >= ?) AND (updated_at <= ?) LIMIT ? OFFSET ?"
+
+    AppOpticsAPM::Config[:sanitize_sql] = false
+  end
+
+  def test_dont_sanitize
+    AppOpticsAPM::Config[:sanitize_sql] = false
+
+    sql = "SELECT `assets`.* FROM `assets` WHERE `assets`.`type` IN ('Picture') AND (updated_at >= '2015-07-08 19:22:00') AND (updated_at <= '2015-07-08 19:23:00') LIMIT 31 OFFSET 0"
+    result = AppOpticsAPM::Util.sanitize_sql(sql)
+    result.must_equal "SELECT `assets`.* FROM `assets` WHERE `assets`.`type` IN ('Picture') AND (updated_at >= '2015-07-08 19:22:00') AND (updated_at <= '2015-07-08 19:23:00') LIMIT 31 OFFSET 0"
+  end
+end
+

data/test/support/tracing_mode_test.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class TracingModeTest  < Minitest::Test
+  def setup
+    @tm = AppOpticsAPM::Config[:tracing_mode]
+    AppOpticsAPM::Config[:tracing_mode] = :always
+  end
+
+  def teardown
+    AppOpticsAPM::Config[:tracing_mode] = @tm
+  end
+
+  def test_trace_when_always
+    AppOpticsAPM::API.start_trace(:test_always) do
+      AppOpticsAPM.tracing?.must_equal true
+    end
+  end
+
+  def test_dont_trace_when_never
+    AppOpticsAPM::Config[:tracing_mode] = :never
+
+    AppOpticsAPM::API.start_trace(:test_never) do
+      AppOpticsAPM.tracing?.must_equal false
+    end
+
+    AppOpticsAPM::API.start_trace('asdf') do
+      AppOpticsAPM.tracing?.must_equal false
+    end
+  end
+end

data/test/support/tvalias_test.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class APPOPTICSAliasTest < Minitest::Test
+
+  def test_responds_various_capitalization
+    defined?(::AppOpticsAPM).must_equal "constant"
+    defined?(::AppOpticsAPM).must_equal "constant"
+
+    AppOpticsAPM.methods.count.must_equal AppOpticsAPM.methods.count
+  end
+end
+

data/test/support/xtrace_test.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+describe "XTrace" do
+
+  it 'should correctly validate X-Trace IDs' do
+    # Invalid X-Trace IDs
+    AppOpticsAPM::XTrace.valid?("").must_equal false
+    AppOpticsAPM::XTrace.valid?(nil).must_equal false
+    AppOpticsAPM::XTrace.valid?("2B00000000000000000000000000000000000000000000000000000000").must_equal false
+    AppOpticsAPM::XTrace.valid?("2b").must_equal false
+    AppOpticsAPM::XTrace.valid?("29348209348").must_equal false
+
+    # Legacy X-Trace IDs are not valid anymore
+    AppOpticsAPM::XTrace.valid?("1B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F").must_equal false
+
+    # Standard X-Trace IDs
+    AppOpticsAPM::XTrace.valid?("2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00").must_equal true
+    AppOpticsAPM::XTrace.valid?("2BA462ADE6CFE479081764CC476AA983351DC51B1BCB3468DA6F06EEFA01").must_equal true
+    AppOpticsAPM::XTrace.valid?("2BADFDFB3DBA36323B2E0975925D0DAE12D10BA5946809504DC4B81FF601").must_equal true
+
+    # X-Trace IDs with lower-case alpha chars
+    AppOpticsAPM::XTrace.valid?("2bf9861cb12e2a257247a8195654e56d30b2f4e2d4fce67c321ad5849500").must_equal true
+    AppOpticsAPM::XTrace.valid?("2b258b2c1d6914f3c6085cb72e7cc93e145b401d4356aa24ef7294b2d600").must_equal true
+  end
+
+  it 'should correctly extract task IDs from X-Trace IDs' do
+    task_id = AppOpticsAPM::XTrace.task_id("2BF86B3D3342FCECAECE33C6411379BB171505DB6A136DFAEBDF74236200")
+    task_id.is_a?(String).must_equal true
+    task_id.must_equal "F86B3D3342FCECAECE33C6411379BB171505DB6A"
+    task_id.length.must_equal 40
+
+    task_id = AppOpticsAPM::XTrace.task_id("2B77970F82332EE22FF04C249FCBA8F63E8AFA2C6730E209453259B2D601")
+    task_id.is_a?(String).must_equal true
+    task_id.must_equal "77970F82332EE22FF04C249FCBA8F63E8AFA2C67"
+    task_id.length.must_equal 40
+  end
+
+end