instana 2.0.0 → 2.1.0

data/test/instrumentation/rails_action_controller_test.rb

@@ -1,218 +0,0 @@
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2017
-
-require 'test_helper'
-
-class RailsActionControllerTest < Minitest::Test
-  include Rack::Test::Methods
-  begin
-    ENV['INSTANA_TEST'] = nil
-    APP = Rack::Builder.parse_file('test/support/apps/action_controller/config.ru')
-  ensure
-    ENV['INSTANA_TEST'] = 'true'
-  end
-  railties_version = Gem::Specification.find_by_name('railties').version
-  if railties_version < Gem::Version.new('7.1.0')
-    APP = APP.first
-  end
-
-  def app
-    APP
-  end
-
-  def test_config_defaults
-    assert ::Instana.config[:action_controller].is_a?(Hash)
-    assert ::Instana.config[:action_controller].key?(:enabled)
-    assert_equal true, ::Instana.config[:action_controller][:enabled]
-  end
-
-  def test_controller_reporting
-    clear_all!
-
-    get '/base/world'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    assert_equal 3, spans.length
-
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal "TestBaseController", ac_span[:data][:actioncontroller][:controller]
-    assert_equal "world", ac_span[:data][:actioncontroller][:action]
-  end
-
-  def test_controller_error
-    clear_all!
-
-    get '/base/error'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 2 + 1 or more error log depending on Rails version
-    assert spans.length >= 3
-
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal "TestBaseController", ac_span[:data][:actioncontroller][:controller]
-    assert_equal "error", ac_span[:data][:actioncontroller][:action]
-    assert ac_span.key?(:error)
-    assert ac_span.key?(:stack)
-    assert_equal "Warning: This is a simulated Error", ac_span[:data][:log][:message]
-    assert_equal "StandardError", ac_span[:data][:log][:parameters]
-  end
-
-  def test_api_controller_reporting
-    # Run only when ActionController::API is used/defined
-    skip unless defined?(::ActionController::API)
-
-    clear_all!
-
-    get '/api/world'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 2 + 1 or more error log depending on Rails version
-    assert spans.length >= 3
-
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal :actioncontroller, ac_span[:n]
-    assert_equal "TestApiController", ac_span[:data][:actioncontroller][:controller]
-    assert_equal "world", ac_span[:data][:actioncontroller][:action]
-  end
-
-  def test_api_controller_error
-    # Run only when ActionController::API is used/defined
-    skip unless defined?(::ActionController::API)
-
-    clear_all!
-
-    get '/api/error'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 2 + 1 or more error log depending on Rails version
-    assert spans.length >= 3
-
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal "TestApiController", ac_span[:data][:actioncontroller][:controller]
-    assert_equal "error", ac_span[:data][:actioncontroller][:action]
-    assert ac_span.key?(:error)
-    assert ac_span.key?(:stack)
-    assert_equal "Warning: This is a simulated Socket API Error", ac_span[:data][:log][:message]
-    assert_equal "StandardError", ac_span[:data][:log][:parameters]
-  end
-
-  def test_api_controller_not_found
-    # Run only when ActionController::API is used/defined
-    skip unless defined?(::ActionController::API)
-
-    clear_all!
-
-    get '/api/thispathdoesnotexist'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 1 + 1 or more error log depending on Rails version
-    assert spans.length >= 2
-
-    rack_span = find_first_span_by_name(spans, :rack)
-
-    assert_equal false, rack_span.key?(:error)
-    assert_equal "/api/thispathdoesnotexist", rack_span[:data][:http][:url]
-    assert_equal 404, rack_span[:data][:http][:status]
-    assert_equal "GET", rack_span[:data][:http][:method]
-  end
-
-  def test_api_controller_raise_routing_error
-    # Run only when ActionController::API is used/defined
-    skip unless defined?(::ActionController::API)
-
-    clear_all!
-
-    get '/api/raise_route_error'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-
-    # 2 + 1 or more error log depending on Rails version
-    assert spans.length >= 3
-
-    rack_span = find_first_span_by_name(spans, :rack)
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal false, rack_span.key?(:error)
-    assert_equal "/api/raise_route_error", rack_span[:data][:http][:url]
-    assert_equal 404, rack_span[:data][:http][:status]
-    assert_equal "GET", rack_span[:data][:http][:method]
-
-    assert_equal true, ac_span[:error]
-    assert ac_span.key?(:stack)
-    assert 1, ac_span[:ec]
-  end
-
-  def test_not_found
-    clear_all!
-
-    get '/base/404'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 1 + 1 or more error log depending on Rails version
-    assert spans.length >= 2
-
-    rack_span = find_first_span_by_name(spans, :rack)
-
-    assert_equal false, rack_span.key?(:error)
-    assert_equal 404, rack_span[:data][:http][:status]
-  end
-
-  def test_raise_routing_error
-    clear_all!
-
-    get '/base/raise_route_error'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    # 2 + 1 or more error log depending on Rails version
-    assert spans.length >= 3
-
-    rack_span = find_first_span_by_name(spans, :rack)
-    ac_span = find_first_span_by_name(spans, :actioncontroller)
-
-    assert_equal false, rack_span.key?(:error)
-    assert_equal 404, rack_span[:data][:http][:status]
-
-    assert_equal true, ac_span[:error]
-    assert ac_span.key?(:stack)
-    assert 1, ac_span[:ec]
-  end
-
-  def test_path_template
-    clear_all!
-
-    get '/base/world'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    rack_span = find_first_span_by_name(spans, :rack)
-
-    assert_equal false, rack_span.key?(:error)
-    assert_equal '/base/world(.:format)', rack_span[:data][:http][:path_tpl]
-  end
-
-  def test_log
-    clear_all!
-
-    get '/base/log_warning'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    assert spans[0][:data][:log]
-    log_span = spans[0][:data][:log]
-
-    assert_equal "Warn", log_span[:level]
-    assert_equal "This is a test warning", log_span[:message]
-  end
-end

