gitlab-dangerfiles 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d0b46a9dcbc098c76a6acb7eda61791470b8a8914e47650532f6fe44158d0f
-  data.tar.gz: f9aa9d41af6ae110acc46de51c9f19457555567ef520aa5b65d91e5fc85eb916
+  metadata.gz: 1d8182a9895b7c4ce505c6c31271030222ef4e3eefaee2569edccfe1a3ce892a
+  data.tar.gz: 32f4cd7af125f0cf2a96f7bb000eb725f2c58a7a5576349fe3905dd93302c53d
 SHA512:
-  metadata.gz: 778edd2df54298a54b37218e6479b6566016248aed13f68a58d1fd43df6ac3bf4e0aee4d47494e0771899be984e5b0cfa667cfb99033f0c9cefde5c4cbe29aa9
-  data.tar.gz: 740003a2197153bcfb8431329e6eb3653707f34276a3cd34afb9cba1b60e6e8b08fe6884a46a14abb70869b957a2f5510ddc765bf5018885021fba571f1e0890
+  metadata.gz: fdb2baf7afe55ad315269cf4231efa717099dbb931ca5a6f3d7b268d9551b337fa5265627b8e134d739383a4cf72f5bf68588a19010bd4327c04297baaf3a49f
+  data.tar.gz: bdfa7d3753215241101362459e869cf53b1b4f141e96c58f9a31aac02a1dcb4aadae2caf98115704e8814664f0b74c466781aafe8da02d8f0bd00793857ccfb8

data/README.md

@@ -172,6 +172,31 @@ include:
 
 See a [real world example](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/105).
 
+#### Without `Gemfile`
+
+Danger is a Ruby project and uses [`bundler`](https://bundler.io/) to manage
+its dependencies. This requires a project to have a `Gemfile` and
+`Gemfile.lock` commited. This is helpful especially if Danger is also used
+locally - with `lefthook`, for example.
+
+In order to skip Ruby and `bundler` dependency in a project, use `bundle` commands directly
+in the CI configuration:
+
+```yaml
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/danger-review.yml'
+
+danger-review:
+  before_script:
+    - bundle init
+    # For latest version
+    - bundle add gitlab-dangerfiles
+    # OR
+    # For a pinned version
+    - bundle add gitlab-dangerfiles --version 3.1.0
+```
+
 ## Rake tasks
 
 You can import this gem's Rake tasks by adding the following to your project's `Rakefile`:
@@ -192,7 +217,9 @@ Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dange
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+To release a new version, update the version number in `version.rb`, and get the MR merged by a maintainer. This will be then be packaged into a gem and pushed to [rubygems.org](https://rubygems.org) by the CI/CD.
 
 ## Contributing
 

data/lib/danger/plugins/internal/helper.rb

@@ -17,7 +17,7 @@ module Danger
       none: "",
       qa: "~QA",
       ux: "~UX",
-      test: "~test ~Quality for `spec/features/*`",
+      test: "~test for `spec/features/*`",
       # Deprecated as of 2.3.0 in favor of tooling
       engineering_productivity: '~"Engineering Productivity" for CI, Danger',
       tooling: '~"maintenance::workflow" / ~"maintenance::pipelines" for CI, Danger',
@@ -25,6 +25,7 @@ module Danger
       product_intelligence: '~"product intelligence"',
       integrations_be: '~"group::integrations" (backend)',
       integrations_fe: '~"group::integrations" (frontend)',
+      "Authentication and Authorization": '~"group::authentication and authorization"',
     }.freeze
 
     # Allows to set specific rule's configuration by passing a block.
@@ -299,6 +300,15 @@ module Danger
       gitlab_helper.mr_json["target_branch"]
     end
 
+    # @return [Hash] +{}+ when not in the CI context, and the merge request approval state otherwise.
+    def mr_approval_state
+      return {} unless ci?
+
+      gitlab_helper.api.merge_request_approval_state(
+        mr_target_project_id, mr_iid
+      )
+    end
+
     # @return [Boolean] +true+ when not in the CI context, and whether the MR is set to be squashed otherwise.
     def squash_mr?
       return true unless ci?

data/lib/danger/plugins/roulette.rb

@@ -18,11 +18,20 @@ module Danger
     Spin = Struct.new(:category, :reviewer, :maintainer, :optional_role, :timezone_experiment)
     HTTPError = Class.new(StandardError)
 
+    Approval = Struct.new(:category, :spin) do
+      def self.from_approval_rule(rule, maintainer)
+        category = rule["section"].to_sym
+        spin = Spin.new(category, nil, maintainer, :reviewer)
+
+        new(category, spin)
+      end
+    end
+
     # Finds the +Gitlab::Dangerfiles::Teammate+ object whose username matches the MR author username.
     #
     # @return [Gitlab::Dangerfiles::Teammate]
     def team_mr_author
-      @team_mr_author ||= company_members.find { |person| person.username == helper.mr_author }
+      @team_mr_author ||= find_member(helper.mr_author)
     end
 
     # Assigns GitLab team members to be reviewer and maintainer
@@ -87,6 +96,18 @@ module Danger
       spins
     end
 
+    def required_approvals
+      approval_rules = helper.mr_approval_state["rules"]
+
+      return [] unless approval_rules
+
+      approval_rules.filter_map do |rule|
+        rule["rule_type"] == "code_owner" &&
+          rule["approvals_required"] > 0 &&
+          Approval.from_approval_rule(rule, spin_for_approver(rule))
+      end
+    end
+
     private
 
     # @param [Gitlab::Dangerfiles::Teammate] person
@@ -115,8 +136,8 @@ module Danger
         team_mr_author&.integrations_fe?(project, category, helper.mr_labels)
     end
 
-    def new_random(seed)
-      Random.new(Digest::MD5.hexdigest(seed).to_i(16))
+    def random
+      @random ||= Random.new(Digest::MD5.hexdigest(helper.mr_source_branch).to_i(16))
     end
 
     def spin_role_for_category(team, role, project, category)
@@ -131,7 +152,7 @@ module Danger
     # @param [Array<Gitlab::Dangerfiles::Teammate>] people
     #
     # @return [Gitlab::Dangerfiles::Teammate]
-    def spin_for_person(people, random:, timezone_experiment: false)
+    def spin_for_person(people, timezone_experiment: false)
       shuffled_people = people.shuffle(random: random)
 
       if timezone_experiment
@@ -141,6 +162,14 @@ module Danger
       end
     end
 
+    def spin_for_approver(rule)
+      approvers = rule["eligible_approvers"].map do |approver|
+        find_member(approver["username"])
+      end
+
+      spin_for_person(approvers)
+    end
+
     def spin_for_category(project, category, timezone_experiment: false)
       team = project_team(project)
       reviewers, traintainers, maintainers =
@@ -148,13 +177,11 @@ module Danger
           spin_role_for_category(team, role, project, category)
         end
 
-      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
 
-      reviewer = spin_for_person(weighted_reviewers, random: random, timezone_experiment: timezone_experiment)
-      maintainer = spin_for_person(weighted_maintainers, random: random, timezone_experiment: timezone_experiment)
+      reviewer = spin_for_person(weighted_reviewers, timezone_experiment: timezone_experiment)
+      maintainer = spin_for_person(weighted_maintainers, timezone_experiment: timezone_experiment)
 
       Spin.new(category, reviewer, maintainer, false, timezone_experiment)
     end
@@ -187,12 +214,19 @@ module Danger
         end
     end
 
+    def find_member(username)
+      company_members.find { |person| person.username == username }
+    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) }
+      company_members.select do |member|
+        member.in_project?(project_name) ||
+          member.in_project?("gitlab") # Used for backup reviewer
+      end
     rescue => err
       warn("Reviewer roulette failed to load team data: #{err.message}")
       []

