gitlab-dangerfiles 0.8.1 → 2.0.0

data/lib/danger/{roulette.rb → plugins/roulette.rb}

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "helper"
-require_relative "../gitlab/dangerfiles/teammate"
-require_relative "../gitlab/dangerfiles/weightage/maintainers"
-require_relative "../gitlab/dangerfiles/weightage/reviewers"
+require_relative "../../gitlab/dangerfiles/teammate"
+require_relative "../../gitlab/dangerfiles/weightage/maintainers"
+require_relative "../../gitlab/dangerfiles/weightage/reviewers"
 
 module Danger
   # Common helper functions for our danger scripts. See Danger::Helper
@@ -17,16 +16,24 @@ 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 == mr_author_username }
+      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, timezone_experiment: false)
+    def spin(project, categories = [nil], timezone_experiment: false)
       spins = categories.sort.map do |category|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
 
@@ -34,6 +41,7 @@ module Danger
       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)
@@ -60,81 +68,37 @@ module Danger
             # Fetch an already picked backend maintainer, or pick one otherwise
             spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
           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 == mr_author_username
-    end
-
-    def mr_author_username
-      helper.gitlab_helper&.mr_author || `whoami`
-    end
-
-    def mr_source_branch
-      return `git rev-parse --abbrev-ref HEAD` unless helper.gitlab_helper&.mr_json
-
-      helper.gitlab_helper.mr_json["source_branch"]
-    end
-
-    def mr_labels
-      helper.gitlab_helper&.mr_labels || []
+      person.username == helper.mr_author
     end
 
     def new_random(seed)
@@ -143,7 +107,23 @@ module Danger
 
     def spin_role_for_category(team, role, project, category)
       team.select do |member|
-        member.public_send("#{role}?", project, category, mr_labels) # rubocop:disable GitlabSecurity/PublicSend
+        member.public_send("#{role}?", project, category, helper.mr_labels) # rubocop:disable GitlabSecurity/PublicSend
+      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
 
@@ -154,7 +134,7 @@ module Danger
           spin_role_for_category(team, role, project, category)
         end
 
-      random = new_random(mr_source_branch)
+      random = new_random(helper.mr_source_branch)
 
       weighted_reviewers = Gitlab::Dangerfiles::Weightage::Reviewers.new(reviewers, traintainers).execute
       weighted_maintainers = Gitlab::Dangerfiles::Weightage::Maintainers.new(maintainers).execute
@@ -164,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/gitlab/dangerfiles.rb

@@ -2,8 +2,87 @@ require "gitlab/dangerfiles/version"
 
 module Gitlab
   module Dangerfiles
-    def self.import_plugins(danger)
-      danger.import_plugin(File.expand_path("../danger/*.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
+    ].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

data/lib/gitlab/dangerfiles/commit_linter.rb

@@ -15,7 +15,7 @@ module Gitlab
           {
             separator_missing: "The commit subject and body must be separated by a blank line",
             details_too_many_changes: "Commits that change #{MAX_CHANGED_LINES_IN_COMMIT} or more lines across " \
-            "at least #{MAX_CHANGED_FILES_IN_COMMIT} files must describe these changes in the commit body",
+            "at least #{MAX_CHANGED_FILES_IN_COMMIT} files should describe these changes in the commit body",
             details_line_too_long: "The commit body should not contain more than #{MAX_LINE_LENGTH} characters per line",
             message_contains_text_emoji: "Avoid the use of Markdown Emoji such as `:+1:`. These add limited value " \
             "to the commit message, and are displayed as plain text outside of GitLab",

data/lib/gitlab/dangerfiles/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Dangerfiles
+    class Config
+      # @!attribute code_size_thresholds
+      #   @return [{ high: Integer, medium: Integer }] a hash of the form +{ high: 42, medium: 12 }+ where +:high+ is the lines changed threshold which triggers an error, and +:medium+ is the lines changed threshold which triggers a warning. Also, see +DEFAULT_CHANGES_SIZE_THRESHOLDS+ for the format of the hash.
+      attr_accessor :code_size_thresholds
+
+      DEFAULT_CHANGES_SIZE_THRESHOLDS = { high: 2_000, medium: 500 }.freeze
+
+      def initialize
+        @code_size_thresholds = DEFAULT_CHANGES_SIZE_THRESHOLDS
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/emoji_checker.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Gitlab
   module Dangerfiles
+    # @api private
     class EmojiChecker
       DIGESTS = File.expand_path("../../../fixtures/emojis/digests.json", __dir__)
       ALIASES = File.expand_path("../../../fixtures/emojis/aliases.json", __dir__)

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -45,17 +45,63 @@ end
 
 RSpec.shared_context "with dangerfile" do
   let(:dangerfile) { DangerSpecHelper.testing_dangerfile }
-  let(:added_files) { %w[added1] }
-  let(:modified_files) { %w[modified1] }
-  let(:deleted_files) { %w[deleted1] }
-  let(:renamed_before_file) { "renamed_before" }
-  let(:renamed_after_file) { "renamed_after" }
+  let(:added_files) { %w[added-from-git] }
+  let(:modified_files) { %w[modified-from-git] }
+  let(:deleted_files) { %w[deleted-from-git] }
+  let(:renamed_before_file) { "renamed_before-from-git" }
+  let(:renamed_after_file) { "renamed_after-from-git" }
   let(:renamed_files) { [{ before: renamed_before_file, after: renamed_after_file }] }
   let(:change_class) { Gitlab::Dangerfiles::Change }
   let(:changes_class) { Gitlab::Dangerfiles::Changes }
   let(:changes) { changes_class.new([]) }
   let(:mr_title) { "Fake Title" }
   let(:mr_labels) { [] }
+  let(:mr_changes_from_api) do
+    {
+      "changes" => [
+        {
+          "old_path" => "added-from-api",
+          "new_path" => "added-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => true,
+          "renamed_file" => false,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "modified-from-api",
+          "new_path" => "modified-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => false,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "renamed_before-from-api",
+          "new_path" => "renamed_after-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => true,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "deleted-from-api",
+          "new_path" => "deleted-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => false,
+          "deleted_file" => true,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+      ],
+    }
+  end
 
   let(:fake_git) { double("fake-git", added_files: added_files, modified_files: modified_files, deleted_files: deleted_files, renamed_files: renamed_files) }
   let(:fake_helper) { double("fake-helper", changes: changes, mr_iid: 1234, mr_title: mr_title, mr_labels: mr_labels) }