gitlab-triage 1.23.1 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fcebd4ec7d33597bb45cf4a48a9708143972b9d5c836f374f2cc629dc392a8
-  data.tar.gz: 48ed9e443369d98b3681d07bd83d81962a82fc5e5449c6c3198935f46a52e764
+  metadata.gz: 42c73b8dcb5e94e895ba0daa399105f8111584523001f233a3b5344dd52e8d13
+  data.tar.gz: 0f9c38c9aa9de8c6210cca84d6224af7647bfeec4c7fa8a73562cb4e035205e9
 SHA512:
-  metadata.gz: d32b0e581d1067771b25a1124d591e1e084c10e042a82d20e00ac4d00346e0f386c4c0962477db98d166dab2b0e893d82cbc171f7a5e81c398d2758c6839807d
-  data.tar.gz: 94b2712733c583bab7bc2a4f0c7d92155f9b454a257cd8461cecb1290b4e3aef77d758fadbba1b8720f95585372d2b1c4366ed38481d013f8c19a7ae52d19f44
+  metadata.gz: 264e37c9838cff91100494a72a791828e555afcac5e028a83cd0de7b86c19f9d206d1ffe0486983cd990cd51686719c660b7b04f530bd633118bc85f734a9960
+  data.tar.gz: dd4e5b974bdf3496ee8a40eca9d69d17a3882cf40e6ac24fb8b452c500ad2fe17c8a40bd32ff1a97ad5639f7837cbdc24c993ea96d264a07a2a58985af6744b8

data/.gitlab/issue_templates/Default.md

@@ -9,3 +9,5 @@ If you are experiencing an issue when using GitLab.com, your first port of call
 If you feel that your issue can be categorized as a reproducible bug or a feature proposal, please use one of the issue templates provided and include as much information as possible.
 
 Thank you for helping to make GitLab a better product.
+
+<!-- template sourced from https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage/-/blob/master/.gitlab/issue_templates/Default.md -->

data/.gitlab/merge_request_templates/Default.md

@@ -7,3 +7,5 @@ Please keep this description updated with any discussion that takes place so
 that reviewers can understand your intent. Keeping the description updated is
 especially important if they didn't participate in the discussion.
 -->
+
+<!-- template sourced from https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage/-/blob/master/.gitlab/merge_request_templates/Default.md -->

data/.gitlab-ci.yml

@@ -106,6 +106,13 @@ specs:
   script:
     - bundle exec rake spec
 
+specs ruby3.0:
+  image: ruby:3.0
+  needs: ["setup-test-env"]
+  stage: test
+  script:
+    - bundle exec rake spec
+
 ##################
 ## Triage stage ##
 ##################

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   gitlab-styles:
     - rubocop-default.yml
@@ -14,3 +16,6 @@ Rails/Output:
 
 Metrics/LineLength:
   Max: 152