data/test/instrumentation/rails_action_mailer_test.rb

@@ -1,66 +0,0 @@
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2021
-
-require 'test_helper'
-require 'action_mailer'
-
-class RailsActionMailerTest < Minitest::Test
-  class TestMailer < ActionMailer::Base
-    def sample_email
-      mail_version = Gem::Specification.find_by_name('mail').version
-      if mail_version >= Gem::Version.new('2.8.1')
-        Mail.new do
-          from 'test@example.com'
-          to 'test@example.com'
-          subject 'Test Email'
-          body 'Hello'
-          content_type "text/html"
-        end
-      else
-        mail(
-          from: 'test@example.com',
-          to: 'test@example.com',
-          subject: 'Test Email',
-          body: 'Hello',
-          content_type: "text/html"
-        )
-      end
-    end
-  end
-
-  def setup
-    TestMailer.delivery_method = :sendmail
-
-    clear_all!
-  end
-
-  def teardown
-    ::Instana.config[:allow_exit_as_root] = false
-  end
-
-  def test_mailer
-    Instana.tracer.in_span(:test) do
-      TestMailer.sample_email.deliver_now
-    end
-
-    mail_span, = *::Instana.processor.queued_spans
-
-    assert_equal :"mail.actionmailer", mail_span[:n]
-    assert_equal 'RailsActionMailerTest::TestMailer', mail_span[:data][:actionmailer][:class]
-    assert_equal 'sample_email', mail_span[:data][:actionmailer][:method]
-  end
-
-  def test_mailer_as_root_exit_span
-    ::Instana.config[:allow_exit_as_root] = true
-    TestMailer.sample_email.deliver_now
-    ::Instana.config[:allow_exit_as_root] = false
-
-    queued_spans = Instana.processor.queued_spans
-    assert_equal 1, queued_spans.length
-    mail_span = queued_spans[0]
-
-    assert_equal :"mail.actionmailer", mail_span[:n]
-    assert_equal 'RailsActionMailerTest::TestMailer', mail_span[:data][:actionmailer][:class]
-    assert_equal 'sample_email', mail_span[:data][:actionmailer][:method]
-  end
-end

