gitlab-triage 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4644219bf9e18ad39bca39fcac9a122f46d69f18dfb618ad441e364200e53a
-  data.tar.gz: '032997cbb0b32059455367606d8647e532c3a440c07289d329b9453e2ef29b39'
+  metadata.gz: 2282112f85b0f8af0edd3fd6c553848768e15c2b39402b1e9344564626086a9c
+  data.tar.gz: 55f84c356fd84e7cd35aea63d2f6c377a96a82b13f23322dece9d9eb077c7f98
 SHA512:
-  metadata.gz: b141fff9291004febcb944b829285358dd8f0c791e044015a3108c259ba95456bb67ae1ac7c0c8f6b02f72faa04a2b725559a6a9803651fecb92ce7668f9d3cc
-  data.tar.gz: 9871a88ac9ecd507d65dd26343e971caa548976bc67c3c7b8533e61dd5f07e93bd98620b9da94539237116d20ae5cf3eafb3bf5dc5ad15781488f9e0fe3fa48e
+  metadata.gz: 0c5989be48592d0f1d6110c2e0f752bcb3a492a20027845829a3b97c21b421d61548007f443f01e7b85c5136f47b081909b2f4470a7f142d4de7ec4abc4f121a
+  data.tar.gz: 994b0b296c5382f2c402b4a42c9ffac7678777051b8dd6ba28bd6e30360f297139d2ab8ec88edbf26ef919b436303ce62bdd0fddddb9358e35177aceb59971e4

data/README.md

@@ -66,9 +66,11 @@ 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:
-            title: Issues require labels
+            title: |
+              #{resource[:type].capitalize} require labels
             item: |
               - [ ] [{{title}}]({{web_url}}) {{labels}}
+            redact_confidential_resources: false
             summary: |
               The following issues require labels:
 
@@ -560,6 +562,8 @@ The following placeholders are supported:
 - `downvotes`: the resources's downvotes count
 - `title`: the resource's title
 - `web_url`: the web URL pointing to the resource
+- `type`: the type of the resources. For now, only `issues` and
+  `merge_requests` are supported.
 
 If the resource doesn't respond to the placeholder, or if the field is `nil`,
 the placeholder is not replaced.
@@ -611,42 +615,56 @@ Generates an issue summarizing what was triaged.
 
 Accepts a hash of fields.
 
-| Field     | Type   | Description                                 | Required | Placeholders | Ruby expression |
-| ----      | ----   | ----                                        | ----     | ----         | ----            |
-| `title`   | string | The title of the generated issue            | yes      | no           | no              |
-| `item`    | string | Template representing each triaged resource | no       | yes          | yes             |
-| `summary` | string | The description of the generated issue      | no       | Only `{{items}}` and `{{title}}` | yes |
+| 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 | |
+| `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
-`{{items}}` and `{{title}}` are supported because it's not tied to a
+`{{title}}`, `{{items}}`, `{{type}}` are supported because it's not tied to a
 particular resource like the comment action.
 
+**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`:
 
-- `items`: Concatenated markdown separated by a newline for each `item`
 - `title`: The title of the generated issue
+- `items`: Concatenated markdown separated by a newline for each `item`
+- `type`: The resource type for the summary. For now `issues` or
+  `merge_requests`
 
 Example:
 
 ```yml
-limits:
-  most_recent: 15
-actions:
-  summarize:
-    title: Issues require labels
-    item: |
-      - [ ] [{{title}}]({{web_url}}) {{labels}}
-    summary: |
-      The following issues require labels:
+resource_rules:
+  issues:
+    rules:
+      - name: Issues require labels
+        limits:
+          most_recent: 15
+        actions:
+          summarize:
+            title: |
+              #{resource[:type].capitalize} require labels
+            item: |
+              - [ ] [{{title}}]({{web_url}}) {{labels}}
+            summary: |
+              The following {{type}} require labels:
 
-      {{items}}
+              {{items}}
 
-      Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
+              Please take care of them before the end of #{7.days.from_now.strftime('%Y-%m-%d')}
 
-      /label ~"needs attention"
+              /label ~"needs attention"
 ```
 
 Which could generate an issue like:
