summaryrefslogtreecommitdiff
path: root/spec/rubocop/cop/migration/add_column_with_default_spec.rb
blob: f3518f2f058bb5e89e0872324d18d73e66223711 (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
# frozen_string_literal: true

require 'spec_helper'

require 'rubocop'
require 'rubocop/rspec/support'

require_relative '../../../../rubocop/cop/migration/add_column_with_default'

describe RuboCop::Cop::Migration::AddColumnWithDefault do
  include CopHelper

  let(:cop) { described_class.new }

  context 'outside of a migration' do
    it 'does not register any offenses' do
      expect_no_offenses(<<~RUBY)
        def up
          add_column_with_default(:ci_build_needs, :artifacts, :boolean, default: true, allow_null: false)
        end
      RUBY
    end
  end

  context 'in a migration' do
    before do
      allow(cop).to receive(:in_migration?).and_return(true)
    end

    let(:offense) { '`add_column_with_default` without `allow_null: true` may cause prolonged lock situations and downtime, see https://gitlab.com/gitlab-org/gitlab/issues/38060' }

    it 'registers an offense when specifying allow_null: false' do
      expect_offense(<<~RUBY)
        def up
          add_column_with_default(:ci_build_needs, :artifacts, :boolean, default: true, allow_null: false)
          ^^^^^^^^^^^^^^^^^^^^^^^ #{offense}
        end
      RUBY
    end

    it 'registers no offense when specifying allow_null: true' do
      expect_no_offenses(<<~RUBY)
        def up
          add_column_with_default(:ci_build_needs, :artifacts, :boolean, default: true, allow_null: true)
        end
      RUBY
    end

    it 'registers an offense when allow_null is not specified' do
      expect_offense(<<~RUBY)
        def up
          add_column_with_default(:ci_build_needs, :artifacts, :boolean, default: true)
          ^^^^^^^^^^^^^^^^^^^^^^^ #{offense}
        end
      RUBY
    end

    it 'registers no offense for application_settings (whitelisted table)' do
      expect_no_offenses(<<~RUBY)
        def up
          add_column_with_default(:application_settings, :another_column, :boolean, default: true, allow_null: false)
        end
      RUBY
    end
  end
end