diff options
Diffstat (limited to 'spec/db')
-rw-r--r-- | spec/db/schema_spec.rb | 92 |
1 files changed, 89 insertions, 3 deletions
diff --git a/spec/db/schema_spec.rb b/spec/db/schema_spec.rb index 95d7981b85c..f31da943957 100644 --- a/spec/db/schema_spec.rb +++ b/spec/db/schema_spec.rb @@ -8,9 +8,10 @@ RSpec.describe 'Database schema' do let(:connection) { ActiveRecord::Base.connection } let(:tables) { connection.tables } + let(:columns_name_with_jsonb) { retrieve_columns_name_with_jsonb } - # Use if you are certain that this column should not have a foreign key - # EE: edit the ee/spec/db/schema_support.rb + # List of columns historically missing a FK, don't add more columns + # See: https://docs.gitlab.com/ce/development/foreign_keys.html#naming-foreign-keys IGNORED_FK_COLUMNS = { abuse_reports: %w[reporter_id user_id], application_settings: %w[performance_bar_allowed_group_id slack_app_id snowplow_app_id eks_account_id eks_access_key_id], @@ -62,6 +63,7 @@ RSpec.describe 'Database schema' do oauth_access_tokens: %w[resource_owner_id application_id], oauth_applications: %w[owner_id], open_project_tracker_data: %w[closed_status_id], + product_analytics_events_experimental: %w[event_id txn_id user_id], project_group_links: %w[group_id], project_statistics: %w[namespace_id], projects: %w[creator_id ci_id mirror_user_id], @@ -118,7 +120,11 @@ RSpec.describe 'Database schema' do let(:ignored_columns) { ignored_fk_columns(table) } it 'do have the foreign keys' do - expect(column_names_with_id - ignored_columns).to contain_exactly(*foreign_keys_columns) + expect(column_names_with_id - ignored_columns).to match_array(foreign_keys_columns) + end + + it 'and having foreign key are not in the ignore list' do + expect(ignored_columns).to match_array(ignored_columns - foreign_keys) end end end @@ -169,8 +175,84 @@ RSpec.describe 'Database schema' do end end + # These pre-existing columns does not use a schema validation yet + IGNORED_JSONB_COLUMNS = { + "ApplicationSetting" => %w[repository_storages_weighted], + "AlertManagement::Alert" => %w[payload], + "Ci::BuildMetadata" => %w[config_options config_variables], + "Geo::Event" => %w[payload], + "GeoNodeStatus" => %w[status], + "Operations::FeatureFlagScope" => %w[strategies], + "Operations::FeatureFlags::Strategy" => %w[parameters], + "Packages::Composer::Metadatum" => %w[composer_json], + "Releases::Evidence" => %w[summary] + }.freeze + + # We are skipping GEO models for now as it adds up complexity + describe 'for jsonb columns' do + it 'uses json schema validator' do + columns_name_with_jsonb.each do |hash| + next if models_by_table_name[hash["table_name"]].nil? + + models_by_table_name[hash["table_name"]].each do |model| + jsonb_columns = [hash["column_name"]] - ignored_jsonb_columns(model.name) + + expect(model).to validate_jsonb_schema(jsonb_columns) + end + end + end + end + + context 'existence of Postgres schemas' do + def get_schemas + sql = <<~SQL + SELECT schema_name FROM + information_schema.schemata + WHERE + NOT schema_name ~* '^pg_' AND NOT schema_name = 'information_schema' + AND catalog_name = current_database() + SQL + + ApplicationRecord.connection.select_all(sql).map do |row| + row['schema_name'] + end + end + + it 'we have a public schema' do + expect(get_schemas).to include('public') + end + + Gitlab::Database::EXTRA_SCHEMAS.each do |schema| + it "we have a '#{schema}' schema'" do + expect(get_schemas).to include(schema.to_s) + end + end + + it 'we do not have unexpected schemas' do + expect(get_schemas.size).to eq(Gitlab::Database::EXTRA_SCHEMAS.size + 1) + end + end + private + def retrieve_columns_name_with_jsonb + sql = <<~SQL + SELECT table_name, column_name, data_type + FROM information_schema.columns + WHERE table_catalog = '#{ApplicationRecord.connection_config[:database]}' + AND table_schema = 'public' + AND table_name NOT LIKE 'pg_%' + AND data_type = 'jsonb' + ORDER BY table_name, column_name, data_type + SQL + + ApplicationRecord.connection.select_all(sql).to_a + end + + def models_by_table_name + @models_by_table_name ||= ApplicationRecord.descendants.reject(&:abstract_class).group_by(&:table_name) + end + def ignored_fk_columns(column) IGNORED_FK_COLUMNS.fetch(column, []) end @@ -178,4 +260,8 @@ RSpec.describe 'Database schema' do def ignored_limit_enums(model) IGNORED_LIMIT_ENUMS.fetch(model, []) end + + def ignored_jsonb_columns(model) + IGNORED_JSONB_COLUMNS.fetch(model, []) + end end |