summaryrefslogtreecommitdiff
path: root/spec/services/spam/spam_verdict_service_spec.rb
blob: 659c21b7d4f05758553809c2c1c80a51aae16c53 (plain)
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Spam::SpamVerdictService do
  include_context 'includes Spam constants'

  let(:fake_ip) { '1.2.3.4' }
  let(:fake_user_agent) { 'fake-user-agent' }
  let(:fake_referer) { 'fake-http-referer' }
  let(:env) do
    { 'action_dispatch.remote_ip' => fake_ip,
      'HTTP_USER_AGENT' => fake_user_agent,
      'HTTP_REFERER' => fake_referer }
  end

  let(:check_for_spam) { true }
  let_it_be(:user) { create(:user) }
  let_it_be(:issue) { create(:issue, author: user) }

  let(:service) do
    described_class.new(user: user, target: issue, options: {})
  end

  let(:attribs) do
    extra_attributes = { "monitorMode" => "false" }
    extra_attributes
  end

  describe '#execute' do
    subject { service.execute }

    before do
      allow(service).to receive(:akismet_verdict).and_return(nil)
      allow(service).to receive(:spamcheck_verdict).and_return([nil, attribs])
    end

    context 'if all services return nil' do
      it 'renders ALLOW verdict' do
        expect(subject).to eq ALLOW
      end
    end

    context 'if only one service returns a verdict' do
      context 'and it is supported' do
        before do
          allow(service).to receive(:akismet_verdict).and_return(DISALLOW)
        end

        it 'renders that verdict' do
          expect(subject).to eq DISALLOW
        end
      end

      context 'and it is unexpected' do
        before do
          allow(service).to receive(:akismet_verdict).and_return("unexpected")
        end

        it 'allows' do
          expect(subject).to eq ALLOW
        end
      end
    end

    context 'if more than one service returns a verdict' do
      context 'and they are supported' do
        before do
          allow(service).to receive(:akismet_verdict).and_return(DISALLOW)
          allow(service).to receive(:spamcheck_verdict).and_return([BLOCK_USER, attribs])
        end

        it 'renders the more restrictive verdict' do
          expect(subject).to eq BLOCK_USER
        end
      end

      context 'and one is supported' do
        before do
          allow(service).to receive(:akismet_verdict).and_return('nonsense')
          allow(service).to receive(:spamcheck_verdict).and_return([BLOCK_USER, attribs])
        end

        it 'renders the more restrictive verdict' do
          expect(subject).to eq BLOCK_USER
        end
      end

      context 'and none are supported' do
        before do
          allow(service).to receive(:akismet_verdict).and_return('nonsense')
          allow(service).to receive(:spamcheck_verdict).and_return(['rubbish', attribs])
        end

        it 'renders the more restrictive verdict' do
          expect(subject).to eq ALLOW
        end
      end

      context 'and attribs - monitorMode is true' do
        let(:attribs) do
          extra_attributes = { "monitorMode" => "true" }
          extra_attributes
        end

        before do
          allow(service).to receive(:akismet_verdict).and_return(DISALLOW)
          allow(service).to receive(:spamcheck_verdict).and_return([BLOCK_USER, attribs])
        end

        it 'renders the more restrictive verdict' do
          expect(subject).to eq(DISALLOW)
        end
      end
    end

    context 'records metrics' do
      let(:histogram) { instance_double(Prometheus::Client::Histogram) }

      using RSpec::Parameterized::TableSyntax

      where(:verdict, :error, :label) do
        Spam::SpamConstants::ALLOW             |  false |  'ALLOW'
        Spam::SpamConstants::ALLOW             |  true  |  'ERROR'
        Spam::SpamConstants::CONDITIONAL_ALLOW |  false |  'CONDITIONAL_ALLOW'
        Spam::SpamConstants::BLOCK_USER        |  false |  'BLOCK'
        Spam::SpamConstants::DISALLOW          |  false |  'DISALLOW'
        Spam::SpamConstants::NOOP              |  false |  'NOOP'
      end

      with_them do
        before do
          allow(Gitlab::Metrics).to receive(:histogram).with(:gitlab_spamcheck_request_duration_seconds, anything).and_return(histogram)
          allow(service).to receive(:spamcheck_verdict).and_return([verdict, attribs, error])
        end

        it 'records duration with labels' do
          expect(histogram).to receive(:observe).with(a_hash_including(result: label), anything)
          subject
        end
      end
    end
  end

  describe '#akismet_verdict' do
    subject { service.send(:akismet_verdict) }

    context 'if Akismet is enabled' do
      before do
        stub_application_setting(akismet_enabled: true)
        allow_next_instance_of(Spam::AkismetService) do |service|
          allow(service).to receive(:spam?).and_return(akismet_result)
        end
      end

      context 'if Akismet considers it spam' do
        let(:akismet_result) { true }

        context 'if reCAPTCHA is enabled' do
          before do
            stub_application_setting(recaptcha_enabled: true)
          end

          it 'returns conditionally allow verdict' do
            expect(subject).to eq CONDITIONAL_ALLOW
          end
        end

        context 'if reCAPTCHA is not enabled' do
          before do
            stub_application_setting(recaptcha_enabled: false)
          end

          it 'renders disallow verdict' do
            expect(subject).to eq DISALLOW
          end
        end
      end

      context 'if Akismet does not consider it spam' do
        let(:akismet_result) { false }

        it 'renders allow verdict' do
          expect(subject).to eq ALLOW
        end
      end
    end

    context 'if Akismet is not enabled' do
      before do
        stub_application_setting(akismet_enabled: false)
      end

      it 'renders allow verdict' do
        expect(subject).to eq ALLOW
      end
    end
  end

  describe '#spamcheck_verdict' do
    subject { service.send(:spamcheck_verdict) }

    context 'if a Spam Check endpoint enabled and set to a URL' do
      let(:spam_check_body) { {} }
      let(:endpoint_url) { "grpc://www.spamcheckurl.com/spam_check" }

      let(:spam_client) do
        Gitlab::Spamcheck::Client.new
      end

      before do
        stub_application_setting(spam_check_endpoint_enabled: true)
        stub_application_setting(spam_check_endpoint_url: endpoint_url)
      end

      context 'if the endpoint is accessible' do
        let(:error) { '' }
        let(:verdict) { nil }

        let(:attribs) do
          extra_attributes = { "monitorMode" => "false" }
          extra_attributes
        end

        before do
          allow(service).to receive(:spamcheck_client).and_return(spam_client)
          allow(spam_client).to receive(:issue_spam?).and_return([verdict, attribs, error])
        end

        context 'if the result is a NOOP verdict' do
          let(:verdict) { NOOP }

          it 'returns the verdict' do
            expect(subject).to eq([NOOP, attribs])
          end
        end

        context 'if attribs - monitorMode is true' do
          let(:attribs) do
            extra_attributes = { "monitorMode" => "true" }
            extra_attributes
          end

          let(:verdict) { ALLOW }

          it 'returns the verdict' do
            expect(subject).to eq([ALLOW, attribs])
          end
        end

        context 'the result is a valid verdict' do
          let(:verdict) { ALLOW }

          it 'returns the verdict' do
            expect(subject).to eq([ALLOW, attribs])
          end
        end

        context 'when recaptcha is enabled' do
          before do
            allow(Gitlab::Recaptcha).to receive(:enabled?).and_return(true)
          end

          using RSpec::Parameterized::TableSyntax

          # rubocop: disable Lint/BinaryOperatorWithIdenticalOperands
          where(:verdict_value, :expected) do
            ::Spam::SpamConstants::ALLOW               | ::Spam::SpamConstants::ALLOW
            ::Spam::SpamConstants::CONDITIONAL_ALLOW   | ::Spam::SpamConstants::CONDITIONAL_ALLOW
            ::Spam::SpamConstants::DISALLOW            | ::Spam::SpamConstants::CONDITIONAL_ALLOW
            ::Spam::SpamConstants::BLOCK_USER          | ::Spam::SpamConstants::CONDITIONAL_ALLOW
          end
          # rubocop: enable Lint/BinaryOperatorWithIdenticalOperands

          with_them do
            let(:verdict) { verdict_value }

            it "returns expected spam constant" do
              expect(subject).to eq([expected, attribs])
            end
          end
        end

        context 'when recaptcha is disabled' do
          before do
            allow(Gitlab::Recaptcha).to receive(:enabled?).and_return(false)
          end

          [::Spam::SpamConstants::ALLOW,
           ::Spam::SpamConstants::CONDITIONAL_ALLOW,
           ::Spam::SpamConstants::DISALLOW,
           ::Spam::SpamConstants::BLOCK_USER].each do |verdict_value|
            let(:verdict) { verdict_value }
            let(:expected) { [verdict_value, attribs] }

            it "returns expected spam constant" do
              expect(subject).to eq(expected)
            end
          end
        end

        context 'the verdict is an unexpected value' do
          let(:verdict) { :this_is_fine }

          it 'returns the string' do
            expect(subject).to eq([verdict, attribs])
          end
        end

        context 'the verdict is an empty string' do
          let(:verdict) { '' }

          it 'returns nil' do
            expect(subject).to eq([verdict, attribs])
          end
        end

        context 'the verdict is nil' do
          let(:verdict) { nil }

          it 'returns nil' do
            expect(subject).to eq([nil, attribs])
          end
        end

        context 'there is an error' do
          let(:error) { "Sorry Dave, I can't do that" }

          it 'returns nil' do
            expect(subject).to eq([nil, attribs])
          end
        end

        context 'the requested is aborted' do
          let(:attribs) { nil }

          before do
            allow(spam_client).to receive(:issue_spam?).and_raise(GRPC::Aborted)
          end

          it 'returns nil' do
            expect(subject).to eq([ALLOW, attribs, true])
          end
        end

        context 'the confused API endpoint returns both an error and a verdict' do
          let(:verdict) { 'disallow' }
          let(:error) { 'oh noes!' }

          it 'renders the verdict' do
            expect(subject).to eq [DISALLOW, attribs]
          end
        end
      end

      context 'if the endpoint times out' do
        let(:attribs) { nil }

        before do
          allow(spam_client).to receive(:issue_spam?).and_raise(GRPC::DeadlineExceeded)
        end

        it 'returns nil' do
          expect(subject).to eq([ALLOW, attribs, true])
        end
      end
    end

    context 'if a Spam Check endpoint is not set' do
      before do
        stub_application_setting(spam_check_endpoint_url: nil)
      end

      it 'returns nil' do
        expect(subject).to be_nil
      end
    end

    context 'if Spam Check endpoint is not enabled' do
      before do
        stub_application_setting(spam_check_endpoint_enabled: false)
      end

      it 'returns nil' do
        expect(subject).to be_nil
      end
    end
  end
end