diff options
Diffstat (limited to 'spec/lib/gitlab/database/migrations/test_background_runner_spec.rb')
-rw-r--r-- | spec/lib/gitlab/database/migrations/test_background_runner_spec.rb | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/spec/lib/gitlab/database/migrations/test_background_runner_spec.rb b/spec/lib/gitlab/database/migrations/test_background_runner_spec.rb new file mode 100644 index 00000000000..c6fe88a7c2d --- /dev/null +++ b/spec/lib/gitlab/database/migrations/test_background_runner_spec.rb @@ -0,0 +1,120 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::Database::Migrations::TestBackgroundRunner, :redis do + include Gitlab::Database::Migrations::BackgroundMigrationHelpers + + # In order to test the interaction between queueing sidekiq jobs and seeing those jobs in queues, + # we need to disable sidekiq's testing mode and actually send our jobs to redis + around do |ex| + Sidekiq::Testing.disable! { ex.run } + end + + context 'without jobs to run' do + it 'returns immediately' do + runner = described_class.new + expect(runner).not_to receive(:run_job) + described_class.new.run_jobs(for_duration: 1.second) + end + end + + context 'with jobs to run' do + let(:migration_name) { 'TestBackgroundMigration' } + + before do + (1..5).each do |i| + migrate_in(i.minutes, migration_name, [i]) + end + end + + context 'finding pending background jobs' do + it 'finds all the migrations' do + expect(described_class.new.traditional_background_migrations.to_a.size).to eq(5) + end + end + + context 'running migrations', :freeze_time do + def define_background_migration(name) + klass = Class.new do + # Can't simply def perform here as we won't have access to the block, + # similarly can't define_method(:perform, &block) here as it would change the block receiver + define_method(:perform) { |*args| yield(*args) } + end + stub_const("Gitlab::BackgroundMigration::#{name}", klass) + klass + end + + def expect_migration_call_counts(migrations_to_calls) + migrations_to_calls.each do |migration, calls| + expect_next_instances_of(migration, calls) do |m| + expect(m).to receive(:perform).and_call_original + end + end + end + + it 'runs the migration class correctly' do + calls = [] + define_background_migration(migration_name) do |i| + calls << i + end + described_class.new.run_jobs(for_duration: 1.second) # Any time would work here as we do not advance time + expect(calls).to contain_exactly(1, 2, 3, 4, 5) + end + + it 'runs the migration for a uniform amount of time' do + migration = define_background_migration(migration_name) do |i| + travel(1.minute) + end + + expect_migration_call_counts(migration => 3) + + described_class.new.run_jobs(for_duration: 3.minutes) + end + + context 'with multiple migrations to run' do + let(:other_migration_name) { 'OtherBackgroundMigration' } + + before do + (1..5).each do |i| + migrate_in(i.minutes, other_migration_name, [i]) + end + end + + it 'splits the time between migrations when all migrations use all their time' do + migration = define_background_migration(migration_name) do |i| + travel(1.minute) + end + + other_migration = define_background_migration(other_migration_name) do |i| + travel(2.minutes) + end + + expect_migration_call_counts( + migration => 2, # 1 minute jobs for 90 seconds, can finish the first and start the second + other_migration => 1 # 2 minute jobs for 90 seconds, past deadline after a single job + ) + + described_class.new.run_jobs(for_duration: 3.minutes) + end + + it 'does not give leftover time to extra migrations' do + # This is currently implemented this way for simplicity, but it could make sense to change this behavior. + + migration = define_background_migration(migration_name) do + travel(1.second) + end + other_migration = define_background_migration(other_migration_name) do + travel(1.minute) + end + expect_migration_call_counts( + migration => 5, + other_migration => 2 + ) + + described_class.new.run_jobs(for_duration: 3.minutes) + end + end + end + end +end |