instana 1.195.0 → 1.197.0.pre1

data/test/config_test.rb

@@ -21,4 +21,14 @@ class ConfigTest < Minitest::Test
       assert_equal true, ::Instana.config[:metrics][k].key?(:enabled)
     end
   end
+
+  def test_custom_agent_host
+    subject = Instana::Config.new(logger: Logger.new('/dev/null'), agent_host: 'abc')
+    assert_equal 'abc', subject[:agent_host]
+  end
+
+  def test_custom_agent_port
+    subject = Instana::Config.new(logger: Logger.new('/dev/null'), agent_port: 'abc')
+    assert_equal 'abc', subject[:agent_port]
+  end
 end

data/test/instana_test.rb

@@ -16,10 +16,6 @@ class InstanaTest < Minitest::Test
     refute_nil ::Instana.agent
   end
 
-  def test_that_it_has_a_collector
-    refute_nil ::Instana.collector
-  end
-
   def test_that_it_has_a_tracer
     refute_nil ::Instana.tracer
   end
@@ -27,4 +23,15 @@ class InstanaTest < Minitest::Test
   def test_that_it_has_a_config
     refute_nil ::Instana.config
   end
+
+  def test_assign_logger
+    mock = Minitest::Mock.new
+    mock.expect(:info, true, [String])
+
+    ::Instana.logger = mock
+    ::Instana.logger.info('test')
+    ::Instana.logger = Logger.new('/dev/null')
+
+    mock.verify
+  end
 end

data/test/instrumentation/aws_test.rb

@@ -4,6 +4,10 @@
 require 'test_helper'
 
 class AwsTest < Minitest::Test
+  def setup
+    clear_all!
+  end
+
   def test_dynamo_db
     dynamo = Aws::DynamoDB::Client.new(
       region: "local",
@@ -27,7 +31,131 @@ class AwsTest < Minitest::Test
     assert rest.empty?
     assert_equal entry_span[:s], dynamo_span[:p]
     assert_equal :dynamodb, dynamo_span[:n]
-    assert_equal :get_item, dynamo_span[:data][:op]
-    assert_equal 'sample_table', dynamo_span[:data][:table]
+    assert_equal 'get', dynamo_span[:data][:dynamodb][:op]
+    assert_equal 'sample_table', dynamo_span[:data][:dynamodb][:table]
+  end
+
+  def test_s3
+    dynamo = Aws::S3::Client.new(
+      region: "local",
+      access_key_id: "minioadmin",
+      secret_access_key: "minioadmin",
+      endpoint: "http://localhost:9000"
+    )
+
+    assert_raises Aws::S3::Errors::NoSuchBucket do
+      Instana::Tracer.start_or_continue_trace(:s3_test, {}) do
+        dynamo.get_object(
+          bucket: 'sample_bucket',
+          key: 'sample_key'
+        )
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    s3_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], s3_span[:p]
+    assert_equal :s3, s3_span[:n]
+    assert_equal 'get', s3_span[:data][:s3][:op]
+    assert_equal 'sample_bucket', s3_span[:data][:s3][:bucket]
+    assert_equal 'sample_key', s3_span[:data][:s3][:key]
+  end
+
+  def test_sns_publish
+    sns = Aws::SNS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9911"
+    )
+
+    assert_raises Aws::SNS::Errors::NotFound do
+      Instana::Tracer.start_or_continue_trace(:sns_test, {}) do
+        sns.publish(
+          topic_arn: 'topic:arn',
+          target_arn: 'target:arn',
+          phone_number: '555-0100',
+          subject: 'Test Subject',
+          message: 'Test Message'
+        )
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    aws_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], aws_span[:p]
+    assert_equal :sns, aws_span[:n]
+    assert_equal 'topic:arn', aws_span[:data][:sns][:topic]
+    assert_equal 'target:arn', aws_span[:data][:sns][:target]
+    assert_equal '555-0100', aws_span[:data][:sns][:phone]
+    assert_equal 'Test Subject', aws_span[:data][:sns][:subject]
+  end
+
+  def test_sns_other
+    sns = Aws::SNS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9911"
+    )
+
+    Instana::Tracer.start_or_continue_trace(:sns_test, {}) do
+      sns.list_subscriptions
+    end
+
+    spans = ::Instana.processor.queued_spans
+    aws_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], aws_span[:p]
+    assert_equal :"net-http", aws_span[:n]
+  end
+
+  def test_sqs
+    sqs = Aws::SQS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9324"
+    )
+
+    create_response = nil
+    get_url_response = nil
+
+    Instana::Tracer.start_or_continue_trace(:sqs_test, {}) do
+      create_response = sqs.create_queue(queue_name: 'test')
+      get_url_response = sqs.get_queue_url(queue_name: 'test')
+      sqs.send_message(queue_url: create_response.queue_url, message_body: 'Sample')
+    end
+
+    received = sqs.receive_message(
+      queue_url: create_response.queue_url,
+      message_attribute_names: ['All']
+    )
+    sqs.delete_queue(queue_url: create_response.queue_url)
+    message = received.messages.first
+    create_span, get_span, send_span, _root = ::Instana.processor.queued_spans
+
+    assert_equal :sqs, create_span[:n]
+    assert_equal create_response.queue_url, create_span[:data][:sqs][:queue]
+    assert_equal 'exit', create_span[:data][:sqs][:sort]
+    assert_equal 'create.queue', create_span[:data][:sqs][:type]
+
+    assert_equal :sqs, get_span[:n]
+    assert_equal get_url_response.queue_url, get_span[:data][:sqs][:queue]
+    assert_equal 'exit', get_span[:data][:sqs][:sort]
+    assert_equal 'get.queue', get_span[:data][:sqs][:type]
+
+    assert_equal :sqs, send_span[:n]
+    assert_equal get_url_response.queue_url, send_span[:data][:sqs][:queue]
+    assert_equal 'exit', send_span[:data][:sqs][:sort]
+    assert_equal 'single.sync', send_span[:data][:sqs][:type]
+    assert_equal send_span[:t], message.message_attributes['X_INSTANA_T'].string_value
+    assert_equal send_span[:s], message.message_attributes['X_INSTANA_S'].string_value
+    assert_equal 'Sample', message.body
   end
 end

