mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
3845832c20
* Check Config File Existence (#4054) * Check config file existence * Eager config file check * Parse expanded path to default sidekiq.yml config file in Rails app * Cleanup * Add minitest-around * Extract context from formatter * Add JSON logger formatter * Adjust job logger to handle elapsed time within context * Add tid test * Rename processor logger * Enforce global state reset in logging tests * Add warning about upcoming refactoring to Sidekiq::Logging * Replace around hook with explicit stub inside test It's implemented with fibers, which means Thread.current returns different values in JRuby. * Fix typo * Concise JSON formatter keys * Add logger_formatter option * Shift context from array of strings to hash Allows more flexibly format context in the different formatters. * Adjust warning message regarding context type change * Add "Formatter" suffix to classes * Fix CLI specs * Replace Sidekiq::Logging with Sidekiq::Logger * Namespace logger formatters * Remove rails 4 appraisal
351 lines
12 KiB
Ruby
351 lines
12 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative 'helper'
|
|
require 'sidekiq/cli'
|
|
|
|
class TestCLI < Minitest::Test
|
|
describe Sidekiq::CLI do
|
|
subject { Sidekiq::CLI.new }
|
|
|
|
let(:logdev) { StringIO.new }
|
|
|
|
around do |test|
|
|
Sidekiq.stub :options, Sidekiq::DEFAULTS.dup do
|
|
Sidekiq.stub :logger, Sidekiq::Logger.new(logdev) do
|
|
test.call
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#parse' do
|
|
describe 'options' do
|
|
describe 'require' do
|
|
it 'accepts with -r' do
|
|
subject.parse(%w[sidekiq -r ./test/fake_env.rb])
|
|
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
end
|
|
end
|
|
|
|
describe 'concurrency' do
|
|
it 'accepts with -c' do
|
|
subject.parse(%w[sidekiq -c 60 -r ./test/fake_env.rb])
|
|
|
|
assert_equal 60, Sidekiq.options[:concurrency]
|
|
end
|
|
|
|
describe 'when concurrency is empty and RAILS_MAX_THREADS env var is set' do
|
|
before do
|
|
ENV['RAILS_MAX_THREADS'] = '9'
|
|
end
|
|
|
|
after do
|
|
ENV.delete('RAILS_MAX_THREADS')
|
|
end
|
|
|
|
it 'sets concurrency from RAILS_MAX_THREADS env var' do
|
|
subject.parse(%w[sidekiq -r ./test/fake_env.rb])
|
|
|
|
assert_equal 9, Sidekiq.options[:concurrency]
|
|
end
|
|
|
|
it 'option overrides RAILS_MAX_THREADS env var' do
|
|
subject.parse(%w[sidekiq -c 60 -r ./test/fake_env.rb])
|
|
|
|
assert_equal 60, Sidekiq.options[:concurrency]
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'queues' do
|
|
it 'accepts with -q' do
|
|
subject.parse(%w[sidekiq -q foo -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['foo'], Sidekiq.options[:queues]
|
|
end
|
|
|
|
describe 'when weights are not present' do
|
|
it 'accepts queues without weights' do
|
|
subject.parse(%w[sidekiq -q foo -q bar -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['foo', 'bar'], Sidekiq.options[:queues]
|
|
end
|
|
|
|
it 'sets strictly ordered queues' do
|
|
subject.parse(%w[sidekiq -q foo -q bar -r ./test/fake_env.rb])
|
|
|
|
assert_equal true, !!Sidekiq.options[:strict]
|
|
end
|
|
end
|
|
|
|
describe 'when weights are present' do
|
|
it 'accepts queues with weights' do
|
|
subject.parse(%w[sidekiq -q foo,3 -q bar -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['foo', 'foo', 'foo', 'bar'], Sidekiq.options[:queues]
|
|
end
|
|
|
|
it 'does not set strictly ordered queues' do
|
|
subject.parse(%w[sidekiq -q foo,3 -q bar -r ./test/fake_env.rb])
|
|
|
|
assert_equal false, !!Sidekiq.options[:strict]
|
|
end
|
|
end
|
|
|
|
it 'accepts queues with multi-word names' do
|
|
subject.parse(%w[sidekiq -q queue_one -q queue-two -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['queue_one', 'queue-two'], Sidekiq.options[:queues]
|
|
end
|
|
|
|
it 'accepts queues with dots in the name' do
|
|
subject.parse(%w[sidekiq -q foo.bar -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['foo.bar'], Sidekiq.options[:queues]
|
|
end
|
|
|
|
describe 'when duplicate queue names' do
|
|
it 'raises an argument error' do
|
|
assert_raises(ArgumentError) { subject.parse(%w[sidekiq -q foo -q foo -r ./test/fake_env.rb]) }
|
|
assert_raises(ArgumentError) { subject.parse(%w[sidekiq -q foo,3 -q foo,1 -r ./test/fake_env.rb]) }
|
|
end
|
|
end
|
|
|
|
describe 'when queues are empty' do
|
|
it "sets 'default' queue" do
|
|
subject.parse(%w[sidekiq -r ./test/fake_env.rb])
|
|
|
|
assert_equal ['default'], Sidekiq.options[:queues]
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'timeout' do
|
|
it 'accepts with -t' do
|
|
subject.parse(%w[sidekiq -t 30 -r ./test/fake_env.rb])
|
|
|
|
assert_equal 30, Sidekiq.options[:timeout]
|
|
end
|
|
end
|
|
|
|
describe 'verbose' do
|
|
it 'accepts with -v' do
|
|
subject.parse(%w[sidekiq -v -r ./test/fake_env.rb])
|
|
|
|
assert_equal Logger::DEBUG, Sidekiq.logger.level
|
|
end
|
|
end
|
|
|
|
describe 'config file' do
|
|
it 'accepts with -C' do
|
|
subject.parse(%w[sidekiq -C ./test/config.yml])
|
|
|
|
assert_equal './test/config.yml', Sidekiq.options[:config_file]
|
|
refute Sidekiq.options[:verbose]
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
assert_nil Sidekiq.options[:environment]
|
|
assert_equal 50, Sidekiq.options[:concurrency]
|
|
assert_equal 2, Sidekiq.options[:queues].count { |q| q == 'very_often' }
|
|
assert_equal 1, Sidekiq.options[:queues].count { |q| q == 'seldom' }
|
|
end
|
|
|
|
it 'accepts stringy keys' do
|
|
subject.parse(%w[sidekiq -C ./test/config_string.yml])
|
|
|
|
assert_equal './test/config_string.yml', Sidekiq.options[:config_file]
|
|
refute Sidekiq.options[:verbose]
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
assert_nil Sidekiq.options[:environment]
|
|
assert_equal 50, Sidekiq.options[:concurrency]
|
|
assert_equal 2, Sidekiq.options[:queues].count { |q| q == 'very_often' }
|
|
assert_equal 1, Sidekiq.options[:queues].count { |q| q == 'seldom' }
|
|
end
|
|
|
|
it 'accepts environment specific config' do
|
|
subject.parse(%w[sidekiq -e staging -C ./test/config_environment.yml])
|
|
|
|
assert_equal './test/config_environment.yml', Sidekiq.options[:config_file]
|
|
refute Sidekiq.options[:verbose]
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
assert_equal 'staging', Sidekiq.options[:environment]
|
|
assert_equal 50, Sidekiq.options[:concurrency]
|
|
assert_equal 2, Sidekiq.options[:queues].count { |q| q == 'very_often' }
|
|
assert_equal 1, Sidekiq.options[:queues].count { |q| q == 'seldom' }
|
|
end
|
|
|
|
describe 'when config file is empty' do
|
|
it 'sets default options' do
|
|
subject.parse(%w[sidekiq -C ./test/config_empty.yml -r ./test/fake_env.rb])
|
|
|
|
assert_equal './test/config_empty.yml', Sidekiq.options[:config_file]
|
|
refute Sidekiq.options[:verbose]
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
assert_nil Sidekiq.options[:environment]
|
|
assert_equal 10, Sidekiq.options[:concurrency]
|
|
assert_equal ['default'], Sidekiq.options[:queues]
|
|
end
|
|
end
|
|
|
|
describe 'when config file and flags' do
|
|
it 'merges options' do
|
|
subject.parse(%w[sidekiq -C ./test/config.yml
|
|
-e snoop
|
|
-c 100
|
|
-r ./test/fake_env.rb
|
|
-q often,7
|
|
-q seldom,3])
|
|
|
|
assert_equal './test/config.yml', Sidekiq.options[:config_file]
|
|
refute Sidekiq.options[:verbose]
|
|
assert_equal './test/fake_env.rb', Sidekiq.options[:require]
|
|
assert_equal 'snoop', Sidekiq.options[:environment]
|
|
assert_equal 100, Sidekiq.options[:concurrency]
|
|
assert_equal 7, Sidekiq.options[:queues].count { |q| q == 'often' }
|
|
assert_equal 3, Sidekiq.options[:queues].count { |q| q == 'seldom' }
|
|
end
|
|
end
|
|
|
|
describe 'default config file' do
|
|
describe 'when required path is a directory' do
|
|
it 'tries config/sidekiq.yml' do
|
|
subject.parse(%w[sidekiq -r ./test/dummy])
|
|
|
|
assert_equal 'sidekiq.yml', File.basename(Sidekiq.options[:config_file])
|
|
assert_equal 25, Sidekiq.options[:concurrency]
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'validation' do
|
|
describe 'when required application path does not exist' do
|
|
it 'exits with status 1' do
|
|
exit = assert_raises(SystemExit) { subject.parse(%w[sidekiq -r /non/existent/path]) }
|
|
assert_equal 1, exit.status
|
|
end
|
|
end
|
|
|
|
describe 'when required path is a directory without config/application.rb' do
|
|
it 'exits with status 1' do
|
|
exit = assert_raises(SystemExit) { subject.parse(%w[sidekiq -r ./test/fixtures]) }
|
|
assert_equal 1, exit.status
|
|
end
|
|
|
|
describe 'when config file path does not exist' do
|
|
it 'raises argument error' do
|
|
assert_raises(ArgumentError) do
|
|
subject.parse(%w[sidekiq -r ./test/fake_env.rb -C /non/existent/path])
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#run' do
|
|
before do
|
|
Sidekiq.options[:require] = './test/fake_env.rb'
|
|
end
|
|
|
|
describe 'require workers' do
|
|
describe 'when path is a rails directory' do
|
|
before do
|
|
Sidekiq.options[:require] = './test/dummy'
|
|
subject.environment = 'test'
|
|
end
|
|
|
|
it 'requires sidekiq railtie and rails application with environment' do
|
|
subject.stub(:launch, nil) do
|
|
subject.run
|
|
end
|
|
|
|
assert defined?(Sidekiq::Rails)
|
|
assert defined?(Dummy::Application)
|
|
end
|
|
|
|
it 'tags with the app directory name' do
|
|
subject.stub(:launch, nil) do
|
|
subject.run
|
|
end
|
|
|
|
assert_equal 'dummy', Sidekiq.options[:tag]
|
|
end
|
|
end
|
|
|
|
describe 'when path is file' do
|
|
it 'requires application' do
|
|
subject.stub(:launch, nil) do
|
|
subject.run
|
|
end
|
|
|
|
assert $LOADED_FEATURES.any? { |x| x =~ /test\/fake_env/ }
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'when development environment and stdout tty' do
|
|
it 'prints banner' do
|
|
subject.stub(:environment, 'development') do
|
|
assert_output(/#{Regexp.escape(Sidekiq::CLI.banner)}/) do
|
|
$stdout.stub(:tty?, true) do
|
|
subject.stub(:launch, nil) do
|
|
subject.run
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'signal handling' do
|
|
%w(INT TERM).each do |sig|
|
|
describe sig do
|
|
it 'raises interrupt error' do
|
|
assert_raises Interrupt do
|
|
subject.handle_signal(sig)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
%w(TSTP USR1).each do |sig|
|
|
describe sig do
|
|
it 'quiets with a corresponding event' do
|
|
quiet = false
|
|
|
|
Sidekiq.on(:quiet) do
|
|
quiet = true
|
|
end
|
|
|
|
subject.launcher = Sidekiq::Launcher.new(Sidekiq.options)
|
|
subject.handle_signal(sig)
|
|
|
|
assert_match(/Got #{sig} signal/, logdev.string)
|
|
assert_equal true, quiet
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'TTIN' do
|
|
it 'prints backtraces for all threads in the process to the logfile' do
|
|
subject.handle_signal('TTIN')
|
|
|
|
assert_match(/Got TTIN signal/, logdev.string)
|
|
assert_match(/\bbacktrace\b/, logdev.string)
|
|
end
|
|
end
|
|
|
|
describe 'UNKNOWN' do
|
|
it 'logs about' do
|
|
# subject.parse(%w[sidekiq -r ./test/fake_env.rb])
|
|
subject.handle_signal('UNKNOWN')
|
|
|
|
assert_match(/Got UNKNOWN signal/, logdev.string)
|
|
assert_match(/No signal handler for UNKNOWN/, logdev.string)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|