gitlab-dangerfiles 1.1.1 → 2.1.3

data/lib/danger/plugins/roulette.rb

@@ -16,23 +16,32 @@ module Danger
     }.freeze
 
     Spin = Struct.new(:category, :reviewer, :maintainer, :optional_role, :timezone_experiment)
+    HTTPError = Class.new(StandardError)
 
+    # Finds the +Gitlab::Dangerfiles::Teammate+ object whose username matches the MR author username.
+    #
+    # @return [Gitlab::Dangerfiles::Teammate]
     def team_mr_author
-      team.find { |person| person.username == helper.mr_author }
+      company_members.find { |person| person.username == helper.mr_author }
     end
 
     # Assigns GitLab team members to be reviewer and maintainer
-    # for each change category that a Merge Request contains.
+    # for the given +categories+.
+    #
+    # @param project [String] A project path.
+    # @param categories [Array<Symbol>] An array of categories symbols.
+    # @param timezone_experiment [Boolean] Whether to select reviewers based in timezone or not.
     #
     # @return [Array<Spin>]
     def spin(project, categories = [nil], timezone_experiment: false)
-      spins = categories.sort.map do |category|
+      spins = categories.sort_by(&:to_s).map do |category|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
 
         spin_for_category(project, category, timezone_experiment: including_timezone)
       end
 
       backend_spin = spins.find { |spin| spin.category == :backend }
+      frontend_spin = spins.find { |spin| spin.category == :frontend }
 
       spins.each do |spin|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(spin.category, timezone_experiment)
@@ -61,64 +70,32 @@ module Danger
           end
         when :product_intelligence
           spin.optional_role = :maintainer
+
+          if spin.maintainer.nil?
+            # Fetch an already picked maintainer, or pick one otherwise
+            spin.maintainer = backend_spin&.maintainer || frontend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
+          end
         end
       end
 
       spins
     end
 
-    # Looks up the current list of GitLab team members and parses it into a
-    # useful form
-    #
-    # @return [Array<Teammate>]
-    def team
-      @team ||= begin
-          data = helper.http_get_json(ROULETTE_DATA_URL)
-          data.map { |hash| Gitlab::Dangerfiles::Teammate.new(hash) }
-        rescue JSON::ParserError
-          raise "Failed to parse JSON response from #{ROULETTE_DATA_URL}"
-        end
-    end
-
-    # Like +team+, but only returns teammates in the current project, based on
-    # project_name.
-    #
-    # @return [Array<Teammate>]
-    def project_team(project_name)
-      team.select { |member| member.in_project?(project_name) }
-    rescue => err
-      warn("Reviewer roulette failed to load team data: #{err.message}")
-      []
-    end
-
-    # Known issue: If someone is rejected due to OOO, and then becomes not OOO, the
-    # selection will change on next spin
-    # @param [Array<Teammate>] people
-    def spin_for_person(people, random:, timezone_experiment: false)
-      shuffled_people = people.shuffle(random: random)
-
-      if timezone_experiment
-        shuffled_people.find(&method(:valid_person_with_timezone?))
-      else
-        shuffled_people.find(&method(:valid_person?))
-      end
-    end
-
     private
 
-    # @param [Teammate] person
+    # @param [Gitlab::Dangerfiles::Teammate] person
     # @return [Boolean]
     def valid_person?(person)
       !mr_author?(person) && person.available
     end
 
-    # @param [Teammate] person
+    # @param [Gitlab::Dangerfiles::Teammate] person
     # @return [Boolean]
     def valid_person_with_timezone?(person)
       valid_person?(person) && HOURS_WHEN_PERSON_CAN_BE_PICKED.cover?(person.local_hour)
     end
 
-    # @param [Teammate] person
+    # @param [Gitlab::Dangerfiles::Teammate] person
     # @return [Boolean]
     def mr_author?(person)
       person.username == helper.mr_author
@@ -134,6 +111,22 @@ module Danger
       end
     end
 
+    # Known issue: If someone is rejected due to OOO, and then becomes not OOO, the
+    # selection will change on next spin.
+    #
+    # @param [Array<Gitlab::Dangerfiles::Teammate>] people
+    #
+    # @return [Gitlab::Dangerfiles::Teammate]
+    def spin_for_person(people, random:, timezone_experiment: false)
+      shuffled_people = people.shuffle(random: random)
+
+      if timezone_experiment
+        shuffled_people.find(&method(:valid_person_with_timezone?))
+      else
+        shuffled_people.find(&method(:valid_person?))
+      end
+    end
+
     def spin_for_category(project, category, timezone_experiment: false)
       team = project_team(project)
       reviewers, traintainers, maintainers =