+
+Style/SingleArgumentDig:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,145 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-05-26 15:15:19 UTC using RuboCop version 0.93.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 43
+CodeReuse/ActiveRecord:
+  Exclude:
+    - 'lib/gitlab/triage/engine.rb'
+    - 'lib/gitlab/triage/graphql_network.rb'
+    - 'spec/gitlab/triage/engine_spec.rb'
+    - 'spec/gitlab/triage/graphql_network_spec.rb'
+    - 'spec/gitlab/triage/network_adapters/graphql_adapter_spec.rb'
+    - 'spec/gitlab/triage/rest_api_network_spec.rb'
+    - 'spec/gitlab/triage/policies/rule_policy_spec.rb'
+    - 'spec/gitlab/triage/resource/label_spec.rb'
+    - 'spec/support/expect_next_instance_of.rb'
+    - 'spec/support/shared_examples/issuable_shared_examples.rb'
+    - 'spec/support/shared_examples/label_command_shared_examples.rb'
+    - 'spec/support/stub_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Cop/LineBreakAroundConditionalBlock:
+  Exclude:
+    - 'lib/gitlab/triage/engine.rb'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'gitlab-triage.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 57
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/ConstantRegexp:
+  Exclude:
+    - 'lib/gitlab/triage/command_builders/text_content_builder.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: SafeMultiline.
+Performance/DeleteSuffix:
+  Exclude:
+    - 'lib/gitlab/triage/api_query_builders/date_query_param_builder.rb'
+    - 'lib/gitlab/triage/graphql_queries/query_param_builders/date_param_builder.rb'
+
+# Offense count: 5
+Performance/MethodObjectAsBlock:
+  Exclude:
+    - 'lib/gitlab/triage/engine.rb'
+    - 'lib/gitlab/triage/entity_builders/issue_builder.rb'
+    - 'lib/gitlab/triage/expand_condition.rb'
+    - 'lib/gitlab/triage/expand_condition/expansion.rb'
+    - 'lib/gitlab/triage/limiters/date_field_limiter.rb'
+
+# Offense count: 31
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterLetBlock:
+  Enabled: false
+
+# Offense count: 93
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 12
+
+# Offense count: 12
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/gitlab/triage/graphql_network_spec.rb'
+    - 'spec/gitlab/triage/network_adapters/graphql_adapter_spec.rb'
+    - 'spec/gitlab/triage/rest_api_network_spec.rb'
+    - 'spec/support/shared_examples/label_command_shared_examples.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/IndexBy:
+  Exclude:
+    - 'lib/gitlab/triage/engine.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Rails/NegateInclude:
+  Exclude:
+    - 'lib/gitlab/triage/filters/member_conditions_filter.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Rails/Pluck:
+  Exclude:
+    - 'lib/gitlab/triage/filters/base_conditions_filter.rb'
+    - 'lib/gitlab/triage/filters/member_conditions_filter.rb'
+    - 'lib/gitlab/triage/validators/limiter_validator.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ArrayCoercion:
+  Exclude:
+    - 'lib/gitlab/triage/graphql_network.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExplicitBlockArgument:
+  Exclude:
+    - 'spec/support/expect_next_instance_of.rb'
+
+# Offense count: 115
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 5
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/gitlab/triage/network_adapters/httparty_adapter_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantRegexpEscape:
+  Exclude:
+    - 'lib/gitlab/triage/command_builders/text_content_builder.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'lib/gitlab/triage/validators/params_validator.rb'

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 gem "yard"
 
 group :test do
-  gem 'gitlab-styles', '~> 3.3.0'
+  gem 'gitlab-styles', '~> 7.0'
 end
 
 group :development, :test, :danger do

data/README.md

@@ -21,6 +21,7 @@ Triage policies are defined on a resource level basis, resources being:
 - Epics
 - Issues
 - Merge Requests
+- Branches
 
 Each policy can declare a number of conditions that must all be satisfied before
 a number of actions are carried out.
@@ -42,6 +43,7 @@ Select which resource to add the policy to:
 - `epics`
 - `issues`
 - `merge_requests`
+- `branches`
 
 And create an array of `rules` to define your policies:
 
@@ -120,6 +122,18 @@ resource_rules:
           comment_type: thread
           comment: |
             {{author}} This issue is unlabelled. Please add one or more labels.
+  branches:
+    rules:
+      - name: My branch policy
+        conditions:
+          date:
+            attribute: committed_date
+            condition: older_than
+            interval_type: 6
+            interval: months
+          name: ^feature
+        actions:
+          delete: true
 ```
 
 ### Real world example
@@ -166,20 +180,23 @@ Available condition types:
 - [`target_branch` condition](#target-branch-condition)
 - [`weight` condition](#weight-condition)
 - [`discussions` condition](#discussions-condition)
+- [`protected` condition](#protected-condition)
 - [`ruby` condition](#ruby-condition)
 
 ##### Date condition
 
 Accepts a hash of fields.
 
-| Field           | Type    | Values                                  | Required  |
-| ---------       | ----    | ----                                    | --------  |
-| `attribute`     | string  | `created_at`, `updated_at`, `merged_at` | yes       |
-| `condition`     | string  | `older_than`, `newer_than`              | yes       |
-| `interval_type` | string  | `days`, `weeks`, `months`, `years`      | yes       |
-| `interval`      | integer | integer                                 | yes       |
-
-> **Note:** `merged_at` only works on merge requests.
+| Field           | Type    | Values                                                                   | Required  |
+| ---------       | ----    |--------------------------------------------------------------------------| --------  |
+| `attribute`     | string  | `created_at`, `updated_at`, `merged_at`, `authored_date`, `committed_date` | yes       |
+| `condition`     | string  | `older_than`, `newer_than`                                               | yes       |
+| `interval_type` | string  | `days`, `weeks`, `months`, `years`                                       | yes       |
+| `interval`      | integer | integer                                                                  | yes       |
+> **Note:**
+>   - `merged_at` only works on merge requests.
+>   - `closed_at` is not supported in the GitLab API, but can be used in a [`ruby` condition](#ruby-condition).
+>   - `committed_date` and `authored_date` only works for branches.
 
 Example:
 
@@ -574,6 +591,13 @@ conditions:
     threshold: 15
 ```
 