data/lib/danger/rules/commits_counter/Dangerfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+if git.commits.size > 20
+  failure 'This MR has more than 20 commits. You need to rebase this branch to have fewer commits.'
+end

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -60,37 +60,44 @@ def note_for_spin_role(spin, role)
   spin.public_send(role)&.markdown_name(author: roulette.team_mr_author)
 end
 
-def markdown_row_for_spins(category = nil, spins_array)
+def markdown_row_for_spins(category = nil, spins_array, has_categories:)
   reviewer_note = note_for_spins_role(spins_array, :reviewer)
   maintainer_note = note_for_spins_role(spins_array, :maintainer)
 
   row = +"| #{reviewer_note} | #{maintainer_note} |"
-  row.prepend("| #{helper.label_for_category(category)} ") if categories_defined?
-
+  row.prepend("| #{helper.label_for_category(category)} ") if has_categories
   row
 end
 
-def categories_defined?
-  helper.config.files_to_category.any?
-end
+changes = helper.changes_by_category
 
-def categories(changes)
-  categories_defined? ? changes.keys : [nil]
-end
+# Replicating label based categories from:
+# https://gitlab.com/gitlab-org/gitlab/-/blob/master/danger/roulette/Dangerfile
+categories = Set.new(changes.keys - [:unknown])
 
-def table_header
-  categories_defined? ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
-end
+# Ensure to spin for database reviewer/maintainer when ~database is applied (e.g. to review SQL queries)
+categories << :database if helper.mr_labels.include?('database')
 
-changes = helper.changes_by_category
+# Ensure to spin for UX reviewer when ~UX is applied (e.g. to review changes to the UI) except when it's from wider community contribution where we want to assign from the corresponding group
+categories << :ux if helper.mr_labels.include?('UX') && !helper.mr_labels.include?('Community contribution')
+
+# Ensure to spin for Product Intelligence reviewer when ~"product intelligence::review pending" is applied
+categories << :product_intelligence if helper.mr_labels.include?("product intelligence::review pending")
+
+# Skip Product intelligence reviews for growth experiment MRs
+categories.delete(:product_intelligence) if helper.mr_labels.include?("growth experiment")
 
 if changes.any?