data/test/instrumentation/rails_action_view_test.rb

@@ -1,154 +0,0 @@
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2021
-
-require 'test_helper'
-
-class RailsActionViewTest < Minitest::Test
-  include Rack::Test::Methods
-  APP = Rack::Builder.parse_file('test/support/apps/action_view/config.ru')
-  railties_version = Gem::Specification.find_by_name('railties').version
-  if railties_version < Gem::Version.new('7.1.0')
-    APP = APP.first
-  end
-
-  def app
-    APP
-  end
-
-  def setup
-    clear_all!
-  end
-
-  def test_config_defaults
-    assert ::Instana.config[:action_view].is_a?(Hash)
-    assert ::Instana.config[:action_view].key?(:enabled)
-    assert_equal true, ::Instana.config[:action_view][:enabled]
-  end
-
-  def test_render_view
-    get '/render_view'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'Default', span[:data][:actionview][:name]
-  end
-
-  def test_render_view_direct
-    get '/render_view_direct'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'Default', span[:data][:actionview][:name]
-  end
-
-  def test_render_nothing
-    # `render nothing: true` was removed in 5.1
-    skip unless Rails::VERSION::MAJOR <= 5 && Rails::VERSION::MINOR <= 1
-    get '/render_nothing'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'Nothing', span[:data][:actionview][:name]
-  end
-
-  def test_render_file
-    get '/render_file'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'test/support/apps/action_view/config.ru', span[:data][:actionview][:name]
-  end
-
-  def test_render_json
-    get '/render_json'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'JSON', span[:data][:actionview][:name]
-  end
-
-  def test_render_xml
-    get '/render_xml'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'XML', span[:data][:actionview][:name]
-  end
-
-  def test_render_body
-    get '/render_rawbody'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'Raw', span[:data][:actionview][:name]
-  end
-
-  def test_render_js
-    get '/render_js'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'Javascript', span[:data][:actionview][:name]
-  end
-
-  def test_render_alternate_layout
-    get '/render_alternate_layout'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :actionview)
-
-    assert_equal 'layouts/mobile', span[:data][:actionview][:name]
-  end
-
-  def test_render_partial
-    get '/render_partial'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :render)
-
-    assert_equal 'message', span[:data][:render][:name]
-  end
-
-  def test_render_partial_that_errors
-    get '/render_partial_that_errors'
-    refute last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :render)
-
-    assert_equal :partial, span[:data][:render][:type]
-    assert_equal 'syntax_error', span[:data][:render][:name]
-    assert span[:data][:log].key?(:message)
-    assert span[:data][:log][:parameters].include?('SyntaxError')
-    assert span[:error]
-    assert span[:stack]
-  end
-
-  def test_render_collection
-    get '/render_collection'
-    assert last_response.ok?
-
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :render)
-    assert_equal :collection, span[:data][:render][:type]
-    assert_equal 'blocks/block', span[:data][:render][:name]
-  end
-end

data/test/instrumentation/rails_active_job_test.rb

