File: update_shared_runners_service_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 (262 lines) | stat: -rw-r--r-- 11,692 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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Groups::UpdateSharedRunnersService, '#execute', :sidekiq_inline, feature_category: :groups_and_projects do
  include ReloadHelpers

  let(:params) { {} }
  let(:service) { described_class.new(group, user, params) }

  subject(:execute) { service.execute }

  context 'when current_user is not the group owner' do
    let_it_be(:user) { create(:user) }

    let(:group) { create(:group, maintainers: user) }
    let(:params) { { shared_runners_setting: 'enabled' } }

    it 'returns error' do
      is_expected.to match(a_hash_including(
        status: :error,
        message: 'Operation not allowed',
        http_status: 403))
    end
  end

  context 'when current_user is the group owner' do
    let_it_be(:user) { create(:user) }

    before do
      group.add_owner(user)
    end

    context 'enable shared Runners' do
      let(:params) { { shared_runners_setting: 'enabled' } }

      context 'when ancestor disable shared runners' do
        let(:parent) { create(:group, :shared_runners_disabled) }
        let(:group) { create(:group, :shared_runners_disabled, parent: parent) }
        let!(:project) { create(:project, shared_runners_enabled: false, group: group) }

        it 'returns an error and does not enable shared runners' do
          expect do
            expect(execute).to match(a_hash_including(
              status: :error,
              message:
                'Validation failed: Shared runners enabled cannot be enabled because parent group ' \
                'has shared Runners disabled'))

            reload_models(parent, group, project)
          end.to not_change { parent.shared_runners_enabled }
            .and not_change { group.shared_runners_enabled }
            .and not_change { project.shared_runners_enabled }
        end
      end

      context 'when updating root group' do
        let(:group) { create(:group, :shared_runners_disabled) }
        let(:sub_group) { create(:group, :shared_runners_disabled, parent: group) }
        let!(:project) { create(:project, shared_runners_enabled: false, group: sub_group) }

        it 'enables shared Runners for itself and descendants' do
          expect do
            expect(execute[:status]).to eq(:success)

            reload_models(group, sub_group, project)
          end.to change { group.shared_runners_enabled }.from(false).to(true)
            .and change { sub_group.shared_runners_enabled }.from(false).to(true)
            .and change { project.shared_runners_enabled }.from(false).to(true)
        end

        context 'when already allowing descendants to override' do
          let(:group) { create(:group, :shared_runners_disabled_and_overridable) }

          it 'enables shared Runners for itself and descendants' do
            expect do
              expect(execute[:status]).to eq(:success)

              reload_models(group, sub_group, project)
            end.to change { group.shared_runners_enabled }.from(false).to(true)
              .and change { group.allow_descendants_override_disabled_shared_runners }.from(true).to(false)
              .and change { sub_group.shared_runners_enabled }.from(false).to(true)
              .and change { project.shared_runners_enabled }.from(false).to(true)
          end
        end
      end

      context 'when group has pending builds', :aggregate_failures do
        let_it_be(:group) { create(:group, :shared_runners_disabled) }
        let_it_be(:sub_group) { create(:group, :shared_runners_disabled, parent: group) }
        let_it_be(:project) { create(:project, namespace: group, shared_runners_enabled: false) }
        let_it_be(:project2) { create(:project, namespace: sub_group, shared_runners_enabled: false) }
        let_it_be(:pending_build_1) { create(:ci_pending_build, project: project, instance_runners_enabled: false) }
        let_it_be(:pending_build_2) { create(:ci_pending_build, project: project, instance_runners_enabled: false) }
        let_it_be(:pending_build_3) { create(:ci_pending_build, project: project2, instance_runners_enabled: false) }

        it 'updates pending builds for the group and descendants' do
          expect(::Ci::PendingBuilds::UpdateGroupWorker).to receive(:perform_async)
            .with(group.id, { 'instance_runners_enabled' => true })
            .and_call_original

          execute

          expect(pending_build_1.reload.instance_runners_enabled).to be_truthy
          expect(pending_build_2.reload.instance_runners_enabled).to be_truthy
          expect(pending_build_3.reload.instance_runners_enabled).to be_truthy
        end

        context 'when shared runners is not toggled' do
          let(:params) { { shared_runners_setting: 'invalid_enabled' } }

          it 'does not update pending builds for the group' do
            expect(::Ci::PendingBuilds::UpdateGroupWorker).not_to receive(:new)

            execute

            expect(pending_build_1.reload.instance_runners_enabled).to be_falsey
            expect(pending_build_2.reload.instance_runners_enabled).to be_falsey
          end
        end
      end
    end

    context 'disable shared Runners' do
      let!(:group) { create(:group) }
      let!(:sub_group) { create(:group, :shared_runners_disabled_and_overridable, parent: group) }
      let!(:sub_group2) { create(:group, parent: group) }
      let!(:project) { create(:project, group: group, shared_runners_enabled: true) }
      let!(:project2) { create(:project, group: sub_group2, shared_runners_enabled: true) }

      let(:params) { { shared_runners_setting: Namespace::SR_DISABLED_AND_UNOVERRIDABLE } }

      it 'disables shared Runners for all descendant groups and projects' do
        expect do
          expect(execute[:status]).to eq(:success)

          reload_models(group, sub_group, sub_group2, project, project2)
        end.to change { group.shared_runners_enabled }.from(true).to(false)
          .and not_change { group.allow_descendants_override_disabled_shared_runners }
          .and not_change { sub_group.shared_runners_enabled }
          .and change { sub_group.allow_descendants_override_disabled_shared_runners }.from(true).to(false)
          .and change { sub_group2.shared_runners_enabled }.from(true).to(false)
          .and not_change { sub_group2.allow_descendants_override_disabled_shared_runners }
          .and change { project.shared_runners_enabled }.from(true).to(false)
          .and change { project2.shared_runners_enabled }.from(true).to(false)
      end

      context 'with override on self' do
        let(:group) { create(:group, :shared_runners_disabled_and_overridable) }

        it 'disables it' do
          expect do
            expect(execute[:status]).to eq(:success)

            group.reload
          end
            .to not_change { group.shared_runners_enabled }
            .and change { group.allow_descendants_override_disabled_shared_runners }.from(true).to(false)
        end
      end

      context 'when group has pending builds', :aggregate_failures do
        let!(:pending_build_1) { create(:ci_pending_build, project: project, instance_runners_enabled: true) }
        let!(:pending_build_2) { create(:ci_pending_build, project: project, instance_runners_enabled: true) }

        it 'updates pending builds for the group and descendants' do
          expect(::Ci::PendingBuilds::UpdateGroupWorker).to receive(:perform_async)
            .with(group.id, { 'instance_runners_enabled' => false })
            .and_call_original

          execute

          expect(pending_build_1.reload.instance_runners_enabled).to be_falsey
          expect(pending_build_2.reload.instance_runners_enabled).to be_falsey
        end
      end
    end

    shared_examples 'allow descendants to override' do
      context 'top level group' do
        let!(:group) { create(:group, :shared_runners_disabled) }
        let!(:sub_group) { create(:group, :shared_runners_disabled, parent: group) }
        let!(:project) { create(:project, shared_runners_enabled: false, group: sub_group) }

        it 'enables allow descendants to override only for itself' do
          expect do
            expect(execute[:status]).to eq(:success)

            reload_models(group, sub_group, project)
          end.to change { group.allow_descendants_override_disabled_shared_runners }.from(false).to(true)
            .and not_change { group.shared_runners_enabled }
            .and not_change { sub_group.allow_descendants_override_disabled_shared_runners }
            .and not_change { sub_group.shared_runners_enabled }
            .and not_change { project.shared_runners_enabled }
        end
      end

      context 'when ancestor disables shared Runners but allows to override' do
        let!(:parent) { create(:group, :shared_runners_disabled_and_overridable) }
        let!(:group) { create(:group, :shared_runners_disabled, parent: parent) }
        let!(:project) { create(:project, shared_runners_enabled: false, group: group) }

        it 'enables allow descendants to override' do
          expect do
            expect(execute[:status]).to eq(:success)

            reload_models(parent, group, project)
          end
            .to not_change { parent.allow_descendants_override_disabled_shared_runners }
            .and not_change { parent.shared_runners_enabled }
            .and change { group.allow_descendants_override_disabled_shared_runners }.from(false).to(true)
            .and not_change { group.shared_runners_enabled }
            .and not_change { project.shared_runners_enabled }
        end
      end

      context 'when ancestor disables shared runners' do
        let(:parent) { create(:group, :shared_runners_disabled) }
        let(:group) { create(:group, :shared_runners_disabled, parent: parent) }
        let!(:project) { create(:project, shared_runners_enabled: false, group: group) }

        it 'returns an error and does not enable shared runners' do
          expect do
            expect(execute).to match(a_hash_including(
              status: :error,
              message:
                'Validation failed: Allow descendants override disabled shared runners cannot be enabled ' \
                'because parent group does not allow it'))

            reload_models(parent, group, project)
          end.to not_change { parent.shared_runners_enabled }
            .and not_change { group.shared_runners_enabled }
            .and not_change { project.shared_runners_enabled }
        end
      end

      context 'top level group that has shared Runners enabled' do
        let!(:group) { create(:group, shared_runners_enabled: true) }
        let!(:sub_group) { create(:group, shared_runners_enabled: true, parent: group) }
        let!(:project) { create(:project, shared_runners_enabled: true, group: sub_group) }

        it 'enables allow descendants to override & disables shared runners everywhere' do
          expect do
            expect(execute[:status]).to eq(:success)

            reload_models(group, sub_group, project)
          end
            .to change { group.shared_runners_enabled }.from(true).to(false)
            .and change { group.allow_descendants_override_disabled_shared_runners }.from(false).to(true)
            .and change { sub_group.shared_runners_enabled }.from(true).to(false)
            .and change { project.shared_runners_enabled }.from(true).to(false)
        end
      end
    end

    context "when using SR_DISABLED_AND_OVERRIDABLE" do
      let(:params) { { shared_runners_setting: Namespace::SR_DISABLED_AND_OVERRIDABLE } }

      include_examples 'allow descendants to override'
    end
  end
end