instana 1.12.0 → 1.193.3.pre1

data/test/{frameworks → instrumentation}/rack_test.rb

@@ -1,11 +1,10 @@
 require 'test_helper'
 require 'rack/test'
 require 'rack/lobster'
-require "instana/rack"
 
 class RackTest < Minitest::Test
   include Rack::Test::Methods
-  
+
   class PathTemplateApp
     def call(env)
       env['INSTANA_HTTP_PATH_TEMPLATE'] = 'sample_template'
@@ -57,11 +56,7 @@ class RackTest < Minitest::Test
     assert rack_span[:f].key?(:e)
     assert rack_span[:f].key?(:h)
     assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
@@ -151,8 +146,9 @@ class RackTest < Minitest::Test
 
   def test_context_continuation
     clear_all!
-    header 'X-INSTANA-T', Instana::Util.id_to_header(1234)
-    header 'X-INSTANA-S', Instana::Util.id_to_header(4321)
+    continuation_id = Instana::Util.generate_id
+    header 'X-INSTANA-T', continuation_id
+    header 'X-INSTANA-S', continuation_id
 
     get '/mrlobster'
     assert last_response.ok?
@@ -186,10 +182,30 @@ class RackTest < Minitest::Test
     # Context validation
     # The first span should have the passed in trace ID
     # and specify the passed in span ID as it's parent.
-    assert_equal 1234, rack_span[:t]
-    assert_equal 4321, rack_span[:p]
+    assert_equal continuation_id, rack_span[:t]
+    assert_equal continuation_id, rack_span[:p]
   end
 
+  def test_correlation_information
+    clear_all!
+
+    header 'X-INSTANA-L', '1,correlationType=test;correlationId=abcdefh123'
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert_equal 'abcdefh123', rack_span[:crid]
+    assert_equal 'test', rack_span[:crtp]
+  end
+
+
   def test_instana_response_headers
     clear_all!
     get '/mrlobster'
@@ -233,26 +249,22 @@ class RackTest < Minitest::Test
     assert rack_span[:data][:http][:header].key?(:"X-Capture-This")
     assert !rack_span[:data][:http][:header].key?(:"X-Capture-That")
     assert_equal "ThereYouGo", rack_span[:data][:http][:header][:"X-Capture-This"]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
     ::Instana.agent.extra_headers = nil
   end
-  
+
   def test_capture_http_path_template
     clear_all!
-    
+
     get '/path_tpl'
     assert last_response.ok?
-    
+
     spans = ::Instana.processor.queued_spans
     assert_equal 1, spans.length
-    
+
     rack_span = spans.first
     assert_equal :rack, rack_span[:n]
     assert_equal 'sample_template', rack_span[:data][:http][:path_tpl]

data/test/instrumentation/redis_test.rb

@@ -20,6 +20,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,7 @@
 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

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

@@ -1,6 +1,12 @@
 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/sidekiq-client_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'support/apps/sidekiq/boot'
 
 class SidekiqClientTest < Minitest::Test
   def setup

data/test/instrumentation/sidekiq-worker_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'support/apps/sidekiq/boot'
 
 class SidekiqServerTest < Minitest::Test
   def setup

data/test/secrets_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class SecretsTest < Minitest::Test
+  def setup
+    @subject = Instana::Secrets.new
+  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
+  
+  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

