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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::LooseForeignKeys do
describe 'verify all definitions' do
subject(:definitions) { described_class.definitions }
it 'all definitions have assigned a known gitlab_schema and on_delete' do
is_expected.to all(have_attributes(
options: a_hash_including(
column: be_a(String),
gitlab_schema: be_in(Gitlab::Database.schemas_to_base_models.symbolize_keys.keys),
on_delete: be_in([:async_delete, :async_nullify])
),
from_table: be_a(String),
to_table: be_a(String)
))
end
context 'ensure keys are sorted' do
it 'does not have any keys that are out of order' do
parsed = YAML.parse_file(described_class.loose_foreign_keys_yaml_path)
mapping = parsed.children.first
table_names = mapping.children.select(&:scalar?).map(&:value)
expect(table_names).to eq(table_names.sort), "expected sorted table names in the YAML file"
end
end
context 'ensure no duplicates are found' do
it 'does not have duplicate tables defined' do
# since we use hash to detect duplicate hash keys we need to parse YAML document
parsed = YAML.parse_file(described_class.loose_foreign_keys_yaml_path)
expect(parsed).to be_document
expect(parsed.children).to be_one, "YAML has a single document"
# require hash
mapping = parsed.children.first
expect(mapping).to be_mapping, "YAML has a top-level hash"
# find all scalars with names
table_names = mapping.children.select(&:scalar?).map(&:value)
expect(table_names).not_to be_empty, "YAML has a non-zero tables defined"
# expect to not have duplicates
expect(table_names).to contain_exactly(*table_names.uniq)
end
it 'does not have duplicate column definitions' do
# ignore other modifiers
all_definitions = definitions.map do |definition|
{ from_table: definition.from_table, to_table: definition.to_table, column: definition.column }
end
# expect to not have duplicates
expect(all_definitions).to contain_exactly(*all_definitions.uniq)
end
end
describe 'ensuring database integrity' do
def base_models_for(table)
parent_table_schema = Gitlab::Database::GitlabSchema.table_schema(table)
Gitlab::Database.schemas_to_base_models.fetch(parent_table_schema)
end
it 'all `to_table` tables are present', :aggregate_failures do
definitions.each do |definition|
base_models_for(definition.to_table).each do |model|
expect(model.connection).to be_table_exist(definition.to_table),
"Table #{definition.from_table} does not exist"
end
end
end
it 'all `from_table` tables are present', :aggregate_failures do
definitions.each do |definition|
base_models_for(definition.from_table).each do |model|
expect(model.connection).to be_table_exist(definition.from_table),
"Table #{definition.from_table} does not exist"
expect(model.connection).to be_column_exist(definition.from_table, definition.column),
"Column #{definition.column} in #{definition.from_table} does not exist"
end
end
end
end
end
context 'all tables have correct triggers installed' do
let(:all_tables_from_yaml) { described_class.definitions.pluck(:to_table).uniq }
let(:all_tables_with_triggers) do
triggers_query = <<~SQL
SELECT event_object_table FROM information_schema.triggers
WHERE trigger_name LIKE '%_loose_fk_trigger'
SQL
ApplicationRecord.connection.execute(triggers_query)
.pluck('event_object_table').uniq
end
it 'all YAML tables do have `track_record_deletions` installed' do
missing_trigger_tables = all_tables_from_yaml - all_tables_with_triggers
expect(missing_trigger_tables).to be_empty, <<~END
The loose foreign keys definitions require using `track_record_deletions`
for the following tables: #{missing_trigger_tables}.
Read more at https://docs.gitlab.com/ee/development/database/loose_foreign_keys.html."
END
end
it 'no extra tables have `track_record_deletions` installed' do
extra_trigger_tables = all_tables_with_triggers - all_tables_from_yaml
pending 'This result of this test is informatory, and not critical' if extra_trigger_tables.any?
expect(extra_trigger_tables).to be_empty, <<~END
The following tables have unused `track_record_deletions` triggers installed,
but they are not referenced by any of the loose foreign key definitions: #{extra_trigger_tables}.
You can remove them in one of the future releases as part of `db/post_migrate`.
Read more at https://docs.gitlab.com/ee/development/database/loose_foreign_keys.html."
END
end
end
describe '.build_definition' do
context 'when child table schema is not defined' do
let(:loose_foreign_keys_yaml) do
{
'ci_unknown_table' => [
{
'table' => 'projects',
'column' => 'project_id',
'on_delete' => 'async_delete'
}
]
}
end
subject { described_class.definitions }
before do
described_class.instance_variable_set(:@definitions, nil)
described_class.instance_variable_set(:@loose_foreign_keys_yaml, loose_foreign_keys_yaml)
end
after do
described_class.instance_variable_set(:@loose_foreign_keys_yaml, nil)
end
it 'raises Gitlab::Database::GitlabSchema::UnknownSchemaError error' do
expect { subject }.to raise_error(Gitlab::Database::GitlabSchema::UnknownSchemaError)
end
end
end
end
|
