spec/lib/gitlab/memory/reports/heap_dump_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

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Memory::Reports::HeapDump, feature_category: :cloud_connector do
  # Copy this class so we do not mess with its state.
  let(:klass) { described_class.dup }

  subject(:report) { klass.new }

  describe '#name' do
    # This is a bit silly, but it caused code coverage failures.
    it 'is set' do
      expect(report.name).to eq('heap_dump')
    end
  end

  describe '#active?' do
    it 'is true when report_heap_dumps is enabled' do
      expect(report).to be_active
    end

    it 'is false when report_heap_dumps is disabled' do
      stub_feature_flags(report_heap_dumps: false)

      expect(report).not_to be_active
    end
  end

  describe '#run' do
    subject(:run) { report.run(writer) }

    let(:writer) { StringIO.new }

    context 'when no heap dump is enqueued' do
      it 'does nothing and returns false' do
        expect(ObjectSpace).not_to receive(:dump_all)

        expect(run).to be(false)
      end
    end

    context 'when a heap dump is enqueued', :aggregate_failures do
      it 'dumps heap and returns true' do
        expect(ObjectSpace).to receive(:dump_all).with(output: writer) do |output:|
          output << 'heap contents'
        end

        klass.enqueue!

        expect(run).to be(true)
        expect(writer.string).to eq('heap contents')
      end
    end
  end
end