gitlab-triage 1.53.1 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0b9314a216bceaf2701553359d22450e602b1d1964c7cf44b5fad5b2f932395
-  data.tar.gz: 841fbddcf617cb4e14ef9679e8a56887bc5f6ddb3741232f9e79219589b5ae8c
+  metadata.gz: 4c82752f4e75557f79131d794be458ada5ea59f6c6e128a9e9a1f85d9228b04c
+  data.tar.gz: e7b98029e513b4990e61a546b0d60d347468857a5a713ad571fec55df7015302
 SHA512:
-  metadata.gz: f84a9f71e56ea5a9de1c329161eb0858dc970694e0b319200ba951c85ede770a3d24053ce93f68f5fe77119e2243ba696a27c539670b2fc79f13f7ff7025ea66
-  data.tar.gz: b44869dfd04f5419fbe7e418fec0e700e52366ae20fa6f7190d8c27fda4c95c7d2946c7716cd82db675f023eaf2b475b04b8b212f6725b5c760520f06b244f72
+  metadata.gz: 1799682dbf8208cf4bfa5609d3e5fffc99726f2f5a7e8425c52a6a900bc525cf4fb540243ddc2c514a7e0110f55f5fdf008019281fe4afb057937ee391cbd101
+  data.tar.gz: 76dc04fa7184e8fb766b7861879e9578b2c0adeb4177887f4fd034f40510f1b02191c10912917a9ecfd308838d11c1bd1e9714d5286fbbb8dfd037d0a259f73b

data/Gemfile

@@ -4,3 +4,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gitlab-rubocop.gemspec
 gemspec
+
+# minitest 5.26.2+ requires Ruby 3.1+; pin to exact version for Ruby 3.0 CI
+gem 'minitest', '5.26.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-triage (1.53.1)
+    gitlab-triage (1.55.0)
       activesupport (>= 5.1)
       globalid (~> 1.0, >= 1.0.1)
       graphql (< 2.1.0)
@@ -58,7 +58,7 @@ GEM
       danger
       gitlab (~> 4.2, >= 4.2.0)
     diff-lcs (1.5.1)
-    drb (2.2.1)
+    drb (2.2.3)
     faraday (2.9.1)
       faraday-net_http (>= 2.0, < 3.2)
     faraday-http-cache (2.5.1)
@@ -124,7 +124,7 @@ GEM
     lumberjack (1.2.10)
     method_source (1.1.0)
     mini_mime (1.1.5)
-    minitest (5.23.1)
+    minitest (5.26.1)
     multi_xml (0.6.0)
     mutex_m (0.2.0)
     nap (1.1.0)
@@ -230,6 +230,7 @@ DEPENDENCIES
   gitlab-triage!
   guard-rspec (~> 4.7.3)
   lefthook (~> 1.3)
+  minitest (= 5.26.1)
   rake (~> 13.2)
   rspec (~> 3.8)
   webmock (~> 3.4)

data/README.md

