gitlab-ce/spec/lib/gitlab/job_waiter_spec.rb

142 lines
4.0 KiB
Ruby

# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::JobWaiter, :redis, feature_category: :shared do
describe '.notify' do
let(:key) { described_class.new.key }
it 'pushes the jid to the named queue', :freeze_time do
described_class.notify(key, 123)
Gitlab::Redis::SharedState.with do |redis|
expect(redis.ttl(key)).to eq(described_class::DEFAULT_TTL)
end
end
it 'can be passed a custom TTL', :freeze_time do
described_class.notify(key, 123, ttl: 5.minutes)
Gitlab::Redis::SharedState.with do |redis|
expect(redis.ttl(key)).to eq(5.minutes.to_i)
end
end
end
describe '.generate_key' do
it 'generates and return a new key' do
key = described_class.generate_key
expect(key).to include('gitlab:job_waiter:')
end
end
describe '.delete_key' do
let(:key) { described_class.generate_key }
it 'deletes the key' do
described_class.notify(key, '1')
described_class.delete_key(key)
Gitlab::Redis::SharedState.with do |redis|
expect(redis.llen(key)).to eq(0)
end
end
context 'when key is not a JobWaiter key' do
let(:key) { 'foo' }
it 'does not delete the key' do
described_class.notify(key, '1')
described_class.delete_key(key)
Gitlab::Redis::SharedState.with do |redis|
expect(redis.llen(key)).to eq(1)
end
end
end
end
describe '#wait' do
let(:waiter) { described_class.new(2) }
before do
allow_any_instance_of(described_class).to receive(:wait).and_call_original
stub_feature_flags(
use_primary_and_secondary_stores_for_shared_state: false,
use_primary_store_as_default_for_shared_state: false
)
end
it 'returns when all jobs have been completed' do
described_class.notify(waiter.key, 'a')
described_class.notify(waiter.key, 'b')
result = nil
expect { Timeout.timeout(1) { result = waiter.wait(2) } }.not_to raise_error
expect(result).to contain_exactly('a', 'b')
end
it 'times out if not all jobs complete' do
described_class.notify(waiter.key, 'a')
result = nil
expect { Timeout.timeout(2) { result = waiter.wait(1) } }.not_to raise_error
expect(result).to contain_exactly('a')
end
context 'when migration is ongoing' do
let(:waiter) { described_class.new(3) }
shared_examples 'returns all jobs' do
it 'returns all jobs' do
result = nil
expect { Timeout.timeout(6) { result = waiter.wait(5) } }.not_to raise_error
expect(result).to contain_exactly('a', 'b', 'c')
end
end
context 'when using both stores' do
context 'with existing jobs in old store' do
before do
described_class.notify(waiter.key, 'a')
described_class.notify(waiter.key, 'b')
described_class.notify(waiter.key, 'c')
stub_feature_flags(use_primary_and_secondary_stores_for_shared_state: true)
end
it_behaves_like 'returns all jobs'
end
context 'with jobs in both stores' do
before do
stub_feature_flags(use_primary_and_secondary_stores_for_shared_state: true)
described_class.notify(waiter.key, 'a')
described_class.notify(waiter.key, 'b')
described_class.notify(waiter.key, 'c')
end
it_behaves_like 'returns all jobs'
end
context 'when using primary store as default store' do
before do
stub_feature_flags(
use_primary_and_secondary_stores_for_shared_state: true,
use_primary_store_as_default_for_shared_state: true
)
described_class.notify(waiter.key, 'a')
described_class.notify(waiter.key, 'b')
described_class.notify(waiter.key, 'c')
end
it_behaves_like 'returns all jobs'
end
end
end
end
end