appoptics_apm 4.0.2

data/test/frameworks/rails_shared_tests.rb

@@ -0,0 +1,172 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require "minitest_helper"
+require 'mocha/mini_test'
+
+
+  describe "RailsSharedTests" do
+    before do
+      clear_all_traces
+      AppOpticsAPM.config_lock.synchronize {
+        @tm = AppOpticsAPM::Config[:tracing_mode]
+        @sample_rate = AppOpticsAPM::Config[:sample_rate]
+      }
+    end
+
+    after do
+      AppOpticsAPM.config_lock.synchronize {
+        AppOpticsAPM::Config[:tracing_mode] = @tm
+        AppOpticsAPM::Config[:sample_rate] = @sample_rate
+      }
+    end
+
+    it "should NOT trace when tracing is set to :never" do
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:tracing_mode] = :never
+        uri = URI.parse('http://127.0.0.1:8140/hello/world')
+        r = Net::HTTP.get_response(uri)
+
+        traces = get_all_traces
+        traces.count.must_equal 0
+      end
+    end
+
+    it "should NOT trace when sample_rate is 0" do
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:sample_rate] = 0
+        uri = URI.parse('http://127.0.0.1:8140/hello/world')
+        r = Net::HTTP.get_response(uri)
+
+        traces = get_all_traces
+        traces.count.must_equal 0
+      end
+    end
+
+    it "should NOT trace when there is no context" do
+      response_headers = HelloController.action("world").call(
+          "REQUEST_METHOD" => "GET",
+          "rack.input" => -> {}
+      )[1]
+
+      response_headers.key?('X-Trace').must_equal false
+
+      traces = get_all_traces
+      traces.count.must_equal 0
+    end
+
+    it "should send inbound metrics" do
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+
+      AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+        test_action = action
+        test_url = url
+        test_status = status
+        test_method = method
+        test_error = error
+      end.once
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/world')
+      Net::HTTP.get_response(uri)
+
+      assert_equal "HelloController.world", test_action
+      assert_equal "http://127.0.0.1:8140/hello/world", test_url
+      assert_equal 200, test_status
+      assert_equal "GET", test_method
+      assert_equal 0, test_error
+
+      assert_controller_action(test_action)
+    end
+
+    it "should send inbound metrics when not tracing" do
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+      AppOpticsAPM.config_lock.synchronize do
+        AppOpticsAPM::Config[:tracing_mode] = :never
+        AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+          test_action = action
+          test_url = url
+          test_status = status
+          test_method = method
+          test_error = error
+        end.once
+
+        uri = URI.parse('http://127.0.0.1:8140/hello/world')
+        Net::HTTP.get_response(uri)
+      end
+
+      assert_equal "HelloController.world", test_action
+      assert_equal "http://127.0.0.1:8140/hello/world", test_url
+      assert_equal 200, test_status
+      assert_equal "GET", test_method
+      assert_equal 0, test_error
+    end
+
+    it "should send metrics for 500 errors" do
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+
+      AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+        test_action = action
+        test_url = url
+        test_status = status
+        test_method = method
+        test_error = error
+      end.once
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/servererror')
+      Net::HTTP.get_response(uri)
+
+      assert_equal "HelloController.servererror", test_action
+      assert_equal "http://127.0.0.1:8140/hello/servererror", test_url
+      assert_equal 500, test_status
+      assert_equal "GET", test_method
+      assert_equal 1, test_error
+
+      assert_controller_action(test_action)
+    end
+
+    it "should find the controller action for a route with a parameter" do
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+
+      AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+        test_action = action
+        test_url = url
+        test_status = status
+        test_method = method
+        test_error = error
+      end.once
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/15/show')
+      Net::HTTP.get_response(uri)
+
+      assert_equal "HelloController.show", test_action
+      assert_equal "http://127.0.0.1:8140/hello/15/show", test_url
+      assert_equal 200, test_status
+      assert_equal "GET", test_method
+      assert_equal 0, test_error
+
+      assert_controller_action(test_action)
+    end
+
+    it "should find controller action in the metal stack" do
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+
+      AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+        test_action = action
+        test_url = url
+        test_status = status
+        test_method = method
+        test_error = error
+      end.once
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/metal')
+      r = Net::HTTP.get_response(uri)
+
+      assert_equal 200, test_status
+      assert_equal "FerroController.world", test_action
+      assert_equal "http://127.0.0.1:8140/hello/metal", test_url
+      assert_equal "GET", test_method
+      assert_equal 0, test_error
+
+      assert_controller_action(test_action)
+    end
+  end

