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
|
# frozen_string_literal: true
require_relative '../../migration_helpers'
require_relative '../../../lib/gitlab/utils/batched_background_migrations_dictionary'
URL_PATTERN = %r{\Ahttps://gitlab\.com/gitlab-org/gitlab/-/merge_requests/\d+\z}
module RuboCop
module Cop
module BackgroundMigration
# Checks the batched background migration has the corresponding dictionary file
class DictionaryFile < RuboCop::Cop::Base
include MigrationHelpers
MSG = {
invalid_url: "Invalid `%{key}` url for the dictionary. Please use the following format: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/XXX",
invalid_milestone: "Invalid `%{key}` for the dictionary. It must be a string. Please ensure it is quoted.",
missing_key: "Mandatory key '%{key}' is missing from the dictionary. Please add with an appropriate value.",
missing_dictionary: <<-MESSAGE.delete("\n").squeeze(' ').strip
Missing %{file_name}.
Use the generator 'batched_background_migration' to create dictionary files automatically.
For more details refer: https://docs.gitlab.com/ee/development/database/batched_background_migrations.html#generator
MESSAGE
}.freeze
DICTIONARY_DIR = "db/docs/batched_background_migrations"
def_node_matcher :batched_background_migration_name_node, <<~PATTERN
`(send nil? :queue_batched_background_migration $_ ...)
PATTERN
def_node_matcher :migration_constant_value, <<~PATTERN
`(casgn nil? %const_name ({sym|str} $_))
PATTERN
def on_class(node)
return unless time_enforced?(node) && in_post_deployment_migration?(node)
migration_name_node = batched_background_migration_name_node(node)
return unless migration_name_node
migration_name = if migration_name_node.const_name.present?
migration_constant_value(node, const_name: migration_name_node.const_name.to_sym)
else
migration_name_node.value
end
error_code, msg_params = validate_dictionary_file(migration_name, node)
return unless error_code.present?
add_offense(node, message: format(MSG[error_code], msg_params))
end
def external_dependency_checksum
::Gitlab::Utils::BatchedBackgroundMigrationsDictionary.checksum
end
private
def valid_url?(url)
url.match?(URL_PATTERN)
end
def valid_milestone?(milestone)
milestone.is_a?(String)
end
def dictionary_file?(migration_class_name)
File.exist?(dictionary_file_path(migration_class_name))
end
def dictionary_file_path(migration_class_name)
File.join(rails_root, DICTIONARY_DIR, "#{migration_class_name.underscore}.yml")
end
def validate_dictionary_file(migration_name, node)
unless dictionary_file?(migration_name)
return [:missing_dictionary, { file_name: dictionary_file_path(migration_name) }]
end
bbm_dictionary = ::Gitlab::Utils::BatchedBackgroundMigrationsDictionary.new(version(node))
return [:missing_key, { key: :milestone }] unless bbm_dictionary.milestone.present?
return [:invalid_milestone, { key: :milestone }] unless valid_milestone?(bbm_dictionary.milestone)
return [:missing_key, { key: :introduced_by_url }] unless bbm_dictionary.introduced_by_url.present?
return [:invalid_url, { key: :introduced_by_url }] unless valid_url?(bbm_dictionary.introduced_by_url)
end
def rails_root
@rails_root ||= File.expand_path('../../..', __dir__)
end
end
end
end
end
|
