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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.shared_examples 'validate path globs' do |path_globs|
it 'returns an array of path globs' do
expect(path_globs).to be_an(Array)
expect(path_globs).to all(be_an(Pathname))
end
end
RSpec.shared_examples 'validate schema data' do |tables_and_views|
it 'all tables and views have assigned a known gitlab_schema' do
expect(tables_and_views).to all(
match([be_a(String), be_in(Gitlab::Database.schemas_to_base_models.keys.map(&:to_sym))])
)
end
end
RSpec.describe Gitlab::Database::GitlabSchema, feature_category: :database do
shared_examples 'maps table name to table schema' do
using RSpec::Parameterized::TableSyntax
before do
ApplicationRecord.connection.execute(<<~SQL)
CREATE INDEX index_name_on_table_belonging_to_gitlab_main ON public.projects (name);
SQL
end
where(:name, :classification) do
'ci_builds' | :gitlab_ci
'my_schema.ci_builds' | :gitlab_ci
'my_schema.ci_runner_machine_builds_100' | :gitlab_ci
'my_schema._test_gitlab_main_table' | :gitlab_main
'information_schema.columns' | :gitlab_internal
'audit_events_part_5fc467ac26' | :gitlab_main
'_test_gitlab_main_table' | :gitlab_main
'_test_gitlab_ci_table' | :gitlab_ci
'_test_my_table' | :gitlab_shared
'pg_attribute' | :gitlab_internal
'index_name_on_table_belonging_to_gitlab_main' | :gitlab_main
end
with_them do
it { is_expected.to eq(classification) }
end
end
describe '.deleted_views_and_tables_to_schema' do
include_examples 'validate schema data', described_class.deleted_views_and_tables_to_schema
end
describe '.views_and_tables_to_schema' do
include_examples 'validate schema data', described_class.views_and_tables_to_schema
# This being run across different databases indirectly also tests
# a general consistency of structure across databases
Gitlab::Database.database_base_models.except(:geo).each do |db_config_name, db_class|
context "for #{db_config_name} using #{db_class}" do
let(:db_data_sources) { db_class.connection.data_sources }
# The embedding and Geo databases do not share the same structure as all decomposed databases
subject do
described_class.views_and_tables_to_schema.reject { |_, v| v == :gitlab_embedding || v == :gitlab_geo }
end
it 'new data sources are added' do
missing_data_sources = db_data_sources.to_set - subject.keys
expect(missing_data_sources).to be_empty, \
"Missing table/view(s) #{missing_data_sources.to_a} not found in " \
"#{described_class}.views_and_tables_to_schema. " \
"Any new tables or views must be added to the database dictionary. " \
"More info: https://docs.gitlab.com/ee/development/database/database_dictionary.html"
end
it 'non-existing data sources are removed' do
extra_data_sources = subject.keys.to_set - db_data_sources
expect(extra_data_sources).to be_empty, \
"Extra table/view(s) #{extra_data_sources.to_a} found in #{described_class}.views_and_tables_to_schema. " \
"Any removed or renamed tables or views must be removed from the database dictionary. " \
"More info: https://docs.gitlab.com/ee/development/database/database_dictionary.html"
end
end
end
end
describe '.dictionary_path_globs' do
include_examples 'validate path globs', described_class.dictionary_path_globs
end
describe '.view_path_globs' do
include_examples 'validate path globs', described_class.view_path_globs
end
describe '.deleted_tables_path_globs' do
include_examples 'validate path globs', described_class.deleted_tables_path_globs
end
describe '.deleted_views_path_globs' do
include_examples 'validate path globs', described_class.deleted_views_path_globs
end
describe '.tables_to_schema' do
let(:database_models) { Gitlab::Database.database_base_models.except(:geo) }
let(:views) { database_models.flat_map { |_, m| m.connection.views }.sort.uniq }
subject { described_class.tables_to_schema }
it 'returns only tables' do
tables = subject.keys
expect(tables).not_to include(views.to_set)
end
end
describe '.views_to_schema' do
let(:database_models) { Gitlab::Database.database_base_models.except(:geo) }
let(:tables) { database_models.flat_map { |_, m| m.connection.tables }.sort.uniq }
subject { described_class.views_to_schema }
it 'returns only views' do
views = subject.keys
expect(views).not_to include(tables.to_set)
end
end
describe '.table_schemas!' do
let(:tables) { %w[users projects ci_builds] }
subject { described_class.table_schemas!(tables) }
it 'returns the matched schemas' do
expect(subject).to match_array %i[gitlab_main gitlab_ci].to_set
end
context 'when one of the tables does not have a matching table schema' do
let(:tables) { %w[users projects unknown ci_builds] }
it 'raises error' do
expect { subject }.to raise_error(/Could not find gitlab schema for table unknown/)
end
end
end
describe '.table_schema' do
subject { described_class.table_schema(name) }
it_behaves_like 'maps table name to table schema'
context 'when mapping fails' do
let(:name) { 'unknown_table' }
it { is_expected.to be_nil }
end
end
describe '.table_schema!' do
subject { described_class.table_schema!(name) }
it_behaves_like 'maps table name to table schema'
context 'when mapping fails' do
let(:name) { 'non_existing_table' }
it "raises error" do
expect { subject }.to raise_error(
Gitlab::Database::GitlabSchema::UnknownSchemaError,
"Could not find gitlab schema for table #{name}: " \
"Any new or deleted tables must be added to the database dictionary " \
"See https://docs.gitlab.com/ee/development/database/database_dictionary.html"
)
end
end
end
end
|
