gitlab-dangerfiles 4.8.1 → 4.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42206a72b735d7a0016622666b37571d85d541a758d5454fbca3260e359f1f2
-  data.tar.gz: ac570434fc3dee200d7656a557668454e2ceb5719c43d49b80c364688d3d0e13
+  metadata.gz: 833ebf65ece50022cfe565242ddb8af684071fdd9abab0d24f94fdf3331b8c37
+  data.tar.gz: 10782785c698f9a32ff8f215cbdf1e8407ce5c85caf7f60faa69ff234748b635
 SHA512:
-  metadata.gz: '030678a153058f6c0ab3fdb198d109ca43b8693f763a6259585b2864c7d688faec108dbbe93285226a7b926ab6f99423b6b57d703f83004b588df27917582d22'
-  data.tar.gz: 7a3398d6bc48bdbd28a43329c311088c211b6343e00200a782b0eef9503dae39befeaaa139710847d3a674e1032508b8c938ef889f7907d9739548919fa12c97
+  metadata.gz: bb2ffba4936cdb33385fb88eec7958bc56b87cce7735c8fc59c79afdb73ccb88e0817cf567a63378612602ba54a2236b029a2059d831933ad72b2db4f4c9d17a
+  data.tar.gz: 22bffdd675c0254a09504a00dcb4fbc949f53f53f0b814e1b1accf500c7e571c022a866256ec60e0f666ffb401fd4a44650f3c88139e539e8ce59c434bc0d45d

data/.gitlab/merge_request_templates/Release.md

@@ -2,7 +2,7 @@
 commit from this merge request, and `<NEW_VERSION>` with the upcoming version number. -->
 ## Diff
 
-https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
+https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/compare/<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
 
 ## Checklist
 

data/.gitlab-ci.yml

@@ -23,7 +23,7 @@ default:
       - vendor/ruby
 
 .default-test-job:
-  image: "ruby:${RUBY_VERSION}"
+  image: "${GITLAB_DEPENDENCY_PROXY}ruby:${RUBY_VERSION}"
   stage: test
   needs: []
   before_script:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-dangerfiles (4.8.1)
+    gitlab-dangerfiles (4.9.1)
       danger (>= 9.3.0)
       danger-gitlab (>= 8.0.0)
       rake (~> 13.0)
@@ -117,6 +117,7 @@ GEM
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
+      racc
     proc_to_ast (0.1.0)
       coderay
       parser
