instana 1.195.4 → 1.198.0

data/test/backend/host_agent_test.rb

@@ -0,0 +1,47 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class HostAgentTest < Minitest::Test
+  def test_spawn_background_thread
+    ENV['INSTANA_TEST'] = nil
+    ::Instana.config[:agent_host] = '10.10.10.10'
+
+    if File.exist?('/sbin/ip')
+      addr = `/sbin/ip route | awk '/default/ { print $3 }'`.strip
+      stub_request(:get, "http://#{addr}:42699/")
+        .to_timeout
+    end
+
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_timeout.times(3).then
+      .to_return(status: 200, body: "", headers: {})
+
+    discovery = Minitest::Mock.new
+    discovery.expect(:delete_observers, discovery, [])
+    discovery.expect(:with_observer, discovery, [Instana::Backend::HostAgentActivationObserver])
+    discovery.expect(:with_observer, discovery, [Instana::Backend::HostAgentReportingObserver])
+    discovery.expect(:swap, discovery, [])
+
+    subject = Instana::Backend::HostAgent.new(discovery: discovery)
+
+    FakeFS.with_fresh do
+      FakeFS::FileSystem.clone('test/support/ecs', '/proc')
+      subject.spawn_background_thread
+    end
+
+    subject.future.value!
+
+    discovery.verify
+  ensure
+    ::Instana.config[:agent_host] = '127.0.0.1'
+    ENV['INSTANA_TEST'] = 'true'
+  end
+
+  def test_discovery_value
+    discovery = Concurrent::Atom.new({'pid' => 1})
+    subject = Instana::Backend::HostAgent.new(discovery: discovery)
+    assert_equal 1, subject.source[:e]
+  end
+end

data/test/backend/process_info_test.rb

@@ -0,0 +1,63 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class ProcessInfoTest < Minitest::Test
+  def test_osx_argument_stripping
+    host_os = RbConfig::CONFIG['host_os']
+    RbConfig::CONFIG['host_os'] = 'darwin'
+
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(cmdline: 'test INSTANA_TEST=1 KV=2'))
+    assert_equal ['KV=2'], subject.arguments
+  ensure
+    RbConfig::CONFIG['host_os'] = host_os
+  end
+
+  def test_linux_argument_stripping
+    host_os = RbConfig::CONFIG['host_os']
+    RbConfig::CONFIG['host_os'] = 'linux'
+
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(cmdline: 'test INSTANA_TEST=1 KV=2'))
+    assert_equal ['INSTANA_TEST=1', 'KV=2'], subject.arguments
+  ensure
+    RbConfig::CONFIG['host_os'] = host_os
+  end
+
+  def test_no_proc
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(pid: 0))
+
+    FakeFS.with_fresh do
+      FakeFS::FileSystem.clone('test/support/ecs', '/proc')
+
+      assert_equal 0, subject.parent_pid
+      assert_nil subject.cpuset
+      assert_nil subject.sched_pid
+      refute subject.in_container?
+    end
+  end
+
+  def test_cpuset_proc
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(pid: 0))
+
+    FakeFS do
+      FakeFS::FileSystem.clone('test/support/proc', '/proc')
+      assert_equal '/', subject.cpuset
+      refute subject.in_container?
+    end
+  end
+
+  def test_sched_pid
+    subject = Instana::Backend::ProcessInfo.new(OpenStruct.new(pid: 1))
+
+    FakeFS do
+      FakeFS::FileSystem.clone('test/support/proc', '/proc')
+      refute_equal '/', subject.cpuset
+
+      assert subject.in_container?
+      assert_equal 35, subject.sched_pid
+      assert subject.from_parent_namespace
+      assert_equal subject.sched_pid, subject.parent_pid
+    end
+  end
+end

data/test/backend/request_client_test.rb

@@ -0,0 +1,39 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class RequestClientTest < Minitest::Test
+  def test_send_request_simple
+    stub_request(:get, 'http://example.com:9292/')
+      .to_return(body: 'ok', status: '200')
+
+    subject = Instana::Backend::RequestClient.new('example.com', 9292)
+    response = subject.send_request('GET', '/')
+
+    assert response.ok?
+    assert 'ok', response.body
+  end
+
+  def test_send_request_json
+    stub_request(:post, 'http://example.com:9292/')
+      .with(body: '{"key":"value"}')
+      .to_return(body: '{"ok": true}', status: '200')
+
+    subject = Instana::Backend::RequestClient.new('example.com', 9292)
+    response = subject.send_request('POST', '/', {key: 'value'})
+
+    assert response.ok?
+    assert_equal({"ok" => true}, response.json)
+  end
+
+  def test_send_request_failure
+    stub_request(:get, 'http://example.com:9292/')
+      .to_return(status: '500')
+
+    subject = Instana::Backend::RequestClient.new('example.com', 9292)
+    response = subject.send_request('GET', '/')
+
+    refute response.ok?
+  end
+end

data/test/backend/serverless_agent_test.rb

@@ -0,0 +1,73 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class ServerlesAgentTest < Minitest::Test
+  def test_report
+    stub_request(:post, "http://10.10.10.10:9292//bundle")
+      .to_return(status: 500)
+      .to_return(status: 200)
+
+    host_name = Class.new do
+      def host_name
+        'hello'
+      end
+    end.new
+
+    snapshots = [Instana::Snapshot::RubyProcess.new, host_name]
+    subject = Instana::Backend::ServerlessAgent.new(snapshots, timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/', logger: Logger.new('/dev/null'))
+
+    subject.timer.block.call
+    subject.timer.block.call
+  end
+
+  def test_ready
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/')
+    assert subject.ready?
+  end
+
+  def test_extra_headers
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/')
+    assert_equal [], subject.extra_headers
+  end
+
+  def test_secret_values
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/')
+    assert_equal({"matcher" => "contains-ignore-case", "list" => %w[key password secret]}, subject.secret_values)
+  end
+
+  def test_spawn_background_thread
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/')
+    subject.spawn_background_thread
+
+    assert subject.timer.running
+  end
+
+  def test_source
+    snapshot = Class.new do
+      def source
+        {test: 1}
+      end
+    end.new
+    subject = Instana::Backend::ServerlessAgent.new([snapshot], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/')
+
+    assert_equal({test: 1}, subject.source)
+    assert_equal({test: 1}, subject.source)
+  end
+
+  def test_missing_source
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/', logger: Logger.new('/dev/null'))
+
+    assert_equal({}, subject.source)
+  end
+
+  def test_report_error
+    stub_request(:post, "http://10.10.10.10:9292//bundle")
+      .to_return(status: 500)
+
+    subject = Instana::Backend::ServerlessAgent.new([], timer_class: MockTimer, backend_uri: 'http://10.10.10.10:9292/', logger: Logger.new('/dev/null'))
+
+    subject.timer.block.call
+  end
+end

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

@@ -29,6 +29,7 @@ class RackInstrumentedRequestTest < Minitest::Test
     expected = {
       trace_id: id,
       span_id: id,
+      from_w3: false,
       level: '1'
     }
 
@@ -47,6 +48,7 @@ class RackInstrumentedRequestTest < Minitest::Test
       external_state: nil,
       trace_id: 'a3ce929d0e0e4736',
       span_id: '00f067aa0ba902b7',
+      from_w3: true,
       level: '1'
     }
 
@@ -81,7 +83,8 @@ 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',
@@ -101,7 +104,7 @@ class RackInstrumentedRequestTest < Minitest::Test
     }
 
     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/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