instana 1.11.6 → 1.209.2

data/test/instrumentation/rails_active_record_test.rb

@@ -0,0 +1,115 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+require 'support/apps/active_record/active_record'
+
+class RailsActiveRecordTest < Minitest::Test
+  def setup
+    skip unless ENV['DATABASE_URL']
+    @connection = ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.run(CreateBlocks, direction: :up)
+    end
+  end
+
+  def teardown
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.run(CreateBlocks, direction: :down)
+    end
+    ActiveRecord::Base.remove_connection(@connection)
+  end
+
+  def test_config_defaults
+    assert ::Instana.config[:sanitize_sql] == true
+    assert ::Instana.config[:active_record].is_a?(Hash)
+    assert ::Instana.config[:active_record].key?(:enabled)
+    assert_equal true, ::Instana.config[:active_record][:enabled]
+  end
+
+  def test_create
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      Block.create(name: 'core', color: 'blue')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('INSERT INTO')
+  end
+
+  def test_read
+    Block.create(name: 'core', color: 'blue')
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      Block.find_by(name: 'core')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('SELECT')
+  end
+
+  def test_update
+    Block.create(name: 'core', color: 'blue')
+    b = Block.find_by(name: 'core')
+
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      b.color = 'red'
+      b.save
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('UPDATE')
+  end
+
+  def test_delete
+    b = Block.create(name: 'core', color: 'blue')
+
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      b.delete
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert data[:sql].start_with?('DELETE')
+  end
+
+  def test_raw
+    Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+      ActiveRecord::Base.connection.execute('SELECT 1')
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+    data = span[:data][:activerecord]
+
+    assert 'SELECT 1', data[:sql]
+  end
+
+  def test_raw_error
+    assert_raises ActiveRecord::StatementInvalid do
+      Instana::Tracer.start_or_continue_trace(:ar_test, {}) do
+        ActiveRecord::Base.connection.execute('INVALID')
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+    span = find_first_span_by_name(spans, :activerecord)
+
+    assert_equal 1, span[:ec]
+  end
+end

data/test/instrumentation/redis_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'test_helper'
 
 class RedisTest < Minitest::Test
@@ -20,6 +23,16 @@ class RedisTest < Minitest::Test
     assert_redis_trace('SET')
   end
 
+  def test_georadius
+    clear_all!
+
+    Instana.tracer.start_or_continue_trace(:redis_test) do
+      @redis_client.georadius('Sicily', '15', '37', '200', 'km', 'WITHCOORD', 'WITHDIST')
+    end
+
+    assert_redis_trace('GEORADIUS')
+  end
+
   def test_normal_call_with_error
     clear_all!
 

data/test/instrumentation/resque_test.rb

@@ -1,15 +1,10 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2018
+
 require 'test_helper'
-require_relative "../jobs/resque_fast_job"
-require_relative "../jobs/resque_error_job"
-require 'resque'
-
-if ENV.key?('REDIS_URL')
-  ::Resque.redis = ENV['REDIS_URL']
-elsif ENV.key?('REDIS_URL')
-  ::Resque.redis = ENV['REDIS_URL']
-else
-  ::Resque.redis = 'localhost:6379'
-end
+require 'support/apps/resque/boot'
+
+::Resque.redis = ENV['REDIS_URL']
 
 class ResqueClientTest < Minitest::Test
   def setup
@@ -27,6 +22,7 @@ class ResqueClientTest < Minitest::Test
       ::Resque.enqueue(FastJob)
     end
 
+    resque_job = Resque.reserve('critical')
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
 
@@ -39,6 +35,9 @@ class ResqueClientTest < Minitest::Test
     assert_equal "FastJob", resque_span[:data][:'resque-client'][:job]
     assert_equal :critical, resque_span[:data][:'resque-client'][:queue]
     assert_equal false, resque_span[:data][:'resque-client'].key?(:error)
+
+    assert_equal resque_job.args.first['trace_id'], resque_span[:t]
+    assert_equal resque_job.args.first['span_id'], resque_span[:s]
   end
 
   def test_enqueue_to
@@ -46,6 +45,7 @@ class ResqueClientTest < Minitest::Test
       ::Resque.enqueue_to(:critical, FastJob)
     end
 
+    resque_job = Resque.reserve('critical')
     spans = ::Instana.processor.queued_spans
     assert_equal 2, spans.length
 
