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
|
# frozen_string_literal: true
require 'spec_helper'
require 'rails/generators/testing/behaviour'
require 'rails/generators/testing/assertions'
RSpec.describe BatchedBackgroundMigration::BatchedBackgroundMigrationGenerator, feature_category: :database do
include Rails::Generators::Testing::Behaviour
include Rails::Generators::Testing::Assertions
include FileUtils
tests described_class
destination File.expand_path('tmp', __dir__)
before do
prepare_destination
end
after do
rm_rf(destination_root)
end
shared_examples "generates files common to both types of migrations" do |migration_job_file, migration_file,
migration_spec_file, migration_dictionary_file|
let(:expected_migration_job_file) { load_expected_file(migration_job_file) }
let(:expected_migration_file) { load_expected_file(migration_file) }
let(:expected_migration_spec_file) { load_expected_file(migration_spec_file) }
let(:expected_migration_dictionary) { load_expected_file(migration_dictionary_file) }
it 'generates expected common files' do
assert_file('lib/gitlab/background_migration/my_batched_migration.rb') do |migration_job_file|
expect(migration_job_file).to eq(expected_migration_job_file)
end
assert_migration('db/post_migrate/queue_my_batched_migration.rb') do |migration_file|
expect(migration_file).to eq(expected_migration_file)
end
assert_migration('spec/migrations/queue_my_batched_migration_spec.rb') do |migration_spec_file|
expect(migration_spec_file).to eq(expected_migration_spec_file)
end
assert_file('db/docs/batched_background_migrations/my_batched_migration.yml') do |migration_dictionary|
# Regex is used to match the dynamically generated 'milestone' in the dictionary
expect(migration_dictionary).to match(/#{expected_migration_dictionary}/)
end
end
end
context 'when generating EE-only batched background migration' do
before do
run_generator %w[my_batched_migration --table_name=projects --column_name=id --feature_category=database
--ee-only]
end
let(:expected_ee_migration_job_file) { load_expected_file('ee_my_batched_migration.txt') }
let(:expected_migration_job_spec_file) { load_expected_file('my_batched_migration_spec_matcher.txt') }
include_examples "generates files common to both types of migrations",
'foss_my_batched_migration.txt',
'queue_my_batched_migration.txt',
'queue_my_batched_migration_spec.txt',
'my_batched_migration_dictionary_matcher.txt'
it 'generates expected files' do
assert_file('ee/lib/ee/gitlab/background_migration/my_batched_migration.rb') do |migration_job_file|
expect(migration_job_file).to eq(expected_ee_migration_job_file)
end
assert_file('ee/spec/lib/ee/gitlab/background_migration/my_batched_migration_spec.rb') do |migration_job_spec_file| # rubocop:disable Layout/LineLength
expect(migration_job_spec_file).to match(/#{expected_migration_job_spec_file}/)
end
end
end
context 'when generating FOSS batched background migration' do
before do
run_generator %w[my_batched_migration --table_name=projects --column_name=id --feature_category=database]
end
let(:expected_migration_job_spec_file) { load_expected_file('my_batched_migration_spec_matcher.txt') }
include_examples "generates files common to both types of migrations",
'my_batched_migration.txt',
'queue_my_batched_migration.txt',
'queue_my_batched_migration_spec.txt',
'my_batched_migration_dictionary_matcher.txt'
it 'generates expected files' do
assert_file('spec/lib/gitlab/background_migration/my_batched_migration_spec.rb') do |migration_job_spec_file|
# Regex is used to match the dynamic schema: <version> in the specs
expect(migration_job_spec_file).to match(/#{expected_migration_job_spec_file}/)
end
end
end
private
def load_expected_file(file_name)
File.read(File.expand_path("expected_files/#{file_name}", __dir__))
end
end
|
