spec/lib/gitlab/sidekiq_middleware/duplicate_jobs/strategies/until_executing_spec.rb


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

# frozen_string_literal: true

require 'fast_spec_helper'

describe Gitlab::SidekiqMiddleware::DuplicateJobs::Strategies::UntilExecuting do
  let(:fake_duplicate_job) do
    instance_double(Gitlab::SidekiqMiddleware::DuplicateJobs::DuplicateJob)
  end

  subject(:strategy) { described_class.new(fake_duplicate_job) }

  describe '#schedule' do
    before do
      allow(Gitlab::SidekiqLogging::DeduplicationLogger.instance).to receive(:log)
    end

    it 'checks for duplicates before yielding' do
      expect(fake_duplicate_job).to receive(:check!).ordered.and_return('a jid')
      expect(fake_duplicate_job).to receive(:duplicate?).ordered.and_return(false)
      expect(fake_duplicate_job).to receive(:droppable?).ordered.and_return(false)

      expect { |b| strategy.schedule({}, &b) }.to yield_control
    end

    it 'adds the jid of the existing job to the job hash' do
      allow(fake_duplicate_job).to receive(:check!).and_return('the jid')
      allow(fake_duplicate_job).to receive(:droppable?).and_return(true)
      job_hash = {}

      expect(fake_duplicate_job).to receive(:duplicate?).and_return(true)
      expect(fake_duplicate_job).to receive(:existing_jid).and_return('the jid')

      strategy.schedule(job_hash) {}

      expect(job_hash).to include('duplicate-of' => 'the jid')
    end

    context "when the job is droppable" do
      before do
        allow(fake_duplicate_job).to receive(:check!).and_return('the jid')
        allow(fake_duplicate_job).to receive(:duplicate?).and_return(true)
        allow(fake_duplicate_job).to receive(:existing_jid).and_return('the jid')
        allow(fake_duplicate_job).to receive(:droppable?).and_return(true)
      end

      it 'drops the job' do
        schedule_result = nil

        expect(fake_duplicate_job).to receive(:droppable?).and_return(true)

        expect { |b| schedule_result = strategy.schedule({}, &b) }.not_to yield_control
        expect(schedule_result).to be(false)
      end

      it 'logs that the job wass dropped' do
        fake_logger = instance_double(Gitlab::SidekiqLogging::DeduplicationLogger)

        expect(Gitlab::SidekiqLogging::DeduplicationLogger).to receive(:instance).and_return(fake_logger)
        expect(fake_logger).to receive(:log).with(a_hash_including({ 'jid' => 'new jid' }), 'dropped until executing')

        strategy.schedule({ 'jid' => 'new jid' }) {}
      end
    end
  end

  describe '#perform' do
    it 'deletes the lock before executing' do
      expect(fake_duplicate_job).to receive(:delete!).ordered
      expect { |b| strategy.perform({}, &b) }.to yield_control
    end
  end
end