@@ -57,6 +57,9 @@ class ResqueClientTest < Minitest::Test
     assert_equal "FastJob", resque_span[:data][:'resque-client'][:job]
     assert_equal :critical, resque_span[:data][:'resque-client'][:queue]
     assert_equal false, resque_span[:data][:'resque-client'].key?(:error)
+
+    assert_equal resque_job.args.first['trace_id'], resque_span[:t]
+    assert_equal resque_job.args.first['span_id'], resque_span[:s]
   end
 
   def test_dequeue
@@ -78,17 +81,58 @@ class ResqueClientTest < Minitest::Test
   end
 
   def test_worker_job
-    Resque::Job.create(:critical, FastJob)
-    @worker.work(0)
+    ::Instana.tracer.start_or_continue_trace(:'resque-client_test') do
+      ::Resque.enqueue_to(:critical, FastJob)
+    end
+
+    resque_job = Resque.reserve('critical')
+    @worker.work_one_job(resque_job)
 
     spans = ::Instana.processor.queued_spans
-    assert_equal 3, spans.length
+    assert_equal 5, spans.length
+
+    client_span = spans[0]
+    resque_span = spans[4]
+    redis1_span = spans[3]
+    redis2_span = spans[2]
+
+    assert_equal :'resque-client', client_span[:n]
+
+    assert_equal :'resque-worker', resque_span[:n]
+    assert_equal client_span[:s], resque_span[:p]
+    assert_equal false, resque_span.key?(:error)
+    assert_equal false, resque_span.key?(:ec)
+    assert_equal "FastJob", resque_span[:data][:'resque-worker'][:job]
+    assert_equal "critical", resque_span[:data][:'resque-worker'][:queue]
+    assert_equal false, resque_span[:data][:'resque-worker'].key?(:error)
+
+    assert_equal :redis, redis1_span[:n]
+    assert_equal "SET", redis1_span[:data][:redis][:command]
+    assert_equal :redis, redis2_span[:n]
+    assert_equal "SET", redis2_span[:data][:redis][:command]
+  end
+
+  def test_worker_job_no_propagate
+    ::Instana.config[:'resque-client'][:propagate] = false
+    ::Instana.tracer.start_or_continue_trace(:'resque-client_test') do
+      ::Resque.enqueue_to(:critical, FastJob)
+    end
+
+    resque_job = Resque.reserve('critical')
+    @worker.work_one_job(resque_job)
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 5, spans.length
+
+    client_span = spans[0]
+    resque_span = spans[4]
+    redis1_span = spans[3]
+    redis2_span = spans[2]
 
-    resque_span = spans[2]
-    redis1_span = spans[1]
-    redis2_span = spans[0]
+    assert_equal :'resque-client', client_span[:n]
 
     assert_equal :'resque-worker', resque_span[:n]
+    refute_equal client_span[:s], resque_span[:p]
     assert_equal false, resque_span.key?(:error)
     assert_equal false, resque_span.key?(:ec)
     assert_equal "FastJob", resque_span[:data][:'resque-worker'][:job]
@@ -99,6 +143,8 @@ class ResqueClientTest < Minitest::Test
     assert_equal "SET", redis1_span[:data][:redis][:command]
     assert_equal :redis, redis2_span[:n]
     assert_equal "SET", redis2_span[:data][:redis][:command]
+  ensure
+    ::Instana.config[:'resque-client'][:propagate] = true
   end
 
   def test_worker_error_job

data/test/instrumentation/{rest-client_test.rb → rest_client_test.rb}

@@ -1,6 +1,15 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
+require 'support/apps/http_endpoint/boot'
 
 class RestClientTest < Minitest::Test
+  def setup
+    # See https://github.com/rest-client/rest-client/issues/612
+    OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:ciphers] = OpenSSL::SSL::SSLContext.new.ciphers
+  end
+
   def test_config_defaults
     assert ::Instana.config[:'rest-client'].is_a?(Hash)
     assert ::Instana.config[:'rest-client'].key?(:enabled)

data/test/instrumentation/shoryuken_test.rb