@@ -903,6 +903,15 @@ Used to declare an action to be carried out on a resource if **all** conditions
 Available action types:
 - [`labels` action](#labels-action)
 - [`remove_labels` action](#remove-labels-action)
+- [`assignees` action](#assignees-action)
+- [`reviewers` action](#reviewers-action)
+- [`remove_assignees` and `remove_reviewers` actions](#remove-assignees-and-remove-reviewers-actions)
+- [`milestone` action](#milestone-action)
+- [`due_date` action](#due-date-action)
+- [`weight` action](#weight-action)
+- [`health_status` action](#health-status-action)
+- [`title` action](#title-action)
+- [`discussion_locked` action](#discussion-locked-action)
 - [`status` action](#status-action)
 - [`work_item_status` action](#work-item-status-action)
 - [`mention` action](#mention-action)
@@ -919,7 +928,9 @@ Available action types:
 
 Adds a number of labels to the resource.
 
-Accepts an array of strings. Each element is the name of a label to add.
+Accepts an array of strings. Each element is the name of a label to add. An
+element may interpolate to a comma-separated list, which is expanded into one
+label per value.
 
 If any of the labels doesn't exist, the automation will stop immediately so
 that if a label is renamed or deleted, you'll have to explicitly update or remove
@@ -934,11 +945,23 @@ actions:
     - awaiting feedback
 ```
 
+Each entry supports Ruby string interpolation. An entry that interpolates to an
+empty string is dropped, so a label can be made conditional on the resource:
+
+```yml
+actions:
+  labels:
+    - Community contribution
+    - "#{'1st contribution' if first_contribution?}"
+```
+
 ##### Remove labels action
 
 Removes a number of labels from the resource.
 
-Accepts an array of strings. Each element is the name of a label to remove.
+Accepts an array of strings. Each element is the name of a label to remove. An
+element may interpolate to a comma-separated list, which is expanded into one
+label per value.
 
 If any of the labels doesn't exist, the automation will stop immediately so
 that if a label is renamed or deleted, you'll have to explicitly update or remove
@@ -953,6 +976,142 @@ actions:
     - awaiting feedback
 ```
 
+##### Assignees action
+
+Sets the assignees on the resource. Applies to issues and merge requests.
+
+Accepts an array of usernames (without the leading `@`). If any username does not exist, the automation stops immediately.
+
+Setting an empty array (`[]`) removes all assignees.
+
+Example:
+
+```yml
+actions:
+  assignees:
+    - username1
+    - username2
+```
+
+##### Reviewers action
+
+Sets the reviewers on the resource. Applies to merge requests only.
+
+Accepts an array of usernames (without the leading `@`). If any username does not exist, the automation stops immediately.
+
+Setting an empty array (`[]`) removes all reviewers.
+
+Example:
+
+```yml
+actions:
+  reviewers:
+    - username1
+```
+
+Both actions replace the whole list rather than adding to it, and both support Ruby string interpolation in each entry. An entry that interpolates to a comma-separated list is expanded, so a policy can compute the list from the resource.
+
+Entries that interpolate to nothing are dropped. If every entry drops out, the action is skipped rather than clearing the list, so a conditional assignee cannot unassign by accident. Only a literal `[]` clears.
+
+##### Remove assignees and remove reviewers actions
+
+Removes the named users and keeps the rest. `remove_assignees` applies to issues and merge requests, `remove_reviewers` to merge requests only.
+
+Accepts an array of usernames (without the leading `@`), with the same interpolation and comma expansion as the actions above. Names that are not on the resource are ignored, and a resource with nobody assigned is left alone.
+
+Example:
+
+```yml
+actions:
+  remove_reviewers:
+    - some-bot
+```
+
+Prefer these over computing the surviving list yourself: they read the ids straight off the resource, so they cost no extra API call and cannot clear the list by accident.
+
+##### Milestone action
+
+Sets the milestone on the resource. Applies to issues and merge requests.
+
+Accepts a string containing the milestone title. If the milestone does not exist, the automation stops immediately.
+
+Supports Ruby string interpolation in the value.
+
+Example:
+
+```yml
+actions:
+  milestone: "17.0"
+```
+
+##### Due date action
+
+Sets the due date on the resource. Applies to issues only. The epics endpoint takes `due_date_fixed` and `due_date_is_fixed` instead, and merge requests have no due date.
+
+Accepts a string in `YYYY-MM-DD` format. Supports Ruby string interpolation.
+
+Example:
+
+```yml
+actions:
+  due_date: "#{(Date.today + 7).iso8601}"
+```
+
+##### Weight action
+
+Sets the weight on an issue. Issues only.
+
+Accepts an integer, or `~` (YAML null) to clear the weight.
+
+Example:
+
+```yml
+actions:
+  weight: 3
+```
+
+##### Health status action
+
+Sets the health status on an issue. Issues only.
+
+Accepts one of `on_track`, `needs_attention`, or `at_risk`, or `~` (YAML null) to clear it.
+
+This one goes through the work item GraphQL API, because the REST issue update
+endpoint does not accept a health status parameter.
+
+Example:
+
+```yml
+actions:
+  health_status: needs_attention
+```
+
+##### Title action
+
+Updates the title of the resource.
+
+Accepts a string. Supports Ruby string interpolation.
+
+Example:
+
+```yml
+actions:
+  title: "#{resource[:title]} [archived]"
+```
+
+##### Discussion locked action
+
+Locks or unlocks discussions on the resource. Applies to issues and merge requests.
+
+Accepts `true` or `false`.
+
+Example:
+
+```yml
+actions:
+  discussion_locked: true
+```
+
 ##### Status action
 
 Changes the open or closed state of the resource.
@@ -999,7 +1158,7 @@ actions:
 
 ##### Mention action
 
-Mentions a number of users.
+Mentions a number of users. The usernames are appended to the comment body as `@username` references. Prior to 1.54.0 they were emitted as `/cc @username`; the mention effect is identical but the rendered text differs.
 
 Accepts an array of strings. Each element is the username of a user to mention.
 
@@ -1018,6 +1177,9 @@ Moves an issue (merge request is not supported yet) to the specified project.
 
 Accepts a string containing the target project path.
 
+When combined with other update actions, the move runs last, because it gives the
+issue a new internal ID at the destination.
+
 Example:
 
 ```yml
@@ -1188,7 +1350,10 @@ Accepts a hash of fields.
 | `destination` | integer or string | The project ID or path to create the generated issue in | no   | no              | no             | source project |
 | `item`        | string | Template representing each triaged resource     | no       | yes          | yes             |                |
 | `summary`     | string | The description of the generated issue          | no       | Only `{{title}}`, `{{items}}`, `{{type}}` | yes | |
+| `labels`      | array of strings | Labels to add to the generated issue. An element may interpolate to a comma-separated list, which is expanded into one label per value | no | yes | yes | |
+| `assignees`   | array of strings | Usernames to assign to the generated issue. An element may interpolate to a comma-separated list, which is expanded into one assignee per value | no | yes | yes | |
 | `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
+| `confidential` | boolean or string | Create the issue confidential. A string is interpolated and counts as true when it evaluates to `true` | no | no | yes | false |
 
 The following placeholders are supported for `summary`:
 
@@ -1208,8 +1373,8 @@ The following placeholders are supported for `summary`:
 > - `redact_confidential_resources` defaults to `true`, so fields on
 > confidential resources will be converted to `(confidential)` except for
 > `{{web_url}}`. Setting it to `false` will reveal the confidential fields.
-> This will be useful if the summary is confidential itself (not implemented
-> yet), or if we're posting to another private project (not implemented yet).
+> This is useful when the summary is itself `confidential`, or if we're
+> posting to another private project (not implemented yet).
 
 Example:
 
@@ -1322,7 +1487,10 @@ Accepts a hash of fields.
 | `title`       | string | The title of the generated issue                | yes      | yes          | yes             |                |
 | `destination` | integer or string | The project ID or path to create the generated issue in | no   | no              | no             | source project |
 | `description`     | string | The description of the generated issue          | no       | yes | yes | |
+| `labels`      | array of strings | Labels to add to the generated issue. An element may interpolate to a comma-separated list, which is expanded into one label per value | no | yes | yes | |
+| `assignees`   | array of strings | Usernames to assign to the generated issue. An element may interpolate to a comma-separated list, which is expanded into one assignee per value | no | yes | yes | |
 | `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
+| `confidential` | boolean or string | Create the issue confidential. A string is interpolated and counts as true when it evaluates to `true` | no | no | yes | false |
 
 The placeholders available in `title` and `destination` are the properties of the resource being used to generate the issue.
 

data/lib/gitlab/triage/action/base.rb

@@ -1,15 +1,77 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
+require_relative '../url_builders/url_builder'
+require_relative '../resource/label'
+
 module Gitlab
   module Triage
     module Action
       class Base
+        AssigneeDoesntExistError  = Class.new(StandardError)
+        MilestoneDoesntExistError = Class.new(StandardError)
+
         attr_reader :policy, :network
 
         def initialize(**args)
           @policy = args[:policy]
           @network = args[:network]
         end
+
+        # Action.process calls this on every active action before any of them
+        # writes. Actions with nothing to look up have nothing to check.
+        def verify!; end
+
+        private
+
+        def ensure_labels_exist!(labels, source_id, source_id_key: :project_id)
+          labels.each do |label|
+            label_opts = { source_id_key => source_id, name: label }
+            next if Resource::Label.new(label_opts, network: network).exist?
+
+            raise Resource::Label::LabelDoesntExistError, "Label `#{label}` doesn't exist!"
+          end
+        end
+
+        def resolve_user_ids(usernames, error_class = AssigneeDoesntExistError)
+          Array(usernames).map do |username|
+            id = resolve_user_id(username)
+            raise error_class, "User `#{username}` doesn't exist!" unless id
+
+            id
+          end
+        end
+        alias_method :resolve_assignee_ids, :resolve_user_ids
+
+        def resolve_user_id(username)
+          users = network.query_api_cached(users_url(username))
+          users.first&.dig(:id)
+        end
+
+        def users_url(username)
+          opts = network.options
+          "#{opts.host_url}/api/#{opts.api_version}/users?username=#{CGI.escape(username)}"
+        end
+
+        # include_ancestors matches the /milestone quick action, which also resolves
+        # milestones defined on a parent group.
+        def milestones_url(source_id, title, source: 'projects')
+          UrlBuilders::UrlBuilder.new(
+            network_options: network.options,
+            source: source,
+            source_id: source_id,
+            resource_type: 'milestones',
+            params: { title: title, include_ancestors: true }
+          ).build
+        end
+
+        def resolve_milestone_id(source_id, title, source: 'projects')
+          milestone = network.query_api_cached(milestones_url(source_id, title, source: source)).first
+          raise MilestoneDoesntExistError, "Milestone `#{title}` doesn't exist!" unless milestone
+
+          milestone[:id]
+        end
       end
     end
   end

data/lib/gitlab/triage/action/comment.rb

@@ -3,11 +3,7 @@
 require_relative 'base'
 require_relative '../command_builders/text_content_builder'
 require_relative '../command_builders/comment_command_builder'
-require_relative '../command_builders/label_command_builder'
-require_relative '../command_builders/remove_label_command_builder'
 require_relative '../command_builders/cc_command_builder'
-require_relative '../command_builders/status_command_builder'
-require_relative '../command_builders/move_command_builder'
 
 module Gitlab
   module Triage
@@ -51,11 +47,7 @@ module Gitlab
                 network: network,
                 redact_confidentials: policy.actions.fetch(:redact_confidential_resources, true)
               ).build_command,
-              CommandBuilders::LabelCommandBuilder.new(policy.actions[:labels], resource: resource, network: network).build_command,
-              CommandBuilders::RemoveLabelCommandBuilder.new(policy.actions[:remove_labels], resource: resource, network: network).build_command,
-              CommandBuilders::CcCommandBuilder.new(policy.actions[:mention]).build_command,
-              CommandBuilders::MoveCommandBuilder.new(policy.actions[:move]).build_command,
-              CommandBuilders::StatusCommandBuilder.new(policy.actions[:status]).build_command
+              CommandBuilders::CcCommandBuilder.new(policy.actions[:mention]).build_command
             ]
           ).build_command
         end

data/lib/gitlab/triage/action/comment_on_summary.rb

@@ -2,12 +2,6 @@
 
 require_relative 'base'
 require_relative '../command_builders/text_content_builder'
-require_relative '../command_builders/comment_command_builder'
-require_relative '../command_builders/label_command_builder'
-require_relative '../command_builders/remove_label_command_builder'
-require_relative '../command_builders/cc_command_builder'
-require_relative '../command_builders/status_command_builder'
-require_relative '../command_builders/move_command_builder'
 
 module Gitlab
   module Triage

data/lib/gitlab/triage/action/issue.rb

@@ -19,11 +19,34 @@ module Gitlab
             puts ">>>"
             puts "* Project: #{issue.destination || resource[policy.source_id_sym]}"
             puts "* Title: #{issue.title}"
+            puts "* Labels: #{issue.labels.join(', ')}" if issue.labels.any?
+            puts "* Assignees: #{issue.assignee_usernames.join(', ')}" if issue.assignee_usernames&.any?
+            puts "* Due date: #{issue.due_date}" if issue.due_date
+            puts "* Milestone: #{issue.milestone_title}" if issue.milestone_title
+            puts "* Confidential: true" if issue.confidential?
             puts "* Description: #{issue.description}"
             puts ">>>"
           end
         end
 
+        # Resolving the assignees and milestone here too keeps a rule naming an
+        # unknown one from failing after Comment has already posted.
+        def verify!
+          policy.resources.each do |resource|
+            issue = policy.build_issue(resource)
+            next unless issue.valid?
+
+            destination_id = issue.destination || resource[policy.source_id_sym]
+
+            ensure_labels_exist!(issue.labels, destination_id)
+            resolve_assignee_ids(issue.assignee_usernames) if issue.assignee_usernames.any?
+            resolve_milestone_id(destination_id, issue.milestone_title) if issue.milestone_title
+            # Evaluated here too, so a bad confidential: template raises before
+            # any action writes rather than mid-way through post_issue_body.
+            issue.confidential?
+          end
+        end
+
         def act
           policy.resources.each do |resource|
             issue = policy.build_issue(resource)
@@ -35,7 +58,7 @@ module Gitlab
         private
 
         def perform(resource, issue)
-          network.post_api(build_post_url(resource, issue), post_issue_body(issue))
+          network.post_api(build_post_url(resource, issue), post_issue_body(resource, issue))
         end
 
         def build_post_url(resource, issue)
@@ -52,11 +75,21 @@ module Gitlab
           post_url
         end
 
-        def post_issue_body(issue)
-          {
+        def post_issue_body(resource, issue)
+          destination_id = issue.destination || resource[policy.source_id_sym]
+
+          body = {
             title: issue.title,
             description: issue.description
           }
+
+          body[:labels] = issue.labels.join(',') if issue.labels.any?
+          body[:assignee_ids] = resolve_assignee_ids(issue.assignee_usernames) if issue.assignee_usernames.any?
+          body[:due_date] = issue.due_date if issue.due_date
+          body[:milestone_id] = resolve_milestone_id(destination_id, issue.milestone_title) if issue.milestone_title
+          body[:confidential] = true if issue.confidential?
+
+          body
         end
       end
     end

data/lib/gitlab/triage/action/summarize.rb

@@ -27,11 +27,28 @@ module Gitlab
             puts "The following issue would be created in project `#{destination}` for the rule **#{policy.name}**:\n\n"
             puts ">>>"
             puts "* Title: #{issue.title}"
+            puts "* Labels: #{issue.labels.join(', ')}" if issue.labels.any?
+            puts "* Assignees: #{issue.assignee_usernames.join(', ')}" if issue.assignee_usernames&.any?
+            puts "* Due date: #{issue.due_date}" if issue.due_date
+            puts "* Milestone: #{issue.milestone_title}" if issue.milestone_title
+            puts "* Confidential: true" if issue.confidential?
             puts "* Description: #{issue.description}"
             puts ">>>"
           end
         end
 
+        def verify!
+          return unless issue.valid?
+          return if group_summary_without_destination?
+
+          ensure_labels_exist!(issue.labels, destination)
+          resolve_assignee_ids(issue.assignee_usernames) if issue.assignee_usernames.any?
+          resolve_milestone_id(destination, issue.milestone_title) if issue.milestone_title
+          # Evaluated here too, so a bad confidential: template raises before
+          # any action writes rather than mid-way through post_issue_body.
+          issue.confidential?
+        end
+
         def act
           perform if issue.valid?
         end
@@ -75,10 +92,18 @@ module Gitlab
         end
 
         def post_issue_body
-          {
+          body = {
             title: issue.title,
             description: issue.description
           }
+
+          body[:labels]       = issue.labels.join(',') if issue.labels.any?
+          body[:assignee_ids] = resolve_assignee_ids(issue.assignee_usernames)  if issue.assignee_usernames.any?
+          body[:due_date]     = issue.due_date                                  if issue.due_date
+          body[:milestone_id] = resolve_milestone_id(destination, issue.milestone_title) if issue.milestone_title
+          body[:confidential] = true if issue.confidential?
+
+          body
         end
       end
     end