summaryrefslogtreecommitdiff
path: root/spec/services/container_expiration_policies/cleanup_service_spec.rb
blob: c6faae7449de0966f5c8b2ea2dce8d6dcc4deb47 (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
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe ContainerExpirationPolicies::CleanupService do
  let_it_be(:repository, reload: true) { create(:container_repository, expiration_policy_started_at: 30.minutes.ago) }
  let_it_be(:project) { repository.project }

  let(:service) { described_class.new(repository) }

  describe '#execute' do
    subject { service.execute }

    shared_examples 'cleaning up a container repository' do
      context 'with a successful cleanup tags service execution' do
        let(:cleanup_tags_service_params) { project.container_expiration_policy.policy_params.merge('container_expiration_policy' => true) }
        let(:cleanup_tags_service) { instance_double(Projects::ContainerRepository::CleanupTagsService) }

        it 'completely clean up the repository' do
          expect(Projects::ContainerRepository::CleanupTagsService)
            .to receive(:new).with(project, nil, cleanup_tags_service_params).and_return(cleanup_tags_service)
          expect(cleanup_tags_service).to receive(:execute).with(repository).and_return(status: :success)

          response = subject

          aggregate_failures "checking the response and container repositories" do
            expect(response.success?).to eq(true)
            expect(response.payload).to include(cleanup_status: :finished, container_repository_id: repository.id)
            expect(ContainerRepository.waiting_for_cleanup.count).to eq(0)
            expect(repository.reload.cleanup_unscheduled?).to be_truthy
            expect(repository.expiration_policy_completed_at).not_to eq(nil)
            expect(repository.expiration_policy_started_at).not_to eq(nil)
          end
        end
      end

      context 'without a successful cleanup tags service execution' do
        let(:cleanup_tags_service_response) { { status: :error, message: 'timeout' } }

        before do
          expect(Projects::ContainerRepository::CleanupTagsService)
            .to receive(:new).and_return(double(execute: cleanup_tags_service_response))
        end

        it 'partially clean up the repository' do
          response = subject

          aggregate_failures "checking the response and container repositories" do
            expect(response.success?).to eq(true)
            expect(response.payload).to include(cleanup_status: :unfinished, container_repository_id: repository.id)
            expect(ContainerRepository.waiting_for_cleanup.count).to eq(1)
            expect(repository.reload.cleanup_unfinished?).to be_truthy
            expect(repository.expiration_policy_started_at).not_to eq(nil)
            expect(repository.expiration_policy_completed_at).to eq(nil)
          end
        end

        context 'with a truncated cleanup tags service response' do
          let(:cleanup_tags_service_response) do
            {
              status: :error,
              original_size: 1000,
              before_truncate_size: 800,
              after_truncate_size: 200,
              before_delete_size: 100,
              deleted_size: 100
            }
          end

          it 'partially clean up the repository' do
            response = subject

            aggregate_failures "checking the response and container repositories" do
              expect(response.success?).to eq(true)
              expect(response.payload)
                .to include(
                  cleanup_status: :unfinished,
                  container_repository_id: repository.id,
                  cleanup_tags_service_original_size: 1000,
                  cleanup_tags_service_before_truncate_size: 800,
                  cleanup_tags_service_after_truncate_size: 200,
                  cleanup_tags_service_before_delete_size: 100,
                  cleanup_tags_service_deleted_size: 100
                )
              expect(ContainerRepository.waiting_for_cleanup.count).to eq(1)
              expect(repository.reload.cleanup_unfinished?).to be_truthy
              expect(repository.expiration_policy_started_at).not_to eq(nil)
              expect(repository.expiration_policy_completed_at).to eq(nil)
            end
          end
        end
      end

      context 'with no repository' do
        let(:service) { described_class.new(nil) }

        it 'returns an error response' do
          expect(subject.success?).to eq(false)
          expect(subject.message).to eq('no repository')
        end
      end

      context 'with an invalid policy' do
        let(:policy) { repository.project.container_expiration_policy }

        before do
          policy.name_regex = nil
          policy.enabled = true
          repository.expiration_policy_cleanup_status = :cleanup_ongoing
        end

        it 'returns an error response' do
          expect { subject }.to change { repository.expiration_policy_cleanup_status }.from('cleanup_ongoing').to('cleanup_unscheduled')
          expect(subject.success?).to eq(false)
          expect(subject.message).to eq('invalid policy')
          expect(policy).not_to be_enabled
        end
      end

      context 'with a network error' do
        before do
          expect(Projects::ContainerRepository::CleanupTagsService)
            .to receive(:new).and_raise(Faraday::TimeoutError)
        end

        it 'raises an error' do
          expect { subject }.to raise_error(Faraday::TimeoutError)

          expect(ContainerRepository.waiting_for_cleanup.count).to eq(1)
          expect(repository.reload.cleanup_unfinished?).to be_truthy
          expect(repository.expiration_policy_started_at).not_to eq(nil)
          expect(repository.expiration_policy_completed_at).to eq(nil)
        end
      end
    end

    context 'with loopless enabled' do
      let(:policy) { repository.project.container_expiration_policy }

      before do
        policy.update!(enabled: true)
        policy.update_column(:next_run_at, 5.minutes.ago)
      end

      it_behaves_like 'cleaning up a container repository'

      context 'next run scheduling' do
        let_it_be_with_reload(:repository2) { create(:container_repository, project: project) }
        let_it_be_with_reload(:repository3) { create(:container_repository, project: project) }

        before do
          cleanup_tags_service = instance_double(Projects::ContainerRepository::CleanupTagsService)
          allow(Projects::ContainerRepository::CleanupTagsService)
            .to receive(:new).and_return(cleanup_tags_service)
          allow(cleanup_tags_service).to receive(:execute).and_return(status: :success)
        end

        shared_examples 'not scheduling the next run' do
          it 'does not scheduled the next run' do
            expect(policy).not_to receive(:schedule_next_run!)

            expect { subject }.not_to change { policy.reload.next_run_at }
          end
        end

        shared_examples 'scheduling the next run' do
          it 'schedules the next run' do
            expect(policy).to receive(:schedule_next_run!).and_call_original

            expect { subject }.to change { policy.reload.next_run_at }
          end
        end

        context 'with cleanups started_at before policy next_run_at' do
          before do
            ContainerRepository.update_all(expiration_policy_started_at: 10.minutes.ago)
          end

          it_behaves_like 'not scheduling the next run'
        end

        context 'with cleanups started_at around policy next_run_at' do
          before do
            repository3.update!(expiration_policy_started_at: policy.next_run_at + 10.minutes.ago)
          end

          it_behaves_like 'not scheduling the next run'
        end

        context 'with only the current repository started_at before the policy next_run_at' do
          before do
            repository2.update!(expiration_policy_started_at: policy.next_run_at + 10.minutes)
            repository3.update!(expiration_policy_started_at: policy.next_run_at + 12.minutes)
          end

          it_behaves_like 'scheduling the next run'
        end

        context 'with cleanups started_at after policy next_run_at' do
          before do
            ContainerRepository.update_all(expiration_policy_started_at: policy.next_run_at + 10.minutes)
          end

          it_behaves_like 'scheduling the next run'
        end

        context 'with a future policy next_run_at' do
          before do
            policy.update_column(:next_run_at, 5.minutes.from_now)
          end

          it_behaves_like 'not scheduling the next run'
        end
      end
    end

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

      it_behaves_like 'cleaning up a container repository'
    end
  end
end