summaryrefslogtreecommitdiff
path: root/spec/rubocop/cop/rspec/have_gitlab_http_status_spec.rb
blob: c2d97c8992a9c7bd5b20f114492b742358e29397 (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
# frozen_string_literal: true

require 'fast_spec_helper'

require 'rspec-parameterized'
require 'rubocop'
require_relative '../../../../rubocop/cop/rspec/have_gitlab_http_status'

RSpec.describe RuboCop::Cop::RSpec::HaveGitlabHttpStatus do
  using RSpec::Parameterized::TableSyntax

  let(:source_file) { 'spec/foo_spec.rb' }

  subject(:cop) { described_class.new }

  shared_examples 'offense' do |bad, good|
    it 'registers an offense', :aggregate_failures do
      expect_offense(<<~CODE, node: bad)
        %{node}
        ^{node} [...]
      CODE

      expect_correction(<<~CODE)
        #{good}
      CODE
    end
  end

  shared_examples 'no offense' do |code|
    it 'does not register an offense' do
      expect_no_offenses(code)
    end
  end

  shared_examples 'offense with no autocorrect' do |code|
    it 'does not autocorrect' do
      expect_offense(<<~CODE, node: code)
        %{node}
        ^{node} [...]
      CODE

      expect_no_corrections
    end
  end

  describe 'offenses and autocorrections' do
    where(:bad, :good) do
      'have_http_status(:ok)'        | 'have_gitlab_http_status(:ok)'
      'have_http_status(204)'        | 'have_gitlab_http_status(:no_content)'
      'have_gitlab_http_status(201)' | 'have_gitlab_http_status(:created)'
      'have_http_status(var)'        | 'have_gitlab_http_status(var)'
      'have_http_status(:success)'   | 'have_gitlab_http_status(:success)'
      'have_http_status(:invalid)'   | 'have_gitlab_http_status(:invalid)'
      'expect(response.status).to eq(200)'     | 'expect(response).to have_gitlab_http_status(:ok)'
      'expect(response.status).not_to eq(200)' | 'expect(response).not_to have_gitlab_http_status(:ok)'
    end

    with_them do
      include_examples 'offense', params[:bad], params[:good]
      include_examples 'no offense', params[:good]
    end
  end

  describe 'partially autocorrects invalid numeric status' do
    where(:bad, :good) do
      'have_http_status(-1)' | 'have_gitlab_http_status(-1)'
    end

    with_them do
      include_examples 'offense', params[:bad], params[:good]
      include_examples 'offense with no autocorrect', params[:good]
    end
  end

  describe 'ignore' do
    where(:code) do
      [
        'have_http_status',
        'have_http_status { }',
        'have_http_status(200, arg)',
        'have_gitlab_http_status',
        'have_gitlab_http_status { }',
        'have_gitlab_http_status(200, arg)',
        'expect(response.status).to eq(arg)',
        'expect(response.status).to eq(:ok)',
        'expect(response.status).to some_matcher(200)',
        'expect(response.status).not_to eq(arg)',
        'expect(response.status).not_to eq(:ok)',
        'expect(response.status).not_to some_matcher(200)',
        'expect(result.status).to eq(200)',
        'expect(result.status).not_to eq(200)',
        <<~CODE,
          response = some_assignment
          expect(response.status).to eq(200)
        CODE
        <<~CODE
          response = some_assignment
          expect(response.status).not_to eq(200)
        CODE
      ]
    end

    with_them do
      include_examples 'no offense', params[:code]
    end
  end
end