gitlab-triage 1.7.1 → 1.11.0

data/gitlab-triage.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(docs|test|spec|features)/})
   end
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

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

@@ -7,6 +7,7 @@ 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
@@ -40,9 +41,10 @@ module Gitlab
           CommandBuilders::CommentCommandBuilder.new(
             [
               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::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
             ]
           ).build_command
@@ -61,13 +63,24 @@ module Gitlab
             source_id: resource[:project_id],
             resource_type: policy.type,
             resource_id: resource['iid'],
-            sub_resource_type: 'notes'
+            sub_resource_type: sub_resource_type
           ).build
 
           puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if network.options.debug
 
           post_url
         end
+
+        def sub_resource_type
+          case type = policy.actions[:comment_type]
+          when 'comment', nil # nil is default
+            'notes'
+          when 'thread'
+            'discussions'
+          else
+            raise ArgumentError, "Unknown comment type: #{type}"
+          end
+        end
       end
     end
   end

data/lib/gitlab/triage/api_query_builders/date_query_param_builder.rb

@@ -0,0 +1,78 @@
+require_relative '../validators/params_validator'
+
+module Gitlab
+  module Triage
+    module APIQueryBuilders
+      class DateQueryParamBuilder
+        ATTRIBUTES = %w[updated_at created_at].freeze
+        CONDITIONS = %w[older_than newer_than].freeze
+        INTERVAL_TYPES = %w[days weeks months years].freeze
+
+        def self.filter_parameters
+          [
+            {
+              name: :attribute,
+              type: String,
+              values: ATTRIBUTES
+            },
+            {
+              name: :condition,
+              type: String,
+              values: CONDITIONS
+            },
+            {
+              name: :interval_type,
+              type: String,
+              values: INTERVAL_TYPES
+            },
+            {
+              name: :interval,
+              type: Numeric
+            }
+          ]
+        end
+
+        def self.applicable?(condition)
+          ATTRIBUTES.include?(condition[:attribute].to_s)
+        end
+
+        def initialize(condition_hash)
+          @attribute = condition_hash[:attribute].to_s
+          @interval_condition = condition_hash[:condition].to_sym
+          @interval_type = condition_hash[:interval_type]
+          @interval = condition_hash[:interval]
+          validate_condition(condition_hash)
+        end
+
+        def validate_condition(condition)
+          ParamsValidator.new(self.class.filter_parameters, condition).validate!
+        end
+
+        def param_name
+          prefix = attribute.sub(/_at\z/, '')
+          suffix =
+            case interval_condition
+            when :older_than
+              'before'
+            when :newer_than
+              'after'
+            end
+
+          "#{prefix}_#{suffix}"
+        end
+
+        def param_content
+          interval.public_send(interval_type).ago.to_date # rubocop:disable GitlabSecurity/PublicSend
+        end
+
+        def build_param
+          "&#{param_name}=#{param_content.strip}"
+        end
+
+        private
+
+        attr_reader :condition_hash, :attribute, :interval_condition, :interval_type, :interval
+      end
+    end
+  end
+end

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

@@ -2,13 +2,15 @@ module Gitlab
   module Triage
     module CommandBuilders
       class BaseCommandBuilder
-        def initialize(items)
+        def initialize(items, resource: nil, network: nil)
           @items = Array.wrap(items)
           @items.delete('')
+          @resource = resource&.with_indifferent_access
+          @network = network
         end
 
         def build_command
-          if @items.any?
+          if items.any?
             [slash_command_string, content_string].compact.join(separator)
           else
             ""
@@ -17,6 +19,8 @@ module Gitlab
 
         private
 
+        attr_reader :items, :resource, :network
+
         def separator
           ' '
         end
@@ -26,7 +30,7 @@ module Gitlab
         end
 
         def content_string
-          @items.map do |item|
+          items.map do |item|
             format_item(item)
           end.join(separator)
         end

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

@@ -4,8 +4,25 @@ module Gitlab
   module Triage
     module CommandBuilders
       class LabelCommandBuilder < BaseCommandBuilder
+        def build_command
+          ensure_labels_exist!
+
+          super
+        end
+
         private
 
