1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
|
# frozen_string_literal: true
require_relative 'helper'
require 'sidekiq/api'
require 'active_job'
require 'action_mailer'
class TestApi < Sidekiq::Test
describe 'api' do
before do
Sidekiq.redis {|c| c.flushdb }
end
describe "stats" do
it "is initially zero" do
s = Sidekiq::Stats.new
assert_equal 0, s.processed
assert_equal 0, s.failed
assert_equal 0, s.enqueued
end
describe "processed" do
it "returns number of processed jobs" do
Sidekiq.redis { |conn| conn.set("stat:processed", 5) }
s = Sidekiq::Stats.new
assert_equal 5, s.processed
end
end
describe "failed" do
it "returns number of failed jobs" do
Sidekiq.redis { |conn| conn.set("stat:failed", 5) }
s = Sidekiq::Stats.new
assert_equal 5, s.failed
end
end
describe "reset" do
before do
Sidekiq.redis do |conn|
conn.set('stat:processed', 5)
conn.set('stat:failed', 10)
end
end
it 'will reset all stats by default' do
Sidekiq::Stats.new.reset
s = Sidekiq::Stats.new
assert_equal 0, s.failed
assert_equal 0, s.processed
end
it 'can reset individual stats' do
Sidekiq::Stats.new.reset('failed')
s = Sidekiq::Stats.new
assert_equal 0, s.failed
assert_equal 5, s.processed
end
it 'can accept anything that responds to #to_s' do
Sidekiq::Stats.new.reset(:failed)
s = Sidekiq::Stats.new
assert_equal 0, s.failed
assert_equal 5, s.processed
end
it 'ignores anything other than "failed" or "processed"' do
Sidekiq::Stats.new.reset((1..10).to_a, ['failed'])
s = Sidekiq::Stats.new
assert_equal 0, s.failed
assert_equal 5, s.processed
end
end
describe "queues" do
it "is initially empty" do
s = Sidekiq::Stats::Queues.new
assert_equal 0, s.lengths.size
end
it "returns a hash of queue and size in order" do
Sidekiq.redis do |conn|
conn.rpush 'queue:foo', '{}'
conn.sadd 'queues', 'foo'
3.times { conn.rpush 'queue:bar', '{}' }
conn.sadd 'queues', 'bar'
end
s = Sidekiq::Stats::Queues.new
assert_equal ({ "foo" => 1, "bar" => 3 }), s.lengths
assert_equal "bar", s.lengths.first.first
assert_equal Sidekiq::Stats.new.queues, Sidekiq::Stats::Queues.new.lengths
end
end
describe "enqueued" do
it "returns total enqueued jobs" do
Sidekiq.redis do |conn|
conn.rpush 'queue:foo', '{}'
conn.sadd 'queues', 'foo'
3.times { conn.rpush 'queue:bar', '{}' }
conn.sadd 'queues', 'bar'
end
s = Sidekiq::Stats.new
assert_equal 4, s.enqueued
end
end
describe "over time" do
before do
require 'active_support/core_ext/time/conversions'
@before = Time::DATE_FORMATS[:default]
Time::DATE_FORMATS[:default] = "%d/%m/%Y %H:%M:%S"
end
after do
Time::DATE_FORMATS[:default] = @before
end
describe "processed" do
it 'retrieves hash of dates' do
Sidekiq.redis do |c|
c.incrby("stat:processed:2012-12-24", 4)
c.incrby("stat:processed:2012-12-25", 1)
c.incrby("stat:processed:2012-12-26", 6)
c.incrby("stat:processed:2012-12-27", 2)
end
Time.stub(:now, Time.parse("2012-12-26 1:00:00 -0500")) do
s = Sidekiq::Stats::History.new(2)
assert_equal({ "2012-12-26" => 6, "2012-12-25" => 1 }, s.processed)
s = Sidekiq::Stats::History.new(3)
assert_equal({ "2012-12-26" => 6, "2012-12-25" => 1, "2012-12-24" => 4 }, s.processed)
s = Sidekiq::Stats::History.new(2, Date.parse("2012-12-25"))
assert_equal({ "2012-12-25" => 1, "2012-12-24" => 4 }, s.processed)
end
end
end
describe "failed" do
it 'retrieves hash of dates' do
Sidekiq.redis do |c|
c.incrby("stat:failed:2012-12-24", 4)
c.incrby("stat:failed:2012-12-25", 1)
c.incrby("stat:failed:2012-12-26", 6)
c.incrby("stat:failed:2012-12-27", 2)
end
Time.stub(:now, Time.parse("2012-12-26 1:00:00 -0500")) do
s = Sidekiq::Stats::History.new(2)
assert_equal ({ "2012-12-26" => 6, "2012-12-25" => 1 }), s.failed
s = Sidekiq::Stats::History.new(3)
assert_equal ({ "2012-12-26" => 6, "2012-12-25" => 1, "2012-12-24" => 4 }), s.failed
s = Sidekiq::Stats::History.new(2, Date.parse("2012-12-25"))
assert_equal ({ "2012-12-25" => 1, "2012-12-24" => 4 }), s.failed
end
end
end
end
end
describe 'with an empty database' do
it 'shows queue as empty' do
q = Sidekiq::Queue.new
assert_equal 0, q.size
assert_equal 0, q.latency
end
before do
ActiveJob::Base.queue_adapter = :sidekiq
ActiveJob::Base.logger = nil
class ApiMailer < ActionMailer::Base
def test_email(*)
end
end
class ApiJob < ActiveJob::Base
def perform(*)
end
end
end
class ApiWorker
include Sidekiq::Worker
end
it 'can enumerate jobs' do
q = Sidekiq::Queue.new
Time.stub(:now, Time.new(2012, 12, 26)) do
ApiWorker.perform_async(1, 'mike')
assert_equal ['TestApi::ApiWorker'], q.map(&:klass)
job = q.first
assert_equal 24, job.jid.size
assert_equal [1, 'mike'], job.args
assert_equal Time.new(2012, 12, 26), job.enqueued_at
end
assert q.latency > 10_000_000
q = Sidekiq::Queue.new('other')
assert_equal 0, q.size
end
it 'has no enqueued_at time for jobs enqueued in the future' do
job_id = ApiWorker.perform_in(100, 1, 'foo')
job = Sidekiq::ScheduledSet.new.find_job(job_id)
assert_nil job.enqueued_at
end
it 'unwraps delayed jobs' do
Sidekiq::Queue.delay.foo(1,2,3)
q = Sidekiq::Queue.new
x = q.first
assert_equal "Sidekiq::Queue.foo", x.display_class
assert_equal [1,2,3], x.display_args
end
it 'unwraps ActiveJob jobs' do
ApiJob.perform_later(1, 2, 3)
q = Sidekiq::Queue.new
x = q.first
assert_equal "TestApi::ApiJob", x.display_class
assert_equal [1,2,3], x.display_args
end
it 'unwraps ActionMailer jobs' do
ApiMailer.test_email(1, 2, 3).deliver_later
q = Sidekiq::Queue.new('mailers')
x = q.first
assert_equal "TestApi::ApiMailer#test_email", x.display_class
assert_equal [1,2,3], x.display_args
end
it 'has no enqueued_at time for jobs enqueued in the future' do
job_id = ApiWorker.perform_in(100, 1, 'foo')
job = Sidekiq::ScheduledSet.new.find_job(job_id)
assert_nil job.enqueued_at
end
it 'can delete jobs' do
q = Sidekiq::Queue.new
ApiWorker.perform_async(1, 'mike')
assert_equal 1, q.size
x = q.first
assert_equal "TestApi::ApiWorker", x.display_class
assert_equal [1,'mike'], x.display_args
assert_equal [true], q.map(&:delete)
assert_equal 0, q.size
end
it "can move scheduled job to queue" do
remain_id = ApiWorker.perform_in(100, 1, 'jason')
job_id = ApiWorker.perform_in(100, 1, 'jason')
job = Sidekiq::ScheduledSet.new.find_job(job_id)
q = Sidekiq::Queue.new
job.add_to_queue
queued_job = q.find_job(job_id)
refute_nil queued_job
assert_equal queued_job.jid, job_id
assert_nil Sidekiq::ScheduledSet.new.find_job(job_id)
refute_nil Sidekiq::ScheduledSet.new.find_job(remain_id)
end
it "handles multiple scheduled jobs when moving to queue" do
jids = Sidekiq::Client.push_bulk('class' => ApiWorker,
'args' => [[1, 'jason'], [2, 'jason']],
'at' => Time.now.to_f)
assert_equal 2, jids.size
(remain_id, job_id) = jids
job = Sidekiq::ScheduledSet.new.find_job(job_id)
q = Sidekiq::Queue.new
job.add_to_queue
queued_job = q.find_job(job_id)
refute_nil queued_job
assert_equal queued_job.jid, job_id
assert_nil Sidekiq::ScheduledSet.new.find_job(job_id)
refute_nil Sidekiq::ScheduledSet.new.find_job(remain_id)
end
it 'can find job by id in sorted sets' do
job_id = ApiWorker.perform_in(100, 1, 'jason')
job = Sidekiq::ScheduledSet.new.find_job(job_id)
refute_nil job
assert_equal job_id, job.jid
assert_in_delta job.latency, 0.0, 0.1
end
it 'can remove jobs when iterating over a sorted set' do
# scheduled jobs must be greater than SortedSet#each underlying page size
51.times do
ApiWorker.perform_in(100, 'aaron')
end
set = Sidekiq::ScheduledSet.new
set.map(&:delete)
assert_equal set.size, 0
end
it 'can remove jobs when iterating over a queue' do
# initial queue size must be greater than Queue#each underlying page size
51.times do
ApiWorker.perform_async(1, 'aaron')
end
q = Sidekiq::Queue.new
q.map(&:delete)
assert_equal q.size, 0
end
it 'can find job by id in queues' do
q = Sidekiq::Queue.new
job_id = ApiWorker.perform_async(1, 'jason')
job = q.find_job(job_id)
refute_nil job
assert_equal job_id, job.jid
end
it 'can clear a queue' do
q = Sidekiq::Queue.new
2.times { ApiWorker.perform_async(1, 'mike') }
q.clear
Sidekiq.redis do |conn|
refute conn.smembers('queues').include?('foo')
refute conn.exists('queue:foo')
end
end
it 'can fetch by score' do
same_time = Time.now.to_f
add_retry('bob1', same_time)
add_retry('bob2', same_time)
r = Sidekiq::RetrySet.new
assert_equal 2, r.fetch(same_time).size
end
it 'can fetch by score and jid' do
same_time = Time.now.to_f
add_retry('bob1', same_time)
add_retry('bob2', same_time)
r = Sidekiq::RetrySet.new
assert_equal 1, r.fetch(same_time, 'bob1').size
end
it 'shows empty retries' do
r = Sidekiq::RetrySet.new
assert_equal 0, r.size
end
it 'can enumerate retries' do
add_retry
r = Sidekiq::RetrySet.new
assert_equal 1, r.size
array = r.to_a
assert_equal 1, array.size
retri = array.first
assert_equal 'ApiWorker', retri.klass
assert_equal 'default', retri.queue
assert_equal 'bob', retri.jid
assert_in_delta Time.now.to_f, retri.at.to_f, 0.02
end
it 'requires a jid to delete an entry' do
start_time = Time.now.to_f
add_retry('bob2', Time.now.to_f)
assert_raises(ArgumentError) do
Sidekiq::RetrySet.new.delete(start_time)
end
end
it 'can delete a single retry from score and jid' do
same_time = Time.now.to_f
add_retry('bob1', same_time)
add_retry('bob2', same_time)
r = Sidekiq::RetrySet.new
assert_equal 2, r.size
Sidekiq::RetrySet.new.delete(same_time, 'bob1')
assert_equal 1, r.size
end
it 'can retry a retry' do
add_retry
r = Sidekiq::RetrySet.new
assert_equal 1, r.size
r.first.retry
assert_equal 0, r.size
assert_equal 1, Sidekiq::Queue.new('default').size
job = Sidekiq::Queue.new('default').first
assert_equal 'bob', job.jid
assert_equal 1, job['retry_count']
end
it 'can clear retries' do
add_retry
add_retry('test')
r = Sidekiq::RetrySet.new
assert_equal 2, r.size
r.clear
assert_equal 0, r.size
end
it 'can enumerate processes' do
identity_string = "identity_string"
odata = {
'pid' => 123,
'hostname' => Socket.gethostname,
'key' => identity_string,
'identity' => identity_string,
'started_at' => Time.now.to_f - 15,
}
time = Time.now.to_f
Sidekiq.redis do |conn|
conn.multi do
conn.sadd('processes', odata['key'])
conn.hmset(odata['key'], 'info', Sidekiq.dump_json(odata), 'busy', 10, 'beat', time)
conn.sadd('processes', 'fake:pid')
end
end
ps = Sidekiq::ProcessSet.new.to_a
assert_equal 1, ps.size
data = ps.first
assert_equal 10, data['busy']
assert_equal time, data['beat']
assert_equal 123, data['pid']
data.quiet!
data.stop!
signals_string = "#{odata['key']}-signals"
assert_equal "TERM", Sidekiq.redis{|c| c.lpop(signals_string) }
assert_equal "USR1", Sidekiq.redis{|c| c.lpop(signals_string) }
end
it 'can enumerate workers' do
w = Sidekiq::Workers.new
assert_equal 0, w.size
w.each do
assert false
end
hn = Socket.gethostname
key = "#{hn}:#{$$}"
pdata = { 'pid' => $$, 'hostname' => hn, 'started_at' => Time.now.to_i }
Sidekiq.redis do |conn|
conn.sadd('processes', key)
conn.hmset(key, 'info', Sidekiq.dump_json(pdata), 'busy', 0, 'beat', Time.now.to_f)
end
s = "#{key}:workers"
data = Sidekiq.dump_json({ 'payload' => {}, 'queue' => 'default', 'run_at' => Time.now.to_i })
Sidekiq.redis do |c|
c.hmset(s, '1234', data)
end
w.each do |p, x, y|
assert_equal key, p
assert_equal "1234", x
assert_equal 'default', y['queue']
assert_equal Time.now.year, Time.at(y['run_at']).year
end
s = "#{key}:workers"
data = Sidekiq.dump_json({ 'payload' => {}, 'queue' => 'default', 'run_at' => (Time.now.to_i - 2*60*60) })
Sidekiq.redis do |c|
c.multi do
c.hmset(s, '5678', data)
c.hmset("b#{s}", '5678', data)
end
end
assert_equal ['1234', '5678'], w.map { |_, tid, _| tid }
end
it 'can reschedule jobs' do
add_retry('foo1')
add_retry('foo2')
retries = Sidekiq::RetrySet.new
assert_equal 2, retries.size
refute(retries.map { |r| r.score > (Time.now.to_f + 9) }.any?)
retries.each do |retri|
retri.reschedule(Time.now.to_f + 10) if retri.jid == 'foo2'
end
assert_equal 2, retries.size
assert(retries.map { |r| r.score > (Time.now.to_f + 9) }.any?)
end
it 'prunes processes which have died' do
data = { 'pid' => rand(10_000), 'hostname' => "app#{rand(1_000)}", 'started_at' => Time.now.to_f }
key = "#{data['hostname']}:#{data['pid']}"
Sidekiq.redis do |conn|
conn.sadd('processes', key)
conn.hmset(key, 'info', Sidekiq.dump_json(data), 'busy', 0, 'beat', Time.now.to_f)
end
ps = Sidekiq::ProcessSet.new
assert_equal 1, ps.size
assert_equal 1, ps.to_a.size
Sidekiq.redis do |conn|
conn.sadd('processes', "bar:987")
conn.sadd('processes', "bar:986")
end
ps = Sidekiq::ProcessSet.new
assert_equal 1, ps.size
assert_equal 1, ps.to_a.size
end
def add_retry(jid = 'bob', at = Time.now.to_f)
payload = Sidekiq.dump_json('class' => 'ApiWorker', 'args' => [1, 'mike'], 'queue' => 'default', 'jid' => jid, 'retry_count' => 2, 'failed_at' => Time.now.to_f)
Sidekiq.redis do |conn|
conn.zadd('retry', at.to_s, payload)
end
end
end
end
end
|