@@ -0,0 +1,47 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+require 'ostruct'
+
+class ShoryukenTest < Minitest::Test
+  def setup
+    clear_all!
+    @middleware = Instana::Instrumentation::Shoryuken.new
+  end
+
+  def test_start_trace_with_context
+    id = Instana::Util.generate_id
+    message = OpenStruct.new(
+      queue_url: 'http://example.com',
+      message_attributes: {
+        "X_INSTANA_T" => OpenStruct.new(string_value: id),
+        "X_INSTANA_S" => OpenStruct.new(string_value: id),
+        "X_INSTANA_L" => OpenStruct.new(string_value: '1')
+      }
+    )
+
+    @middleware.call(nil, nil, message, nil) {}
+
+    span = ::Instana.processor.queued_spans.first
+
+    assert_equal id, span[:t]
+    assert_equal id, span[:p]
+    assert_equal 'entry', span[:data][:sqs][:sort]
+    assert_equal 'http://example.com', span[:data][:sqs][:queue]
+  end
+
+  def test_start_trace
+    message = OpenStruct.new(
+      queue_url: 'http://example.com'
+    )
+
+    @middleware.call(nil, nil, message, nil) {}
+
+    span = ::Instana.processor.queued_spans.first
+
+    assert_nil span[:p]
+    assert_equal 'entry', span[:data][:sqs][:sort]
+    assert_equal 'http://example.com', span[:data][:sqs][:queue]
+  end
+end

data/test/instrumentation/sidekiq-client_test.rb

@@ -1,4 +1,8 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'test_helper'
+require 'support/apps/sidekiq/boot'
 
 class SidekiqClientTest < Minitest::Test
   def setup

data/test/instrumentation/sidekiq-worker_test.rb

@@ -1,4 +1,8 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'test_helper'
+require 'support/apps/sidekiq/boot'
 
 class SidekiqServerTest < Minitest::Test
   def setup

data/test/secrets_test.rb

@@ -0,0 +1,112 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class SecretsTest < Minitest::Test
+  def setup
+    @subject = Instana::Secrets.new(logger: Logger.new('/dev/null'))
+  end
+
+  def test_equals_ignore_case
+    sample_config = {
+      "matcher"=>"equals-ignore-case",
+      "list"=>["key"]
+    }
+
+    url = url_for(%w(key Str kEy KEY))
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(key kEy KEY)
+  end
+
+  def test_equals
+    sample_config = {
+      "matcher"=>"equals",
+      "list"=>["key", "kEy"]
+    }
+
+    url = url_for(%w(key Str kEy KEY))
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(key kEy)
+  end
+
+  def test_contains_ignore_case
+    sample_config = {
+      "matcher"=>"contains-ignore-case",
+      "list"=>["stan"]
+    }
+
+    url = url_for(%w(instantiate conTESTant sample))
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(instantiate conTESTant)
+  end
+
+  def test_contains
+    sample_config = {
+      "matcher"=>"contains",
+      "list"=>["stan"]
+    }
+
+    url = url_for(%w(instantiate conTESTant sample))
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(instantiate)
+  end
+
+  def test_regexp
+    sample_config = {
+      "matcher"=>"regex",
+      "list"=>["l{2}"]
+    }
+
+    url = url_for(%w(ball foot move))
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(ball)
+  end
+
+  def test_invalid
+    sample_config = {
+      "matcher"=>"test_invalid",
+      "list"=>["key"]
+    }
+
+    url = url_for(%w(key Str kEy KEY))
+    assert_redacted @subject.remove_from_query(url, sample_config), []
+  end
+
+  def test_without_scheme
+    sample_config = {
+      "matcher"=>"contains",
+      "list"=>["stan"]
+    }
+
+    url = 'example.com?instantiate=true'
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(instantiate)
+  end
+
+  def test_without_url
+    sample_config = {
+      "matcher"=>"contains",
+      "list"=>["stan"]
+    }
+
+    url = 'filter[instantiate]=true'
+    assert_redacted @subject.remove_from_query(url, sample_config), %w(filter[instantiate]), raw_str: true
+  end
+
+  def test_with_nil
+    sample_config = {
+      "matcher"=>"contains",
+      "list"=>["stan"]
+    }
+
+    assert_equal @subject.remove_from_query(nil, sample_config), nil
+  end
+
+  private
+
+  def url_for(keys)
+    url = URI('http://example.com')
+    url.query = URI.encode_www_form(keys.map { |k| [k, rand(1..100)]})
+    url.to_s
+  end
+
+  def assert_redacted(str, keys, raw_str: false)
+    params = raw_str ? CGI.parse(str) : CGI.parse(URI(str).query)
+    assert_equal keys, params.select { |_, v| v == %w(<redacted>) }.keys, 'to be redacted'
+  end
+end