gitlab-triage 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3ad1de83211c86782bec839652791e4adaa7aa34e8b4a27d10c1f9216f54bc
-  data.tar.gz: 33e4c17d4f11d4987ce54792145631e1364785d6f69e59cda1ec9f4c07b7ac7f
+  metadata.gz: 9187a7efe616ce28b479744eea6e43478dd680e33c026db5994a031b36432102
+  data.tar.gz: 89e49562453a05254b5734d735849db38ab5ad4a6e0fc38b9f3d159011f264af
 SHA512:
-  metadata.gz: d0753dc463f49da2ebdcecaceb1cd9719303fe4996a0d8e45a1a22677a9540f1abbce33506e400578cc3e77cf48e4aa9f016c64e7403d45f6eb01d1ca9d7f0c9
-  data.tar.gz: 22b466f912d990e290941b2d36c89b1c4c3f2136e620ac522bf688fb2325c816cc6ece5334813e2da83b1aff38781d579c1fe7de11ee661896742b8a0cb07f6b
+  metadata.gz: 5486b57cda76c1943e85ecab08a4613ba4a139874602abc034983d967a18fbe48f876607f7d0f26c8f7109538754c4e0f868b07c96c486ac6b370c2586bb1e0a
+  data.tar.gz: ef43a5344601f546c8c634da223c4d36cfec219a3fd85f98a3f56cff7f88df917bf1a5d100d0524745941db98d2bbb12fce31a941a65940dc0675dbda6c375dc

data/.gitlab-ci.yml

@@ -14,7 +14,7 @@ stages:
 
 .default-before_script:
   before_script:
-    - gem install bundler --no-document
+    - gem install bundler --no-document --version 2.0.2
     - bundle install --jobs $(nproc) --retry 3 --quiet
 
 ###################

data/.rubocop.yml

@@ -2,5 +2,12 @@ inherit_gem:
   gitlab-styles:
     - rubocop-default.yml
 
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+  CacheRootDirectory: tmp
+
 Rails/Output:
   Enabled: false

data/Gemfile

@@ -4,7 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  # Pin these dependencies, otherwise a new rule could break the CI pipelines
-  gem 'rubocop', '0.69.0'
-  gem 'rubocop-rspec', '1.35.0'
+  gem 'gitlab-styles', '~> 3.0'
 end

data/README.md

@@ -2,7 +2,7 @@
 
 # GitLab Triage Project
 
