gitlab-dangerfiles 3.3.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf965c37aaf01dff0630442feecb4fbe6e8d96bb2c9f7f714c631487c9eb894e
-  data.tar.gz: 720fe1ddfd202e0b199dfbd63fdb360a8a7e58d355182b7055ff0fdebb74c886
+  metadata.gz: bcb56a4513a5f26239f800a2692bd8feedc8fed15bd2d4d2d93d9d2203e0df70
+  data.tar.gz: 0fd4fd6f9cacee27bf394c2b5ef17a7fee6b34b45b215e08524d5641fc0b092d
 SHA512:
-  metadata.gz: 31a832aa516290296662a7949b01a13c7dd47e7c05ad6c6e78cb1f189f2190b99094e97a07875d65f4cb6b5504a8816d1a26aa39a618480899f2026c58c2c311
-  data.tar.gz: 4f18f92c83494aff49ceec1a05f2b380bd9be7aee17a50a4126ec25c011cfc468a672da200d4a93420d4c47bbec19d6678dc389e083a56945d94d52a58862107
+  metadata.gz: 8bcfa9f04ce155b7e77393c9d8e2eef9ab6534111f2ce5eaa33d484ed5e811827172ba90f40589b81f1987fd35277eab91afcd5365282e4deb94de92752d5054
+  data.tar.gz: 526c301f0e148a4ed6faf4dcffb3afa4d142ab828eb36eb8e745783ba80964a769a4e3456683ad1898d0d4328bc3f25f5847557042fad7ae9f53b20b7d2e22e1

data/Gemfile

@@ -7,6 +7,10 @@ gem "rake", "~> 12.0"
 gem "guard-rspec"
 gem "yard"
 
+group :development do
+  gem "lefthook", require: false
+end
+
 group :test do
   gem "pry-byebug", "~> 3.8", require: false
 end

data/README.md

@@ -215,12 +215,19 @@ Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dange
 
 ## Development
 
+### Initial setup
+
 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 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.
 
+### Activate lefthook locally
+
+```shell
+lefthook install
+```
 ## Contributing
 
 Bug reports and merge requests are welcome at https://gitlab.com/gitlab-org/gitlab-dangerfiles. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/gitlab-org/gitlab-dangerfiles/blob/master/CODE_OF_CONDUCT.md).

data/lefthook.yml

@@ -0,0 +1,11 @@
+# EXAMPLE USAGE
+# Refer for explanation to following link:
+# https://github.com/evilmartians/lefthook/blob/master/docs/full_guide.md
+#
+
+pre-push:
+  commands:
+    # Runs RUby FOrmatter (rufo)
+    rufo:
+      run: bundle exec rufo --check .
+      glob: '*.rb'

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

@@ -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,46 @@ module Danger
       end
     end
 
+    # Spin a reviewer for a particular approval rule
+    #
+    # @param [Hash] rule of approval
+    #
+    # @return [Gitlab::Dangerfiles::Teammate]
+    def spin_for_approver(rule)
+      # This will filter out approvers who are not even reviewers who
+      # don't show up in roulette data we're relying on.
+      # That's why `filter_map` is used.
+      approvers = rule["eligible_approvers"].filter_map do |approver|
+        find_member(approver["username"])
+      end
+
+      spin_for_person(approvers) || spin_for_approver_fallback(rule)
+    end
+
+    # It can be possible that we don't have a valid reviewer for approval.
+    # In this case, we sample again without considering:
+    #
+    # * If they're available
+    # * If they're an actual reviewer from roulette data
+    #
+    # We do this because we strictly require an approval from the approvers.
+    #
+    # @param [Hash] rule of approval
+    #
+    # @return [Gitlab::Dangerfiles::Teammate]
+    def spin_for_approver_fallback(rule)
+      fallback_approvers = rule["eligible_approvers"].map do |approver|
+        find_member(approver["username"]) ||
+          Gitlab::Dangerfiles::Teammate.new(approver)
+      end
+
+      # Intentionally not using `spin_for_person` to skip `valid_person?`.
+      # This should strictly return someone so we don't filter anything,
+      # and it's a fallback mechanism which should not happen often that
+      # deserves a complex algorithm.
+      fallback_approvers.sample(random: random)
+    end
+
     def spin_for_category(project, category, timezone_experiment: false)
       team = project_team(project)
       reviewers, traintainers, maintainers =
@@ -148,13 +209,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
@@ -167,6 +226,10 @@ module Danger
     def http_get_json(url)
       rsp = Net::HTTP.get_response(URI.parse(url))
 
+      if rsp.is_a?(Net::HTTPRedirection)
+        raise "Redirection detected: #{rsp.header["location"]}"
+      end
+
       unless rsp.is_a?(Net::HTTPOK)
         raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
       end
@@ -187,6 +250,10 @@ 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.
     #

data/lib/gitlab/dangerfiles/teammate.rb

@@ -10,7 +10,8 @@ module Gitlab
         @options = options
         @username = options["username"]
         @name = options["name"]
-        @markdown_name = options["markdown_name"]
+        @markdown_name = options["markdown_name"] ||
+                         default_markdown_name(*options.values_at("username", "name"))
         @role = options["role"]
         @projects = process_projects(options["projects"])
         @available = options["available"]
