instana 1.10.1-java

data/test/servers/rails_3205.rb

@@ -0,0 +1,167 @@
+
+::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 'rack/handler/puma'
+require File.expand_path(File.dirname(__FILE__) + '/../models/block')
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'blocks'
+  if Rails::VERSION::STRING < '4.0'
+    CreateBlocks.migrate(:up)
+  else
+    ActiveRecord::Migration.run(CreateBlocks)
+  end
+end
+
+class RailsTestApp < Rails::Application
+  routes.append do
+    get "/test/world"              => "test#world"
+    get "/test/db"                 => "test#db"
+    get "/test/error"              => "test#error"
+    get "/test/render_view"        => "test#render_view"
+    get "/test/render_partial"     => "test#render_partial"
+    get "/test/render_collection"  => "test#render_collection"
+    get "/test/render_file"        => "test#render_file"
+    get "/test/render_nothing"     => "test#render_nothing"
+    get "/test/render_json"        => "test#render_json"
+    get "/test/render_xml"         => "test#render_xml"
+    get "/test/render_rawbody"     => "test#render_rawbody"
+    get "/test/render_js"          => "test#render_js"
+    get "/test/render_alternate_layout"        => "test#render_alternate_layout"
+    get "/test/render_partial_that_errors"     => "test#render_partial_that_errors"
+
+    get "/api/world" => "socket#world"
+    get "/api/error" => "socket#error"
+  end
+
+  # Enable cache classes. Production style.
+  config.cache_classes = true
+  config.eager_load = false
+
+  # uncomment below to display errors
+  # config.consider_all_requests_local = true
+
+  config.paths['app/views'].unshift(File.expand_path(File.dirname(__FILE__) + '/../views'))
+
+  config.active_support.deprecation = :stderr
+
+  config.middleware.delete Rack::Lock
+  config.middleware.delete ActionDispatch::Flash
+
+  # We need a secret token for session, cookies, etc.
+  config.secret_token = "doesntneedtobesecurefortests"
+  config.secret_key_base = "blueredaquarossoseven"
+end
+
+class TestController < ActionController::Base
+  def world
+    if ::Rails::VERSION::MAJOR > 4
+      render :plain => "Hello test world!"
+    else
+      render :text => "Hello test world!"
+    end
+  end
+
+  def db
+    white_block = Block.new(:name => 'Part #28349', :color => 'White')
+    white_block.save
+    found = Block.where(:name => 'Part #28349').first
+    found.delete
+
+    if ::Rails::VERSION::MAJOR > 4
+      render :plain => "Hello test db!"
+    else
+      render :text => "Hello test db!"
+    end
+  end
+
+  def render_view
+    @message = "Hello Instana!"
+  end
+
+  def render_partial
+    @message = "Hello Instana!"
+  end
+
+  def render_partial_that_errors
+    @message = "Hello Instana!"
+  end
+
+  def render_collection
+    @blocks = Block.all
+  end
+
+  def render_file
+    @message = "Hello Instana!"
+    render :file => '/etc/issue'
+  end
+
+  def render_alternate_layout
+    @message = "Hello Instana!"
+    render :layout => 'layouts/mobile'
+  end
+
+  def render_nothing
+    @message = "Hello Instana!"
+    render :nothing => true
+  end
+
+  def render_json
+    @message = "Hello Instana!"
+    render :json => @message
+  end
+
+  def render_xml
+    @message = "Hello Instana!"
+    render :xml => @message
+  end
+
+  def render_rawbody
+    @message = "Hello Instana!"
+    render :body => 'raw body output'
+  end
+
+  def render_js
+    @message = "Hello Instana!"
+    render :js => @message
+  end
+
+  def error
+    raise Exception.new("Warning: This is a simulated Error")
+  end
+end
+
+if ::Rails::VERSION::MAJOR > 4
+  class SocketController < ActionController::API
+    def world
+      if ::Rails::VERSION::MAJOR > 4
+        render :plain => "Hello api world!"
+      else
+        render :text => "Hello api world!"
+      end
+    end
+
+    def error
+      raise Exception.new("Warning: This is a simulated Socket API Error")
+    end
+  end
+end
+
+RailsTestApp.initialize!
+
+# Initialize some blocks so we have stuff to test against.
+Block.new(:name => :corner, :color => :blue).save
+Block.new(:name => :floor, :color => :green).save
+
+Thread.new do
+  Rack::Handler::Puma.run(RailsTestApp.to_app, {:Host => '127.0.0.1', :Port => 3205})
+end
+
+sleep(1)

