instana 1.193.2 → 1.193.3.pre1

data/test/frameworks/sinatra_test.rb

@@ -1,66 +1,63 @@
-require 'sinatra'
-if defined?(::Sinatra)
-  require 'test_helper'
-  require File.expand_path(File.dirname(__FILE__) + '/../apps/sinatra')
-  require 'rack/test'
-
-  class SinatraTest < Minitest::Test
-    include Rack::Test::Methods
-
-    def app
-      InstanaSinatraApp
-    end
-
-    def test_basic_get
-      clear_all!
-
-      r = get '/'
-      assert last_response.ok?
-
-
-      spans = ::Instana.processor.queued_spans
-      assert_equal 1, spans.count
-
-      rack_span = spans.first
-      assert_equal :rack, rack_span[:n]
-      # ::Instana::Util.pry!
-
-      assert r.headers.key?("X-Instana-T")
-      assert r.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
-      assert r.headers.key?("X-Instana-S")
-      assert r.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
-      assert r.headers.key?("X-Instana-L")
-      assert r.headers["X-Instana-L"] == '1'
-      assert r.headers.key?("Server-Timing")
-      assert r.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
-      
-      assert rack_span.key?(:data)
-      assert rack_span[:data].key?(:http)
-      assert rack_span[:data][:http].key?(:method)
-      assert_equal "GET", rack_span[:data][:http][:method]
-
-      assert rack_span[:data][:http].key?(:url)
-      assert_equal "/", rack_span[:data][:http][:url]
-
-      assert rack_span[:data][:http].key?(:status)
-      assert_equal 200, rack_span[:data][:http][:status]
-
-      assert rack_span[:data][:http].key?(:host)
-      assert_equal "example.org", rack_span[:data][:http][:host]
-    end
-    
-    def test_path_template
-      clear_all!
-
-      r = get '/greet/instana'
-      assert last_response.ok?
-
-      spans = ::Instana.processor.queued_spans
-      assert_equal 1, spans.count
-
-      first_span = spans.first
-      assert_equal :rack, first_span[:n]
-      assert_equal '/greet/:name', first_span[:data][:http][:path_tpl]
-    end
+require 'test_helper'
+require 'rack/test'
+
+class SinatraTest < Minitest::Test
+  include Rack::Test::Methods
+  APP = Rack::Builder.parse_file('test/support/apps/sinatra/config.ru').first
+
+  def app
+    APP
+  end
+
+  def test_basic_get
+    clear_all!
+
+    r = get '/'
+    assert last_response.ok?
+
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+    # ::Instana::Util.pry!
+
+    assert r.headers.key?("X-Instana-T")
+    assert r.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert r.headers.key?("X-Instana-S")
+    assert r.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert r.headers.key?("X-Instana-L")
+    assert r.headers["X-Instana-L"] == '1'
+    assert r.headers.key?("Server-Timing")
+    assert r.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert rack_span[:data][:http].key?(:method)
+    assert_equal "GET", rack_span[:data][:http][:method]
+
+    assert rack_span[:data][:http].key?(:url)
+    assert_equal "/", rack_span[:data][:http][:url]
+
+    assert rack_span[:data][:http].key?(:status)
+    assert_equal 200, rack_span[:data][:http][:status]
+
+    assert rack_span[:data][:http].key?(:host)
+    assert_equal "example.org", rack_span[:data][:http][:host]
+  end
+
+  def test_path_template
+    clear_all!
+
+    r = get '/greet/instana'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal '/greet/:name', first_span[:data][:http][:path_tpl]
   end
 end

data/test/instrumentation/excon_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'support/apps/http_endpoint/boot'
 
 class ExconTest < Minitest::Test
   def test_config_defaults

data/test/instrumentation/grpc_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'support/apps/grpc/boot'
 
 class GrpcTest < Minitest::Test
   def client_stub
@@ -225,7 +226,7 @@ class GrpcTest < Minitest::Test
     server_span = find_spans_by_name(spans, :'rpc-server').first
 
     validate_sdk_span(sdk_span)
