schema_spec.rb 7.34 KB
Newer Older
1
2
3
# frozen_string_literal: true

require 'spec_helper'
4
require Rails.root.join('ee', 'spec', 'db', 'schema_support') if Gitlab.ee?
5
6

describe 'Database schema' do
7
8
  prepend_if_ee('EE::DB::SchemaSupport')

9
10
11
12
  let(:connection) { ActiveRecord::Base.connection }
  let(:tables) { connection.tables }

  # Use if you are certain that this column should not have a foreign key
13
  # EE: edit the ee/spec/db/schema_support.rb
14
15
  IGNORED_FK_COLUMNS = {
    abuse_reports: %w[reporter_id user_id],
16
    application_settings: %w[performance_bar_allowed_group_id slack_app_id snowplow_app_id eks_account_id eks_access_key_id],
17
18
19
    approvers: %w[target_id user_id],
    approvals: %w[user_id],
    approver_groups: %w[target_id],
20
21
    audit_events: %w[author_id entity_id],
    award_emoji: %w[awardable_id user_id],
22
    aws_roles: %w[role_external_id],
23
    boards: %w[milestone_id],
24
    chat_names: %w[chat_id team_id user_id],
25
26
27
28
29
    chat_teams: %w[team_id],
    ci_builds: %w[erased_by_id runner_id trigger_request_id user_id],
    ci_pipelines: %w[user_id],
    ci_runner_projects: %w[runner_id],
    ci_trigger_requests: %w[commit_id],
30
    cluster_providers_aws: %w[security_group_id vpc_id access_key_id],
31
32
33
    cluster_providers_gcp: %w[gcp_project_id operation_id],
    deploy_keys_projects: %w[deploy_key_id],
    deployments: %w[deployable_id environment_id user_id],
34
    draft_notes: %w[discussion_id commit_id],
35
36
    emails: %w[user_id],
    events: %w[target_id],
37
    epics: %w[updated_by_id last_edited_by_id state_id],
38
    forked_project_links: %w[forked_from_project_id],
39
40
41
42
43
44
45
    geo_event_log: %w[hashed_storage_attachments_event_id],
    geo_job_artifact_deleted_events: %w[job_artifact_id],
    geo_lfs_object_deleted_events: %w[lfs_object_id],
    geo_node_statuses: %w[last_event_id cursor_last_event_id],
    geo_nodes: %w[oauth_application_id],
    geo_repository_deleted_events: %w[project_id],
    geo_upload_deleted_events: %w[upload_id model_id],
46
    gitlab_subscription_histories: %w[gitlab_subscription_id hosted_plan_id namespace_id],
47
    import_failures: %w[project_id],
48
    identities: %w[user_id],
Felipe Artur's avatar
Felipe Artur committed
49
    issues: %w[last_edited_by_id state_id],
50
    jira_tracker_data: %w[jira_issue_transition_id],
51
52
53
    keys: %w[user_id],
    label_links: %w[target_id],
    lfs_objects_projects: %w[lfs_object_id project_id],
54
    ldap_group_links: %w[group_id],
55
    members: %w[source_id created_by_id],
Felipe Artur's avatar
Felipe Artur committed
56
    merge_requests: %w[last_edited_by_id state_id],
57
    namespaces: %w[owner_id parent_id],
58
    notes: %w[author_id commit_id noteable_id updated_by_id resolved_by_id confirmed_by_id discussion_id],
59
60
61
62
    notification_settings: %w[source_id],
    oauth_access_grants: %w[resource_owner_id application_id],
    oauth_access_tokens: %w[resource_owner_id application_id],
    oauth_applications: %w[owner_id],
63
    open_project_tracker_data: %w[closed_status_id],
64
65
    project_group_links: %w[group_id],
    project_statistics: %w[namespace_id],
66
    projects: %w[creator_id namespace_id ci_id mirror_user_id],
67
68
69
70
71
72
73
    redirect_routes: %w[source_id],
    repository_languages: %w[programming_language_id],
    routes: %w[source_id],
    sent_notifications: %w[project_id noteable_id recipient_id commit_id in_reply_to_discussion_id],
    snippets: %w[author_id],
    spam_logs: %w[user_id],
    subscriptions: %w[user_id subscribable_id],
74
    slack_integrations: %w[team_id user_id],
75
76
77
78
79
    taggings: %w[tag_id taggable_id tagger_id],
    timelogs: %w[user_id],
    todos: %w[target_id commit_id],
    uploads: %w[model_id],
    user_agent_details: %w[subject_id],
80
    users: %w[color_scheme_id created_by_id theme_id email_opted_in_source_id],
81
    users_star_projects: %w[user_id],
82
83
84
    vulnerability_identifiers: %w[external_id],
    vulnerability_scanners: %w[external_id],
    web_hooks: %w[service_id group_id],
85
86
    suggestions: %w[commit_id],
    commit_user_mentions: %w[commit_id]
87
88
89
90
91
92
93
94
  }.with_indifferent_access.freeze

  context 'for table' do
    ActiveRecord::Base.connection.tables.sort.each do |table|
      describe table do
        let(:indexes) { connection.indexes(table) }
        let(:columns) { connection.columns(table) }
        let(:foreign_keys) { connection.foreign_keys(table) }