@@ -151,5 +144,44 @@ module Danger
 
       Spin.new(category, reviewer, maintainer, false, timezone_experiment)
     end
+
+    # Fetches the given +url+ and parse its response as JSON.
+    #
+    # @param [String] url
+    #
+    # @return [Hash, Array]
+    def http_get_json(url)
+      rsp = Net::HTTP.get_response(URI.parse(url))
+
+      unless rsp.is_a?(Net::HTTPOK)
+        raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
+      end
+
+      JSON.parse(rsp.body)
+    end
+
+    # Looks up the current list of GitLab team members and parses it into a
+    # useful form.
+    #
+    # @return [Array<Gitlab::Dangerfiles::Teammate>]
+    def company_members
+      @company_members ||= begin
+          data = http_get_json(ROULETTE_DATA_URL)
+          data.map { |hash| Gitlab::Dangerfiles::Teammate.new(hash) }
+        rescue JSON::ParserError
+          raise "Failed to parse JSON response from #{ROULETTE_DATA_URL}"
+        end
+    end
+
+    # Like +team+, but only returns teammates in the current project, based on
+    # project_name.
+    #
+    # @return [Array<Gitlab::Dangerfiles::Teammate>]
+    def project_team(project_name)
+      company_members.select { |member| member.in_project?(project_name) }
+    rescue => err
+      warn("Reviewer roulette failed to load team data: #{err.message}")
+      []
+    end
   end
 end

data/lib/danger/rules/changes_size/Dangerfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+thresholds = helper.config.code_size_thresholds
+lines_changed = git.lines_of_code
+
+if lines_changed > thresholds[:high]
+  warn "This merge request is definitely too big (#{lines_changed} lines changed), please split it into multiple merge requests."
+elsif lines_changed > thresholds[:medium]
+  warn "This merge request is quite big (#{lines_changed} lines changed), please consider splitting it into multiple merge requests."
+end