data/test/servers/sidekiq/worker.rb

@@ -0,0 +1,27 @@
+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'
+
+::Instana.logger.info "Booting instrumented sidekiq worker for tests."
+::Sidekiq.logger.level = ::Logger::FATAL
+
+sidekiq_thread = Thread.new do
+  launcher = ::Sidekiq::Launcher.new(
+    ::Sidekiq.options.merge(
+      queues: ['important'],
+      concurrency: 2
+    )
+  )
+  launcher.run
+  Thread.current[:worker] = launcher
+end
+
+Minitest.after_run do
+  ::Instana.logger.info "Killing Sidekiq worker"
+  sidekiq_thread[:worker].stop
+  sleep 1
+end

data/test/test_helper.rb

@@ -0,0 +1,145 @@
+$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
+
+# 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)
+
+# Boot background webservers to test against.
+require "./test/servers/rackapp_6511"
+
+case File.basename(ENV['BUNDLE_GEMFILE'])
+when /rails50|rails42|rails32/
+  require './test/servers/rails_3205'
+when /libraries/
+  # Configure gRPC
+  require './test/servers/grpc_50051.rb'
+
+  # Hook into sidekiq to control the current mode
+  $sidekiq_mode = :client
+  class << Sidekiq
+    def server?
+      $sidekiq_mode == :server
+    end
+  end
+
+  ENV['I_REDIS_URL'] ||= 'redis://127.0.0.1:6379'
+
+  # Configure redis for sidekiq client
+  Sidekiq.configure_client do |config|
+    config.redis = { url: ENV['I_REDIS_URL'] }
+  end
+
+  # Configure redis for sidekiq worker
+  $sidekiq_mode = :server
+  ::Sidekiq.configure_server do |config|
+    config.redis = { url: ENV['I_REDIS_URL'] }
+  end
+  $sidekiq_mode = :client
+
+  require './test/servers/sidekiq/worker'
+end
+
+if defined?(::Redis)
+  $redis = Redis.new(url: ENV['I_REDIS_URL'])
+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!
+  $redis.flushall if $redis
+  nil
+end
+
+def disable_redis_instrumentation
+  ::Redis::Client.class_eval do
+    alias call call_without_instana
+    alias call_pipeline call_pipeline_without_instana
+  end
+end
+
+def enable_redis_instrumentation
+  ::Redis::Client.class_eval do
+    alias call call_with_instana
+    alias call_pipeline call_pipeline_with_instana
+  end
+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
+
+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
+
+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
+
+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

data/test/tracing/custom_test.rb

