summaryrefslogtreecommitdiff
path: root/spec/workers/container_expiration_policy_worker_spec.rb
blob: 2d5176e874d3008a0de1f27288c9f517b50a9d91 (plain)
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe ContainerExpirationPolicyWorker do
  include ExclusiveLeaseHelpers

  let(:worker) { described_class.new }
  let(:started_at) { nil }

  describe '#perform' do
    subject { worker.perform }

    shared_examples 'not executing any policy' do
      it 'does not run any policy' do
        expect(ContainerExpirationPolicyService).not_to receive(:new)

        subject
      end
    end

    shared_examples 'handling a taken exclusive lease' do
      context 'with exclusive lease taken' do
        before do
          stub_exclusive_lease_taken(worker.lease_key, timeout: 5.hours)
        end

        it 'does not do anything' do
          expect(ContainerExpirationPolicies::CleanupContainerRepositoryWorker).not_to receive(:perform_with_capacity)
          expect(worker).not_to receive(:runnable_policies)

          expect { subject }.not_to change { ContainerRepository.cleanup_scheduled.count }
        end
      end
    end

    context 'With no container expiration policies' do
      it 'does not execute any policies' do
        expect(ContainerRepository).not_to receive(:for_project_id)

        expect { subject }.not_to change { ContainerRepository.cleanup_scheduled.count }
      end
    end

    context 'with throttling enabled' do
      before do
        stub_feature_flags(container_registry_expiration_policies_throttling: true)
      end

      context 'with loopless disabled' do
        before do
          stub_feature_flags(container_registry_expiration_policies_loopless: false)
        end

        context 'with container expiration policies' do
          let_it_be(:container_expiration_policy) { create(:container_expiration_policy, :runnable) }
          let_it_be(:container_repository) { create(:container_repository, project: container_expiration_policy.project) }

          before do
            expect(worker).to receive(:with_runnable_policy).and_call_original
          end

          context 'with a valid container expiration policy' do
            it 'schedules the next run' do
              expect { subject }.to change { container_expiration_policy.reload.next_run_at }
            end

            it 'marks the container repository as scheduled for cleanup' do
              expect { subject }.to change { container_repository.reload.cleanup_scheduled? }.from(false).to(true)
              expect(ContainerRepository.cleanup_scheduled.count).to eq(1)
            end

            it 'calls the limited capacity worker' do
              expect(ContainerExpirationPolicies::CleanupContainerRepositoryWorker).to receive(:perform_with_capacity)

              subject
            end
          end

          context 'with a disabled container expiration policy' do
            before do
              container_expiration_policy.disable!
            end

            it 'does not run the policy' do
              expect(ContainerRepository).not_to receive(:for_project_id)

              expect { subject }.not_to change { ContainerRepository.cleanup_scheduled.count }
            end
          end

          context 'with an invalid container expiration policy' do
            let(:user) { container_expiration_policy.project.owner }

            before do
              container_expiration_policy.update_column(:name_regex, '*production')
            end

            it 'disables the policy and tracks an error' do
              expect(ContainerRepository).not_to receive(:for_project_id)
              expect(Gitlab::ErrorTracking).to receive(:log_exception).with(instance_of(described_class::InvalidPolicyError), container_expiration_policy_id: container_expiration_policy.id)

              expect { subject }.to change { container_expiration_policy.reload.enabled }.from(true).to(false)
              expect(ContainerRepository.cleanup_scheduled).to be_empty
            end
          end
        end

        it_behaves_like 'handling a taken exclusive lease'
      end

      context 'with loopless enabled' do
        before do
          stub_feature_flags(container_registry_expiration_policies_loopless: true)
          expect(worker).not_to receive(:with_runnable_policy)
        end

        it 'calls the limited capacity worker' do
          expect(ContainerExpirationPolicies::CleanupContainerRepositoryWorker).to receive(:perform_with_capacity)

          subject
        end

        it_behaves_like 'handling a taken exclusive lease'
      end
    end

    context 'with throttling disabled' do
      before do
        stub_feature_flags(container_registry_expiration_policies_throttling: false)
      end

      context 'with no container expiration policies' do
        it_behaves_like 'not executing any policy'
      end

      context 'with container expiration policies' do
        let_it_be(:container_expiration_policy, reload: true) { create(:container_expiration_policy, :runnable) }
        let_it_be(:container_repository) { create(:container_repository, project: container_expiration_policy.project) }
        let_it_be(:user) { container_expiration_policy.project.owner }

        context 'a valid policy' do
          it 'runs the policy' do
            expect(ContainerExpirationPolicyService)
              .to receive(:new).with(container_expiration_policy.project, user).and_call_original
            expect(CleanupContainerRepositoryWorker).to receive(:perform_async).once.and_call_original

            expect { subject }.not_to raise_error
          end
        end

        context 'a disabled policy' do
          before do
            container_expiration_policy.disable!
          end

          it_behaves_like 'not executing any policy'
        end

        context 'a policy that is not due for a run' do
          before do
            container_expiration_policy.update_column(:next_run_at, 2.minutes.from_now)
          end

          it_behaves_like 'not executing any policy'
        end

        context 'a policy linked to no container repository' do
          before do
            container_expiration_policy.container_repositories.delete_all
          end

          it_behaves_like 'not executing any policy'
        end

        context 'an invalid policy' do
          before do
            container_expiration_policy.update_column(:name_regex, '*production')
          end

          it 'disables the policy and tracks an error' do
            expect(ContainerExpirationPolicyService).not_to receive(:new).with(container_expiration_policy, user)
            expect(Gitlab::ErrorTracking).to receive(:log_exception).with(instance_of(described_class::InvalidPolicyError), container_expiration_policy_id: container_expiration_policy.id)

            expect { subject }.to change { container_expiration_policy.reload.enabled }.from(true).to(false)
          end
        end
      end
    end
  end
end