data/lib/danger/rules/commit_messages/Dangerfile

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative "../../../gitlab/dangerfiles/commit_linter"
+require_relative "../../../gitlab/dangerfiles/merge_request_linter"
+
+COMMIT_MESSAGE_GUIDELINES = "https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines"
+MORE_INFO = "For more information, take a look at our [Commit message guidelines](#{COMMIT_MESSAGE_GUIDELINES})."
+THE_DANGER_JOB_TEXT = "the `%<job_name>` job"
+MAX_COMMITS_COUNT = helper.config.max_commits_count
+MAX_COMMITS_COUNT_EXCEEDED_MESSAGE = <<~MSG
+This merge request includes more than %<max_commits_count>d commits. Each commit should meet the following criteria:
+
+1. Have a well-written commit message.
+1. Has all tests passing when used on its own (e.g. when using git checkout SHA).
+1. Can be reverted on its own without also requiring the revert of commit that came before it.
+1. Is small enough that it can be reviewed in isolation in under 30 minutes or so.
+
+If this merge request contains commits that do not meet this criteria and/or contains intermediate work, please rebase these commits into a smaller number of commits or split this merge request into multiple smaller merge requests.
+MSG
+
+def fail_commit(commit, message, more_info: true)
+  self.fail(build_message(commit, message, more_info: more_info))
+end
+
+def warn_commit(commit, message, more_info: true)
+  self.warn(build_message(commit, message, more_info: more_info))
+end
+
+def build_message(commit, message, more_info: true)
+  [message].tap do |full_message|
+    full_message << ". #{MORE_INFO}" if more_info
+    full_message.unshift("#{commit.sha}: ") if commit.sha
+  end.join
+end
+
+def danger_job_link
+  helper.ci? ? "[#{format(THE_DANGER_JOB_TEXT, job_name: ENV["CI_JOB_NAME"])}](#{ENV['CI_JOB_URL']})" : THE_DANGER_JOB_TEXT
+end
+
+# Perform various checks against commits. We're not using
+# https://github.com/jonallured/danger-commit_lint because its output is not
+# very helpful, and it doesn't offer the means of ignoring merge commits.
+def lint_commit(commit)
+  linter = Gitlab::Dangerfiles::CommitLinter.new(commit)
+
+  # For now we'll ignore merge commits, as getting rid of those is a problem
+  # separate from enforcing good commit messages.
+  return linter if linter.merge?
+
+  # We ignore revert commits as they are well structured by Git already
+  return linter if linter.revert?
+
+  # If MR is set to squash, we ignore fixup commits
+  return linter if linter.fixup? && helper.squash_mr?
+
+  if linter.fixup?
+    msg = "Squash or fixup commits must be squashed before merge, or enable squash merge option and re-run #{danger_job_link}."
+    if helper.draft_mr? || helper.squash_mr?
+      warn_commit(commit, msg, more_info: false)
+    else
+      fail_commit(commit, msg, more_info: false)
+    end
+
+    # Makes no sense to process other rules for fixup commits, they trigger just more noise
+    return linter
+  end
+
+  # Fail if a suggestion commit is used and squash is not enabled
+  if linter.suggestion?
+    unless helper.squash_mr?
+      fail_commit(commit, "If you are applying suggestions, enable squash in the merge request and re-run #{danger_job_link}.", more_info: false)
+    end
+
+    return linter
+  end
+
+  linter.lint
+end
+
+def lint_mr_title(mr_title)
+  commit = Struct.new(:message, :sha).new(mr_title)
+
+  Gitlab::Dangerfiles::MergeRequestLinter.new(commit).lint
+end
+
+def count_non_fixup_commits(commit_linters)
+  commit_linters.count { |commit_linter| !commit_linter.fixup? }
+end
+
+def lint_commits(commits)
+  commit_linters = commits.map { |commit| lint_commit(commit) }
+
+  if helper.squash_mr?
+    multi_line_commit_linter = commit_linters.detect { |commit_linter| !commit_linter.merge? && commit_linter.multi_line? }
+
+    if multi_line_commit_linter && multi_line_commit_linter.failed?
+      warn_or_fail_commits(multi_line_commit_linter)
+      commit_linters.delete(multi_line_commit_linter) # Don't show an error (here) and a warning (below)
+    elsif helper.ci? # We don't have access to the MR title locally
+      title_linter = lint_mr_title(gitlab.mr_json['title'])
+      if title_linter.failed?
+        warn_or_fail_commits(title_linter)
+      end
+    end
+  else
+    if count_non_fixup_commits(commit_linters) > MAX_COMMITS_COUNT
+      self.warn(format(MAX_COMMITS_COUNT_EXCEEDED_MESSAGE, max_commits_count: MAX_COMMITS_COUNT))
+    end
+  end
+
+  failed_commit_linters = commit_linters.select { |commit_linter| commit_linter.failed? }
+  warn_or_fail_commits(failed_commit_linters, default_to_fail: !helper.squash_mr?)
+end
+
+def warn_or_fail_commits(failed_linters, default_to_fail: true)
+  level = default_to_fail ? :fail : :warn
+
+  Array(failed_linters).each do |linter|
+    linter.problems.each do |problem_key, problem_desc|
+      case problem_key
+      when :subject_too_short, :subject_above_warning, :details_too_many_changes, :details_line_too_long
+        warn_commit(linter.commit, problem_desc)
+      else
+        self.__send__("#{level}_commit", linter.commit, problem_desc) # rubocop:disable GitlabSecurity/PublicSend
+      end
+    end
+  end
+end
+
+# As part of https://gitlab.com/groups/gitlab-org/-/epics/4826 we are
+# vendoring workhorse commits from the stand-alone gitlab-workhorse
+# repo. There is no point in linting commits that we want to vendor as
+# is.
+def workhorse_changes?
+  git.diff.any? { |file| file.path.start_with?('workhorse/') }
+end
+
+lint_commits(git.commits) unless workhorse_changes?

data/lib/gitlab/dangerfiles.rb

@@ -2,8 +2,88 @@ require "gitlab/dangerfiles/version"
 
 module Gitlab
   module Dangerfiles
