instana 1.192.1 → 1.193.5

data/test/instrumentation/rails_active_record_test.rb

@@ -0,0 +1,122 @@
+# (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')
+    assert 'core', data[:binds][0]
+    assert 'blue', data[:binds][1]
+  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')
+    assert 'core', data[:binds][0]
+    assert 1, data[:binds][1]
+  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')
+    assert 'red', data[:binds][0]
+    assert 1, data[:binds][2]
+  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')
+    assert 1, data[:binds][0]
+  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

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

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

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
 require 'test_helper'
 
 class SecretsTest < Minitest::Test

data/test/support/apps/active_record/active_record.rb

@@ -0,0 +1,24 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'rails'
+require 'active_record/railtie'
+
+migration_class = if ActiveRecord::Migration.respond_to?(:[])
+                    ActiveRecord::Migration[4.2]
+                  else
+                    ActiveRecord::Migration
+                  end
+
+class CreateBlocks < migration_class
+  def change
+    create_table :blocks do |t|
+      t.string :name
+      t.string :color
+      t.timestamps
+    end
+  end
+end
+
+class Block < ActiveRecord::Base
+end

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

@@ -1,4 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../apps/grpc_server.rb')
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
+require_relative 'grpc_server'
 
 ::Instana.logger.info "Booting instrumented gRPC server on port 50051 for tests."
 

data/test/{apps → support/apps/grpc}/grpc_server.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/test/{servers/rackapp_6511.rb → support/apps/http_endpoint/boot.rb}

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'rack/handler/puma'
 require 'rack/builder'
 require 'instana/rack'

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

@@ -1,22 +1,19 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
 
 ::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 +59,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

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 class Block < ActiveRecord::Base
   def do_work(*args)
     block = Block.first
@@ -7,7 +10,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/{models → support/apps/rails/models}/block6.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 class Block < ActiveRecord::Base
   def do_work(*args)
     block = Block.first

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

@@ -0,0 +1,5 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require_relative 'jobs/resque_error_job'
+require_relative 'jobs/resque_fast_job'

data/test/{jobs → support/apps/resque/jobs}/resque_error_job.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2018
+
 require "redis"
 require "net/http"
 

data/test/{jobs → support/apps/resque/jobs}/resque_fast_job.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2018
+
 require "redis"
 require "net/http"
 

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

@@ -0,0 +1,25 @@
+# Hook into sidekiq to control the current mode
+
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+$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/{jobs → support/apps/sidekiq/jobs}/sidekiq_job_1.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 class SidekiqJobOne
   include Sidekiq::Worker
 

data/test/{jobs → support/apps/sidekiq/jobs}/sidekiq_job_2.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 class SidekiqJobTwo
   include Sidekiq::Worker
 

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

@@ -1,10 +1,13 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'sidekiq/launcher'
 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,97 @@
+# frozen_string_literal: true
+
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+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