traceview 3.6.0 → 3.7.0

data/test/frameworks/rails5x_test.rb

@@ -0,0 +1,213 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+require "minitest_helper"
+
+if defined?(::Rails)
+
+  describe "Rails5x" do
+    before do
+      clear_all_traces
+      ENV['DBTYPE'] = "postgresql" unless ENV['DBTYPE']
+    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.header.key?('X-Trace').must_equal true
+      r.header['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]['Query'].must_equal "INSERT INTO \"widgets\" (\"name\", \"description\", \"created_at\", \"updated_at\") VALUES ($1, $2, $3, $4) RETURNING \"id\""
+      traces[3]['Name'].must_equal "SQL"
+      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 "postgresql"
+      traces[5]['Query'].must_equal "SELECT  \"widgets\".* FROM \"widgets\" WHERE \"widgets\".\"name\" = $1 ORDER BY \"widgets\".\"id\" ASC LIMIT $2"
+      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 "postgresql"
+      traces[7]['Query'].must_equal "DELETE FROM \"widgets\" WHERE \"widgets\".\"id\" = $1"
+      traces[7]['Name'].must_equal "SQL"
+      traces[7].key?('Backtrace').must_equal true
+      traces[7].key?('QueryArgs').must_equal true
+
+      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 mysql2 db calls" do
+      # Skip for JRuby since the java instrumentation
+      # handles DB instrumentation for JRuby
+      skip if defined?(JRUBY_VERSION) || ENV['DBTYPE'] != 'mysql2'
+
+      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
+      sql = traces[3]['Query'].gsub(/\d\d\d\d-\d\d-\d\d\s\d\d:\d\d:\d\d/, 'xxx')
+      sql.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[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"
+
+      # Replace the datestamps with xxx to make testing easier
+      sql = traces[7]['Query'].gsub /\d+/, 'xxx'
+      sql.must_equal "DELETE FROM `widgets` WHERE `widgets`.`id` = xxx"
+
+      traces[7]['Name'].must_equal "SQL"
+      traces[7].key?('Backtrace').must_equal true
+      traces[7].key?('QueryArgs').must_equal true
+
+      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 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.header.key?('X-Trace').must_equal true
+      r.header['X-Trace'].must_equal traces[4]['X-Trace']
+    end
+  end
+end

data/test/instrumentation/excon_test.rb

@@ -16,6 +16,9 @@ class ExconTest < Minitest::Test
     clear_all_traces
     get "/"
     xtrace = last_response['X-Trace']
+    # FIXME: This test passes inconsistently.  Investigate
+    # Rack response header management under JRUBY.
+    skip if defined?(JRUBY_VERSION)
     assert xtrace
     assert TraceView::XTrace.valid?(xtrace)
   end

data/test/instrumentation/sequel_mysql2_test.rb

@@ -5,11 +5,8 @@ require 'minitest_helper'
 
 if defined?(::Sequel) && !defined?(JRUBY_VERSION)
 
-  if ENV.key?('TRAVIS_MYSQL_PASS')
-    MYSQL2_DB = Sequel.connect("mysql2://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/travis_ci_test")
-  else
-    MYSQL2_DB = Sequel.connect('mysql2://root@127.0.0.1:3306/travis_ci_test')
-  end
+  TraceView::Test.set_mysql2_env
+  MYSQL2_DB = Sequel.connect(ENV['DATABASE_URL'])
 
   unless MYSQL2_DB.table_exists?(:items)
     MYSQL2_DB.create_table :items do

data/test/instrumentation/sequel_mysql_test.rb

@@ -5,11 +5,8 @@ require 'minitest_helper'
 
 if defined?(::Sequel) && !defined?(JRUBY_VERSION)
 
-  if ENV.key?('TRAVIS_MYSQL_PASS')
-    MYSQL_DB = Sequel.connect("mysql://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/travis_ci_test")
-  else
-    MYSQL_DB = Sequel.connect('mysql://root@127.0.0.1:3306/travis_ci_test')
-  end
+  TraceView::Test.set_mysql_env
+  MYSQL_DB = Sequel.connect(ENV['DATABASE_URL'])
 
   unless MYSQL_DB.table_exists?(:items)
     MYSQL_DB.create_table :items do

data/test/instrumentation/sequel_pg_test.rb

@@ -5,11 +5,8 @@ require 'minitest_helper'
 
 if defined?(::Sequel) && !defined?(JRUBY_VERSION)
 
-  if ENV.key?('TRAVIS_PSQL_PASS')
-    PG_DB = Sequel.connect("postgres://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test")
-  else
-    PG_DB = Sequel.connect('postgres://postgres@127.0.0.1:5432/travis_ci_test')
-  end
+  TraceView::Test.set_postgresql_env
+  PG_DB = Sequel.connect(ENV['DATABASE_URL'])
 
   unless PG_DB.table_exists?(:items)
     PG_DB.create_table :items do

data/test/minitest_helper.rb

@@ -7,7 +7,6 @@ require "minitest/spec"
 require "minitest/autorun"
 require "minitest/reporters"
 require "minitest/debugger" if ENV['DEBUG']
-require "sinatra"
 
 require "minitest/hell"
 class Minitest::Test
@@ -58,6 +57,9 @@ case File.basename(ENV['BUNDLE_GEMFILE'])
 when /delayed_job/
   require './test/servers/delayed_job'
 
+when /rails5/
+  require './test/servers/rails5x_8140'
+
 when /rails4/
   require './test/servers/rails4x_8140'
 
@@ -201,29 +203,31 @@ def layer_doesnt_have_key(traces, layer, key)
   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
+if (File.basename(ENV['BUNDLE_GEMFILE']) =~ /^frameworks/) == 0
+  require "sinatra"
+  ##
+  # 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
+  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
+    # 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)
+    def app
+      Rack::Lint.new(@app)
+    end
   end
 end

data/test/servers/delayed_job.rb

@@ -10,13 +10,9 @@ require File.expand_path(File.dirname(__FILE__) + '/../models/widget')
 TraceView.logger.level = Logger::DEBUG
 TraceView.logger.info "[traceview/info] Starting background utility rails app on localhost:8140."
 
-if ENV.key?('TRAVIS_PSQL_PASS')
-  DJ_DB_URL = "postgres://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
-else
-  DJ_DB_URL = 'postgres://postgres@127.0.0.1:5432/travis_ci_test'
-end
+TraceView::Test.set_postgresql_env
 
-ActiveRecord::Base.establish_connection(DJ_DB_URL)
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
 
 unless ActiveRecord::Base.connection.table_exists? :delayed_jobs
   TraceView.logger.info "[traceview/servers] Creating DelayedJob DB table."

data/test/servers/rails3x_8140.rb

@@ -23,10 +23,15 @@ require File.expand_path(File.dirname(__FILE__) + '/../models/widget')
 
 TraceView.logger.info "[traceview/info] Starting background utility rails app on localhost:8140."
 
-if ENV.key?('TRAVIS_PSQL_PASS')
-  ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
+# Set the database.  Default is postgresql.
+if ENV['DBTYPE'] == 'mysql2'
+  TraceView::Test.set_mysql2_env
+elsif ENV['DBTYPE'] == 'mysql'
+  TraceView::Test.set_mysql_env
 else
-  ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
+  TV.logger.warn "Unidentified DBTYPE: #{ENV['DBTYPE']}" unless ENV['DBTYPE'] == "postgresql"
+  TV.logger.debug "Defaulting to postgres DB for background Rails server."
+  TraceView::Test.set_postgresql_env
 end
 
 ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
@@ -75,9 +80,14 @@ class HelloController < ActionController::Base
   end
 
   def db
-    Widget.all.first
-    w = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
-    w.save
+    # Create a widget
+    w1 = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
+    w1.save
+
+    # query for that widget
+    w2 = Widget.where(:name => 'blah').first
+    w2.delete
+
     render :text => "Hello database!"
   end
 end

data/test/servers/rails4x_8140.rb

@@ -17,11 +17,6 @@
 # existing in any Rails 4 app. Here they are simply in one
 # file and without the comments.
 #
-if ENV.key?('TRAVIS_PSQL_PASS')
-  ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
-else
-  ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
-end
 
 require "rails/all"
 require "action_controller/railtie" # require more if needed
@@ -30,6 +25,17 @@ require File.expand_path(File.dirname(__FILE__) + '/../models/widget')
 
 TraceView.logger.info "[traceview/info] Starting background utility rails app on localhost:8140."
 
+# Set the database.  Default is postgresql.
+if ENV['DBTYPE'] == 'mysql2'
+  TraceView::Test.set_mysql2_env
+elsif ENV['DBTYPE'] == 'mysql'
+  TraceView::Test.set_mysql_env
+else
+  TV.logger.warn "Unidentified DBTYPE: #{ENV['DBTYPE']}" unless ENV['DBTYPE'] == "postgresql"
+  TV.logger.debug "Defaulting to postgres DB for background Rails server."
+  TraceView::Test.set_postgresql_env
+end
+
 ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
 
 unless ActiveRecord::Base.connection.table_exists? 'widgets'
@@ -76,9 +82,14 @@ class HelloController < ActionController::Base
   end
 
   def db
-    Widget.all.first
-    w = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
-    w.save
+    # Create a widget
+    w1 = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
+    w1.save
+
+    # query for that widget
+    w2 = Widget.where(:name => 'blah').first
+    w2.delete
+
     render :text => "Hello database!"
   end
 end
@@ -96,7 +107,7 @@ TraceView::API.profile_method(FerroController, :world)
 Rails40MetalStack.initialize!
 
 Thread.new do
-  Rack::Handler::Puma.run(Rails40MetalStack.to_app, {:Host => '127.0.0.1', :Port => 8140})
+  Rack::Handler::Puma.run(Rails40MetalStack.to_app, {:Host => '127.0.0.1', :Port => 8140, :Threads => "0:1"})
 end
 
 sleep(2)