File: monitor_locked_tables_worker_spec.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 (178 lines) | stat: -rw-r--r-- 6,956 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
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.describe Database::MonitorLockedTablesWorker, feature_category: :cell do
  let(:worker) { described_class.new }
  let(:tables_locker) { instance_double(Gitlab::Database::TablesLocker, lock_writes: nil) }

  describe '#perform' do
    context 'when running with single database' do
      before do
        skip_if_database_exists(:ci)
        skip_if_database_exists(:sec)
      end

      it 'skips executing the job' do
        expect(Gitlab::Database::TablesLocker).not_to receive(:new)
        worker.perform
      end
    end

    context 'when running in decomposed database' do
      before do
        skip_if_shared_database(:ci)
      end

      context 'when the feature flag is disabled' do
        before do
          stub_feature_flags(monitor_database_locked_tables: false)
        end

        it 'skips executing the job' do
          expect(Gitlab::Database::TablesLocker).not_to receive(:new)
          worker.perform
        end
      end

      context 'when the feature flag is enabled' do
        before do
          stub_feature_flags(monitor_database_locked_tables: true)
          allow(Gitlab::Database::TablesLocker).to receive(:new).and_return(tables_locker)
        end

        it 'calls TablesLocker with dry_run enabled' do
          expect(tables_locker).to receive(:lock_writes).and_return([])
          expect(worker).to receive(:log_extra_metadata_on_done)

          worker.perform
        end

        it 'reports the tables that need to be locked on both databases main and ci' do
          skip_if_database_exists(:sec)

          lock_writes_results = [
            { table: 'users', database: 'ci', action: 'needs_lock' },
            { table: 'projects', database: 'ci', action: 'needs_lock' },
            { table: 'ci_builds', database: 'ci', action: 'skipped' },
            { table: 'ci_builds', database: 'main', action: 'needs_lock' },
            { table: 'users', database: 'main', action: 'skipped' },
            { table: 'projects', database: 'main', action: 'skipped' },
            { table: 'issues', database: 'main', action: 'needs_unlock' } # if a table was locked by mistake
          ]
          expected_log_results = {
            'ci' => {
              tables_need_lock: %w[users projects],
              tables_need_lock_count: 2,
              tables_need_unlock: [],
              tables_need_unlock_count: 0
            },
            'main' => {
              tables_need_lock: ['ci_builds'],
              tables_need_lock_count: 1,
              tables_need_unlock: ['issues'],
              tables_need_unlock_count: 1
            }
          }
          expect(tables_locker).to receive(:lock_writes).and_return(lock_writes_results)
          expect(worker).to receive(:log_extra_metadata_on_done).with(:results, expected_log_results)

          worker.perform
        end

        it 'reports the tables that need to be locked on main, ci, and sec databases' do
          skip_if_shared_database(:ci)
          skip_if_shared_database(:sec)

          lock_writes_results = [
            { table: 'vulnerabilities', database: 'sec', action: 'skipped' },
            { table: 'vulnerabilities', database: 'ci', action: 'needs_lock' },
            { table: 'vulnerabilities', database: 'main', action: 'needs_lock' },
            { table: 'users', database: 'sec', action: 'needs_lock' },
            { table: 'users', database: 'ci', action: 'needs_lock' },
            { table: 'projects', database: 'ci', action: 'needs_lock' },
            { table: 'ci_builds', database: 'ci', action: 'skipped' },
            { table: 'ci_builds', database: 'main', action: 'needs_lock' },
            { table: 'users', database: 'main', action: 'skipped' },
            { table: 'projects', database: 'main', action: 'skipped' },
            { table: 'issues', database: 'main', action: 'needs_unlock' } # if a table was locked by mistake
          ]
          expected_log_results = {
            'ci' => {
              tables_need_lock: %w[vulnerabilities users projects],
              tables_need_lock_count: 3,
              tables_need_unlock: [],
              tables_need_unlock_count: 0
            },
            'sec' => {
              tables_need_lock: %w[users],
              tables_need_lock_count: 1,
              tables_need_unlock: [],
              tables_need_unlock_count: 0
            },
            'main' => {
              tables_need_lock: %w[vulnerabilities ci_builds],
              tables_need_lock_count: 2,
              tables_need_unlock: ['issues'],
              tables_need_unlock_count: 1
            }
          }
          expect(tables_locker).to receive(:lock_writes).and_return(lock_writes_results)
          expect(worker).to receive(:log_extra_metadata_on_done).with(:results, expected_log_results)

          worker.perform
        end

        context 'with automatically locking the unlocked tables' do
          context 'when there are no tables to be locked' do
            before do
              stub_feature_flags(lock_tables_in_monitoring: true)
              allow(tables_locker).to receive(:lock_writes).and_return([])
            end

            it 'does not call the Database::LockTablesWorker' do
              expect(Database::LockTablesWorker).not_to receive(:perform_async)
            end
          end

          context 'when there are tables to be locked' do
            before do
              lock_writes_results = [
                { table: 'users', database: 'ci', action: 'needs_lock' },
                { table: 'projects', database: 'ci', action: 'needs_lock' },
                { table: 'ci_builds', database: 'main', action: 'needs_lock' },
                { table: 'ci_pipelines', database: 'main', action: 'skipped' }
              ]
              allow(tables_locker).to receive(:lock_writes).and_return(lock_writes_results)
            end

            context 'when feature flag lock_tables_in_monitoring is enabled' do
              before do
                stub_feature_flags(lock_tables_in_monitoring: true)
              end

              it 'locks the tables that need to be locked' do
                expect(Database::LockTablesWorker).to receive(:perform_async).once.with('ci', %w[users projects])
                expect(Database::LockTablesWorker).to receive(:perform_async).once.with('main', %w[ci_builds])

                worker.perform
              end
            end

            context 'when feature flag lock_tables_in_monitoring is disabled' do
              before do
                stub_feature_flags(lock_tables_in_monitoring: false)
              end

              it 'does not lock the tables that need to be locked' do
                expect(Database::LockTablesWorker).not_to receive(:perform_async)

                worker.perform
              end
            end
          end
        end
      end
    end
  end
end