-  random_roulette_spins = roulette.spin(nil, categories(changes))
+  has_categories = categories.any?
+  categories = [nil] unless has_categories
+  random_roulette_spins = roulette.spin(nil, categories)
 
   rows = random_roulette_spins.map do |spin|
-    markdown_row_for_spins(spin.category, [spin])
+    markdown_row_for_spins(spin.category, [spin], has_categories: has_categories)
   end
 
+  table_header = has_categories ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
+
   markdown(MESSAGE)
   markdown(TABLE_MARKDOWN + table_header + rows.join("\n")) unless rows.empty?
 end

data/lib/gitlab/dangerfiles/teammate.rb

@@ -23,6 +23,10 @@ module Gitlab
         options
       end
 
+      def inspect
+        "#<#{self.class} @username=#{username.inspect}>"
+      end
+
       def ==(other)
         return false unless other.respond_to?(:username)
 
@@ -130,11 +134,22 @@ module Gitlab
           capabilities(project).include?("#{kind}")
         else
           capabilities(project).include?("#{kind} #{category}")
+        end || has_backup_capability?(category, kind, labels)
+      end
+
+      def has_backup_capability?(category, kind, labels)
+        case category
+        when :ux
+          capacity = "#{kind} #{category}"
+
+          projects.each_value.find do |capabilities|
+            capabilities.include?(capacity)
+          end
         end
       end
 
       def capabilities(project)
-        Array(projects.fetch(project, []))
+        projects.fetch(project, [])
       end
 
       def pluralize(count, singular, plural)

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.1.0"
+    VERSION = "3.4.0"
   end
 end

data/lib/gitlab/dangerfiles/weightage/reviewers.rb

@@ -13,15 +13,15 @@ module Gitlab
       # | reduced capacity reviewer    |                              1 |
       # | reviewer                     |                              2 |
       # | hungry reviewer              |                              4 |
-      # | reduced capacity traintainer |                              3 |
-      # | traintainer                  |                              6 |
-      # | hungry traintainer           |                              8 |
+      # | reduced capacity traintainer |                              1 |
+      # | traintainer                  |                              2 |
+      # | hungry traintainer           |                              6 |
       # +------------------------------+--------------------------------+
       #
       # @api private
       class Reviewers
         DEFAULT_REVIEWER_WEIGHT = Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER * Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT
-        TRAINTAINER_WEIGHT = 3
+        TRAINTAINER_WEIGHT = 2
 
         def initialize(reviewers, traintainers)
           @reviewers = reviewers
@@ -32,6 +32,8 @@ module Gitlab
           # TODO: take CODEOWNERS into account?
           # https://gitlab.com/gitlab-org/gitlab/issues/26723
 
+          remove_traintainers_from_reviewers!
+
           weighted_reviewers + weighted_traintainers
         end
 
@@ -39,25 +41,33 @@ module Gitlab
 
         attr_reader :reviewers, :traintainers
 
+        def remove_traintainers_from_reviewers!
+          # Sometimes folks will add themselves as traintainers and not remove themselves as reviewers.
+          # There seems no way currently to ensure only one of these entries exists for a person.
+          # We need to protect ourselves from that scenario here as the code assumes a reviewer will only
+          # appear in reviewers or traintainers, not both.
+          reviewers.reject! { |reviewer| traintainers.include?(reviewer) }
+        end
+
         def weighted_reviewers
           reviewers.each_with_object([]) do |reviewer, total_reviewers|
-            add_weighted_reviewer(total_reviewers, reviewer, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
+            add_weighted_reviewer(total_reviewers, reviewer, DEFAULT_REVIEWER_WEIGHT)
           end
         end
 
         def weighted_traintainers
           traintainers.each_with_object([]) do |reviewer, total_traintainers|
-            add_weighted_reviewer(total_traintainers, reviewer, TRAINTAINER_WEIGHT)
+            add_weighted_reviewer(total_traintainers, reviewer, DEFAULT_REVIEWER_WEIGHT + TRAINTAINER_WEIGHT)
           end
         end
 
-        def add_weighted_reviewer(reviewers, reviewer, weight)
+        def add_weighted_reviewer(reviewers, reviewer, added_weight_for_hungry)
           if reviewer.reduced_capacity
-            reviewers.fill(reviewer, reviewers.size, weight)
+            reviewers.fill(reviewer, reviewers.size, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
           elsif reviewer.hungry
-            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER + DEFAULT_REVIEWER_WEIGHT)
+            reviewers.fill(reviewer, reviewers.size, DEFAULT_REVIEWER_WEIGHT + added_weight_for_hungry)
           else
-            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER)
+            reviewers.fill(reviewer, reviewers.size, DEFAULT_REVIEWER_WEIGHT)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -169,6 +169,7 @@ files:
 - lib/danger/rules/changelog/Dangerfile
 - lib/danger/rules/changes_size/Dangerfile
 - lib/danger/rules/commit_messages/Dangerfile
+- lib/danger/rules/commits_counter/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
 - lib/danger/rules/type_label/Dangerfile
 - lib/danger/rules/z_add_labels/Dangerfile