diff options
Diffstat (limited to 'spec/support/shared_examples/services/repositories/housekeeping_shared_examples.rb')
-rw-r--r-- | spec/support/shared_examples/services/repositories/housekeeping_shared_examples.rb | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/spec/support/shared_examples/services/repositories/housekeeping_shared_examples.rb b/spec/support/shared_examples/services/repositories/housekeeping_shared_examples.rb new file mode 100644 index 00000000000..a174ae94b75 --- /dev/null +++ b/spec/support/shared_examples/services/repositories/housekeeping_shared_examples.rb @@ -0,0 +1,118 @@ +# frozen_string_literal: true + +RSpec.shared_examples 'housekeeps repository' do + subject { described_class.new(resource) } + + context 'with a clean redis state', :clean_gitlab_redis_shared_state do + describe '#execute' do + it 'enqueues a sidekiq job' do + expect(subject).to receive(:try_obtain_lease).and_return(:the_uuid) + expect(subject).to receive(:lease_key).and_return(:the_lease_key) + expect(subject).to receive(:task).and_return(:incremental_repack) + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :incremental_repack, :the_lease_key, :the_uuid).and_call_original + + Sidekiq::Testing.fake! do + expect { subject.execute }.to change(GitGarbageCollectWorker.jobs, :size).by(1) + end + end + + it 'yields the block if given' do + expect do |block| + subject.execute(&block) + end.to yield_with_no_args + end + + it 'resets counter after execution' do + expect(subject).to receive(:try_obtain_lease).and_return(:the_uuid) + allow(subject).to receive(:gc_period).and_return(1) + resource.increment_pushes_since_gc + + perform_enqueued_jobs do + expect { subject.execute }.to change { resource.pushes_since_gc }.to(0) + end + end + + context 'when no lease can be obtained' do + before do + expect(subject).to receive(:try_obtain_lease).and_return(false) + end + + it 'does not enqueue a job' do + expect(GitGarbageCollectWorker).not_to receive(:perform_async) + + expect { subject.execute }.to raise_error(Repositories::HousekeepingService::LeaseTaken) + end + + it 'does not reset pushes_since_gc' do + expect do + expect { subject.execute }.to raise_error(Repositories::HousekeepingService::LeaseTaken) + end.not_to change { resource.pushes_since_gc } + end + + it 'does not yield' do + expect do |block| + expect { subject.execute(&block) } + .to raise_error(Repositories::HousekeepingService::LeaseTaken) + end.not_to yield_with_no_args + end + end + + context 'task type' do + it 'goes through all three housekeeping tasks, executing only the highest task when there is overlap' do + allow(subject).to receive(:try_obtain_lease).and_return(:the_uuid) + allow(subject).to receive(:lease_key).and_return(:the_lease_key) + + # At push 200 + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :gc, :the_lease_key, :the_uuid) + .once + # At push 50, 100, 150 + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :full_repack, :the_lease_key, :the_uuid) + .exactly(3).times + # At push 10, 20, ... (except those above) + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :incremental_repack, :the_lease_key, :the_uuid) + .exactly(16).times + # At push 6, 12, 18, ... (except those above) + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :pack_refs, :the_lease_key, :the_uuid) + .exactly(27).times + + 201.times do + subject.increment! + subject.execute if subject.needed? + end + + expect(resource.pushes_since_gc).to eq(1) + end + end + + it 'runs the task specifically requested' do + housekeeping = described_class.new(resource, :gc) + + allow(housekeeping).to receive(:try_obtain_lease).and_return(:gc_uuid) + allow(housekeeping).to receive(:lease_key).and_return(:gc_lease_key) + + expect(GitGarbageCollectWorker).to receive(:perform_async).with(resource.id, :gc, :gc_lease_key, :gc_uuid).twice + + 2.times do + housekeeping.execute + end + end + end + + describe '#needed?' do + it 'when the count is low enough' do + expect(subject.needed?).to eq(false) + end + + it 'when the count is high enough' do + allow(resource).to receive(:pushes_since_gc).and_return(10) + expect(subject.needed?).to eq(true) + end + end + + describe '#increment!' do + it 'increments the pushes_since_gc counter' do + expect { subject.increment! }.to change { resource.pushes_since_gc }.by(1) + end + end + end +end |