@@ -688,9 +706,9 @@ resource_rules:
       - name: Newest and oldest issues summary
         actions:
           summarize:
-            title: "Newest and oldest issues summary"
+            title: "Newest and oldest {{type}} summary"
             summary: |
-              Please triage the following issues:
+              Please triage the following {{type}}:
 
               {{items}}
 
@@ -707,7 +725,7 @@ resource_rules:
               summarize:
                 item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
                 summary: |
-                  Please triage the following new issues:
+                  Please triage the following new {{type}}:
 
                   {{items}}
           - name: Old issues
@@ -719,7 +737,7 @@ resource_rules:
               summarize:
                 item: "- [ ] [{{title}}]({{web_url}}) {{labels}}"
                 summary: |
-                  Please triage the following old issues:
+                  Please triage the following old {{type}}:
 
                   {{items}}
 ```
@@ -759,6 +777,10 @@ Here's a list of currently available Ruby expression API:
 | ----      | ----        | ----        |
 | resource  | Hash        | The hash containing the raw data of the resource |
 | milestone | Milestone   | The milestone attached to the resource |
+| labels                  | [Label] | A list of labels, having only names |
+| labels_with_details     | [Label] | A list of labels which has more information loaded from another API request |
+| labels_chronologically  | [Label] | Same as `labels_with_details` but sorted chronologically |
+| label_events            | [LabelEvent] | A list of label events on the resource |
 | instance_version | InstanceVersion | The version for the GitLab instance we're triaging with |
 
 ##### Methods for `Milestone`
@@ -779,6 +801,29 @@ Here's a list of currently available Ruby expression API:
 | succ        | Milestone   | The next active milestone beside this milestone |
 | active?     | Boolean     | `true` if `state` is `active`; `false` otherwise |
 
+##### Methods for `Label`
+
+| Method      | Return type | Description |
+| ----        | ----        | ----        |
+| id          | Integer     | The id of the label |
+| project_id  | Integer     | The project id of the label if available |
+| group_id    | Integer     | The group id of the label if available |
+| name        | String      | The name of the label |
+| description | String      | The description of the label |
+| color       | String      | The color of the label in RGB |
+| priority    | Integer     | The priority of the label |
+| added_at    | Time        | When the label was added to the resource |
+
+##### Methods for `LabelEvent`
+
+| Method        | Return type | Description |
+| ----          | ----        | ----        |
+| id            | Integer     | The id of the label event |
+| resource_type | String      | The resource type of the event. Could be `Issue` or `MergeRequest` |
+| resource_id   | Integer     | The id of the resource |
+| action        | String      | The action of the event. Could be `add` or `remove` |
+| created_at    | Time        | When the event happened |
+
 ##### Methods for `InstanceVersion`
 
 | Method        | Return type | Description |

data/bin/gitlab-triage

@@ -1,82 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
 require 'yaml'
+require_relative '../lib/gitlab/triage/option_parser'
 require_relative '../lib/gitlab/triage/engine'
 
-Options = Struct.new(
-  :dry_run,
-  :policies_file,
-  :project_id,
-  :token,
-  :debug,
-  :host_url
-)
-
-class TriageOptionParser
-  class << self
-    def parse(argv)
-      options = Options.new
-      options.host_url = 'https://gitlab.com'
-
-      parser = OptionParser.new do |opts|
-        opts.banner = "Usage: #{__FILE__} [options]\n\n"
-
-        opts.on('-n', '--dry-run', "Don't actually update anything, just print") do |value|
-          options.dry_run = value
-        end
-
-        opts.on('-f', '--policies-file [string]', String, 'A valid policies YML file') do |value|
-          options.policies_file = value
-        end
-
-        opts.on('-p', '--project-id [string]', String, 'A project ID or path') do |value|
-          options.project_id = value
-        end
-
-        opts.on('-t', '--token [string]', String, 'A valid API token') do |value|
-          options.token = value
-        end
-
-        opts.on('-H', '--host-url [string]', String, 'A valid host url') do |value|
-          options.host_url = value
-        end
-
-        opts.on('-d', '--debug', 'Print debug information') do |value|
-          options.debug = value
-        end
-
-        opts.on('-h', '--help', 'Print help message') do
-          $stdout.puts opts
-          exit
-        end
-
-        opts.on('--init', 'Initialize the project with a policy file') do
-          example_path =
-            File.expand_path('../support/.triage-policies.example.yml', __dir__)
-
-          FileUtils.cp(example_path, '.triage-policies.yml')
-          exit
-        end
-
-        opts.on('--init-ci', 'Initialize the project with a .gitlab-ci.yml file') do
-          example_path =
-            File.expand_path('../support/.gitlab-ci.example.yml', __dir__)
-
-          FileUtils.cp(example_path, '.gitlab-ci.yml')
-          exit
-        end
-      end
-
-      parser.parse!(argv)
-
-      options
-    end
-  end
-end
-
-options = TriageOptionParser.parse(ARGV)
-
+options = Gitlab::Triage::OptionParser.parse(ARGV)
 policies_file = options.policies_file || '.triage-policies.yml'
 policies = HashWithIndifferentAccess.new(YAML.load_file(policies_file))
 

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

@@ -2,11 +2,11 @@ module Gitlab
   module Triage
     module Action
       class Base
-        attr_reader :policy, :net
+        attr_reader :policy, :network
 
-        def initialize(policy:, net:)
+        def initialize(policy:, network:)
           @policy = policy
-          @net = net
+          @network = network
         end
       end
     end

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

@@ -39,7 +39,7 @@ module Gitlab
         def build_comment(resource)
           CommandBuilders::CommentCommandBuilder.new(
             [
-              CommandBuilders::TextContentBuilder.new(policy.actions[:comment], resource: resource, net: net).build_command,
+              CommandBuilders::TextContentBuilder.new(policy.actions[:comment], resource: resource, network: network).build_command,
               CommandBuilders::LabelCommandBuilder.new(policy.actions[:labels]).build_command,
               CommandBuilders::RemoveLabelCommandBuilder.new(policy.actions[:remove_labels]).build_command,
               CommandBuilders::CcCommandBuilder.new(policy.actions[:mention]).build_command,
@@ -49,8 +49,7 @@ module Gitlab
         end
 
         def perform(resource, comment)
-          net[:network].post_api(
-            net[:token],
+          network.post_api(
             build_post_url(resource),
             body: comment)
         end
@@ -58,15 +57,14 @@ module Gitlab
         def build_post_url(resource)
           # POST /projects/:id/issues/:issue_iid/notes
           post_url = UrlBuilders::UrlBuilder.new(
-            host_url: net[:host_url],
-            api_version: net[:api_version],
-            source_id: net[:source_id],
+            network_options: network.options,
+            source_id: network.options.project_id,
             resource_type: policy.type,
             resource_id: resource['iid'],
             sub_resource_type: 'notes'
           ).build
 
-          puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if net[:debug]
+          puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if network.options.debug
 
           post_url
         end

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

@@ -25,7 +25,7 @@ module Gitlab
         private
 
         def perform
-          net[:network].post_api(net[:token], post_issue_url, post_issue_body)
+          network.post_api(post_issue_url, post_issue_body)
         end
 
         def issue
@@ -36,13 +36,12 @@ module Gitlab
           # POST /projects/:id/issues
           # https://docs.gitlab.com/ee/api/issues.html#new-issue
           post_url = UrlBuilders::UrlBuilder.new(
-            host_url: net[:host_url],
-            api_version: net[:api_version],
-            source_id: net[:source_id],
+            network_options: network.options,
+            source_id: network.options.project_id,
             resource_type: 'issues'
           ).build
 
-          puts Gitlab::Triage::UI.debug "post_issue_url: #{post_url}" if net[:debug]
+          puts Gitlab::Triage::UI.debug "post_issue_url: #{post_url}" if network.options.debug
 
           post_url
         end

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

@@ -3,7 +3,7 @@ module Gitlab
     module CommandBuilders
       class BaseCommandBuilder
         def initialize(items)
-          @items = Array(items)
+          @items = Array.wrap(items)
           @items.delete('')
         end
 

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

@@ -26,16 +26,19 @@ module Gitlab
           downvotes: "{{downvotes}}",
           title: "{{title}}",
           web_url: "{{web_url}}",
+          type: "{{type}}",
           items: "{{items}}"
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/
 
-        attr_reader :resource, :net
+        attr_reader :resource, :network
 
-        def initialize(items, resource: nil, net: {})
+        def initialize(
+          items, resource: nil, network: nil, redact_confidentials: true)
           super(items)
-          @resource = resource
-          @net = net
+          @resource = resource&.with_indifferent_access
+          @network = network
+          @redact_confidentials = redact_confidentials
         end
 
         private
@@ -53,30 +56,65 @@ module Gitlab
         def eval_interpolation(item)
           quoted_comment = "%Q{#{item}}"
 
-          Resource::Context.new(resource, net).eval(quoted_comment)
+          Resource::Context.build(
+            resource,
+            network: network,
+            redact_confidentials: @redact_confidentials
+          ).eval(quoted_comment)
         end
 
         def replace_placeholders(item)
-          SUPPORTED_PLACEHOLDERS.inject(item) do |comment, (placeholder, formatted_text)|
+          SUPPORTED_PLACEHOLDERS.inject(item) do |comment, (placeholder, template)|
             next comment unless comment.include?("{{#{placeholder}}}")
 
-            methods = formatted_text.match(/.*#{PLACEHOLDER_REGEX}.*/)[1].split('.')
-            fields = resource_fields(resource, methods)
+            path = template[/.*#{PLACEHOLDER_REGEX}.*/, 1]
+            attributes = extract_attributes(path)
 
-            final_fields = fields.map { |field| formatted_text.sub(PLACEHOLDER_REGEX, field.to_s) }
+            formatted_text = attributes.map do |attribute|
+              template.sub(PLACEHOLDER_REGEX, attribute.to_s)
+            end.join(', ')
 
-            comment.gsub("{{#{placeholder}}}", final_fields.join(', '))
+            comment.gsub("{{#{placeholder}}}", formatted_text)
           end
         end
 
-        def resource_fields(resource, methods)
-          method = methods.shift
+        def extract_attributes(path)
+          redact_attributes(path, resource_dig_and_map(path.split('.')))
+        end
+
+        # If we don't have to map arrays, we can simply do:
+        #
+        #     resource.dig(*indices)
+        #
+        # Thus this method name. The only array here is `assignees`
+        def resource_dig_and_map(indices)
+          attributes = indices.inject(resource) do |result, index|
+            break unless result
+
+            case result
+            when Array
+              result.flat_map { |sub_resource| sub_resource[index] }
+            else
+              result[index]
+            end
+          end
+
+          Array.wrap(attributes)
+        end
+
+        def redact_attributes(path, attributes)
+          return attributes unless redact_confidential_attributes?
 
-          return Array(resource) unless method && resource
-          return [] unless resource.key?(method)
+          case path
+          when 'web_url', 'items', 'type'
+            attributes # No need to redact them
+          else
+            [Resource::Base::CONFIDENTIAL_TEXT]
+          end
+        end
 
-          sub_resources = resource[method]
-          Array.wrap(sub_resources).flat_map { |res| resource_fields(res, methods.dup) }
+        def redact_confidential_attributes?
+          @redact_confidentials && resource[:confidential]
         end
       end
     end