# encoding: utf-8 # This file is distributed under New Relic's license terms. # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details. # https://newrelic.atlassian.net/browse/RUBY-775 require File.join(File.dirname(__FILE__), "sidekiq_server") SidekiqServer.instance.run # Important to require after Sidekiq server starts for middleware to install require 'newrelic_rpm' require 'logger' require 'stringio' require 'fake_collector' require 'multiverse_helpers' require File.join(File.dirname(__FILE__), "test_worker") require File.join(File.dirname(__FILE__), "..", "..", "..", "agent_helper") class SidekiqTest < Minitest::Test JOB_COUNT = 5 ROLLUP_METRIC = 'OtherTransaction/SidekiqJob/all' TRANSACTION_NAME = 'OtherTransaction/SidekiqJob/TestWorker/perform' DELAYED_TRANSACTION_NAME = 'OtherTransaction/SidekiqJob/TestWorker/record' DELAYED_FAILED_TXN_NAME = 'OtherTransaction/SidekiqJob/Sidekiq::Extensions::DelayedClass/perform' include MultiverseHelpers setup_and_teardown_agent do TestWorker.register_signal('jobs_completed') @sidekiq_log = ::StringIO.new string_logger = ::Logger.new(@sidekiq_log) string_logger.formatter = Sidekiq.logger.formatter Sidekiq.logger = string_logger end def teardown teardown_agent if !passed? || ENV["VERBOSE"] @sidekiq_log.rewind puts @sidekiq_log.read end end def run_jobs run_and_transmit do |i| TestWorker.perform_async('jobs_completed', i + 1) end end def run_delayed run_and_transmit do |i| TestWorker.delay(:queue => SidekiqServer.instance.queue_name).record('jobs_completed', i + 1) end end def run_and_transmit with_config(:'transaction_tracer.transaction_threshold' => 0.0) do TestWorker.run_jobs(JOB_COUNT) do |i| yield i end end NewRelic::Agent.instance.send(:transmit_data) end def test_delayed run_delayed assert_metric_and_call_count(ROLLUP_METRIC, JOB_COUNT) assert_metric_and_call_count(DELAYED_TRANSACTION_NAME, JOB_COUNT) end def test_delayed_with_malformed_yaml YAML.stubs(:load).raises(RuntimeError.new("Ouch")) run_delayed assert_metric_and_call_count(ROLLUP_METRIC, JOB_COUNT) assert_metric_and_call_count(DELAYED_FAILED_TXN_NAME, JOB_COUNT) end def test_all_jobs_ran run_jobs completed_jobs = Set.new(TestWorker.records_for('jobs_completed').map(&:to_i)) expected_completed_jobs = Set.new((1..JOB_COUNT).to_a) assert_equal(expected_completed_jobs, completed_jobs) end def test_agent_posts_correct_metric_data run_jobs assert_metric_and_call_count(ROLLUP_METRIC, JOB_COUNT) assert_metric_and_call_count(TRANSACTION_NAME, JOB_COUNT) end def test_doesnt_capture_args_by_default run_jobs assert_no_params_on_jobs end def test_isnt_influenced_by_global_capture_params with_config(:capture_params => true) do run_jobs end assert_no_params_on_jobs end def test_agent_posts_captured_args_to_job with_config(:'sidekiq.capture_params' => true) do run_jobs end transaction_samples = $collector.calls_for('transaction_sample_data') refute transaction_samples.empty?, "Expected a transaction trace" transaction_samples.each do |post| post.samples.each do |sample| assert_equal sample.metric_name, TRANSACTION_NAME, "Huh, that transaction shouldn't be in there!" args = sample.tree.custom_params["job_arguments"] assert_equal args.length, 2 assert_equal args[0], "jobs_completed" end end end def assert_metric_and_call_count(name, expected_call_count) metric_data = $collector.calls_for('metric_data') assert_equal(1, metric_data.size, "expected exactly one metric_data post from agent") metric = metric_data.first.metrics.find { |m| m[0]['name'] == name } assert(metric, "Could not find metric named #{name}. Did have metrics:\n"+ metric_data.first.metrics.map{|m| m[0]['name']}.join("\t\n")) call_count = metric[1][0] assert_equal(expected_call_count, call_count) end def assert_no_params_on_jobs transaction_samples = $collector.calls_for('transaction_sample_data') refute transaction_samples.empty?, "Didn't find any transaction samples!" transaction_samples.each do |post| post.samples.each do |sample| assert_equal sample.metric_name, TRANSACTION_NAME, "Huh, that transaction shouldn't be in there!" assert_nil sample.tree.custom_params["job_arguments"] end end end end