File: idempotency_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 (44 lines) | stat: -rw-r--r-- 1,174 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
# frozen_string_literal: true

# This shared_example requires the following variables:
# - job_args (if not given, will fallback to call perform without arguments)
#
# Usage:
#
#   it_behaves_like 'an idempotent worker' do
#     it 'checks the side-effects for multiple calls' do
#       # it'll call the job's perform method 2 times
#       perform_idempotent_work
#
#       expect(model.state).to eq('state')
#     end
#   end
#
RSpec.shared_examples 'an idempotent worker' do
  let(:worker_exec_times) { IdempotentWorkerHelper::WORKER_EXEC_TIMES }

  # Avoid stubbing calls for a more accurate run.
  subject(:perform_idempotent_work) do
    if described_class.include?(::Gitlab::EventStore::Subscriber)
      event_worker
    else
      standard_worker
    end
  end

  it 'is labeled as idempotent' do
    expect(described_class).to be_idempotent
  end

  it 'performs multiple times sequentially without raising an exception' do
    expect { subject }.not_to raise_error
  end

  def event_worker
    consume_event(subscriber: described_class, event: event)
  end

  def standard_worker
    defined?(job_args) ? perform_multiple(job_args) : perform_multiple
  end
end