95
        let(:primary_key_column) { connection.primary_key(table) }
96
97
98
99
100
101
102

        context 'all foreign keys' do
          # for index to be effective, the FK constraint has to be at first place
          it 'are indexed' do
            first_indexed_column = indexes.map(&:columns).map(&:first)
            foreign_keys_columns = foreign_keys.map(&:column)

103
104
105
106
107
108
            # Add the primary key column to the list of indexed columns because
            # postgres and mysql both automatically create an index on the primary
            # key. Also, the rails connection.indexes() method does not return
            # automatically generated indexes (like the primary key index).
            first_indexed_column = first_indexed_column.push(primary_key_column)

109
110
111
112
113
114
115
116
            expect(first_indexed_column.uniq).to include(*foreign_keys_columns)
          end
        end

        context 'columns ending with _id' do
          let(:column_names) { columns.map(&:name) }
          let(:column_names_with_id) { column_names.select { |column_name| column_name.ends_with?('_id') } }
          let(:foreign_keys_columns) { foreign_keys.map(&:column) }
Kamil Trzciński's avatar
Kamil Trzciński committed
117
          let(:ignored_columns) { ignored_fk_columns(table) }
118
119
120
121
122
123
124
125

          it 'do have the foreign keys' do
            expect(column_names_with_id - ignored_columns).to contain_exactly(*foreign_keys_columns)
          end
        end
      end
    end
  end
Kamil Trzciński's avatar
Kamil Trzciński committed
126

127
128
129
130
131
132
133
134
  # These pre-existing enums have limits > 2 bytes
  IGNORED_LIMIT_ENUMS = {
    'Analytics::CycleAnalytics::GroupStage' => %w[start_event_identifier end_event_identifier],
    'Analytics::CycleAnalytics::ProjectStage' => %w[start_event_identifier end_event_identifier],
    'Ci::Bridge' => %w[failure_reason],
    'Ci::Build' => %w[failure_reason],
    'Ci::BuildMetadata' => %w[timeout_source],
    'Ci::BuildTraceChunk' => %w[data_store],
135
    'Ci::DailyReportResult' => %w[param_type],
136
137
    'Ci::JobArtifact' => %w[file_type],
    'Ci::Pipeline' => %w[source config_source failure_reason],
138
    'Ci::Processable' => %w[failure_reason],
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
    'Ci::Runner' => %w[access_level],
    'Ci::Stage' => %w[status],
    'Clusters::Applications::Ingress' => %w[ingress_type],
    'Clusters::Cluster' => %w[platform_type provider_type],
    'CommitStatus' => %w[failure_reason],
    'GenericCommitStatus' => %w[failure_reason],
    'Gitlab::DatabaseImporters::CommonMetrics::PrometheusMetric' => %w[group],
    'InternalId' => %w[usage],
    'List' => %w[list_type],
    'NotificationSetting' => %w[level],
    'Project' => %w[auto_cancel_pending_pipelines],
    'ProjectAutoDevops' => %w[deploy_strategy],
    'PrometheusMetric' => %w[group],
    'ResourceLabelEvent' => %w[action],
    'User' => %w[layout dashboard project_view],
    'UserCallout' => %w[feature_name],
    'PrometheusAlert' => %w[operator]
  }.freeze

  context 'for enums' do
    ApplicationRecord.descendants.each do |model|
      describe model do
        let(:ignored_enums) { ignored_limit_enums(model.name) }
        let(:enums) { model.defined_enums.keys - ignored_enums }

        it 'uses smallint for enums' do
          expect(model).to use_smallint_for_enums(enums)
        end
      end
    end
  end

Kamil Trzciński's avatar
Kamil Trzciński committed
171
172
173
174
175
  private

  def ignored_fk_columns(column)
    IGNORED_FK_COLUMNS.fetch(column, [])
  end
176
177
178
179

  def ignored_limit_enums(model)
    IGNORED_LIMIT_ENUMS.fetch(model, [])
  end
180
end