+##### Protected condition  
+
+** This condition is only applicable for branches** 
+
+Accept a boolean.
+If not specified, default to `false` to filter out protected branches.
+
 ##### Ruby condition
 
 This condition allows users to write a Ruby expression to be evaluated for
@@ -612,6 +636,13 @@ conditions:
 This will make it only act on resources which have active milestones and
 there exists next milestone which has already started.
 
+Since `closed_at` is not a queryable attribute in the GitLab API, we can use a Ruby expression to filter resources like:
+
+```yml
+conditions:
+  ruby: resource[:closed_at] > 7.days.ago.strftime('%Y-%m-%dT00:00:00.000Z')
+```
+
 See [Ruby expression API](#ruby-expression-api) for the list of currently
 available API.
 
@@ -653,6 +684,8 @@ Available action types:
 - [`comment_type` action option](#comment-type-action-option)
 - [`summarize` action](#summarize-action)
 - [`comment_on_summary` action](#comment-on-summary-action)
+- [`issue` action](#create-a-new-issue-from-each-resource)
+- [`delete` action](#delete-action)
 
 ##### Labels action
 
@@ -984,6 +1017,70 @@ resource_rules:
               /label ~"needs attention"
 ```
 
+##### Create a new issue from each resource
+
+Generates one issue for each resource, by default in the same project as the resource.
+
+The use case for this is, for example, creating test issues in the same (or different)
+project for issues labeled "extended-testing"; or automatically splitting one issue with a
+certain label into multiple ones.
+
+Accepts a hash of fields.
+
+| Field         | Type   | Description                                     | Required | Placeholders | Ruby expression | Default        |
+| ----          | ----   | ----                                            | ----     | ----         | ----            | ----           |
+| `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 | |
+| `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
+
+The placeholders available in `title` and `destination` are the properties of the resource being used to generate the issue.
+
+Example
+
+```yml
+resource_rules:
+  issues:
+    rules:
+      - name: Issues requiring extra testing
+        labels:
+          - needs-testing
+        actions:
+          issue:
+            title: |
+              Testing: {{ title }}
+            description: |
+              The issue {{ full_reference }} needs testing.
+
+              Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+
+              /label ~"needs attention"
+```
+
+##### Delete action
+
+**This action is only applicable for branches.**
+
+Delete the resource. 
+
+Accept a boolean. Set to `true` to enable.
+
+Example : 
+```yaml
+resource_rules:
+  branches:
+    rules:
+      - name: My branch policy
+        conditions:
+          date:
+            attribute: committed_date
+            condition: older_than
+            interval_type: months
+            interval: 30
+        actions:
+          delete: true
+```
+
 ### Summary policies
 
 Summary policies are special policies that join multiple rule policies together
@@ -1090,13 +1187,20 @@ Here's a list of currently available Ruby expression API:
 | project_path            | String          | The path with namespace to the issues or merge requests project |
 | full_resource_reference | String          | A full reference including project path to the issue or merge request |
 
-##### Methods for `Issue` (issue context)
+##### Methods for `Issue` and `LinkedIssue` (issue context)
 
 | Name                   | Return type    | Description |
 | ----                   | ----           | ----        |
 | merge_requests_count   | Integer        | The number of merge requests related to the issue |
 | related_merge_requests | [MergeRequest] | The list of merge requests related to the issue |
 | closed_by              | [MergeRequest] | The list of merge requests that close the issue |
+| linked_issues          | [LinkedIssue]  | The list of issues that are linked to the issue |
+
+##### Methods for `LinkedIssue`
+
+| Method    | Return type | Description |
+| ----      | ----        | ----        |
+| link_type | String      | The link type of the linked issue (`blocks`, `is_blocked_by`, or `relates_to`) |
 
 ##### Methods for `MergeRequest` (merge request context)
 
@@ -1227,8 +1331,8 @@ run:triage:triage:
   script:
     - gem install gitlab-triage
     - gitlab-triage --token $GITLAB_API_TOKEN --source-id $CI_PROJECT_PATH
-  only:
-    - schedules
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
 ```
 
 > **Note:** You can use the [`--init-ci`](#usage) option to add an example [`.gitlab-ci.yml` file](support/.gitlab-ci.example.yml) to your project

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

@@ -28,6 +28,11 @@ module Gitlab
         end
 
         def act
+          if policy.type == 'branches'
+            puts Gitlab::Triage::UI.warn "Comment actions are not available for branches. They will NOT be performed\n\n"
+            return
+          end
+
           policy.resources.each do |resource|
             comment = build_comment(resource).strip
 

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Gitlab
+  module Triage
+    module Action
+      class Delete < Base
+        class Dry < Delete
+          def act
+            puts "The following resources will be deleted by the rule **#{policy.name}**:\n\n"
+            super
+          end
+
+          private
+
+          def perform(resource)
+            puts "DELETE resource with type: #{resource[:type]} and id: #{resource_id(resource)}"
+          end
+        end
+
+        def act
+          return unless policy.type&.to_sym == :branches
+
+          policy.resources.each do |resource|
+            perform(resource)
+          end
+        end
+
+        private
+
+        def perform(resource)
+          network.delete_api(build_delete_url(resource))
+        end
+
+        def build_delete_url(resource)
+          delete_url = UrlBuilders::UrlBuilder.new(
+            source: policy.source,
+            source_id: network.options.source_id,
+            resource_type: policy.type,
+            resource_id: resource_id(resource),
+            network_options: network.options
+          ).build
+
+          puts Gitlab::Triage::UI.debug "delete_url: #{delete_url}" if network.options.debug
+
+          delete_url
+        end
+
+        def resource_id(resource)
+          resource[:name]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Gitlab
+  module Triage
+    module Action
+      class Issue < Base
+        class Dry < Issue
+          def act
+            puts "The following issues would be created for the rule **#{policy.name}**:\n\n"
+
+            super
+          end
+
+          private
+
+          def perform(resource, issue)
+            puts ">>>"
+            puts "* Project: #{issue.destination || resource[policy.source_id_sym]}"
+            puts "* Title: #{issue.title}"
+            puts "* Description: #{issue.description}"
+            puts ">>>"
+          end
+        end
+
+        def act
+          policy.resources.each do |resource|
+            issue = policy.build_issue(resource)
+
+            perform(resource, issue) if issue.valid?
+          end
+        end
+
+        private
+
+        def perform(resource, issue)
+          network.post_api(build_post_url(resource, issue), post_issue_body(issue))
+        end
+
+        def build_post_url(resource, issue)
+          # POST /projects/:id/issues
+          # https://docs.gitlab.com/ee/api/issues.html#new-issue
+          post_url = UrlBuilders::UrlBuilder.new(
+            network_options: network.options,
+            source_id: issue.destination || resource[policy.source_id_sym],
+            resource_type: 'issues'
+          ).build
+
+          puts Gitlab::Triage::UI.debug "post_issue_url: #{post_url}" if network.options.debug
+
+          post_url
+        end
+
+        def post_issue_body(issue)
+          {
+            title: issue.title,
+            description: issue.description
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -45,7 +45,7 @@ module Gitlab
         end
 
         def issue
-          @issue ||= policy.build_issue
+          @issue ||= policy.build_summary
         end
 
         def destination

data/lib/gitlab/triage/action.rb

@@ -1,6 +1,8 @@
 require_relative 'action/summarize'
 require_relative 'action/comment'
 require_relative 'action/comment_on_summary'
+require_relative 'action/issue'
+require_relative 'action/delete'
 
 module Gitlab
   module Triage
@@ -11,7 +13,9 @@ module Gitlab
         [
           [Summarize, policy.summarize?],
           [Comment, policy.comment?],
-          [CommentOnSummary, policy.comment_on_summary?]
+          [CommentOnSummary, policy.comment_on_summary?],
+          [Issue, policy.issue?],
+          [Delete, policy.delete?]
         ].each do |action, active|
           act(action: action, policy: policy, **args) if active
         end

data/lib/gitlab/triage/command_builders/text_content_builder.rb

@@ -31,7 +31,8 @@ module Gitlab
           web_url: "{{web_url}}",
           full_reference: "{{references.full}}",
           type: "{{type}}",
-          items: "{{items}}"
+          items: "{{items}}",
+          name: "{{name}}"
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/.freeze
 

data/lib/gitlab/triage/engine.rb

@@ -3,6 +3,8 @@ require 'active_support/inflector'
 
 require_relative 'expand_condition'
 require_relative 'filters/merge_request_date_conditions_filter'
+require_relative 'filters/branch_date_filter'
+require_relative 'filters/branch_protected_filter'
 require_relative 'filters/votes_conditions_filter'
 require_relative 'filters/no_additional_labels_conditions_filter'
 require_relative 'filters/author_member_conditions_filter'
@@ -21,6 +23,7 @@ require_relative 'api_query_builders/multi_query_param_builder'
 require_relative 'url_builders/url_builder'
 require_relative 'network'
 require_relative 'graphql_network'
+require_relative 'rest_api_network'
 require_relative 'network_adapters/httparty_adapter'
 require_relative 'network_adapters/graphql_adapter'
 require_relative 'graphql_queries/query_builder'
@@ -78,7 +81,11 @@ module Gitlab
       end
 
       def network
-        @network ||= Network.new(network_adapter)
+        @network ||= Network.new(restapi: restapi_network, graphql: graphql_network)
+      end
+
+      def restapi_network
+        @restapi_network ||= RestAPINetwork.new(network_adapter)
       end
 
       def graphql_network
@@ -334,7 +341,16 @@ module Gitlab
 
           # rubocop:disable Style/IfUnlessModifier
           if conditions[:date]
-            results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
+            case resource[:type]
+            when 'branches'
+              results << Filters::BranchDateFilter.new(resource, conditions[:date]).calculate
+            when 'merge_requests'
+              results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
+            end
+          end
+
+          if resource[:type] == 'branches'
+            results << Filters::BranchProtectedFilter.new(resource, conditions[:protected]).calculate
           end
 
           if conditions[:upvotes]
@@ -397,7 +413,7 @@ module Gitlab
 
         condition_builders << milestone_condition_builder(resource_type, conditions[:milestone]) if conditions[:milestone]
 
-        if conditions[:date] && APIQueryBuilders::DateQueryParamBuilder.applicable?(conditions[:date])
+        if conditions[:date] && APIQueryBuilders::DateQueryParamBuilder.applicable?(conditions[:date]) && resource_type&.to_sym != :branches
           condition_builders << APIQueryBuilders::DateQueryParamBuilder.new(conditions.delete(:date))
         end
 
@@ -406,6 +422,8 @@ module Gitlab
           condition_builders.concat(issues_resource_query(conditions))
         when :merge_requests
           condition_builders.concat(merge_requests_resource_query(conditions))
+        when :branches
+          condition_builders.concat(branches_resource_query(conditions))
         end
 
         condition_builders.compact.each do |condition_builder|
@@ -463,6 +481,12 @@ module Gitlab
         end
       end
 
+      def branches_resource_query(conditions)
+        [].tap do |condition_builders|
+          condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('search', conditions[:name]) if conditions[:name]
+        end
+      end
+
       def draft_condition_builder(draft_condittion)
         # Issues API only accepts 'yes' and 'no' as strings: https://docs.gitlab.com/ee/api/merge_requests.html
         wip =