data/test/{servers/grpc_50051.rb → support/apps/grpc/boot.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../apps/grpc_server.rb')
+require_relative 'grpc_server'
 
 ::Instana.logger.info "Booting instrumented gRPC server on port 50051 for tests."
 

data/test/{servers/rails_3205.rb → support/apps/rails/boot.rb}

@@ -1,22 +1,16 @@
-
 ::Instana.logger.warn "Starting background Ruby on Rails #{Rails::VERSION::STRING} application on port 3205"
 
-if Rails::VERSION::STRING >= '5.0' && ::Instana::Test.mysql?
-  ::Instana.logger.fatal "Rails 5.x doesn't support the mysql adapter (discontinued).  Set DB_FLAVOR=msyql2 instead.  This will fail as is."
-end
-
-require "rails/all"
-require "action_controller/railtie" # require more if needed
+require "rails"
+require "active_record/railtie"
+require "active_model/railtie"
+require "action_controller/railtie"
+require "active_model/railtie"
 require 'rack/handler/puma'
 
 if Rails::VERSION::STRING >= '6.0'
-  require File.expand_path(File.dirname(__FILE__) + '/../models/block6')
-  system("mkdir -p app/assets/config && echo '{}' > app/assets/config/manifest.js")
-  # Rails 6 Issue: https://github.com/rails/rails/issues/37183
-  class ApplicationController < ActionController::Base
-  end
+  require_relative 'models/block6'
 else
-  require File.expand_path(File.dirname(__FILE__) + '/../models/block')
+  require_relative 'models/block'
 end
 
 ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
@@ -62,7 +56,7 @@ class RailsTestApp < Rails::Application
   # uncomment below to display errors
   # config.consider_all_requests_local = true
 
-  config.paths['app/views'].unshift(File.expand_path(File.dirname(__FILE__) + '/../views'))
+  config.paths['app/views'].unshift(File.join(__dir__, 'views'))
 
   config.active_support.deprecation = :stderr
 

data/test/{models → support/apps/rails/models}/block.rb

@@ -7,7 +7,7 @@ class Block < ActiveRecord::Base
   end
 end
 
-class CreateBlocks < ActiveRecord::Migration
+class CreateBlocks < ActiveRecord::Migration[4.2]
   def change
     create_table :blocks do |t|
       t.string :name

data/test/support/apps/resque/boot.rb

@@ -0,0 +1,2 @@
+require_relative 'jobs/resque_error_job'
+require_relative 'jobs/resque_fast_job'

data/test/support/apps/sidekiq/boot.rb

@@ -0,0 +1,21 @@
+# Hook into sidekiq to control the current mode
+$sidekiq_mode = :client
+class << Sidekiq
+  def server?
+    $sidekiq_mode == :server
+  end
+end
+
+# Configure redis for sidekiq client
+Sidekiq.configure_client do |config|
+  config.redis = { url: ENV['REDIS_URL'] }
+end
+
+# Configure redis for sidekiq worker
+$sidekiq_mode = :server
+::Sidekiq.configure_server do |config|
+  config.redis = { url: ENV['REDIS_URL'] }
+end
+$sidekiq_mode = :client
+
+require_relative 'worker'

data/test/{servers → support/apps}/sidekiq/worker.rb

@@ -3,8 +3,8 @@ require 'sidekiq/cli'
 require 'sidekiq/api'
 require 'sidekiq/processor'
 
-require Dir.pwd + '/test/jobs/sidekiq_job_1.rb'
-require Dir.pwd + '/test/jobs/sidekiq_job_2.rb'
+require_relative 'jobs/sidekiq_job_1'
+require_relative 'jobs/sidekiq_job_2'
 
 ::Instana.logger.info "Booting instrumented sidekiq worker for tests."
 ::Sidekiq.logger.level = ::Logger::FATAL

data/test/support/helpers.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Instana
+  module TestHelpers
+    # Used to reset the gem to boot state.  It clears out any queued and/or staged
+    # traces and resets the tracer to no active trace.
+    #
+    def clear_all!
+      ::Instana.processor.clear!
+      ::Instana.tracer.clear!
+      nil
+    end
+
+    def disable_redis_instrumentation
+      ::Instana.config[:redis][:enabled] = false
+    end
+
+    def enable_redis_instrumentation
+      ::Instana.config[:redis][:enabled] = true
+    end
+
+    def validate_sdk_span(json_span, sdk_hash = {}, errored = false, _ec = 1)
+      assert_equal :sdk, json_span[:n]
+      assert json_span.key?(:k)
+      assert json_span.key?(:d)
+      assert json_span.key?(:ts)
+
+      sdk_hash.each do |k, v|
+        assert_equal v, json_span[:data][:sdk][k]
+      end
+
+      return unless errored
+
+      assert_equal true, json_span[:error]
+      assert_equal 1, json_span[:ec]
+    end
+
+    def find_spans_by_name(spans, name)
+      spans.select do |span|
+        (span[:n] == :sdk && span[:data][:sdk][:name] == name) || span[:n] == name
+      end.tap do |result|
+        raise StandardError, "No SDK spans (#{name}) could be found" if result.empty?
+      end
+    end
+
+    def find_first_span_by_name(spans, name)
+      spans.each do |span|
+        case span[:n]
+        when :sdk
+          return span if span[:data][:sdk][:name] == name
+        when name
+          return span
+        end
+      end
+      raise StandardError, "Span (#{name}) not found"
+    end
+
+    def find_span_by_id(spans, id)
+      spans.each do |span|
+        return span if span[:s] == id
+      end
+      raise StandardError, "Span with id (#{id}) not found"
+    end
+
+    # Finds the first span in +spans+ for which +block+ returns true
+    #
+    #     ar_span = find_first_span_by_qualifier(ar_spans) do |span|
+    #       span[:data][:activerecord][:sql] == sql
+    #     end
+    #
+    # This helper will raise an exception if no span evaluates to true against he provided block.
+    #
+    # +spans+: +Array+ of spans to search
+    # +block+: The Ruby block to evaluate against each span
+    def find_first_span_by_qualifier(spans, &block)
+      spans.each do |span|
+        return span if block.call(span)
+      end
+      raise StandardError, 'Span with qualifier not found'
+    end
+
+    def has_postgres_database?
+      URI(ENV.fetch('DATABASE_URL', '')).scheme == 'postgres'
+    end
+
+    def has_mysql2_database?
+      URI(ENV.fetch('DATABASE_URL', '')).scheme == 'mysql2'
+    end
+
+    def has_mysql_database?
+      URI(ENV.fetch('DATABASE_URL', '')).scheme == 'mysql'
+    end
+  end
+end