-    
+
     assert_client_span(
         client_span,
         call: '/PingPongService/FailToPing',

data/test/instrumentation/{net-http_test.rb → net_http_test.rb}

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'support/apps/http_endpoint/boot'
 
 class NetHTTPTest < Minitest::Test
   def test_config_defaults

data/test/instrumentation/{instrumented_request_test.rb → rack_instrumented_request_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class InstrumentedRequestTest < Minitest::Test
+class RackInstrumentedRequestTest < Minitest::Test
   def test_skip_trace_with_header
     req = Instana::InstrumentedRequest.new(
       'HTTP_X_INSTANA_L' => '0;sample-data'

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

@@ -1,7 +1,6 @@
 require 'test_helper'
 require 'rack/test'
 require 'rack/lobster'
-require "instana/rack"
 
 class RackTest < Minitest::Test
   include Rack::Test::Methods

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/{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

data/test/test_helper.rb

@@ -1,153 +1,39 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 ENV['INSTANA_TEST'] = 'true'
-require "rubygems"
-require "bundler/setup"
-Bundler.require(:default, :test)
 
-require "minitest/spec"
-require "minitest/autorun"
-require "minitest/reporters"
-require "minitest/debugger" if ENV['DEBUG']
-require "minitest/benchmark"
-require 'webmock/minitest'
-
-require "instana/test"
-::Instana::Test.setup_environment
+begin
+  require 'simplecov'
+  require 'simplecov_json_formatter'
 
-# Webmock: Whitelist local IPs
-whitelist = ['127.0.0.1', 'localhost', '172.17.0.1', '172.0.12.100']
-allowed_sites = lambda{|uri|
-  whitelist.include?(uri.host)
-}
-::WebMock.disable_net_connect!(allow: allowed_sites)
+  SimpleCov.start do
+    enable_coverage :branch
 
-# Boot background webservers to test against.
-require "./test/servers/rackapp_6511"
+    add_group 'Frameworks', 'lib/instana/frameworks'
+    add_group 'Instrumentation', 'lib/instana/instrumentation'
 
-case File.basename(ENV['BUNDLE_GEMFILE'])
-when /rails/
-  require './test/servers/rails_3205'
-when /libraries/
-  # Configure gRPC
-  require './test/servers/grpc_50051.rb'
+    add_filter %r{^/test/}
 
-  # Hook into sidekiq to control the current mode
-  $sidekiq_mode = :client
-  class << Sidekiq
-    def server?
-      $sidekiq_mode == :server
+    if ENV['CI']
+      formatter SimpleCov::Formatter::JSONFormatter
     end
   end
-
-  ENV['REDIS_URL'] ||= 'redis://127.0.0.1:6379'
-
-  # 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 './test/servers/sidekiq/worker'
-end
-
-Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
-
-# 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!
+rescue LoadError => _e
   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)
-
-  for k,v in sdk_hash
-    assert_equal v, json_span[:data][:sdk][k]
-  end
-
-  if errored
-    assert_equal true, json_span[:error]
-    assert_equal 1, json_span[:ec]
-  end
-end
+require 'bundler/setup'
+Bundler.require
 
-def find_spans_by_name(spans, name)
-  result = []
-  for span in spans
-    if span[:n] == :sdk
-      if span[:data][:sdk][:name] == name
-        result << span
-      end
-    elsif span[:n] == name
-      result << span
-    end
-  end
-  if result.empty?
-    raise Exception.new("No SDK spans (#{name}) could be found")
-  else
-    return result
-  end
-end
+require "minitest/spec"
+require "minitest/autorun"
+require "minitest/reporters"
 
-def find_first_span_by_name(spans, name)
-  for span in spans
-    if span[:n] == :sdk
-      if span[:data][:sdk][:name] == name
-        return span
-      end
-    else
-      if span[:n] == name
-        return span
-      end
-    end
-  end
-  raise Exception.new("Span (#{name}) not found")
-end
+require 'webmock/minitest'
+# Webmock: Whitelist local IPs
+WebMock.disable_net_connect!(
+  allow: ->(uri) { %w[localhost 127.0.0.1 172.17.0.1 172.0.12.100].include?(uri.host) }
+)
 
-def find_span_by_id(spans, id)
-  for span in spans
-    if span[:s] == id
-      return span
-    end
-  end
-  raise Exception.new("Span with id (#{id}) not found")
-end
+Dir['test/support/*.rb'].each { |f| load(f) }
 
-# 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|
-    if block.call(span)
-      return span
-    end
-  end
-  raise Exception.new("Span with qualifier not found")
-end
+Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+Minitest::Test.include(Instana::TestHelpers)