traceview 3.0.0

data/test/instrumentation/sequel_pg_test.rb

@@ -0,0 +1,330 @@
+require 'minitest_helper'
+
+unless 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
+
+  unless PG_DB.table_exists?(:items)
+    PG_DB.create_table :items do
+      primary_key :id
+      String :name
+      Float :price
+    end
+  end
+
+  describe "Sequel (postgres)" do
+    before do
+      clear_all_traces
+
+      # These are standard entry/exit KVs that are passed up with all sequel operations
+      @entry_kvs = {
+        'Layer' => 'sequel',
+        'Label' => 'entry',
+        'Database' => 'travis_ci_test',
+        'RemoteHost' => '127.0.0.1',
+        'RemotePort' => 5432 }
+
+      @exit_kvs = { 'Layer' => 'sequel', 'Label' => 'exit' }
+      @collect_backtraces = TraceView::Config[:sequel][:collect_backtraces]
+      @sanitize_sql = TraceView::Config[:sanitize_sql]
+    end
+
+    after do
+      TraceView::Config[:sequel][:collect_backtraces] = @collect_backtraces
+      TraceView::Config[:sanitize_sql] = @sanitize_sql
+    end
+
+    it 'Stock sequel should be loaded, defined and ready' do
+      defined?(::Sequel).wont_match nil
+    end
+
+    it 'sequel should have traceview methods defined' do
+      # Sequel::Database
+      ::Sequel::Database.method_defined?(:run_with_traceview).must_equal true
+
+      # Sequel::Dataset
+      ::Sequel::Dataset.method_defined?(:execute_with_traceview).must_equal true
+      ::Sequel::Dataset.method_defined?(:execute_ddl_with_traceview).must_equal true
+      ::Sequel::Dataset.method_defined?(:execute_dui_with_traceview).must_equal true
+      ::Sequel::Dataset.method_defined?(:execute_insert_with_traceview).must_equal true
+    end
+
+    it "should obey :collect_backtraces setting when true" do
+      TraceView::Config[:sequel][:collect_backtraces] = true
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.run('select 1')
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'sequel', 'Backtrace')
+    end
+
+    it "should obey :collect_backtraces setting when false" do
+      TraceView::Config[:sequel][:collect_backtraces] = false
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.run('select 1')
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'sequel', 'Backtrace')
+    end
+
+    it 'should trace PG_DB.run insert' do
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.run("insert into items (name, price) values ('blah', '12')")
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "insert into items (name, price) values ('blah', '12')"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace PG_DB.run select' do
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.run("select 1")
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "select 1"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace a dataset insert and count' do
+      items = PG_DB[:items]
+      # Preload the primary key to avoid breaking tests with the seemingly
+      # random lookup (random due to random test order)
+      PG_DB.primary_key(:items)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        items.insert(:name => 'abc', :price => 2.514)
+        items.count
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 6
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+
+      # SQL column/value order can vary between Ruby and gem versions
+      # Use must_include to test against one or the other
+      [
+       "INSERT INTO \"items\" (\"price\", \"name\") VALUES (2.514, 'abc') RETURNING \"id\"",
+       "INSERT INTO \"items\" (\"name\", \"price\") VALUES ('abc', 2.514) RETURNING \"id\""
+      ].must_include traces[1]['Query']
+
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      traces[2]['Layer'].must_equal "sequel"
+      traces[2]['Label'].must_equal "exit"
+      traces[3]['Query'].downcase.must_equal "select count(*) as \"count\" from \"items\" limit 1"
+      validate_event_keys(traces[4], @exit_kvs)
+    end
+
+    it 'should trace a dataset insert and obey query privacy' do
+      TraceView::Config[:sanitize_sql] = true
+      items = PG_DB[:items]
+      # Preload the primary key to avoid breaking tests with the seemingly
+      # random lookup (random due to random test order)
+      PG_DB.primary_key(:items)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        items.insert(:name => 'abc', :price => 2.514461383352462)
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+
+      # SQL column/value order can vary between Ruby and gem versions
+      # Use must_include to test against one or the other
+      [
+        "INSERT INTO \"items\" (\"price\", \"name\") VALUES (?, ?) RETURNING \"id\"",
+        "INSERT INTO \"items\" (\"name\", \"price\") VALUES (?, ?) RETURNING \"id\""
+      ].must_include traces[1]['Query']
+
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace a dataset filter' do
+      items = PG_DB[:items]
+      items.count
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        items.filter(:name => 'abc').all
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "SELECT * FROM \"items\" WHERE (\"name\" = 'abc')"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace create table' do
+      # Drop the table if it already exists
+      PG_DB.drop_table(:fake) if PG_DB.table_exists?(:fake)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.create_table :fake do
+          primary_key :id
+          String :name
+          Float :price
+        end
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "CREATE TABLE \"fake\" (\"id\" serial PRIMARY KEY, \"name\" text, \"price\" double precision)"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace add index' do
+      # Drop the table if it already exists
+      PG_DB.drop_table(:fake) if PG_DB.table_exists?(:fake)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        PG_DB.create_table :fake do
+          primary_key :id
+          String :name
+          Float :price
+        end
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "CREATE TABLE \"fake\" (\"id\" serial PRIMARY KEY, \"name\" text, \"price\" double precision)"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should capture and report exceptions' do
+      begin
+        TraceView::API.start_trace('sequel_test', '', {}) do
+          PG_DB.run("this is bad sql")
+        end
+      rescue
+        # Do nothing - we're testing exception logging
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 5
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "this is bad sql"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      traces[2]['Layer'].must_equal "sequel"
+      traces[2]['Label'].must_equal "error"
+      traces[2].has_key?('Backtrace').must_equal true
+      traces[2]['ErrorClass'].must_equal "Sequel::DatabaseError"
+      validate_event_keys(traces[3], @exit_kvs)
+    end
+
+    it 'should trace placeholder queries with bound vars' do
+      items = PG_DB[:items]
+      items.count
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        ds = items.where(:name=>:$n)
+        ds.call(:select, :n=>'abc')
+        ds.call(:delete, :n=>'cba')
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 6
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "SELECT * FROM \"items\" WHERE (\"name\" = $1)"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      traces[3]['Query'].must_equal "DELETE FROM \"items\" WHERE (\"name\" = $1)"
+      traces[3].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace prepared statements' do
+      ds = PG_DB[:items].filter(:name=>:$n)
+      ps = ds.prepare(:select, :select_by_name)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        ps.call(:n=>'abc')
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "select_by_name"
+      if RUBY_VERSION < "1.9"
+        traces[1]['QueryArgs'].must_equal "abc"
+      else
+        traces[1]['QueryArgs'].must_equal "[\"abc\"]"
+      end
+      traces[1]['IsPreparedStatement'].must_equal "true"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
+    it 'should trace prep\'d stmnts and obey query privacy' do
+      TraceView::Config[:sanitize_sql] = true
+      ds = PG_DB[:items].filter(:name=>:$n)
+      ps = ds.prepare(:select, :select_by_name)
+
+      TraceView::API.start_trace('sequel_test', '', {}) do
+        ps.call(:n=>'abc')
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'sequel_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['Query'].must_equal "select_by_name"
+      traces[1]['QueryArgs'].must_equal nil
+      traces[1]['IsPreparedStatement'].must_equal "true"
+      traces[1].has_key?('Backtrace').must_equal TraceView::Config[:sequel][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+  end
+end

data/test/instrumentation/typhoeus_test.rb

@@ -0,0 +1,285 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+require 'minitest_helper'
+require 'rack'
+
+describe "Typhoeus" do
+  before do
+    clear_all_traces
+    @collect_backtraces = TraceView::Config[:typhoeus][:collect_backtraces]
+    @log_args = TraceView::Config[:typhoeus][:log_args]
+  end
+
+  after do
+    TraceView::Config[:typhoeus][:collect_backtraces] = @collect_backtraces
+    TraceView::Config[:typhoeus][:log_args] = @log_args
+  end
+
+  it 'Typhoeus should be defined and ready' do
+    defined?(::Typhoeus::Request::Operations).wont_match nil
+  end
+
+  it 'Typhoeus should have traceview methods defined' do
+    [ :run_with_traceview ].each do |m|
+      ::Typhoeus::Request::Operations.method_defined?(m).must_equal true
+    end
+  end
+
+  it 'should trace a typhoeus request' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("http://127.0.0.1:8101/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].must_equal 'http://127.0.0.1:8101/'
+    traces[5]['HTTPMethod'].must_equal 'GET'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus POST request' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.post("127.0.0.1:8101/",
+                    :body => { :key => "traceview-ruby-fake", :content => "traceview-ruby repo test suite"})
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].casecmp('http://127.0.0.1:8101/').must_equal 0
+    traces[5]['HTTPMethod'].must_equal 'POST'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus PUT request' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.put("http://127.0.0.1:8101/",
+                    :body => { :key => "traceview-ruby-fake", :content => "traceview-ruby repo test suite"})
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].must_equal 'http://127.0.0.1:8101/'
+    traces[5]['HTTPMethod'].must_equal 'PUT'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus DELETE request' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.delete("http://127.0.0.1:8101/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].must_equal 'http://127.0.0.1:8101/'
+    traces[5]['HTTPMethod'].must_equal 'DELETE'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus HEAD request' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.head("http://127.0.0.1:8101/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].must_equal 'http://127.0.0.1:8101/'
+    traces[5]['HTTPMethod'].must_equal 'HEAD'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus GET request to an instr\'d app' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("127.0.0.1:8101/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 8
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[5]['Layer'].must_equal 'typhoeus'
+    traces[5]['Label'].must_equal 'info'
+    traces[5]['IsService'].must_equal 1
+    traces[5]['RemoteURL'].casecmp('http://127.0.0.1:8101/').must_equal 0
+    traces[5]['HTTPMethod'].must_equal 'GET'
+    traces[5]['HTTPStatus'].must_equal 200
+
+    traces[6]['Layer'].must_equal 'typhoeus'
+    traces[6]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus GET request with DNS error' do
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("thisdomaindoesntexisthopefully.asdf/products/traceview/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 6
+
+    valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal TraceView::Config[:typhoeus][:collect_backtraces]
+
+    traces[2]['Layer'].must_equal 'typhoeus'
+    traces[2]['Label'].must_equal 'error'
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'info'
+    traces[3]['IsService'].must_equal 1
+    traces[3]['RemoteURL'].casecmp('http://thisdomaindoesntexisthopefully.asdf/products/traceview/').must_equal 0
+    traces[3]['HTTPMethod'].must_equal 'GET'
+    traces[3]['HTTPStatus'].must_equal 0
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'info'
+
+    traces[4]['Layer'].must_equal 'typhoeus'
+    traces[4]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace parallel typhoeus requests' do
+    TraceView::API.start_trace('typhoeus_test') do
+      hydra = Typhoeus::Hydra.hydra
+
+      first_request  = Typhoeus::Request.new("127.0.0.1:8101/products/traceview/")
+      second_request = Typhoeus::Request.new("127.0.0.1:8101/products/")
+      third_request  = Typhoeus::Request.new("127.0.0.1:8101/")
+
+      hydra.queue first_request
+      hydra.queue second_request
+      hydra.queue third_request
+
+      hydra.run
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 13
+
+    # FIXME: Until we support async tracing for Typhoeus, this won't
+    # work.
+    # valid_edges?(traces).must_equal true
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus_hydra'
+    traces[1]['Label'].must_equal 'entry'
+
+    traces[11]['Layer'].must_equal 'typhoeus_hydra'
+    traces[11]['Label'].must_equal 'exit'
+  end
+
+  it 'should obey :log_args setting when true' do
+    TraceView::Config[:typhoeus][:log_args] = true
+
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("127.0.0.1:8101/?blah=1")
+    end
+
+    traces = get_all_traces
+    traces[5]['RemoteURL'].casecmp('http://127.0.0.1:8101/?blah=1').must_equal 0
+  end
+
+  it 'should obey :log_args setting when false' do
+    TraceView::Config[:typhoeus][:log_args] = false
+
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("127.0.0.1:8101/?blah=1")
+    end
+
+    traces = get_all_traces
+    traces[5]['RemoteURL'].casecmp('http://127.0.0.1:8101/').must_equal 0
+  end
+
+  it 'should obey :collect_backtraces setting when true' do
+    TraceView::Config[:typhoeus][:collect_backtraces] = true
+
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("127.0.0.1:8101/?blah=1")
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'typhoeus', 'Backtrace')
+  end
+
+  it 'should obey :collect_backtraces setting when false' do
+    TraceView::Config[:typhoeus][:collect_backtraces] = false
+
+    TraceView::API.start_trace('typhoeus_test') do
+      Typhoeus.get("127.0.0.1:8101/")
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'typhoeus', 'Backtrace')
+  end
+end