File: swap_conversion_columns_shared_examples.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (119 lines) | stat: -rw-r--r-- 3,485 bytes parent folder | download
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
# frozen_string_literal: true

COLUMN_OPTIONS_TO_REMAIN =
  %i[
    null
    serial?
    collation
    default
    default_function
  ].freeze

SQL_TYPE_OPTIONS_TO_REMAIN =
  %i[
    precision
    scale
  ].freeze

SQL_TYPE_OPTIONS_TO_CHANGE =
  %i[
    type
    sql_type
    limit
  ].freeze

RSpec.shared_examples 'swap conversion columns' do |table_name:, from:, to:, before_type: nil, after_type: nil|
  it 'correctly swaps conversion columns' do
    before_from_column = before_to_column = before_indexes = before_foreign_keys = nil
    after_from_column = after_to_column = after_indexes = after_foreign_keys = nil

    expect_column_type_is_changed_but_others_remain_unchanged = -> do
      # SQL type is changed
      SQL_TYPE_OPTIONS_TO_CHANGE.each do |sql_type_option|
        expect(
          after_from_column.sql_type_metadata.public_send(sql_type_option)
        ).to eq(
          before_to_column.sql_type_metadata.public_send(sql_type_option)
        )

        expect(
          after_to_column.sql_type_metadata.public_send(sql_type_option)
        ).to eq(
          before_from_column.sql_type_metadata.public_send(sql_type_option)
        )
      end

      # column metadata remains unchanged
      COLUMN_OPTIONS_TO_REMAIN.each do |column_option|
        expect(
          after_from_column.public_send(column_option)
        ).to eq(
          before_from_column.public_send(column_option)
        )

        expect(
          after_to_column.public_send(column_option)
        ).to eq(
          before_to_column.public_send(column_option)
        )
      end

      SQL_TYPE_OPTIONS_TO_REMAIN.each do |sql_type_option|
        expect(
          after_from_column.sql_type_metadata.public_send(sql_type_option)
        ).to eq(
          before_from_column.sql_type_metadata.public_send(sql_type_option)
        )

        expect(
          after_to_column.sql_type_metadata.public_send(sql_type_option)
        ).to eq(
          before_to_column.sql_type_metadata.public_send(sql_type_option)
        )
      end

      # indexes remain unchanged
      expect(before_indexes).to eq(after_indexes)

      # foreign keys remain unchanged
      expect(before_foreign_keys).to eq(after_foreign_keys)
    end

    find_column_by = ->(name) do
      active_record_base.connection.columns(table_name).find { |c| c.name == name.to_s }
    end

    find_indexes = -> do
      active_record_base.connection.indexes(table_name)
    end

    find_foreign_keys = -> do
      Gitlab::Database::PostgresForeignKey.by_constrained_table_name(table_name)
    end

    reversible_migration do |migration|
      migration.before -> {
        before_from_column = find_column_by.call(from)
        before_to_column = find_column_by.call(to)
        before_indexes = find_indexes
        before_foreign_keys = find_foreign_keys

        next if after_from_column.nil?

        # For migrate down
        expect(before_from_column.sql_type_metadata.sql_type).to eq(before_type) if before_type
        expect_column_type_is_changed_but_others_remain_unchanged.call
      }

      migration.after -> {
        after_from_column = find_column_by.call(from)
        after_to_column = find_column_by.call(to)
        after_indexes = find_indexes
        after_foreign_keys = find_foreign_keys

        expect(after_from_column.sql_type_metadata.sql_type).to eq(after_type) if after_type
        expect_column_type_is_changed_but_others_remain_unchanged.call
      }
    end
  end
end