@@ -1,65 +0,0 @@
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2021
-
-require 'test_helper'
-
-require 'rails'
-require 'active_job'
-
-class RailsActiveJobTest < Minitest::Test
-  class SampleJob < ActiveJob::Base
-    queue_as :test_queue
-
-    def perform(*args); end
-  end
-
-  def setup
-    @test_adapter = ActiveJob::Base.queue_adapter = ActiveJob::QueueAdapters::TestAdapter.new
-    ActiveJob::Base.logger = Logger.new('/dev/null')
-
-    clear_all!
-  end
-
-  def test_perform_now
-    SampleJob.perform_now("test_perform_now")
-    spans = ::Instana.processor.queued_spans
-
-    server_span, *rest = spans
-    assert_equal [], rest
-
-    assert_equal :activejob, server_span[:n]
-    assert_equal 'RailsActiveJobTest::SampleJob', server_span[:data][:activejob][:job]
-    assert_equal :perform, server_span[:data][:activejob][:action]
-    assert_equal 'test_queue', server_span[:data][:activejob][:queue]
-  end
-
-  def test_enqueue_perform
-    # ActiveJob::QueueAdapters::TestAdapter.new doesn't work for this test on any version less than 6
-    skip unless Rails::VERSION::MAJOR >= 6
-
-    Instana.tracer.in_span(:peform_test) do
-      SampleJob.perform_later("test_enqueue_perform")
-    end
-
-    job, *rest_jobs = @test_adapter.enqueued_jobs
-    assert_equal [], rest_jobs
-
-    ActiveJob::Base.execute(job)
-
-    spans = ::Instana.processor.queued_spans
-    client_span, _test_span, server_span, *rest = spans
-    assert_equal [], rest
-
-    assert_equal :activejob, server_span[:n]
-    assert_equal 'RailsActiveJobTest::SampleJob', server_span[:data][:activejob][:job]
-    assert_equal :perform, server_span[:data][:activejob][:action]
-
-    assert_equal :activejob, client_span[:n]
-    assert_equal 'RailsActiveJobTest::SampleJob', client_span[:data][:activejob][:job]
-    assert_equal :enqueue, client_span[:data][:activejob][:action]
-    assert_equal 'test_queue', server_span[:data][:activejob][:queue]
-
-    assert_equal client_span[:t], server_span[:t]
-    assert_equal client_span[:s], server_span[:p]
-  end
-end

data/test/instrumentation/rails_active_record_database_missing_test.rb

@@ -1,44 +0,0 @@
-# (c) Copyright IBM Corp. 2021
-# (c) Copyright Instana Inc. 2021
-
-require 'test_helper'
-require 'support/apps/active_record/active_record'
-require 'fileutils'
-
-class RailsActiveRecordDatabaseMissingTest < Minitest::Test
-  def setup
-    skip unless ENV['DATABASE_URL']
-    clear_all!
-    @old_url = ENV['DATABASE_URL']
-    SQLite3::Database.new('/tmp/test.db')
-    ENV['DATABASE_URL'] = 'sqlite3:///tmp/test.db'
-
-    @connection_pool = ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
-    c = ::ActiveRecord::Base.connection
-    c.execute 'PRAGMA journal_mode=DELETE'
-    c.execute 'PRAGMA locking_mode=NORMAL'
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.run(CreateBlocks, direction: :up)
-    end
-  end
-
-  def teardown
-    @connection_pool.disconnect
-    ENV['DATABASE_URL'] = @old_url
-  end
-
-  def test_error_on_missing_database
-    assert_raises(ActiveRecord::StatementInvalid) do
-      Instana.tracer.in_span(:ar_test, attributes: {}) do
-        b = Block.new
-        FileUtils.rm('/tmp/test.db')
-        b.save!
-      end
-    end
-    spans = ::Instana.processor.queued_spans
-    span = find_first_span_by_name(spans, :activerecord)
-
-    assert_equal 1, span[:ec]
-    assert span[:data][:activerecord][:error].include?("SQLite3::ReadOnlyException: attempt to write a readonly database")
-  end
-end

data/test/instrumentation/rails_active_record_test.rb

@@ -1,116 +0,0 @@
-# (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
-    clear_all!
-    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
-  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
-    # clear_all!
-    Instana.tracer.in_span(:ar_test, attributes: {}) 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')
-  end
-
-  def test_read
-    Block.create(name: 'core', color: 'blue')
-    Instana.tracer.in_span(:ar_test, attributes: {}) 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')
-  end
-
-  def test_update
-    Block.create(name: 'core', color: 'blue')
-    b = Block.find_by(name: 'core')
-
-    Instana.tracer.in_span(:ar_test, attributes: {}) 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')
-  end
-
-  def test_delete
-    b = Block.create(name: 'core', color: 'blue')
-
-    Instana.tracer.in_span(:ar_test, attributes: {}) 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')
-  end
-
-  def test_raw
-    Instana.tracer.in_span(:ar_test, attributes: {}) 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.in_span(:ar_test, attributes: {}) 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