Welcome to mirror list, hosted at ThFree Co, Russian Federation.

bulk_database_actions.rb « danger « tooling - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 0f74e31cdde6564042558f25aa27786436412687 (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
# frozen_string_literal: true

require_relative 'suggestor'

module Tooling
  module Danger
    module BulkDatabaseActions
      include ::Tooling::Danger::Suggestor

      BULK_UPDATE_METHODS_REGEX = /\.((update|delete|destroy)(_all)?)\b/

      DOCUMENTATION_LINK = 'https://docs.gitlab.com/ee/development/database_review.html#preparation-when-using-update-delete-update_all-and-destroy_all'
      COMMENT_TEXT =
        "When using `update`, `delete`, `update_all`, `delete_all` or `destroy_all` you must include the full " \
        "database query and query execution plan in the merge request description, and request a ~database review. " \
        "This comment can be ignored if the object is not an ActiveRecord class, since no database query " \
        "would be generated. For more information, see [Database Review documentation](#{DOCUMENTATION_LINK}).".freeze

      def add_comment_for_bulk_database_action_method_usage
        changed_ruby_files.each do |filename|
          add_suggestion(
            filename: filename,
            regex: BULK_UPDATE_METHODS_REGEX,
            comment_text: COMMENT_TEXT
          )
        end
      end

      def changed_ruby_files
        helper.added_files.select { |f| f.end_with?('.rb') && !f.start_with?('spec/', 'ee/spec/', 'jh/spec/') }
      end
    end
  end
end