+        def ensure_labels_exist!
+          items.each do |label|
+            label_opts = { project_id: resource[:project_id], name: label }
+
+            unless Resource::Label.new(label_opts, network: network).exist?
+              raise Resource::Label::LabelDoesntExistError,
+                    "Label `#{label}` doesn't exist!"
+            end
+          end
+        end
+
         def slash_command_string
           "/label"
         end

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

@@ -0,0 +1,19 @@
+require_relative 'base_command_builder'
+
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class MoveCommandBuilder < BaseCommandBuilder
+        private
+
+        def slash_command_string
+          "/move"
+        end
+
+        def format_item(item)
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/array/wrap'
+require 'cgi'
 
 require_relative 'base_command_builder'
 require_relative '../resource/context'
@@ -33,13 +34,9 @@ module Gitlab
         }.freeze
         PLACEHOLDER_REGEX = /{{([\w\.]+)}}/.freeze
 
-        attr_reader :resource, :network
-
         def initialize(
           items, resource: nil, network: nil, redact_confidentials: true)
-          super(items)
-          @resource = resource&.with_indifferent_access
-          @network = network
+          super(items, resource: resource, network: network)
           @redact_confidentials = redact_confidentials
         end
 
@@ -76,7 +73,22 @@ module Gitlab
               template.sub(PLACEHOLDER_REGEX, attribute.to_s)
             end.join(', ')
 
-            comment.gsub("{{#{placeholder}}}", formatted_text)
+            escaped_text =
+              case placeholder
+              when :items
+                # We don't need to escape it because it's recursive,
+                # which the contents should all be escaped already.
+                # Or put it another way, items isn't an attribute
+                # retrieved externally. It's a generated value which
+                # should be safe to begin with. At some point we
+                # may want to make this more distinguishable,
+                # separating values from API and values generated.
+                formatted_text
+              else
+                CGI.escape_html(formatted_text)
+              end
+
+            comment.gsub("{{#{placeholder}}}", escaped_text)
           end
         end
 

data/lib/gitlab/triage/engine.rb

@@ -2,10 +2,8 @@ require 'active_support/all'
 require 'active_support/inflector'
 
 require_relative 'expand_condition'
-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'
 require_relative 'filters/author_member_conditions_filter'
 require_relative 'filters/assignee_member_conditions_filter'
@@ -16,6 +14,7 @@ require_relative 'policies/rule_policy'
 require_relative 'policies/summary_policy'
 require_relative 'policies_resources/rule_resources'
 require_relative 'policies_resources/summary_resources'
+require_relative 'api_query_builders/date_query_param_builder'
 require_relative 'api_query_builders/single_query_param_builder'
 require_relative 'api_query_builders/multi_query_param_builder'
 require_relative 'url_builders/url_builder'
@@ -38,6 +37,7 @@ module Gitlab
         @options = options
         @network_adapter_class = network_adapter_class
 
+        assert_all!
         assert_project_id!
         assert_token!
         require_ruby_files
@@ -66,6 +66,7 @@ module Gitlab
 
       def assert_project_id!
         return if options.source_id
+        return if options.all
 
         raise ArgumentError, 'A project_id is needed (pass it with the `--source-id` option)!'
       end
@@ -76,6 +77,11 @@ module Gitlab
         raise ArgumentError, 'A token is needed (pass it with the `--token` option)!'
       end
 
+      def assert_all!
+        raise ArgumentError, '--all-projects option cannot be used in conjunction with --source and --source-id option!' if
+          options.all && (options.source || options.source_id)
+      end
+
       def require_ruby_files
         options.require_files.each(&method(:require))
       end
@@ -146,7 +152,7 @@ module Gitlab
       end
 
       def resources_for_rule(resource_type, rule)
-        puts Gitlab::Triage::UI.header("Processing rule: **#{rule[:name]}**", char: '-')
+        puts Gitlab::Triage::UI.header("Gathering resources for rule: **#{rule[:name]}**", char: '-')
 
         ExpandCondition.perform(rule_conditions(rule)) do |conditions|
           # retrieving the resources for every rule is inefficient
@@ -186,22 +192,31 @@ module Gitlab
         resources.select do |resource|
           results = []
 
+          # rubocop:disable Style/IfUnlessModifier
           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
+            results << Filters::MergeRequestDateConditionsFilter.new(resource, conditions[:date]).calculate
           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]
