appoptics_apm 4.0.2

data/test/frameworks/rails4x_test.rb

@@ -0,0 +1,570 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require "minitest_helper"
+
+if defined?(::Rails)
+
+  describe "Rails4x" do
+    before do
+      clear_all_traces
+      AppOpticsAPM.config_lock.synchronize {
+        @tm = AppOpticsAPM::Config[:tracing_mode]
+        @collect_backtraces = AppOpticsAPM::Config[:action_controller][:collect_backtraces]
+        @sample_rate = AppOpticsAPM::Config[:sample_rate]
+        @sanitize_sql = AppOpticsAPM::Config[:sanitize_sql]
+      }
+      ENV['DBTYPE'] = "postgresql" unless ENV['DBTYPE']
+    end
+
+    after do
+      AppOpticsAPM.config_lock.synchronize {
+        AppOpticsAPM::Config[:action_controller][:collect_backtraces] = @collect_backtraces
+        AppOpticsAPM::Config[:tracing_mode] = @tm
+        AppOpticsAPM::Config[:sample_rate] = @sample_rate
+        AppOpticsAPM::Config[:sanitize_sql] = @sanitize_sql
+      }
+    end
+
+    it "should trace a request to a rails stack" do
+
+      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 7
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+      traces[2]['Controller'].must_equal "HelloController"
+      traces[2]['Action'].must_equal "world"
+
+      traces[3]['Layer'].must_equal "actionview"
+      traces[3]['Label'].must_equal "entry"
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "rails"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rack"
+      traces[6]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[6]['X-Trace']
+    end
+
+    it "should trace rails postgres db calls" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != 'postgresql'
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/db')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 13
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rack')
+
+      traces[3]['Layer'].must_equal "activerecord"
+      traces[3]['Label'].must_equal "entry"
+      traces[3]['Flavor'].must_equal "postgresql"
+      traces[3]['Name'].must_equal "SQL"
+      traces[3].key?('Backtrace').must_equal true
+
+      # Use a regular expression to test the SQL string since field order varies between
+      # Rails versions
+      match_data = traces[3]['Query']
+      match_data.must_equal("INSERT INTO \"widgets\" (\"name\", \"description\", \"created_at\", \"updated_at\") VALUES ($?, $?, $?, $?) RETURNING \"id\"")
+
+      traces[4]['Layer'].must_equal "activerecord"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "activerecord"
+      traces[5]['Label'].must_equal "entry"
+      traces[5]['Flavor'].must_equal "postgresql"
+
+      # Some versions of rails adds in another space before the ORDER keyword.
+      # Make 2 or more consecutive spaces just 1
+      sql = traces[5]['Query'].gsub(/\s{2,}/, ' ')
+      sql.must_equal "SELECT \"widgets\".* FROM \"widgets\" WHERE \"widgets\".\"name\" = $? ORDER BY \"widgets\".\"id\" ASC LIMIT ?"
+
+      traces[5]['Name'].must_equal "Widget Load"
+      traces[5].key?('Backtrace').must_equal true
+      traces[5].key?('QueryArgs').must_equal false
+
+      traces[6]['Layer'].must_equal "activerecord"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "activerecord"
+      traces[7]['Label'].must_equal "entry"
+      traces[7]['Flavor'].must_equal "postgresql"
+      traces[7]['Query'].must_equal "DELETE FROM \"widgets\" WHERE \"widgets\".\"id\" = $?"
+      traces[7]['Name'].must_equal "SQL"
+      traces[7].key?('Backtrace').must_equal true
+      traces[7].key?('QueryArgs').must_equal false
+
+      traces[8]['Layer'].must_equal "activerecord"
+      traces[8]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r.header.key?('X-Trace').must_equal true
+      r.header['X-Trace'].must_equal traces[12]['X-Trace']
+    end
+
+    it "should trace rails mysql db calls" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != "mysql"
+
+      AppOpticsAPM::Config[:sanitize_sql] = false
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/db')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 17
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rack')
+
+      traces[3]['Layer'].must_equal "activerecord"
+      traces[3]['Label'].must_equal "entry"
+      traces[3]['Flavor'].must_equal "mysql"
+      traces[3]['Query'].must_equal "BEGIN"
+      traces[3].key?('Backtrace').must_equal true
+
+      traces[4]['Layer'].must_equal "activerecord"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "activerecord"
+      traces[5]['Label'].must_equal "entry"
+      traces[5]['Flavor'].must_equal "mysql"
+      traces[5]['Query'].must_equal "INSERT INTO `widgets` (`name`, `description`, `created_at`, `updated_at`) VALUES (?, ?, ?, ?)"
+      traces[5]['Name'].must_equal "SQL"
+      traces[5].key?('Backtrace').must_equal true
+      traces[5].key?('QueryArgs').must_equal true
+
+      traces[6]['Layer'].must_equal "activerecord"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "activerecord"
+      traces[7]['Label'].must_equal "entry"
+      traces[7]['Flavor'].must_equal "mysql"
+      traces[7]['Query'].must_equal "COMMIT"
+      traces[7].key?('Backtrace').must_equal true
+
+      traces[8]['Layer'].must_equal "activerecord"
+      traces[8]['Label'].must_equal "exit"
+
+      traces[9]['Layer'].must_equal "activerecord"
+      traces[9]['Label'].must_equal "entry"
+      traces[9]['Flavor'].must_equal "mysql"
+      traces[9]['Name'].must_equal "Widget Load"
+      traces[9].key?('Backtrace').must_equal true
+
+      # Some versions of rails adds in another space before the ORDER keyword.
+      # Make 2 or more consecutive spaces just 1
+      sql = traces[9]['Query'].gsub(/\s{2,}/, ' ')
+      sql.must_equal "SELECT `widgets`.* FROM `widgets` WHERE `widgets`.`name` = ? ORDER BY `widgets`.`id` ASC LIMIT 1"
+
+      traces[10]['Layer'].must_equal "activerecord"
+      traces[10]['Label'].must_equal "exit"
+
+      traces[11]['Layer'].must_equal "activerecord"
+      traces[11]['Label'].must_equal "entry"
+      traces[11]['Flavor'].must_equal "mysql"
+      traces[11]['Name'].must_equal "SQL"
+      traces[11].key?('Backtrace').must_equal true
+      traces[11].key?('QueryArgs').must_equal true
+      traces[11]['Query'].must_equal "DELETE FROM `widgets` WHERE `widgets`.`id` = ?"
+
+      traces[12]['Layer'].must_equal "activerecord"
+      traces[12]['Label'].must_equal "exit"
+
+      traces[13]['Layer'].must_equal "actionview"
+      traces[13]['Label'].must_equal "entry"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[16]['X-Trace']
+    end
+
+    it "should trace rails mysql db calls with sanitize sql" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != "mysql"
+
+      AppOpticsAPM::Config[:sanitize_sql] = true
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/db')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 17
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rack')
+
+      traces[3]['Layer'].must_equal "activerecord"
+      traces[3]['Label'].must_equal "entry"
+      traces[3]['Flavor'].must_equal "mysql"
+      traces[3]['Query'].must_equal "BEGIN"
+      traces[3].key?('Backtrace').must_equal true
+
+      traces[4]['Layer'].must_equal "activerecord"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "activerecord"
+      traces[5]['Label'].must_equal "entry"
+      traces[5]['Flavor'].must_equal "mysql"
+      traces[5]['Query'].must_equal "INSERT INTO `widgets` (`name`, `description`, `created_at`, `updated_at`) VALUES (?, ?, ?, ?)"
+      traces[5]['Name'].must_equal "SQL"
+      traces[5].key?('Backtrace').must_equal true
+      traces[5].key?('QueryArgs').must_equal false
+
+      traces[6]['Layer'].must_equal "activerecord"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "activerecord"
+      traces[7]['Label'].must_equal "entry"
+      traces[7]['Flavor'].must_equal "mysql"
+      traces[7]['Query'].must_equal "COMMIT"
+      traces[7].key?('Backtrace').must_equal true
+
+      traces[8]['Layer'].must_equal "activerecord"
+      traces[8]['Label'].must_equal "exit"
+
+      traces[9]['Layer'].must_equal "activerecord"
+      traces[9]['Label'].must_equal "entry"
+      traces[9]['Flavor'].must_equal "mysql"
+      traces[9]['Name'].must_equal "Widget Load"
+      traces[9].key?('Backtrace').must_equal true
+
+      # Some versions of rails adds in another space before the ORDER keyword.
+      # Make 2 or more consecutive spaces just 1
+      sql = traces[9]['Query'].gsub(/\s{2,}/, ' ')
+      sql.must_equal "SELECT `widgets`.* FROM `widgets` WHERE `widgets`.`name` = ? ORDER BY `widgets`.`id` ASC LIMIT ?"
+
+      traces[10]['Layer'].must_equal "activerecord"
+      traces[10]['Label'].must_equal "exit"
+
+      traces[11]['Layer'].must_equal "activerecord"
+      traces[11]['Label'].must_equal "entry"
+      traces[11]['Flavor'].must_equal "mysql"
+      traces[11]['Name'].must_equal "SQL"
+      traces[11].key?('Backtrace').must_equal true
+      traces[11].key?('QueryArgs').must_equal false
+      traces[11]['Query'].must_equal "DELETE FROM `widgets` WHERE `widgets`.`id` = ?"
+
+      traces[12]['Layer'].must_equal "activerecord"
+      traces[12]['Label'].must_equal "exit"
+
+      traces[13]['Layer'].must_equal "actionview"
+      traces[13]['Label'].must_equal "entry"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[16]['X-Trace']
+    end
+
+    it "should trace rails mysql2 db calls" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != "mysql2"
+
+      AppOpticsAPM::Config[:sanitize_sql] = false
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/db')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 13
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rack')
+
+      traces[3]['Layer'].must_equal "activerecord"
+      traces[3]['Label'].must_equal "entry"
+      traces[3]['Flavor'].must_equal "mysql"
+
+      # Replace the datestamps with xxx to make testing easier
+      traces[3]['Query'].gsub!(/\d\d\d\d-\d\d-\d\d\s\d\d:\d\d:\d\d/, 'xxx')
+      traces[3]['Query'].must_equal "INSERT INTO `widgets` (`name`, `description`, `created_at`, `updated_at`) VALUES ('blah', 'This is an amazing widget.', 'xxx', 'xxx')"
+
+      traces[3]['Name'].must_equal "SQL"
+      traces[3].key?('Backtrace').must_equal true
+      traces[3].key?('QueryArgs').must_equal true
+
+      traces[4]['Layer'].must_equal "activerecord"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "activerecord"
+      traces[5]['Label'].must_equal "entry"
+      traces[5]['Flavor'].must_equal "mysql"
+      traces[5]['Query'].must_equal "SELECT  `widgets`.* FROM `widgets` WHERE `widgets`.`name` = 'blah'  ORDER BY `widgets`.`id` ASC LIMIT 1"
+      traces[5]['Name'].must_equal "Widget Load"
+      traces[5].key?('Backtrace').must_equal true
+      traces[5].key?('QueryArgs').must_equal true
+
+      traces[6]['Layer'].must_equal "activerecord"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "activerecord"
+      traces[7]['Label'].must_equal "entry"
+      traces[7]['Flavor'].must_equal "mysql"
+      traces[7]['Name'].must_equal "SQL"
+      traces[7].key?('Backtrace').must_equal true
+
+      sql = traces[7]['Query'].gsub(/\d+/, 'xxx')
+      sql.must_equal "DELETE FROM `widgets` WHERE `widgets`.`id` = xxx"
+
+      traces[8]['Layer'].must_equal "activerecord"
+      traces[8]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[12]['X-Trace']
+    end
+
+    it "should trace rails mysql2 db calls with santize sql" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != "mysql2"
+
+      AppOpticsAPM::Config[:sanitize_sql] = true
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/db')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 13
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rack')
+
+      traces[3]['Layer'].must_equal "activerecord"
+      traces[3]['Label'].must_equal "entry"
+      traces[3]['Flavor'].must_equal "mysql"
+
+      # Replace the datestamps with xxx to make testing easier
+      traces[3]['Query'].must_equal "INSERT INTO `widgets` (`name`, `description`, `created_at`, `updated_at`) VALUES (?, ?, ?, ?)"
+
+      traces[3]['Name'].must_equal "SQL"
+      traces[3].key?('Backtrace').must_equal true
+      traces[3].key?('QueryArgs').must_equal false
+
+      traces[4]['Layer'].must_equal "activerecord"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "activerecord"
+      traces[5]['Label'].must_equal "entry"
+      traces[5]['Flavor'].must_equal "mysql"
+      traces[5]['Query'].must_equal "SELECT  `widgets`.* FROM `widgets` WHERE `widgets`.`name` = ?  ORDER BY `widgets`.`id` ASC LIMIT ?"
+      traces[5]['Name'].must_equal "Widget Load"
+      traces[5].key?('Backtrace').must_equal true
+      traces[5].key?('QueryArgs').must_equal false
+
+      traces[6]['Layer'].must_equal "activerecord"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "activerecord"
+      traces[7]['Label'].must_equal "entry"
+      traces[7]['Flavor'].must_equal "mysql"
+      traces[7]['Name'].must_equal "SQL"
+      traces[7].key?('Backtrace').must_equal true
+
+      traces[7]['Query'].must_equal "DELETE FROM `widgets` WHERE `widgets`.`id` = ?"
+
+      traces[8]['Layer'].must_equal "activerecord"
+      traces[8]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[12]['X-Trace']
+    end
+
+    it "should trace a request to a rails metal stack" do
+      uri = URI.parse('http://127.0.0.1:8140/hello/metal')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 5
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/metal"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Label'].must_equal "profile_entry"
+      traces[2]['Language'].must_equal "ruby"
+      traces[2]['ProfileName'].must_equal "world"
+      traces[2]['MethodName'].must_equal "world"
+      traces[2]['Class'].must_equal "FerroController"
+      traces[2]['Controller'].must_equal "FerroController"
+      traces[2]['Action'].must_equal "world"
+
+      traces[3]['Label'].must_equal "profile_exit"
+      traces[3]['Language'].must_equal "ruby"
+      traces[3]['ProfileName'].must_equal "world"
+
+      traces[4]['Layer'].must_equal "rack"
+      traces[4]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[4]['X-Trace']
+    end
+
+    it "should collect backtraces when true" do
+      AppOpticsAPM::Config[:action_controller][:collect_backtraces] = true
+
+      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 7
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+      traces[2]['Controller'].must_equal "HelloController"
+      traces[2]['Action'].must_equal "world"
+      traces[2].key?('Backtrace').must_equal true
+
+      traces[3]['Layer'].must_equal "actionview"
+      traces[3]['Label'].must_equal "entry"
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "rails"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rack"
+      traces[6]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[6]['X-Trace']
+    end
+
+    it "should NOT collect backtraces when false" do
+      AppOpticsAPM::Config[:action_controller][:collect_backtraces] = false
+
+      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 7
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+      traces[2]['Controller'].must_equal "HelloController"
+      traces[2]['Action'].must_equal "world"
+      traces[2].key?('Backtrace').must_equal false
+
+      traces[3]['Layer'].must_equal "actionview"
+      traces[3]['Label'].must_equal "entry"
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "rails"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rack"
+      traces[6]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[6]['X-Trace']
+    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['X-Trace'].must_be_nil
+
+      traces = get_all_traces
+      traces.count.must_equal 0
+    end
+
+    require_relative "rails_shared_tests"
+  end
+end