@@ -23,6 +24,10 @@ module Gitlab
         options
       end
 
+      def inspect
+        "#<#{self.class} @username=#{username.inspect}>"
+      end
+
       def ==(other)
         return false unless other.respond_to?(:username)
 
@@ -62,7 +67,7 @@ module Gitlab
       end
 
       def markdown_name(author: nil)
-        "#{@markdown_name} (#{utc_offset_text(author)})"
+        "#{@markdown_name}#{utc_offset_text(author)}"
       end
 
       def local_hour
@@ -79,6 +84,10 @@ module Gitlab
 
       private
 
+      def default_markdown_name(username, name)
+        "[#{name}](https://gitlab.com/#{username}) (`@#{username}`)"
+      end
+
       def process_projects(projects)
         return nil unless projects
 
@@ -88,15 +97,19 @@ module Gitlab
       end
 
       def utc_offset_text(author = nil)
+        return unless tz_offset_hours
+
         offset_text = if floored_offset_hours >= 0
             "UTC+#{floored_offset_hours}"
           else
             "UTC#{floored_offset_hours}"
           end
 
-        return offset_text unless author
-
-        "#{offset_text}, #{offset_diff_compared_to_author(author)}"
+        if author
+          " (#{offset_text}, #{offset_diff_compared_to_author(author)})"
+        else
+          " (#{offset_text})"
+        end
       end
 
       def offset_diff_compared_to_author(author)

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.3.0"
+    VERSION = "3.4.2"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -58,7 +58,7 @@ module Gitlab
         danger_plugin.import_plugin(File.expand_path("../danger/plugins/*.rb", __dir__))
 
         Dir.glob(File.expand_path("danger/plugins/*.rb", config.project_root)).sort.each do |path|
-          puts "Importing plugin at #{path}" if dangerfile.verbose
+          puts "Importing plugin at #{path}" if helper_plugin.ci?
           danger_plugin.import_plugin(path)
         end
       end
@@ -87,10 +87,9 @@ module Gitlab
         return if helper_plugin.release_automation?
 
         rules = filtered_rules(only, except)
-        puts "Running rules: #{rules}\n" if dangerfile.verbose
 
         rules.each do |rule, path|
-          puts "Importing rule #{rule} at #{path}" if dangerfile.verbose
+          puts "Importing rule #{rule} at #{path}" if helper_plugin.ci?
           danger_plugin.import_dangerfile(path: path)
         end
       end
@@ -116,45 +115,45 @@ module Gitlab
 
       attr_reader :dangerfile
 
+      def filtered_rules(only_rules, except_rules)
+        only_rules = Array(only_rules).compact.map(&:to_s)
+
+        rules = allowed_rules_based_on_context.reject { |rule, _v| except_rules.include?(rule) }
+
+        if only_rules.any?
+          rules.select! { |rule, _v| only_rules.include?(rule) }
+        end
+
+        rules.sort.to_h
+      end
+
+      def allowed_rules_based_on_context
+        helper_plugin.ci? ? all_rules : local_rules
+      end
+
+      def all_rules
+        all_gem_rules.merge(custom_rules)
+      end
+
       def all_gem_rules
-        @all_gem_rules ||= Dir.glob(File.join(RULES_DIR, "*")).sort.each_with_object({}) do |path, memo|
+        @all_gem_rules ||= Dir.glob(File.join(RULES_DIR, "*")).each_with_object({}) do |path, memo|
           rule_name = File.basename(path)
           memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
         end
       end
 
       def custom_rules
-        @custom_rules ||= Dir.glob(File.expand_path("danger/*", config.project_root)).sort.each_with_object({}) do |path, memo|
+        @custom_rules ||= Dir.glob(File.expand_path("danger/*", config.project_root)).each_with_object({}) do |path, memo|
           rule_name = File.basename(path)
           memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
         end
       end
 
-      def all_rules
-        all_gem_rules.merge(custom_rules)
-      end
-
       def local_rules
         ci_only_rules = CI_ONLY_RULES | config.ci_only_rules
         all_rules.reject { |rule, _v| ci_only_rules.include?(rule) }
       end
 
-      def allowed_rules_based_on_context
-        helper_plugin.ci? ? all_rules : local_rules
-      end
-
-      def filtered_rules(only_rules, except_rules)
-        only_rules = Array(only_rules).compact.map(&:to_s)
-
-        rules = allowed_rules_based_on_context.reject { |rule, _v| except_rules.include?(rule) }
-
-        if only_rules.any?
-          rules.select! { |rule, _v| only_rules.include?(rule) }
-        end
-
-        rules
-      end
-
       def danger_plugin
         @danger_plugin ||= dangerfile.plugins[Danger::DangerfileDangerPlugin]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.2
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -163,6 +163,7 @@ files:
 - fixtures/emojis/aliases.json
 - fixtures/emojis/digests.json
 - gitlab-dangerfiles.gemspec
+- lefthook.yml
 - lib/danger/plugins/changelog.rb
 - lib/danger/plugins/internal/helper.rb
 - lib/danger/plugins/roulette.rb