data/test/instrumentation/excon_test.rb

@@ -22,7 +22,7 @@ class ExconTest < Minitest::Test
     url = "http://127.0.0.1:6511"
 
     connection = Excon.new(url)
-    Instana.tracer.start_or_continue_trace('excon-test') do
+    Instana.tracer.start_or_continue_trace(:'excon-test') do
       connection.get(:path => '/?basic_get')
     end
 
@@ -40,6 +40,7 @@ class ExconTest < Minitest::Test
     refute_nil excon_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", excon_span[:data][:http][:url]
     assert_equal 200, excon_span[:data][:http][:status]
+    assert_equal 'basic_get', excon_span[:data][:http][:params]
 
     # excon backtrace not included by default check
     assert !excon_span.key?(:stack)
@@ -146,4 +147,18 @@ class ExconTest < Minitest::Test
       assert_equal :sdk, grandparent_span[:n]
     end
   end
+
+  def test_basic_get_no_tracing
+    clear_all!
+
+    # A slight hack but webmock chokes with pipelined requests.
+    # Delete their excon middleware
+    Excon.defaults[:middlewares].delete ::WebMock::HttpLibAdapters::ExconAdapter
+    Excon.defaults[:middlewares].delete ::Excon::Middleware::Mock
+
+    url = "http://127.0.0.1:6511"
+
+    connection = Excon.new(url)
+    connection.get(:path => '/?basic_get')
+  end
 end

data/test/instrumentation/net_http_test.rb

@@ -11,6 +11,24 @@ class NetHTTPTest < Minitest::Test
     assert_equal true, ::Instana.config[:nethttp][:enabled]
   end
 
+  def test_get_with_query
+    clear_all!
+    WebMock.allow_net_connect!
+
+    Instana.tracer.start_or_continue_trace(:"net-http-test") do
+      Net::HTTP.get(URI('http://127.0.0.1:6511/?query_value=true'))
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 3, spans.length
+
+    http_span = find_first_span_by_name(spans, :'net-http')
+    assert_equal "http://127.0.0.1:6511/", http_span[:data][:http][:url]
+    assert_equal "query_value=true", http_span[:data][:http][:params]
+
+    WebMock.disable_net_connect!
+  end
+
   def test_block_request
     clear_all!
     WebMock.allow_net_connect!

data/test/instrumentation/rack_instrumented_request_test.rb

