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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Memory::Reporter, :aggregate_failures, feature_category: :application_performance do
let(:fake_report) do
Class.new do
def name
'fake_report'
end
def active?
true
end
def run(writer)
writer << 'I ran'
end
end
end
let(:logger) { instance_double(::Logger) }
let(:report) { fake_report.new }
after do
FileUtils.rm_rf(reports_path)
end
describe '#run_report', time_travel_to: '2020-02-02 10:30:45 +0000' do
let(:report_duration_counter) { instance_double(::Prometheus::Client::Counter) }
let(:file_size) { 1_000_000 }
let(:report_file) { "#{reports_path}/fake_report.2020-02-02.10:30:45:000.worker_1.abc123.gz" }
let(:output) { File.read(report_file) }
before do
stub_const('Gitlab::Memory::Reporter::COMPRESS_CMD', %w[cat])
allow(SecureRandom).to receive(:uuid).and_return('abc123')
allow(Gitlab::Metrics).to receive(:counter).and_return(report_duration_counter)
allow(report_duration_counter).to receive(:increment)
allow(::Prometheus::PidProvider).to receive(:worker_id).and_return('worker_1')
allow(File).to receive(:size).with(report_file).and_return(file_size)
allow(logger).to receive(:info)
end
shared_examples 'runs and stores reports' do
it 'runs the given report and returns true' do
expect(reporter.run_report(report)).to be(true)
expect(output).to eq('I ran')
end
it 'logs start and finish event' do
expect(logger).to receive(:info).ordered.with(
hash_including(
message: 'started',
pid: Process.pid,
worker_id: 'worker_1',
perf_report_worker_uuid: 'abc123',
perf_report: 'fake_report'
))
expect(logger).to receive(:info).ordered.with(
hash_including(
:duration_s,
:cpu_s,
perf_report_file: report_file,
perf_report_size_bytes: file_size,
message: 'finished',
pid: Process.pid,
worker_id: 'worker_1',
perf_report_worker_uuid: 'abc123',
perf_report: 'fake_report'
))
reporter.run_report(report)
end
it 'increments Prometheus duration counter' do
expect(report_duration_counter).to receive(:increment).with({ report: 'fake_report' }, an_instance_of(Float))
reporter.run_report(report)
end
context 'when the report returns invalid file path' do
before do
allow(File).to receive(:size).with(report_file).and_raise(Errno::ENOENT)
end
it 'logs `0` as `perf_report_size_bytes`' do
expect(logger).to receive(:info).ordered.with(
hash_including(message: 'started')
)
expect(logger).to receive(:info).ordered.with(
hash_including(message: 'finished', perf_report_size_bytes: 0)
)
reporter.run_report(report)
end
end
context 'when an error occurs' do
shared_examples 'handles errors gracefully' do
it 'logs the error and returns false' do
expect(logger).to receive(:info).ordered.with(hash_including(message: 'started'))
expect(logger).to receive(:error).ordered.with(
hash_including(
message: 'failed', error: match(error_message)
))
expect(reporter.run_report(report)).to be(false)
end
context 'when compression process is still running' do
it 'terminates the process' do
allow(logger).to receive(:info)
allow(logger).to receive(:error)
expect(Gitlab::ProcessManagement).to receive(:signal).with(an_instance_of(Integer), :KILL)
reporter.run_report(report)
end
end
end
context 'when cause was an error being raised' do
let(:error_message) { 'report failed' }
before do
allow(report).to receive(:run).and_raise(RuntimeError.new('report failed'))
end
it_behaves_like 'handles errors gracefully'
end
context 'when cause was compression command failing' do
let(:error_message) { "StandardError: exit 1: cat:" }
before do
stub_const('Gitlab::Memory::Reporter::COMPRESS_CMD', %w[cat --bad-flag])
end
it_behaves_like 'handles errors gracefully'
end
end
context 'when a report is disabled' do
it 'does nothing and returns false' do
expect(report).to receive(:active?).and_return(false)
expect(report).not_to receive(:run)
expect(logger).not_to receive(:info)
expect(report_duration_counter).not_to receive(:increment)
reporter.run_report(report)
end
end
end
context 'when reports path is specified directly' do
let(:reports_path) { Dir.mktmpdir }
subject(:reporter) { described_class.new(reports_path: reports_path, logger: logger) }
it_behaves_like 'runs and stores reports'
end
context 'when reports path is specified via environment' do
let(:reports_path) { Dir.mktmpdir }
subject(:reporter) { described_class.new(logger: logger) }
before do
stub_env('GITLAB_DIAGNOSTIC_REPORTS_PATH', reports_path)
end
it_behaves_like 'runs and stores reports'
end
context 'when reports path is not specified' do
let(:reports_path) { reporter.reports_path }
subject(:reporter) { described_class.new(logger: logger) }
it 'defaults to a temporary location' do
expect(reports_path).not_to be_empty
end
it_behaves_like 'runs and stores reports'
end
end
end
|
