spec/tooling/danger/outdated_todo_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
75
76
77
78
79
80
81
82
83

# frozen_string_literal: true

require 'fast_spec_helper'
require 'gitlab/dangerfiles/spec_helper'

require_relative '../../../tooling/danger/outdated_todo'

RSpec.describe Tooling::Danger::OutdatedTodo, feature_category: :tooling do
  let(:fake_danger) { double }
  let(:filenames) { ['app/controllers/application_controller.rb'] }

  let(:todos) do
    [
      File.join('spec', 'fixtures', 'tooling', 'danger', 'rubocop_todo', '**', '*.yml')
    ]
  end

  subject(:plugin) { described_class.new(filenames, context: fake_danger, todos: todos) }

  context 'when the filenames are mentioned in single todo' do
    let(:filenames) { ['app/controllers/acme_challenges_controller.rb'] }

    it 'warns about mentions' do
      expect(fake_danger)
        .to receive(:warn)
        .with <<~MESSAGE
          `app/controllers/acme_challenges_controller.rb` was removed but is mentioned in:
          - `spec/fixtures/tooling/danger/rubocop_todo/cop1.yml:5`
        MESSAGE

      plugin.check
    end
  end

  context 'when the filenames are mentioned in multiple todos' do
    let(:filenames) do
      [
        'app/controllers/application_controller.rb',
        'app/controllers/acme_challenges_controller.rb'
      ]
    end

    it 'warns about mentions' do
      expect(fake_danger)
        .to receive(:warn)
        .with(<<~FIRSTMESSAGE)
          `app/controllers/application_controller.rb` was removed but is mentioned in:
          - `spec/fixtures/tooling/danger/rubocop_todo/cop1.yml:4`
          - `spec/fixtures/tooling/danger/rubocop_todo/cop2.yml:4`
        FIRSTMESSAGE

      expect(fake_danger)
        .to receive(:warn)
        .with(<<~SECONDMESSAGE)
          `app/controllers/acme_challenges_controller.rb` was removed but is mentioned in:
          - `spec/fixtures/tooling/danger/rubocop_todo/cop1.yml:5`
        SECONDMESSAGE

      plugin.check
    end
  end

  context 'when the filenames are not mentioned in todos' do
    let(:filenames) { ['any/inexisting/file.rb'] }

    it 'does not warn' do
      expect(fake_danger).not_to receive(:warn)

      plugin.check
    end
  end

  context 'when there is no todos' do
    let(:filenames) { ['app/controllers/acme_challenges_controller.rb'] }
    let(:todos) { [] }

    it 'does not warn' do
      expect(fake_danger).not_to receive(:warn)

      plugin.check
    end
  end
end