@@ -81,12 +81,14 @@ class RackInstrumentedRequestTest < Minitest::Test
   end
 
   def test_request_tags
-    ::Instana.agent.extra_headers = %w[X-Capture-This]
+    ::Instana.agent.define_singleton_method(:extra_headers) { %w[X-Capture-This] }
+
     req = Instana::InstrumentedRequest.new(
       'HTTP_HOST' => 'example.com',
       'REQUEST_METHOD' => 'GET',
       'HTTP_X_CAPTURE_THIS' => 'that',
-      'PATH_INFO' => '/'
+      'PATH_INFO' => '/',
+      'QUERY_STRING' => 'test=true'
     )
 
     expected = {
@@ -95,11 +97,12 @@ class RackInstrumentedRequestTest < Minitest::Test
       host: 'example.com',
       header: {
         "X-Capture-This": 'that'
-      }
+      },
+      params: 'test=true'
     }
 
     assert_equal expected, req.request_tags
-    ::Instana.agent.extra_headers = nil
+    ::Instana.agent.singleton_class.send(:remove_method, :extra_headers)
   end
 
   def test_correlation_data_valid

data/test/instrumentation/rack_test.rb

@@ -80,9 +80,6 @@ class RackTest < Minitest::Test
     assert_equal 200, rack_span[:data][:http][:status]
     assert_equal 'example.org', rack_span[:data][:http][:host]
     assert rack_span.key?(:f)
-    assert rack_span[:f].key?(:e)
-    assert rack_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
     assert !rack_span.key?(:stack)
 
     # Restore to default
@@ -134,9 +131,6 @@ class RackTest < Minitest::Test
     assert_equal "/mrlobster", rack_span[:data][:http][:url]
     assert_equal 200, rack_span[:data][:http][:status]
     assert rack_span.key?(:f)
-    assert rack_span[:f].key?(:e)
-    assert rack_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
   end
 
   def test_basic_put
@@ -166,9 +160,6 @@ class RackTest < Minitest::Test
     assert_equal "/mrlobster", rack_span[:data][:http][:url]
     assert_equal 200, rack_span[:data][:http][:status]
     assert rack_span.key?(:f)
-    assert rack_span[:f].key?(:e)
-    assert rack_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
   end
 
   def test_context_continuation
@@ -202,9 +193,6 @@ class RackTest < Minitest::Test
     assert_equal "/mrlobster", rack_span[:data][:http][:url]
     assert_equal 200, rack_span[:data][:http][:status]
     assert rack_span.key?(:f)
-    assert rack_span[:f].key?(:e)
-    assert rack_span[:f].key?(:h)
-    assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
 
     # Context validation
     # The first span should have the passed in trace ID
@@ -260,7 +248,7 @@ class RackTest < Minitest::Test
   def test_custom_headers_capture
     clear_all!
     ::Instana.config[:collect_backtraces] = true
-    ::Instana.agent.extra_headers = %w(X-Capture-This X-Capture-That)
+    ::Instana.agent.define_singleton_method(:extra_headers) { %w(X-Capture-This X-Capture-That) }
 
     get '/mrlobster', {}, { "HTTP_X_CAPTURE_THIS" => "ThereYouGo" }
     assert last_response.ok?
@@ -280,7 +268,7 @@ class RackTest < Minitest::Test
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
-    ::Instana.agent.extra_headers = nil
+    ::Instana.agent.singleton_class.send(:remove_method, :extra_headers)
   end
 
   def test_capture_http_path_template

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/secrets_test.rb

@@ -5,72 +5,91 @@ require 'test_helper'
 
 class SecretsTest < Minitest::Test
   def setup
-    @subject = Instana::Secrets.new
+    @subject = Instana::Secrets.new(logger: Logger.new('/dev/null'))
   end
-  
+
   def test_equals_ignore_case
     sample_config = {
-      "matcher"=>"equals-ignore-case", 
+      "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", 
+      "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", 
+      "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", 
+      "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", 
+      "matcher"=>"regex",
       "list"=>["l{2}"]
     }
-    
+
     url = url_for(%w(ball foot move))
-    assert_redacted @subject.remove_from_query(url, sample_config), %w(ball) 
+    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
-  
+
   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)
     url = URI(str)
     params = CGI.parse(url.query)
-    
+
     assert_equal keys, params.select { |_, v| v == %w(<redacted>) }.keys, 'to be redacted'
   end
 end