-This project contains the library and pipeline definition to enable automated triaging of issues in the [GitLab-CE Project](https://gitlab.com/gitlab-org/gitlab-ce).
+This project contains the library and pipeline definition to enable automated triaging of issues in the [GitLab Project](https://gitlab.com/gitlab-org/gitlab).
 
 ## gitlab-triage gem
 
@@ -33,7 +33,7 @@ create a summary issue with all the sub-policies' summaries, see
 Policies are defined in a policy file (by default `./.triage-policies.yml`).
 The format of the file is [YAML](https://en.wikipedia.org/wiki/YAML).
 
-> Note: You can use the [`--init`](#usage) option to add an example
+> **Note:** You can use the [`--init`](#usage) option to add an example
 [`.triage-policies.yml` file](support/.triage-policies.example.yml) to your
 project.
 
@@ -69,6 +69,7 @@ resource_rules:
           comment: |
             {{author}} This issue is unlabelled after 5 days. It needs attention. Please take care of this before the end of #{2.days.from_now.strftime('%Y-%m-%d')}
           summarize:
+            destination: gitlab-org/gitlab-triage
             title: |
               #{resource[:type].capitalize} require labels
             item: |
@@ -127,12 +128,14 @@ Available condition types:
 
 Accepts a hash of fields.
 
-| Field           | Type    | Values                              | Required  |
-| ---------       | ----    | ----                                | --------  |
-| `attribute`     | string  | `created_at`, `updated_at`          | yes       |
-| `condition`     | string  | `older_than`, `newer_than`          | yes       |
-| `interval_type` | string  | `days`, `weeks`, `months`, `years`  | yes       |
-| `interval`      | integer | integer                             | yes       |
+| 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.
 
 Example:
 
@@ -197,7 +200,7 @@ conditions:
 
 Accepts an array of strings. Each element in the array represents the name of a label to filter on.
 
-> Note: **All** specified labels must be present on the resource for the condition to be satisfied
+> **Note:** **All** specified labels must be present on the resource for the condition to be satisfied
 
 Example:
 
@@ -216,7 +219,7 @@ expansion:
 1. List: `{ apple, orange }`
 2. Sequence: `{1..4}`
 
-> Note:
+> **Note:**
 >   - Spaces around the items are ignored.
 >   - Do not rely on the expansion ordering. This is subject to change.
 
@@ -264,7 +267,7 @@ resource_rules:
             - Quality
 ```
 
-> Note:
+> **Note:**
 >   If you want to define a full label expansion, you'll need to [force string](https://yaml.org/YAML_for_ruby.html#forcing_strings) or [quote string](https://yaml.org/YAML_for_ruby.html#single-quoted_strings) because otherwise it won't be considered a string due to the YAML parser.
 >   For example, we can quote the expression like `'{ apple, orange }'`, which will create 2 rules, for the two specified labels.
 
@@ -337,7 +340,7 @@ resource_rules:
 
 Accepts an array of strings. Each element in the array represents the name of a label to filter on.
 
-> Note: **All** specified labels must be absent on the resource for the condition to be satisfied
+> **Note:** **All** specified labels must be absent on the resource for the condition to be satisfied
 
 Example:
 
@@ -373,7 +376,7 @@ Accepts a hash of fields.
 | ---------       | ----    | ----                                | --------  |
 | `source`        | string  | `group`, `project`                  | yes       |
 | `condition`     | string  | `member_of`, `not_member_of`        | yes       |
-| `source_id`     | integer or string | gitlab-org/gitlab-ce      | yes       |
+| `source_id`     | integer or string | gitlab-org/gitlab      | yes       |
 
 Example:
 
@@ -395,7 +398,7 @@ Accepts a hash of fields.
 | ---------       | ----    | ----                                | --------  |
 | `source`        | string  | `group`, `project`                  | yes       |
 | `condition`     | string  | `member_of`, `not_member_of`        | yes       |
-| `source_id`     | integer or string | gitlab-org/gitlab-ce      | yes       |
+| `source_id`     | integer or string | gitlab-org/gitlab      | yes       |
 
 Example:
 
@@ -658,14 +661,14 @@ actions:
 See [Ruby expression API](#ruby-expression-api) for the list of currently
 available API.
 
-**Note:** If you get a syntax error due to stray braces (`{` or `}`), use `\`
+> **Note:** If you get a syntax error due to stray braces (`{` or `}`), use `\`
 to escape it. For example:
-
-```yml
-actions:
-  comment: |
-    If \} comes first and/or following \{, you'll need to escape them. If it's just { wrapping something } then you don't need to, but it's also fine to escape them like \{ this \} if you prefer.
-```
+>
+> ```yml
+> actions:
+>  comment: |
+>    If \} comes first and/or following \{, you'll need to escape them. If it's just { wrapping something } then you don't need to, but it's also fine to escape them like \{ this \} if you prefer.
+> ```
 
 ##### Summarize action
 
@@ -673,29 +676,14 @@ Generates an issue summarizing what was triaged.
 
 Accepts a hash of fields.
 
-| Field     | Type   | Description                                 | Required | Placeholders | Ruby expression | Default |
-| ----      | ----   | ----                                        | ----     | ----         | ----            | ----    |
-| `title`   | string | The title of the generated issue            | yes      | yes          | no              |         |
-| `item`    | string | Template representing each triaged resource | no       | yes          | yes             |         |
-| `summary` | string | The description of the generated issue      | no       | Only `{{title}}`, `{{items}}`, `{{type}}` | yes | |
+| Field         | Type   | Description                                     | Required | Placeholders | Ruby expression | Default        |
+| ----          | ----   | ----                                            | ----     | ----         | ----            | ----           |
+| `title`       | string | The title of the generated issue                | yes      | yes          | no              |                |
+| `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 | |
 | `redact_confidential_resources` | boolean | Whether redact fields for confidential resources | no | no | no | true |
 
-**Note:**: Both `item` and `summary` fields act like a
-[comment action](#comment-action), therefore
-[Ruby expression](#ruby-expression) is supported.
-Placeholders work regularly for `item`, but for `summary` only
-`{{title}}`, `{{items}}`, `{{type}}` are supported because it's not tied to a
-particular resource like the comment action.
-
-**Note:**: No issues will be created if the specific policy doesn't yield
-any resources.
-
-**Note:**: `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).
-
 The following placeholders are supported for `summary`:
 
 - `title`: The title of the generated issue
@@ -703,6 +691,21 @@ The following placeholders are supported for `summary`:
 - `type`: The resource type for the summary. For now `issues` or
   `merge_requests`
 
+> **Note:**
+> - Both `item` and `summary` fields act like a [comment action](#comment-action),
+>   therefore [Ruby expression](#ruby-expression) is supported.
+> - Placeholders work regularly for `item`, but for `summary` only `{{title}}`,
+>   `{{items}}`, `{{type}}` are supported because it's not tied to a particular
+>   resource like the comment action.
+> - No issues will be created if:
+>    - the specific policy doesn't yield any resources; or
+>    - the source type is a group and `destination` is not set.
+> - `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).
+
 Example:
 
 ```yml
@@ -828,9 +831,9 @@ Which could generate an issue like:
   /label ~"needs attention"
   ```
 
-**Note:**: If a specific policy doesn't yield any resources, it will not generate
-the corresponding description. If all policies yield no resources, then
-no issues will be created.
+> **Note:** If a specific policy doesn't yield any resources, it will not
+> generate the corresponding description. If all policies yield no resources,
+> then no issues will be created.
 
 ### Ruby expression API
 
@@ -865,6 +868,10 @@ Here's a list of currently available Ruby expression API:
 | created_at  | Time        | The created timestamp of the milestone |
 | succ        | Milestone   | The next active milestone beside this milestone |
 | active?     | Boolean     | `true` if `state` is `active`; `false` otherwise |
+| closed?     | Boolean     | `true` if `state` is `closed`; `false` otherwise |
+| started?    | Boolean     | `true` if `start_date` exists and in the past; `false` otherwise |
+| expired?    | Boolean     | `true` if `due_date` exists and in the past; `false` otherwise |
+| in_progress?| Boolean     | `true` if `started?` and `!expired`; `false` otherwise |
 
 ##### Methods for `Label`
 
@@ -952,7 +959,7 @@ run:triage:triage:
     - schedules
 ```
 
-> 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
+> **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
 
 #### Can I use gitlab-triage for my self-hosted GitLab instance?
 

data/gitlab-triage.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'gitlab-triage'
   spec.version       = Gitlab::Triage::VERSION
   spec.authors       = ['GitLab']
-  spec.email         = ['remy@rymai.me']
+  spec.email         = ['gitlab_rubygems@gitlab.com']
 
   spec.summary       = 'GitLab triage automation project.'
   spec.homepage      = 'https://gitlab.com/gitlab-org/gitlab-triage'

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

@@ -10,7 +10,12 @@ module Gitlab
           private
 
           def perform
-            puts "The following issue would be created for the rule **#{policy.name}**:\n\n"
+            if group_summary_without_destination?
+              puts Gitlab::Triage::UI.warn("No issue will be created: No summary destination specified when source is 'groups'.")
+              return
+            end
+
+            puts "The following issue would be created in project `#{destination}` for the rule **#{policy.name}**:\n\n"
             puts ">>>"
             puts "* Title: #{issue.title}"
             puts "* Description: #{issue.description}"
@@ -25,6 +30,11 @@ module Gitlab
         private
 
         def perform
+          if group_summary_without_destination?
+            puts Gitlab::Triage::UI.warn("Issue was not created: No summary destination specified when source is 'groups'.")
+            return
+          end
+
           network.post_api(post_issue_url, post_issue_body)
         end
 
@@ -32,12 +42,20 @@ module Gitlab
           @issue ||= policy.build_issue
         end
 
+        def destination
+          issue.destination || network.options.source_id
+        end
+
+        def group_summary_without_destination?
+          network.options.source == :groups && !issue.destination
+        end
+
         def post_issue_url
           # 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: network.options.source_id,
+            source_id: destination,
             resource_type: 'issues'
           ).build
 

data/lib/gitlab/triage/engine.rb

@@ -2,7 +2,8 @@ require 'active_support/all'
 require 'active_support/inflector'
 
 require_relative 'expand_condition'
-require_relative 'filters/date_conditions_filter'
+require_relative 'filters/issuable_date_conditions_filter'
+require_relative 'filters/merge_request_date_conditions_filter'
 require_relative 'filters/votes_conditions_filter'
 require_relative 'filters/forbidden_labels_conditions_filter'
 require_relative 'filters/no_additional_labels_conditions_filter'
@@ -185,7 +186,16 @@ module Gitlab
         resources.select do |resource|
           results = []
 
-          results << Filters::DateConditionsFilter.new(resource, conditions[:date]).calculate if conditions[:date]
+          if conditions[:date]
+            results << case resource[:type]
+                       when 'issues'
+                         Filters::IssuableDateConditionsFilter.new(resource, conditions[:date]).calculate
+                       when 'merge_requests'
+                         Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
+                       else
+                         raise "Unknown resource type: #{resource[:type]}"
+                       end
+          end
           results << Filters::VotesConditionsFilter.new(resource, conditions[:upvotes]).calculate if conditions[:upvotes]
           results << Filters::ForbiddenLabelsConditionsFilter.new(resource, conditions[:forbidden_labels]).calculate if conditions[:forbidden_labels]
           results << Filters::NoAdditionalLabelsConditionsFilter.new(resource, conditions.fetch(:labels) { [] }).calculate if conditions[:no_additional_labels]

data/lib/gitlab/triage/entity_builders/issue_builder.rb

@@ -14,6 +14,7 @@ module Gitlab
           @item_template = action[:item]
           @title_template = action[:title]
           @summary_template = action[:summary]
+          @summary_destination = action[:destination]
           @redact_confidentials =
             action[:redact_confidential_resources] != false
           @resources = resources
@@ -29,6 +30,10 @@ module Gitlab
           @description ||= build_text(description_resource, @summary_template)
         end
 
+        def destination
+          @summary_destination
+        end
+
         def valid?
           title =~ /\S+/ && any_resources?
         end

data/lib/gitlab/triage/filters/{date_conditions_filter.rb → issuable_date_conditions_filter.rb}

@@ -3,17 +3,21 @@ require_relative 'base_conditions_filter'
 module Gitlab
   module Triage
     module Filters
-      class DateConditionsFilter < BaseConditionsFilter
+      class IssuableDateConditionsFilter < BaseConditionsFilter
         ATTRIBUTES = %w[updated_at created_at].freeze
         CONDITIONS = %w[older_than newer_than].freeze
         INTERVAL_TYPES = %w[days weeks months years].freeze
 
+        def self.allowed_attributes
+          self::ATTRIBUTES
+        end
+
         def self.filter_parameters
           [
             {
               name: :attribute,
               type: String,
-              values: ATTRIBUTES
+              values: allowed_attributes
             },
             {
               name: :condition,

data/lib/gitlab/triage/filters/merge_request_date_conditions_filter.rb

@@ -0,0 +1,23 @@
+require_relative 'issuable_date_conditions_filter'
+
+module Gitlab
+  module Triage
+    module Filters
+      class MergeRequestDateConditionsFilter < IssuableDateConditionsFilter
+        ATTRIBUTES = %w[updated_at created_at merged_at].freeze
+
+        # Guard against merge requests with no merged_at values
+        def resource_value
+          super if @resource[@attribute]
+        end
+
+        # Guard against merge requests with no merged_at values
+        def calculate
+          return false unless resource_value
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/label_event.rb

@@ -11,6 +11,7 @@ module Gitlab
       class LabelEvent < Base
         FIELDS = %i[
           id
+          user
           resource_type
           resource_id
           action

data/lib/gitlab/triage/resource/milestone.rb

@@ -58,6 +58,22 @@ module Gitlab
           state == 'active'
         end
 
+        def closed?
+          state == 'closed'
+        end
+
+        def started?(now = Time.now)
+          start_date && start_date <= now
+        end
+
+        def expired?(now = Time.now)
+          due_date && due_date <= now
+        end
+
+        def in_progress?(now = Time.now)
+          started?(now) && !expired?(now)
+        end
+
         private
 
         def current_index

data/lib/gitlab/triage/retryable.rb

@@ -13,7 +13,7 @@ module Gitlab
             @tries += 1
             result = yield
             break
-          rescue exception_type # rubocop:disable Naming/RescuedExceptionsVariableName
+          rescue exception_type
             raise if maximum_retries_reached?
           end
         end

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '1.4.2'.freeze
+    VERSION = '1.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,7 +110,7 @@ dependencies:
         version: '3.4'
 description: 
 email:
-- remy@rymai.me
+- gitlab_rubygems@gitlab.com
 executables:
 - gitlab-triage
 extensions: []
@@ -153,9 +153,10 @@ files:
 - lib/gitlab/triage/filters/assignee_member_conditions_filter.rb
 - lib/gitlab/triage/filters/author_member_conditions_filter.rb
 - lib/gitlab/triage/filters/base_conditions_filter.rb
-- lib/gitlab/triage/filters/date_conditions_filter.rb
 - lib/gitlab/triage/filters/forbidden_labels_conditions_filter.rb
+- lib/gitlab/triage/filters/issuable_date_conditions_filter.rb
 - lib/gitlab/triage/filters/member_conditions_filter.rb
+- lib/gitlab/triage/filters/merge_request_date_conditions_filter.rb
 - lib/gitlab/triage/filters/name_conditions_filter.rb
 - lib/gitlab/triage/filters/no_additional_labels_conditions_filter.rb
 - lib/gitlab/triage/filters/ruby_conditions_filter.rb