data/test/frameworks/sinatra_test.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+
+require "minitest_helper"
+require "mocha/mini_test"
+require File.expand_path(File.dirname(__FILE__) + '/apps/sinatra_simple')
+
+describe Sinatra do
+  before do
+    clear_all_traces
+  end
+
+  it "should trace a request to a simple sinatra stack" do
+    @app = SinatraSimple
+
+    r = get "/render"
+
+    traces = get_all_traces
+
+    traces.count.must_equal 9
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'rack')
+
+    traces[2]['Layer'].must_equal "sinatra"
+    traces[4]['Label'].must_equal "profile_entry"
+    traces[7]['Controller'].must_equal "SinatraSimple"
+    traces[8]['Label'].must_equal "exit"
+
+    # Validate the existence of the response header
+    r.headers.key?('X-Trace').must_equal true
+    r.headers['X-Trace'].must_equal traces[8]['X-Trace']
+  end
+
+  it "should not have RUM code in the response" do
+    @app = SinatraSimple
+
+    r = get "/render"
+
+    (r.body =~ /tly.js/).must_be_nil
+  end
+
+  it "should report the route with :id" do
+    @app = SinatraSimple
+    test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+    AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+      test_action = action
+      test_url = url
+      test_status = status
+      test_method = method
+      test_error = error
+    end.once
+
+    r = get "/render/123304952309747203947"
+
+    r.body.must_match /123304952309747203947/
+
+    assert_equal "SinatraSimple.GET /render/:id", test_action
+    assert_equal "http://example.org/render/123304952309747203947", test_url
+    assert_equal 200, test_status
+    assert_equal "GET", test_method
+    assert_equal 0, test_error
+
+    assert_controller_action(test_action)
+  end
+
+  it "should report the route with :id and more" do
+    @app = SinatraSimple
+    test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+    AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+      test_action = action
+      test_url = url
+      test_status = status
+      test_method = method
+      test_error = error
+    end.once
+
+    r = get "/render/123304952309747203947/what"
+
+    r.body.must_match /WOOT.*123304952309747203947/
+
+    assert_equal "SinatraSimple.GET /render/:id/what", test_action
+    assert_equal "http://example.org/render/123304952309747203947/what", test_url
+    assert_equal 200, test_status
+    assert_equal "GET", test_method
+    assert_equal 0, test_error
+
+    assert_controller_action(test_action)
+  end
+
+  it "should report the route with splats" do
+    @app = SinatraSimple
+    test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+    AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+      test_action = action
+      test_url = url
+      test_status = status
+      test_method = method
+      test_error = error
+    end.once
+
+    r = get "/say/hello/to/world"
+
+    r.body.must_match /hello world/
+
+    assert_equal "SinatraSimple.GET /say/*/to/*", test_action
+    assert_equal "http://example.org/say/hello/to/world", test_url
+    assert_equal 200, test_status
+    assert_equal "GET", test_method
+    assert_equal 0, test_error
+
+    assert_controller_action(test_action)
+  end
+
+  if RUBY_VERSION > '2.2'
+    it "should report the route with regex" do
+      @app = SinatraSimple
+      test_action, test_url, test_status, test_method, test_error = nil, nil, nil, nil, nil
+      AppOpticsAPM::Span.expects(:createHttpSpan).with do |action, url, _duration, status, method, error|
+        test_action = action
+        test_url = url
+        test_status = status
+        test_method = method
+        test_error = error
+      end.once
+
+      r = get "/hello/friend"
+
+      r.body.must_match /Hello, friend/
+
+      test_action.must_match  "SinatraSimple.GET \\/hello\\/([\\w]+)", test_action
+      assert_equal "http://example.org/hello/friend", test_url
+      assert_equal 200, test_status
+      assert_equal "GET", test_method
+      assert_equal 0, test_error
+
+      assert_controller_action(test_action)
+    end
+  end
+end

data/test/instrumentation/bunny_client_test.rb