@@ -0,0 +1,158 @@
+require 'test_helper'
+
+class CustomTracingTest < Minitest::Test
+  def test_custom_tracing
+    clear_all!
+
+    assert_equal false, ::Instana.tracer.tracing?
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:custom_trace, {:one => 1})
+    assert_equal true, ::Instana.tracer.tracing?
+    ::Instana.tracer.log_info({:info_logged => 1})
+    # End tracing
+    ::Instana.tracer.log_end(:custom_trace, {:close_one => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.length
+
+    first_span = spans.first
+    assert_equal :sdk, first_span[:n]
+
+    assert first_span[:ts].is_a?(Integer)
+    assert first_span[:ts] > 0
+    assert first_span[:d].is_a?(Integer)
+    assert first_span[:d].between?(0, 5)
+
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:sdk)
+    assert first_span[:data][:sdk].key?(:custom)
+    assert first_span[:data][:sdk][:custom].key?(:tags)
+    assert_equal :custom_trace, first_span[:data][:sdk][:name]
+    assert_equal 1, first_span[:data][:sdk][:custom][:tags][:one]
+
+    assert first_span.key?(:f)
+    assert first_span[:f].key?(:e)
+    assert first_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+  end
+
+  def test_custom_tracing_with_args
+    clear_all!
+    assert_equal false, ::Instana.tracer.tracing?
+
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:rack, :on_trace_start => 1)
+    assert_equal true, ::Instana.tracer.tracing?
+
+    kvs = {}
+    kvs[:on_entry_kv] = 1
+    kvs[:arguments] = [[1,2,3], "test_arg", :ok]
+    kvs[:return] = true
+
+    ::Instana.tracer.log_entry(:custom_span, kvs)
+    ::Instana.tracer.log_info({:on_info_kv => 1})
+    ::Instana.tracer.log_exit(:custom_span, :on_exit_kv => 1)
+
+    # End tracing
+    ::Instana.tracer.log_end(:rack, {:on_trace_end => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+
+    first_span = find_first_span_by_name(spans, :rack)
+    second_span = find_first_span_by_name(spans, :custom_span)
+
+    assert first_span[:ts].is_a?(Integer)
+    assert first_span[:ts] > 0
+    assert first_span[:d].is_a?(Integer)
+    assert first_span[:d].between?(0, 5)
+
+    assert_equal :rack, first_span[:n]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:on_trace_start)
+    assert_equal 1, first_span[:data][:on_trace_start]
+    assert first_span[:data].key?(:on_trace_end)
+    assert_equal 1, first_span[:data][:on_trace_end]
+
+    assert_equal :sdk, second_span[:n]
+    assert second_span.key?(:data)
+    assert second_span[:data].key?(:sdk)
+    assert second_span[:data][:sdk].key?(:custom)
+    assert second_span[:data][:sdk][:custom].key?(:tags)
+    assert :custom_span, second_span[:data][:sdk][:name]
+    assert :unknown, second_span[:data][:sdk][:type]
+    assert [[1, 2, 3], "test_arg", :ok], second_span[:data][:sdk][:arguments]
+    assert true, second_span[:data][:sdk][:return]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_entry_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_info_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_exit_kv]
+  end
+
+  def test_custom_tracing_with_error
+    clear_all!
+    assert_equal false, ::Instana.tracer.tracing?
+
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:rack, :on_trace_start => 1)
+    assert_equal true, ::Instana.tracer.tracing?
+
+    begin
+      kvs = {}
+      kvs[:on_entry_kv] = 1
+      kvs[:arguments] = [[1,2,3], "test_arg", :ok]
+      kvs[:return] = true
+
+      ::Instana.tracer.log_entry(:custom_span, kvs)
+      raise "custom tracing error.  This is only a test"
+      ::Instana.tracer.log_info({:on_info_kv => 1})
+    rescue => e
+      ::Instana.tracer.log_error(e)
+    ensure
+      ::Instana.tracer.log_exit(:custom_span, :on_exit_kv => 1)
+    end
+    ::Instana.tracer.log_end(:rack, {:on_trace_end => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 2, spans.length
+
+    first_span = find_first_span_by_name(spans, :rack)
+    second_span = find_first_span_by_name(spans, :custom_span)
+
+    assert first_span[:ts].is_a?(Integer)
+    assert first_span[:ts] > 0
+    assert first_span[:d].is_a?(Integer)
+    assert first_span[:d].between?(0, 5)
+
+    assert_equal :rack, first_span[:n]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:on_trace_start)
+    assert_equal 1, first_span[:data][:on_trace_start]
+    assert first_span[:data].key?(:on_trace_end)
+    assert_equal 1, first_span[:data][:on_trace_end]
+
+    assert second_span[:ts].is_a?(Integer)
+    assert second_span[:ts] > 0
+    assert second_span[:d].is_a?(Integer)
+    assert second_span[:d].between?(0, 5)
+
+    assert_equal :sdk, second_span[:n]
+    assert second_span.key?(:data)
+    assert second_span[:data].key?(:sdk)
+    assert second_span[:data][:sdk].key?(:custom)
+    assert second_span[:data][:sdk][:custom].key?(:tags)
+    assert :custom_span, second_span[:data][:sdk][:name]
+    assert :unknown, second_span[:data][:sdk][:type]
+    assert [[1, 2, 3], "test_arg", :ok], second_span[:data][:sdk][:arguments]
+    assert true, second_span[:data][:sdk][:return]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_entry_kv]
+    assert !second_span[:data][:sdk][:custom][:tags].key?(:on_info_kv)
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_exit_kv]
+
+    # Check the error
+    assert_equal true, second_span[:error]
+    assert_equal 1, second_span[:ec]
+  end
+end