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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe 'new tables with gitlab_main schema', feature_category: :cell do
# During the development of Cells, we will be moving tables from the `gitlab_main` schema
# to either the `gitlab_main_clusterwide` or `gitlab_main_cell` schema.
# As part of this process, starting from milestone 16.7, it will be a mandatory requirement that
# all newly created tables are associated with one of these two schemas.
# Any attempt to set the `gitlab_main` schema for a new table will result in a failure of this spec.
# Specific tables can be exempted from this requirement, and such tables must be added to the `exempted_tables` list.
let!(:exempted_tables) do
[
"audit_events_instance_amazon_s3_configurations", # https://gitlab.com/gitlab-org/gitlab/-/issues/431327
"sbom_source_packages" # https://gitlab.com/gitlab-org/gitlab/-/issues/437718
]
end
let!(:starting_from_milestone) { 16.7 }
it 'only allows exempted tables to have `gitlab_main` as its schema, after milestone 16.7', :aggregate_failures do
tables_having_gitlab_main_schema(starting_from_milestone: starting_from_milestone).each do |table_name|
expect(exempted_tables).to include(table_name), error_message(table_name)
end
end
it 'only allows tables having `gitlab_main` as its schema in `exempted_tables`', :aggregate_failures do
tables_having_gitlab_main_schema = gitlab_main_schema_tables.map(&:table_name)
exempted_tables.each do |exempted_table|
expect(tables_having_gitlab_main_schema).to include(exempted_table),
"`#{exempted_table}` does not have `gitlab_main` as its schema.
Please remove this table from the `exempted_tables` list."
end
end
private
def error_message(table_name)
<<~HEREDOC
The table `#{table_name}` has been added with `gitlab_main` schema.
Starting from GitLab #{starting_from_milestone}, we expect new tables to use either the `gitlab_main_cell` or the
`gitlab_main_clusterwide` schema.
To choose an appropriate schema for this table from among `gitlab_main_cell` and `gitlab_main_clusterwide`, please refer
to our guidelines at https://docs.gitlab.com/ee/development/database/multiple_databases.html#guidelines-on-choosing-between-gitlab_main_cell-and-gitlab_main_clusterwide-schema, or consult with the Tenant Scale group.
Please see issue https://gitlab.com/gitlab-org/gitlab/-/issues/424990 to understand why this change is being enforced.
HEREDOC
end
def tables_having_gitlab_main_schema(starting_from_milestone:)
selected_data = gitlab_main_schema_tables.select do |entry|
entry.milestone.to_f >= starting_from_milestone
end
selected_data.map(&:table_name)
end
def gitlab_main_schema_tables
::Gitlab::Database::Dictionary.entries.select do |entry|
entry.schema?('gitlab_main')
end
end
end
|