@@ -0,0 +1,276 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+unless defined?(JRUBY_VERSION)
+  class BunnyClientTest < Minitest::Test
+    def setup
+      # Support specific environment variables to support remote rabbitmq servers
+      ENV['APPOPTICS_RABBITMQ_SERVER'] = "127.0.0.1"      unless ENV['APPOPTICS_RABBITMQ_SERVER']
+      ENV['APPOPTICS_RABBITMQ_PORT'] = "5672"             unless ENV['APPOPTICS_RABBITMQ_PORT']
+      ENV['APPOPTICS_RABBITMQ_USERNAME'] = "guest"        unless ENV['APPOPTICS_RABBITMQ_USERNAME']
+      ENV['APPOPTICS_RABBITMQ_PASSWORD'] = "guest"        unless ENV['APPOPTICS_RABBITMQ_PASSWORD']
+      ENV['APPOPTICS_RABBITMQ_VHOST'] = "/"               unless ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      @connection_params = {}
+      @connection_params[:host]   = ENV['APPOPTICS_RABBITMQ_SERVER']
+      @connection_params[:port]   = ENV['APPOPTICS_RABBITMQ_PORT']
+      @connection_params[:vhost]  = ENV['APPOPTICS_RABBITMQ_VHOST']
+      @connection_params[:user]   = ENV['APPOPTICS_RABBITMQ_USERNAME']
+      @connection_params[:pass]   = ENV['APPOPTICS_RABBITMQ_PASSWORD']
+
+      clear_all_traces
+    end
+
+    def test_publish_default_exchange
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @queue = @ch.queue("tv.ruby.test")
+      @exchange  = @ch.default_exchange
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        @exchange.publish("The Tortoise and the Hare", :routing_key => @queue.name)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, "bunny_tests")
+      assert valid_edges?(traces), "Invalid edge in traces"
+
+      traces[1]['Layer'].must_equal "rabbitmq-client"
+      traces[1]['Label'].must_equal "entry"
+      traces[2]['Layer'].must_equal "rabbitmq-client"
+      traces[2]['Label'].must_equal "exit"
+      traces[2]['Spec'].must_equal "pushq"
+      traces[2]['Flavor'].must_equal "rabbitmq"
+      traces[2]['ExchangeName'].must_equal "default"
+      traces[2]['RoutingKey'].must_equal "tv.ruby.test"
+      traces[2]['Op'].must_equal "publish"
+      traces[2]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      @conn.close
+    end
+
+    def test_publish_fanout_exchange
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @exchange = @ch.fanout("tv.ruby.fanout.tests")
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        @exchange.publish("The Tortoise and the Hare in the fanout exchange.", :routing_key => 'tv.ruby.test').publish("And another...")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 6
+
+      validate_outer_layers(traces, "bunny_tests")
+      assert valid_edges?(traces), "Invalid edge in traces"
+
+      traces[1]['Layer'].must_equal "rabbitmq-client"
+      traces[1]['Label'].must_equal "entry"
+      traces[2]['Layer'].must_equal "rabbitmq-client"
+      traces[2]['Label'].must_equal "exit"
+      traces[2]['Spec'].must_equal "pushq"
+      traces[2]['Flavor'].must_equal "rabbitmq"
+      traces[2]['ExchangeName'].must_equal "tv.ruby.fanout.tests"
+      traces[2]['RoutingKey'].must_equal "tv.ruby.test"
+      traces[2]['Op'].must_equal "publish"
+      traces[2]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      traces[3]['Layer'].must_equal "rabbitmq-client"
+      traces[3]['Label'].must_equal "entry"
+      traces[4]['Layer'].must_equal "rabbitmq-client"
+      traces[4]['Label'].must_equal "exit"
+      traces[4]['Spec'].must_equal "pushq"
+      traces[4]['Flavor'].must_equal "rabbitmq"
+      traces[4]['ExchangeName'].must_equal "tv.ruby.fanout.tests"
+      traces[4].key?('RoutingKey').must_equal false
+      traces[4]['Op'].must_equal "publish"
+      traces[4]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[4]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[4]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      @conn.close
+    end
+
+    def test_publish_topic_exchange
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @exchange = @ch.topic("tv.ruby.topic.tests", :auto_delete => true)
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        @exchange.publish("The Tortoise and the Hare in the topic exchange.", :routing_key => 'tv.ruby.test.1').publish("And another...", :routing_key => 'tv.ruby.test.2' )
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 6
+
+      validate_outer_layers(traces, "bunny_tests")
+      assert valid_edges?(traces), "Invalid edge in traces"
+
+      traces[1]['Layer'].must_equal "rabbitmq-client"
+      traces[1]['Label'].must_equal "entry"
+      traces[2]['Layer'].must_equal "rabbitmq-client"
+      traces[2]['Label'].must_equal "exit"
+      traces[2]['Spec'].must_equal "pushq"
+      traces[2]['Flavor'].must_equal "rabbitmq"
+      traces[2]['ExchangeName'].must_equal "tv.ruby.topic.tests"
+      traces[2]['RoutingKey'].must_equal "tv.ruby.test.1"
+      traces[2]['Op'].must_equal "publish"
+      traces[2]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      traces[3]['Layer'].must_equal "rabbitmq-client"
+      traces[3]['Label'].must_equal "entry"
+      traces[4]['Layer'].must_equal "rabbitmq-client"
+      traces[4]['Label'].must_equal "exit"
+      traces[4]['Spec'].must_equal "pushq"
+      traces[4]['Flavor'].must_equal "rabbitmq"
+      traces[4]['ExchangeName'].must_equal "tv.ruby.topic.tests"
+      traces[4]['RoutingKey'].must_equal "tv.ruby.test.2"
+      traces[4]['Op'].must_equal "publish"
+      traces[4]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[4]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[4]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      @conn.close
+    end
+
+    def test_publish_error_handling
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+
+      begin
+        AppOpticsAPM::API.start_trace('bunny_tests') do
+          @exchange = @ch.topic("tv.ruby.error.1", :auto_delete => true)
+          @exchange = @ch.fanout("tv.ruby.error.1", :auto_delete => true)
+          @exchange.publish("The Tortoise and the Hare in the topic exchange.", :routing_key => 'tv.ruby.test.1').publish("And another...", :routing_key => 'tv.ruby.test.2' )
+        end
+      rescue
+        # Capture intentional redeclaration error
+      end
+
+      traces = get_all_traces
+      assert_equal 3, traces.count
+
+      validate_outer_layers(traces, "bunny_tests")
+      assert valid_edges?(traces), "Invalid edge in traces"
+
+      traces[1]['Label'].must_equal "error"
+      traces[1]['ErrorClass'].must_equal "Bunny::PreconditionFailed"
+      traces[1]['ErrorMsg'].must_match(/PRECONDITION_FAILED/)
+      traces[1].key?('Backtrace').must_equal true
+
+      @conn.close
+    end
+
+    def test_delete_exchange
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @exchange = @ch.fanout("tv.delete_exchange.test")
+      @queue = @ch.queue("", :exclusive => true).bind(@exchange)
+
+      @ch.confirm_select
+      @exchange.publish("", :routing_key => 'tv.ruby.test')
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        @exchange.delete
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, "bunny_tests")
+
+      traces[2]['Spec'].must_equal "pushq"
+      traces[2]['Flavor'].must_equal "rabbitmq"
+      traces[2]['ExchangeName'].must_equal "tv.delete_exchange.test"
+      traces[2]['ExchangeType'].must_equal "fanout"
+      traces[2]['Op'].must_equal "delete"
+      traces[2]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+    end
+
+    def test_wait_for_confirms
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @exchange = @ch.fanout("tv.ruby.wait_for_confirm.tests")
+      @queue = @ch.queue("", :exclusive => true).bind(@exchange)
+
+      @ch.confirm_select
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        1000.times do
+          @exchange.publish("", :routing_key => 'tv.ruby.test')
+        end
+
+        @ch.wait_for_confirms
+      end
+
+      traces = get_all_traces
+      assert_equal 2004,traces.count
+
+      validate_outer_layers(traces, "bunny_tests")
+
+      traces[2000]['Spec'].must_equal "pushq"
+      traces[2000]['Flavor'].must_equal "rabbitmq"
+      traces[2000]['ExchangeName'].must_equal "tv.ruby.wait_for_confirm.tests"
+      traces[2000]['RoutingKey'].must_equal "tv.ruby.test"
+      traces[2000]['Op'].must_equal "publish"
+      traces[2000]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2000]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2000]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      traces[2001]['Layer'].must_equal "rabbitmq-client"
+      traces[2001]['Label'].must_equal "entry"
+      traces[2002]['Layer'].must_equal "rabbitmq-client"
+      traces[2002]['Label'].must_equal "exit"
+      traces[2002]['Spec'].must_equal "pushq"
+      traces[2002]['Flavor'].must_equal "rabbitmq"
+      traces[2002]['Op'].must_equal "wait_for_confirms"
+      traces[2002]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2002]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2002]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+
+      @conn.close
+    end
+
+    def test_channel_queue
+      @conn = Bunny.new(@connection_params)
+      @conn.start
+      @ch = @conn.create_channel
+      @exchange = @ch.fanout("tv.queue.test")
+
+      AppOpticsAPM::API.start_trace('bunny_tests') do
+        @queue = @ch.queue("blah", :exclusive => true).bind(@exchange)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, "bunny_tests")
+
+      traces[2]['Spec'].must_equal "pushq"
+      traces[2]['Flavor'].must_equal "rabbitmq"
+      traces[2]['Op'].must_equal "queue"
+      traces[2]['Queue'].must_equal "blah"
+      traces[2]['RemoteHost'].must_equal ENV['APPOPTICS_RABBITMQ_SERVER']
+      traces[2]['RemotePort'].must_equal ENV['APPOPTICS_RABBITMQ_PORT'].to_i
+      traces[2]['VirtualHost'].must_equal ENV['APPOPTICS_RABBITMQ_VHOST']
+    end
+  end
+end