payping-gitlab-triage 0.1.1

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/gitlab-triage

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require_relative '../lib/gitlab/triage/option_parser'
+require_relative '../lib/gitlab/triage/engine'
+require_relative '../lib/gitlab/triage/ui'
+
+options = Gitlab::Triage::OptionParser.parse(ARGV)
+options.policies_files << '.triage-policies.yml' if options.policies_files.empty?
+
+options.policies_files.each do |policies_file|
+  policies = HashWithIndifferentAccess.new(YAML.load_file(policies_file))
+
+  policy_engine = Gitlab::Triage::Engine
+    .new(policies: policies, options: options)
+
+  puts Gitlab::Triage::UI.header("Executing policies from #{policies_file}.", char: '*')
+  policy_engine.perform
+end

data/gitlab-triage.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/triage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'payping-gitlab-triage'
+  spec.version       = Gitlab::Triage::VERSION
+  spec.authors       = ['GitLab']
+  spec.email         = ['gitlab_rubygems@gitlab.com']
+
+  spec.summary       = 'GitLab triage automation project.'
+  spec.homepage      = 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-triage/-/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match?(%r{^(docs?|spec|tmp)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.1'
+  spec.add_dependency 'globalid', '~> 0.4'
+  spec.add_dependency 'graphql-client', '~> 0.16'
+  spec.add_dependency 'httparty', '~> 0.17'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'gitlab-styles', '~> 2.8'
+  spec.add_development_dependency 'rake', '~> 10.2'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+end

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

@@ -0,0 +1,14 @@
+module Gitlab
+  module Triage
+    module Action
+      class Base
+        attr_reader :policy, :network
+
+        def initialize(policy:, network:)
+          @policy = policy
+          @network = network
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+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
+    module Action
+      class Comment < Base
+        class Dry < Comment
+          def act
+            puts "The following comments would be posted for the rule **#{policy.name}**:\n\n"
+
+            super
+          end
+
+          private
+
+          def perform(resource, comment)
+            puts "# #{resource[:web_url]}\n```\n#{comment}\n```\n"
+          end
+        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
+
+            perform(resource, comment) unless comment.empty?
+          end
+        end
+
+        private
+
+        def build_comment(resource)
+          CommandBuilders::CommentCommandBuilder.new(
+            [
+              CommandBuilders::TextContentBuilder.new(policy.actions[:comment], resource: resource, network: network).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
+        end
+
+        def perform(resource, comment)
+          network.post_api(
+            build_post_url(resource),
+            body: comment)
+        end
+
+        def build_post_url(resource)
+          url_builder_opts = {
+            network_options: network.options,
+            source: policy.source,
+            source_id: resource[policy.source_id_sym],
+            resource_type: policy.type,
+            resource_id: resource_id(resource),
+            sub_resource_type: sub_resource_type
+          }
+
+          # POST /(groups|projects)/:id/(epics|issues|merge_requests)/:iid/notes
+          post_url = UrlBuilders::UrlBuilder.new(url_builder_opts).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
+
+        def resource_id(resource)
+          case policy.type
+          when 'epics'
+            resource['id']
+          else
+            resource['iid']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+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
+    module Action
+      class CommentOnSummary < Base
+        class Dry < CommentOnSummary
+          def act
+            puts "The following comments would be posted for the rule **#{policy.name}**:\n\n"
+
+            super
+          end
+
+          private
+
+          def perform(comment)
+            puts "# #{summary[:web_url]}\n```\n#{comment}\n```\n"
+          end
+        end
+
+        attr_reader :summary
+
+        def initialize(policy:, network:)
+          super(policy: policy, network: network)
+          @summary = policy.summary
+        end
+
+        def act
+          policy.resources.each do |resource|
+            comment = build_comment(resource).strip
+
+            perform(comment) unless comment.empty?
+          end
+        end
+
+        private
+
+        def build_comment(resource)
+          CommandBuilders::TextContentBuilder.new(policy.actions[:comment_on_summary], resource: resource, network: network).build_command
+        end
+
+        def perform(comment)
+          network.post_api(build_post_url, body: comment)
+        end
+
+        def build_post_url
+          # POST /projects/:id/issues/:issue_iid/notes
+          post_url = UrlBuilders::UrlBuilder.new(
+            network_options: network.options,
+            source_id: summary['project_id'],
+            resource_type: policy.type,
+            resource_id: summary['iid'],
+            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
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Gitlab
+  module Triage
+    module Action
+      class Summarize < Base
+        class Dry < Summarize
+          private
+
+          def perform
+            policy.summary = {
+              web_url: '[the-created-issue-url]',
+              project_id: 'some-id',
+              iid: 'some-iid'
+            }.with_indifferent_access
+
+            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}"
+            puts ">>>"
+          end
+        end
+
+        def act
+          perform if issue.valid?
+        end
+
+        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
+
+          policy.summary = network.post_api(post_issue_url, post_issue_body)
+        end
+
+        def issue
+          @issue ||= policy.build_summary
+        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: destination,
+            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
+          {
+            title: issue.title,
+            description: issue.description
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/action.rb

@@ -0,0 +1,36 @@
+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
+    module Action
+      def self.process(policy:, **args)
+        policy.validate!
+
+        [
+          [Summarize, policy.summarize?],
+          [Comment, policy.comment?],
+          [CommentOnSummary, policy.comment_on_summary?],
+          [Issue, policy.issue?],
+          [Delete, policy.delete?]
+        ].each do |action, active|
+          act(action: action, policy: policy, **args) if active
+        end
+      end
+
+      def self.act(action:, dry:, **args)
+        klass =
+          if dry
+            action.const_get(:Dry)
+          else
+            action
+          end
+
+        klass.new(**args).act
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Gitlab
+  module Triage
+    module APIQueryBuilders
+      class BaseQueryParamBuilder
+        attr_reader :param_name, :param_contents, :allowed_values
+
+        def initialize(param_name, param_contents, allowed_values: nil)
+          @param_name = param_name
+          @param_contents = param_contents
+          @allowed_values = allowed_values
+
+          validate_allowed_values! if allowed_values
+        end
+
+        def build_param
+          "&#{param_name}=#{param_content.strip}"
+        end
+
+        private
+
+        def validate_allowed_values!
+          ParamsValidator.new([{ name: param_name, type: String, values: allowed_values }], { param_name => param_contents }).validate!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require_relative '../param_builders/date_param_builder'
+require_relative 'base_query_param_builder'
+
+module Gitlab
+  module Triage
+    module APIQueryBuilders
+      class DateQueryParamBuilder < BaseQueryParamBuilder
+        ATTRIBUTES = %w[updated_at created_at].freeze
+
+        def self.applicable?(condition)
+          ATTRIBUTES.include?(condition[:attribute].to_s) &&
+            condition[:filter_in_ruby] != true
+        end
+
+        def initialize(condition_hash)
+          date_param_builder = ParamBuilders::DateParamBuilder.new(ATTRIBUTES, condition_hash)
+
+          super(build_param_name(condition_hash), date_param_builder.param_content)
+        end
+
+        def param_content
+          param_contents
+        end
+
+        private
+
+        def build_param_name(condition_hash)
+          prefix = condition_hash[:attribute].to_s.sub(/_at\z/, '')
+          suffix =
+            case condition_hash[:condition].to_sym
+            when :older_than
+              'before'
+            when :newer_than
+              'after'
+            end
+
+          "#{prefix}_#{suffix}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require_relative 'base_query_param_builder'
+
+module Gitlab
+  module Triage
+    module APIQueryBuilders
+      class MultiQueryParamBuilder < BaseQueryParamBuilder
+        attr_reader :separator
+
+        def initialize(param_name, param_contents, separator, allowed_values: nil)
+          @separator = separator
+          super(param_name, Array(param_contents), allowed_values: allowed_values)
+        end
+
+        def param_content
+          param_contents.map(&:strip).join(separator)
+        end
+
+        private
+
+        def validate_allowed_values!
+          param_contents.each do |param|
+            ParamsValidator.new([{ name: param_name, type: String, values: allowed_values }], { param_name => param }).validate!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative 'base_query_param_builder'
+
+module Gitlab
+  module Triage
+    module APIQueryBuilders
+      class SingleQueryParamBuilder < BaseQueryParamBuilder
+        def param_content
+          param_contents
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class BaseCommandBuilder
+        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?
+            [slash_command_string, content_string].compact.join(separator)
+          else
+            ""
+          end
+        end
+
+        private
+
+        attr_reader :items, :resource, :network
+
+        def separator
+          ' '
+        end
+
+        def slash_command_string
+          nil
+        end
+
+        def content_string
+          items.map do |item|
+            format_item(item)
+          end.join(separator)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative 'base_command_builder'
+
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class CcCommandBuilder < BaseCommandBuilder
+        private
+
+        def slash_command_string
+          "/cc"
+        end
+
+        def format_item(item)
+          "@#{item}"
+        end
+      end
+    end
+  end
+end