-    def self.import_plugins(danger)
-      danger.import_plugin(File.expand_path("../danger/plugins/*.rb", __dir__))
+    RULES_DIR = File.expand_path("../danger/rules", __dir__)
+    EXISTING_RULES = Dir.glob(File.join(RULES_DIR, "*")).each_with_object([]) do |path, memo|
+      if File.directory?(path)
+        memo << File.basename(path)
+      end
+    end
+    LOCAL_RULES = %w[
+      changes_size
+      commit_messages
+    ].freeze
+    CI_ONLY_RULES = %w[
+    ].freeze
+
+    # This class provides utility methods to import plugins and dangerfiles easily.
+    class Engine
+      # @param dangerfile [Danger::Dangerfile] A +Danger::Dangerfile+ object.
+      #
+      # @example
+      #   # In your main Dangerfile:
+      #   dangerfiles = Gitlab::Dangerfiles::Engine.new(self)
+      #
+      # @return [Gitlab::Dangerfiles::Engine]
+      def initialize(dangerfile)
+        @dangerfile = dangerfile
+      end
+
+      # Import all available plugins.
+      #
+      # @example
+      #   # In your main Dangerfile:
+      #   dangerfiles = Gitlab::Dangerfiles::Engine.new(self)
+      #
+      #   # Import all plugins
+      #   dangerfiles.import_plugins
+      def import_plugins
+        danger_plugin.import_plugin(File.expand_path("../danger/plugins/*.rb", __dir__))
+      end
+
+      # Import available Dangerfiles.
+      #
+      # @param rules [Symbol, Array<String>] Can be either +:all+ (default) to import all rules,
+      #   or an array of rules.
+      #   Available rules are: +changes_size+.
+      #
+      # @example
+      #   # In your main Dangerfile:
+      #   dangerfiles = Gitlab::Dangerfiles::Engine.new(self)
+      #
+      #   # Import all rules
+      #   dangerfiles.import_dangerfiles
+      #
+      #   # Or import only a subset of rules
+      #   dangerfiles.import_dangerfiles(rules: %w[changes_size])
+      def import_dangerfiles(rules: :all)
+        filtered_rules(rules).each do |rule|
+          danger_plugin.import_dangerfile(path: File.join(RULES_DIR, rule))
+        end
+      end
+
+      private
+
+      attr_reader :dangerfile
+
+      def allowed_rules
+        return LOCAL_RULES unless helper_plugin.respond_to?(:ci?)
+
+        helper_plugin.ci? ? LOCAL_RULES | CI_ONLY_RULES : LOCAL_RULES
+      end
+
+      def filtered_rules(rules)
+        rules = EXISTING_RULES if rules == :all
+
+        Array(rules).map(&:to_s) & EXISTING_RULES & allowed_rules
+      end
+
+      def danger_plugin
+        @danger_plugin ||= dangerfile.plugins[Danger::DangerfileDangerPlugin]
+      end
+
+      def helper_plugin
+        @helper_plugin ||= dangerfile.plugins[Danger::Helper]
+      end
     end
   end
 end

data/lib/gitlab/dangerfiles/changes.rb

@@ -4,41 +4,63 @@ require_relative "title_linting"
 
 module Gitlab
   module Dangerfiles
+    # @!attribute file
+    #   @return [String] the file name that's changed.
+    # @!attribute change_type
+    #   @return [Symbol] the type of change (+:added+, +:modified+, +:deleted+, +:renamed_before+, +:renamed_after+).
+    # @!attribute category
+    #   @return [Symbol] the category of the change.
+    #     This is defined by consumers of the gem through +helper.changes_by_category+ or +helper.changes+.
     Change = Struct.new(:file, :change_type, :category)
 
     class Changes < ::SimpleDelegator
+      # Return an +Gitlab::Dangerfiles::Changes+ object with only the changes for the added files.
+      #
+      # @return [Gitlab::Dangerfiles::Changes]
       def added
         select_by_change_type(:added)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the modified files.
       def modified
         select_by_change_type(:modified)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the deleted files.
       def deleted
         select_by_change_type(:deleted)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the renamed files (before the rename).
       def renamed_before
         select_by_change_type(:renamed_before)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the renamed files (after the rename).
       def renamed_after
         select_by_change_type(:renamed_after)
       end
 
+      # @param category [Symbol] A category of change.
+      #
+      # @return [Boolean] whether there are any change for the given +category+.
       def has_category?(category)
         any? { |change| change.category == category }
       end
 
+      # @param category [Symbol] a category of change.
+      #
+      # @return [Gitlab::Dangerfiles::Changes] changes for the given +category+.
       def by_category(category)
         Changes.new(select { |change| change.category == category })
       end
 
+      # @return [Array<Symbol>] an array of the unique categories of changes.
       def categories
         map(&:category).uniq
       end
 
+      # @return [Array<String>] an array of the changed files.
       def files
         map(&:file)
       end