@@ -125,6 +126,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
+    racc (1.8.1)
     rack (3.0.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -220,6 +222,7 @@ DEPENDENCIES
   gitlab-styles (~> 10.0)
   guard-rspec (~> 4.7.3)
   lefthook (~> 1.3)
+  racc (~> 1.8)
   rspec (~> 3.8)
   rspec-parameterized
   rubocop-rails (< 2.21.2)

data/README.md

@@ -171,6 +171,15 @@ This rule ensures the merge request isn't too big to be reviewed, otherwise it s
 
 This rule posts a failure if the merge request has more than 20 commits.
 
+#### `danger_code_review`
+
+This rule posts a warning/failure when `@GitLabDuo` isn't assigned as a reviewer.
+
+##### Available configurations
+
+- `duo_code_review`: Whether a review from GitLab Duo Code is `:mandatory` or `:optional`.
+  Default to `:optional`.
+
 #### `metadata`
 
 This rule ensures basic metadata such as assignee, milestone and description are set on the merge request.
@@ -194,6 +203,16 @@ project. To use it in your project, perform the following steps:
    end
    ```
 
+##### Available configurations
+
+Note: These options aren't actually used in the `simple_roulette` rule, but can be used in your own
+implementation of the roulette if you use `roulette.required_approvals`/`roulette.codeowners_approvals`.
+
+- `included_optional_codeowners_sections_for_roulette`: Indicates which optional codeowners sections
+  should be included in roulette. Default to `[]`.
+- `excluded_required_codeowners_sections_for_roulette`: Indicates which required codeowners sections
+  should be excluded from roulette. Default to `[]`.
+
 #### `type_label`
 
 If the `changelog` plugin is available, it tries to infer a type label from the `Changelog` trailer of the MR.
@@ -281,6 +300,16 @@ To run the Danger Rake task in a project that doesn't have `master` as the defau
 DANGER_LOCAL_BASE="origin/main" bundle exec rake danger_local
 ```
 
+## Warnings vs Errors
+
+The following lint violations generate warnings:
+
+1. The commit subject is too short ([code](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/blob/bccb167/lib/gitlab/dangerfiles/base_linter.rb#L74-76)).
+1. The commit changes too many lines across too many files without describing the changes in the commit body ([code](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/blob/bccb167/lib/gitlab/dangerfiles/commit_linter.rb#L83-85)).
+1. The commit body contains too many characters per line ([code](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/blob/bccb167/lib/gitlab/dangerfiles/commit_linter.rb#L87-96)).
+
+All other lint violations generate errors, except when the MR has [Squash commits when merge request is accepted](https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html#squash-commits-in-a-merge-request) enabled, which downgrades lint violations to warnings.
+
 ## Documentation
 
 Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dangerfiles>.
@@ -307,8 +336,8 @@ For example, to test `gitlab-dangerfiles` changes from the `your-branch-name` br
 
 ```ruby
 group :development, :test, :danger do
-  gem 'gitlab-dangerfiles', '~> 3.4.3', require: false,
-  git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles.git',
+  gem 'gitlab-dangerfiles', require: false, feature_category: :tooling,
+  git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles.git', # rubocop:disable Cop/GemFetcher -- Testing unreleased changes
   ref: 'your-branch-name'
 end
 ```

data/gitlab-dangerfiles.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "lefthook", "~> 1.3"
   spec.add_development_dependency "rspec-parameterized"
   spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "racc", "~> 1.8"
   # we do not commit the bundle lockfile, so this temporary workaround needs to be
   # present until 2.21.3 or 2.22.x is released
   # See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/63

data/lib/danger/plugins/duo_code.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Danger
+  # Contains method to check if Duo code suggestion added to MR as a reviewer.
+  class DuoCode < Danger::Plugin
+    def suggestion_added?
+      return false unless helper.ci?
+
+      helper.mr_reviewers.include?("GitLabDuo")
+    end
+  end
+end

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

@@ -244,7 +244,7 @@ module Danger
     # @return [String] the GFM for a category label, making its best guess if it's not
     #   a category we know about.
     def label_for_category(category)
-      CATEGORY_LABELS[category] ||
+      helper.config.custom_labels_for_categories[category] || CATEGORY_LABELS[category] ||
 
         if category.start_with?("`")
           category.to_s
@@ -288,6 +288,13 @@ module Danger
       gitlab_helper.mr_json["assignees"]
     end
 
+    # @return [Array<Hash>] +[]+ when not in the CI context, and the MR reviewers otherwise.
+    def mr_reviewers
+      return [] unless ci?
+
+      gitlab_helper.mr_json["reviewers"]
+    end
+
     # @return [String] +""+ when not in the CI context, and the MR title otherwise.
     def mr_title
       return "" unless ci?

data/lib/danger/plugins/roulette.rb

@@ -45,7 +45,7 @@ module Danger
     # @param categories [Array<Symbol>] An array of categories symbols.
     #
     # @return [Array<Spin>]
-    def spin(project = nil, categories = [:none], ux_fallback_wider_community_reviewer: teammate_pedroms)
+    def spin(project = nil, categories = [:none], ux_fallback_wider_community_reviewer: ux_fallback_reviewer)
       # TODO: Deprecate the project argument. It prevents us from
       # memorizing Spinner and can cause unexpected results if it's
       # passing a different project than the merge request project.
@@ -89,8 +89,9 @@ module Danger
 
     private
 
-    def teammate_pedroms
-      @teammate_pedroms ||= Gitlab::Dangerfiles::Teammate.find_member("pedroms")
+    def ux_fallback_reviewer
+      teammates = %w[pedroms annabeldunstone seggenberger jmiocene clavimoniere]
+      Gitlab::Dangerfiles::Teammate.find_member(teammates.sample)
     end
 
     def spin_for_approval_rule?(rule)

data/lib/danger/rules/commit_messages/Dangerfile

@@ -113,7 +113,7 @@ def warn_or_fail_commits(failed_linters, default_to_fail: true)
   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
+      when :subject_too_short, :details_too_many_changes, :details_line_too_long
         warn_commit(linter.commit, problem_desc)
       else
         self.__send__(:"#{level}_commit", linter.commit, problem_desc)

data/lib/danger/rules/duo_code_review/Dangerfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+return if duo_code.suggestion_added?
+
+case helper.config.duo_code_review
+when :optional
+  markdown("We advise getting a review from from GitLab Duo Code. You can assign `@GitLabDuo` as a reviewer to this merge request.")
+when :mandatory
+  failure("A review from GitLab Duo Code is mandatory. Please assign `@GitLabDuo` as a reviewer to this merge request.")
+end

data/lib/gitlab/dangerfiles/capability.rb

@@ -62,15 +62,13 @@ module Gitlab
 
       class ImportIntegrateBE < Capability
         def has_capability?(teammate)
-          kind == :reviewer &&
-            teammate.role.match?(/Backend Engineer.+Manage:Import and Integrate/)
+          kind == :reviewer && teammate.role.match?(/Backend Engineer.+:Import and Integrate/)
         end
       end
 
       class ImportIntegrateFE < Capability
         def has_capability?(teammate)
-          kind == :reviewer &&
-            teammate.role.match?(/Frontend Engineer.+Manage:Import and Integrate/)
+          kind == :reviewer && teammate.role.match?(/Frontend Engineer.+:Import and Integrate/)
         end
       end
 

data/lib/gitlab/dangerfiles/config.rb

@@ -21,22 +21,36 @@ module Gitlab
       #           match changed lines in files that match +filename_regex+. Used in `helper.changes_by_category`, `helper.changes`, and `helper.categories_for_file`.
       attr_accessor :files_to_category
 
+      # @!attribute custom_labels_for_categories
+      #   @return [{String => String}] A hash of the form +{ category_name => label }+.
+      #           Used in `helper.custom_labels_for_categories`.
+      attr_accessor :custom_labels_for_categories
+
+      # @!attribute disabled_roulette_categories
+      #   @return [Array] indicating which categories would be disabled for the simple roulette. Default to `[]` (all categories are enabled)
+      attr_accessor :disabled_roulette_categories
+
+      # Rule: changes_size
       # @!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
 
+      # Rule: commit_messages
       # @!attribute max_commits_count
       #   @return [Integer] the maximum number of allowed non-squashed/non-fixup commits for a given MR. A warning is triggered if the MR has more commits.
       attr_accessor :max_commits_count
 
-      # @!attribute disabled_roulette_categories
-      #   @return [Array] indicating which categories would be disabled for the simple roulette. Default to `[]` (all categories are enabled)
-      attr_accessor :disabled_roulette_categories
+      # Rule: duo_code_review
+      # @!attribute duo_code_review
+      #   @return [Symbol] whether a review from GitLab Duo Code is `:mandatory` or `:optional`. Default to `:optional`.
+      attr_accessor :duo_code_review
 
+      # Rule: simple_roulette
       # @!attribute included_optional_codeowners_sections_for_roulette
       #   @return [Array] indicating which optional codeowners sections should be included in roulette. Default to `[]`.
       attr_accessor :included_optional_codeowners_sections_for_roulette
 
+      # Rule: simple_roulette
       # @!attribute excluded_required_codeowners_sections_for_roulette
       #   @return [Array] indicating which required codeowners sections should be excluded from roulette. Default to `[]`.
       attr_accessor :excluded_required_codeowners_sections_for_roulette
@@ -46,6 +60,7 @@ module Gitlab
 
       def initialize
         @files_to_category = {}
+        @custom_labels_for_categories = {}
         @project_root = nil
         @project_name = ENV["CI_PROJECT_NAME"]
         @ci_only_rules = []
@@ -54,6 +69,7 @@ module Gitlab
         @disabled_roulette_categories = []
         @included_optional_codeowners_sections_for_roulette = []
         @excluded_required_codeowners_sections_for_roulette = []
+        @duo_code_review = :optional
       end
     end
   end

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -168,8 +168,8 @@ RSpec.shared_context "with teammates" do
   let(:software_engineer_in_import_integrate_fe) do
     Gitlab::Dangerfiles::Teammate.new(
       "username" => "software-engineer-in-import-and-integrate-fe",
-      "name" => "Software Engineer in Import and Integrate FE",
-      "role" => "Frontend Engineer, Manage:Import and Integrate",
+      "name" => "Frontend Engineer in Import and Integrate",
+      "role" => "AnyRole Frontend Engineer, AnyStage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer frontend" },
       "available" => true,
       "tz_offset_hours" => 2.0
@@ -179,8 +179,8 @@ RSpec.shared_context "with teammates" do
   let(:software_engineer_in_import_integrate_be) do
     Gitlab::Dangerfiles::Teammate.new(
       "username" => "software-engineer-in-import-and-integrate-be",
-      "name" => "Software Engineer in Import and Integrate BE",
-      "role" => "Backend Engineer, Manage:Import and Integrate",
+      "name" => "Backend Engineer in Import and Integrate",
+      "role" => "AnyRole Backend Engineer, AnyStage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer backend" },
       "available" => true,
       "tz_offset_hours" => 2.0
@@ -224,7 +224,7 @@ RSpec.shared_context "with teammates" do
     Gitlab::Dangerfiles::Teammate.new(
       "username" => "import-and-integrate-backend-reviewer",
       "name" => "Import and Integrate BE engineer",
-      "role" => "Backend Engineer, Manage:Import and Integrate",
+      "role" => "AnyRole Backend Engineer, AnyStage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer backend" },
       "available" => backend_reviewer_available,
       "tz_offset_hours" => 2.0
@@ -235,7 +235,7 @@ RSpec.shared_context "with teammates" do
     Gitlab::Dangerfiles::Teammate.new(
       "username" => "import-and-integrate-frontend-reviewer",
       "name" => "Import and Integrate FE engineer",
-      "role" => "Frontend Engineer, Manage:Import and Integrate",
+      "role" => "AnyRole Frontend Engineer, AnyStage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer frontend" },
       "available" => true,
       "tz_offset_hours" => 2.0
@@ -285,7 +285,7 @@ RSpec.shared_context "with teammates" do
   end
 
   let(:teammate_json) { teammates.to_json }
-  let(:teammate_pedroms) { instance_double(Gitlab::Dangerfiles::Teammate, name: "Pedro") }
+  let(:ux_fallback_reviewer) { instance_double(Gitlab::Dangerfiles::Teammate) }
   let(:company_members) { Gitlab::Dangerfiles::Teammate.fetch_company_members }
 
   before do

data/lib/gitlab/dangerfiles/spinner.rb

@@ -18,7 +18,7 @@ module Gitlab
         @team_author = team_author
         @labels = labels
         @categories = categories.reject do |category|
-          import_and_integrate_reject_category?(category)
+          import_and_integrate_reject_category?(project, category, labels)
         end
         @random = random
         @ux_fallback_wider_community_reviewer = ux_fallback_wider_community_reviewer
@@ -98,12 +98,13 @@ module Gitlab
 
       attr_reader :random, :ux_fallback_wider_community_reviewer
 
+      # Reject Import and Integrate categories if the MR author has reviewing abilities for the category.
+      #
       # @param [String] category name
       # @return [Boolean]
-      def import_and_integrate_reject_category?(category)
-        # Reject Import and Integrate categories if the MR author has reviewing abilities for the category.
-        team_author&.import_integrate_be?(project, category, labels) ||
-          team_author&.import_integrate_fe?(project, category, labels)
+      def import_and_integrate_reject_category?(project, category, labels)
+        [:import_integrate_be, :import_integrate_fe].include?(category) && team_author &&
+          (team_author.reviewer?(project, category, labels) || team_author.maintainer?(project, category, labels))
       end
 
       # MR includes QA changes, but also other changes, and author isn't an SET

data/lib/gitlab/dangerfiles/teammate.rb

@@ -141,18 +141,6 @@ module Gitlab
         has_capability?(project, category, :maintainer, labels)
       end
 
-      def import_integrate_be?(project, category, labels)
-        return false unless category == :import_integrate_be
-
-        has_capability?(project, category, :reviewer, labels)
-      end
-
-      def import_integrate_fe?(project, category, labels)
-        return false unless category == :import_integrate_fe
-
-        has_capability?(project, category, :reviewer, labels)
-      end
-
       def markdown_name(author: nil)
         "#{@markdown_name}#{utc_offset_text(author)}"
       end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "4.8.1"
+    VERSION = "4.9.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.9.1
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -225,12 +239,14 @@ files:
 - gitlab-dangerfiles.gemspec
 - lefthook.yml
 - lib/danger/plugins/changelog.rb
+- lib/danger/plugins/duo_code.rb
 - lib/danger/plugins/internal/helper.rb
 - lib/danger/plugins/roulette.rb
 - 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/duo_code_review/Dangerfile
 - lib/danger/rules/metadata/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
 - lib/danger/rules/type_label/Dangerfile
@@ -282,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: This gem provides common Dangerfile and plugins for GitLab projects.