-          results << Filters::AuthorMemberConditionsFilter.new(resource, conditions[:author_member], network).calculate if conditions[:author_member]
-          results << Filters::AssigneeMemberConditionsFilter.new(resource, conditions[:assignee_member], network).calculate if conditions[:assignee_member]
-          results << Filters::RubyConditionsFilter.new(resource, conditions, network).calculate if conditions[:ruby]
+
+          if conditions[:upvotes]
+            results << Filters::VotesConditionsFilter.new(resource, conditions[:upvotes]).calculate
+          end
+
+          if conditions[:no_additional_labels]
+            results << Filters::NoAdditionalLabelsConditionsFilter.new(resource, conditions.fetch(:labels) { [] }).calculate
+          end
+
+          if conditions[:author_member]
+            results << Filters::AuthorMemberConditionsFilter.new(resource, conditions[:author_member], network).calculate
+          end
+
+          if conditions[:assignee_member]
+            results << Filters::AssigneeMemberConditionsFilter.new(resource, conditions[:assignee_member], network).calculate
+          end
+
+          if conditions[:ruby]
+            results << Filters::RubyConditionsFilter.new(resource, conditions, network).calculate
+          end
+          # rubocop:enable Style/IfUnlessModifier
 
           results.all?
         end
@@ -224,17 +239,27 @@ module Gitlab
 
         condition_builders = []
         condition_builders << APIQueryBuilders::MultiQueryParamBuilder.new('labels', conditions[:labels], ',') if conditions[:labels]
+
+        if conditions[:forbidden_labels]
+          condition_builders << APIQueryBuilders::MultiQueryParamBuilder.new('not[labels]', conditions[:forbidden_labels], ',')
+        end
+
         condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('state', conditions[:state]) if conditions[:state]
         condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('milestone', Array(conditions[:milestone])[0]) if conditions[:milestone]
         condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('source_branch', conditions[:source_branch]) if conditions[:source_branch]
         condition_builders << APIQueryBuilders::SingleQueryParamBuilder.new('target_branch', conditions[:target_branch]) if conditions[:target_branch]
 
+        if conditions[:date] && APIQueryBuilders::DateQueryParamBuilder.applicable?(conditions[:date])
+          condition_builders << APIQueryBuilders::DateQueryParamBuilder.new(conditions.delete(:date))
+        end
+
         condition_builders.each do |condition_builder|
           params[condition_builder.param_name] = condition_builder.param_content
         end
 
         UrlBuilders::UrlBuilder.new(
           network_options: options,
+          all: options.all,
           source: options.source,
           source_id: options.source_id,
           resource_type: resource_type,

data/lib/gitlab/triage/errors.rb

@@ -1 +1 @@
-require 'gitlab/triage/errors/network'
+require_relative 'errors/network'

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

@@ -1,21 +1,67 @@
-require_relative 'issuable_date_conditions_filter'
+require_relative 'base_conditions_filter'
 
 module Gitlab
   module Triage
     module Filters
-      class MergeRequestDateConditionsFilter < IssuableDateConditionsFilter
-        ATTRIBUTES = %w[updated_at created_at merged_at].freeze
+      class MergeRequestDateConditionsFilter < BaseConditionsFilter
+        ATTRIBUTES = %w[merged_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: allowed_attributes
+            },
+            {
+              name: :condition,
+              type: String,
+              values: CONDITIONS
+            },
+            {
+              name: :interval_type,
+              type: String,
+              values: INTERVAL_TYPES
+            },
+            {
+              name: :interval,
+              type: Numeric
+            }
+          ]
+        end
+
+        def initialize_variables(condition)
+          @attribute = condition[:attribute].to_sym
+          @condition = condition[:condition].to_sym
+          @interval_type = condition[:interval_type].to_sym
+          @interval = condition[:interval]
+        end
 
         # Guard against merge requests with no merged_at values
         def resource_value
-          super if @resource[@attribute]
+          @resource[@attribute]&.to_date
+        end
+
+        def condition_value
+          @interval.public_send(@interval_type).ago.to_date # rubocop:disable GitlabSecurity/PublicSend
         end
 
         # Guard against merge requests with no merged_at values
         def calculate
           return false unless resource_value
 
-          super
+          case @condition
+          when :older_than
+            resource_value < condition_value
+          when :newer_than
+            resource_value > condition_value
+          end
         end
       end
     end