spec/lib/gitlab/health_checks/master_check_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
73
74

# frozen_string_literal: true

require 'fast_spec_helper'
require_relative './simple_check_shared'

RSpec.describe Gitlab::HealthChecks::MasterCheck do
  context 'when Puma runs in Clustered mode' do
    before do
      allow(Gitlab::Runtime).to receive(:puma_in_clustered_mode?).and_return(true)

      # We need to capture the read pipe here to stub out the non-blocking read.
      # The original implementation actually forked the test suite for a more
      # end-to-end test but that caused knock-on effects on other tests.
      @pipe_read, _ = described_class.register_master
    end

    after do
      described_class.finish_master
    end

    describe '.available?' do
      specify { expect(described_class.available?).to be true }
    end

    describe '.readiness' do
      context 'when no worker registered' do
        it 'succeeds' do
          expect(described_class.readiness.success).to be(true)
        end
      end

      context 'when worker registers itself' do
        context 'when reading from pipe succeeds' do
          it 'succeeds' do
            expect(@pipe_read).to receive(:read_nonblock) # rubocop: disable RSpec/InstanceVariable

            described_class.register_worker

            expect(described_class.readiness.success).to be(true)
          end
        end

        context 'when read pipe is open but not ready for reading' do
          it 'succeeds' do
            expect(@pipe_read).to receive(:read_nonblock).and_raise(IO::EAGAINWaitReadable) # rubocop: disable RSpec/InstanceVariable

            described_class.register_worker

            expect(described_class.readiness.success).to be(true)
          end
        end
      end

      context 'when master finishes early' do
        it 'fails' do
          described_class.finish_master

          expect(described_class.readiness.success).to be(false)
        end
      end
    end
  end

  # '.readiness' check is not invoked if '.available?' returns false
  context 'when Puma runs in Single mode' do
    before do
      allow(Gitlab::Runtime).to receive(:puma_in_clustered_mode?).and_return(false)
    end

    describe '.available?' do
      specify { expect(described_class.available?).to be false }
    end
  end
end