gitlab-triage 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1242b945b940e1378f6bb8f66eb5f08f3adb387245c0425954aa7a6cc3e98f25
-  data.tar.gz: 925cbb79cd61b2c5f4eeb87eed0596c674902aa6fd44bfe679b9740d660aede6
+  metadata.gz: e02cd169e252e4656441f6e9268314c2b968935957dbcb906ae3048ee7045da4
+  data.tar.gz: 3b58c8b37e3f82878272641ad848239c74623499f0e309ba0ac9aaaf6803cf0f
 SHA512:
-  metadata.gz: 1caedc0d489bc0e45e66399aa9529cf3eaf9812a78cb99fddba5cc5a078b10ab748e763d2407e6911da9ba2cadbc56453040366c8bad1757a0ae07fbcbf25b1d
-  data.tar.gz: 12de27a31f013916beee14fe3da467e1ee316774e8fea019c0735c68c81f0e5694a79cdcb5d4bc94522b620a94c4c4989c4367f51fd28d400f19a1dca63d48dc
+  metadata.gz: 181a6a5055a61b5d8c78f36d047dfef269a92a7d0173598a490e5420ab04fb267c9c42be2ae9bef31a815eb7730a15b921dde2b1834e49dcc20d0969d4986f54
+  data.tar.gz: 621d6e208ad9dcdd034931ca0656778e5247c6aa3f3e6fa8edf53ed401795452f0d136eec259df8a377e36589de866fc7ee949a792cd1fa5b2c07257cab577ee

data/.gitlab-ci.yml

@@ -2,7 +2,7 @@ stages:
   - prepare
   - test
   - triage
-  - release
+  - deploy
 
 default:
   image: ruby:2.7
@@ -38,6 +38,7 @@ workflow:
   services:
     - docker:${DOCKER_VERSION}-dind
   variables:
+    DOCKER_VERSION: "19.03.0"
     DOCKER_DRIVER: overlay2
     DOCKER_HOST: tcp://docker:2375
     DOCKER_TLS_CERTDIR: ""
@@ -118,7 +119,7 @@ dry-run:gitlab-triage:
     - gitlab-triage --version
     - gitlab-triage --help
     - gitlab-triage --init
-    - gitlab-triage --dry-run --debug --token $API_TOKEN --source-id $CI_PROJECT_PATH
+    - gitlab-triage --dry-run --debug --token $GITLAB_API_TOKEN --source-id $CI_PROJECT_PATH
 
 # This job requires allows to override the `CI_PROJECT_PATH` variable when triggered.
 dry-run:custom:
@@ -127,26 +128,6 @@ dry-run:custom:
     - when: manual
       allow_failure: true
 
-###################
-## Release stage ##
-###################
-release:
-  stage: release
-  rules:
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"'
-      changes: ["lib/gitlab/triage/version.rb"]
-    - if: '$CI_MERGE_REQUEST_TITLE =~ /RELEASE/'
-      when: manual
-  before_script: []
-  script:
-    - version=$(ruby -r ./lib/gitlab/triage/version -e 'puts Gitlab::Triage::VERSION' | tr -d "\n")
-    - tag="v${version}"
-    - message="Version ${version}."
-    # TODO: Add release notes from the Release MR?
-    - 'curl --request POST --header "PRIVATE-TOKEN: ${API_TOKEN}" -d "tag_name=${tag}" -d "ref=${CI_COMMIT_SHA}" -d "message=${message}" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/repository/tags"'
-    - gem build gitlab-triage.gemspec
-    - gem push "gitlab-triage-${version}.gem"
-  artifacts:
-    paths:
-      - gitlab-triage*.gem
-    expire_in: 30 days
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/gem-release.yml'

data/Guardfile

@@ -24,7 +24,7 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
+guard :rspec, cmd: "bundle exec rspec -f doc" do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -552,6 +552,10 @@ Adds a number of labels to the resource.
 
 Accepts an array of strings. Each element is the name of a label to add.
 
+If any of the labels doesn't exist, the automation will stop immediately so
+that if a label is renamed or deleted, you'll have to explicitly update or remove
+it in your policy file.
+
 Example:
 
 ```yml
@@ -567,6 +571,10 @@ Removes a number of labels from the resource.
 
 Accepts an array of strings. Each element is the name of a label to remove.
 
+If any of the labels doesn't exist, the automation will stop immediately so
+that if a label is renamed or deleted, you'll have to explicitly update or remove
+it in your policy file.
+
 Example:
 
 ```yml
@@ -1016,22 +1024,22 @@ Usage: gitlab-triage [options]
 Triaging against a specific project:
 
 ```
-gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org/triage
+gitlab-triage --dry-run --token $GITLAB_API_TOKEN --source-id gitlab-org/triage
 ```
 
 Triaging against a whole group:
 
 ```
-gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org --source groups
+gitlab-triage --dry-run --token $GITLAB_API_TOKEN --source-id gitlab-org --source groups
 ```
 
 Triaging against an entire instance:
 
 ```
-gitlab-triage --dry-run --token $API_TOKEN --all-projects
+gitlab-triage --dry-run --token $GITLAB_API_TOKEN --all-projects
 ```
 
-> **Note:** The `--all-projects` option will process all resources for all projects visible to the specified `$API_TOKEN`
+> **Note:** The `--all-projects` option will process all resources for all projects visible to the specified `$GITLAB_API_TOKEN`
 
 #### Running on GitLab CI pipeline
 
@@ -1042,7 +1050,7 @@ run:triage:triage:
   stage: triage
   script:
     - gem install gitlab-triage
-    - gitlab-triage --token $API_TOKEN --source-id $CI_PROJECT_PATH
+    - gitlab-triage --token $GITLAB_API_TOKEN --source-id $CI_PROJECT_PATH
   only:
     - schedules
 ```
@@ -1056,7 +1064,7 @@ Yes, you can override the host url using the following options:
 ##### CLI
 
 ```
-gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org/triage --host-url https://gitlab.host.com
+gitlab-triage --dry-run --token $GITLAB_API_TOKEN --source-id gitlab-org/triage --host-url https://gitlab.host.com
 ```
 
 ##### Policy file
@@ -1093,7 +1101,7 @@ Gitlab::Triage::Resource::Context.include MyPlugin
 And then run it with:
 
 ```shell
-gitlab-triage -r ./my_plugin.rb --token $API_TOKEN --source-id gitlab-org/triage
+gitlab-triage -r ./my_plugin.rb --token $GITLAB_API_TOKEN --source-id gitlab-org/triage
 ```
 
 This allows you to use `has_severity_label?` in the Ruby condition:

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

@@ -41,8 +41,8 @@ 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

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/text_content_builder.rb

@@ -34,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
 

data/lib/gitlab/triage/engine.rb

@@ -4,7 +4,6 @@ require 'active_support/inflector'
 require_relative 'expand_condition'
 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'
@@ -202,10 +201,6 @@ module Gitlab
             results << Filters::VotesConditionsFilter.new(resource, conditions[:upvotes]).calculate
           end
 
-          if conditions[:forbidden_labels]
-            results << Filters::ForbiddenLabelsConditionsFilter.new(resource, conditions[:forbidden_labels]).calculate
-          end
-
           if conditions[:no_additional_labels]
             results << Filters::NoAdditionalLabelsConditionsFilter.new(resource, conditions.fetch(:labels) { [] }).calculate
           end
@@ -244,6 +239,11 @@ 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]

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

@@ -58,11 +58,15 @@ module Gitlab
           build_url(params: params)
         end
 
+        def resource_id
+          resource[:iid]
+        end
+
         def resource_url(params: {}, sub_resource_type: nil)
           build_url(
             params: params,
             options: {
-              resource_id: resource[:iid],
+              resource_id: resource_id,
               sub_resource_type: sub_resource_type
             }
           )

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

@@ -8,6 +8,8 @@ module Gitlab
   module Triage
     module Resource
       class Label < Base
+        LabelDoesntExistError = Class.new(StandardError)
+
         FIELDS = %i[
           id
           project_id
@@ -35,6 +37,19 @@ module Gitlab
             Time.parse(value) if value
           end
         end
+
+        def exist?
+          label = network.query_api_cached(resource_url).first
+          return false unless label
+
+          label[:name] == name
+        end
+
+        private
+
+        def resource_id
+          name
+        end
       end
     end
   end

data/lib/gitlab/triage/url_builders/url_builder.rb

@@ -17,7 +17,7 @@ module Gitlab
 
         def build
           url = base_url
-          url << "/#{@resource_id}" if @resource_id
+          url << "/#{CGI.escape(@resource_id.to_s)}" if @resource_id
           url << "/#{@sub_resource_type}" if @sub_resource_type
           url << params_string if @params
           url

data/lib/gitlab/triage/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Triage
-    VERSION = '1.10.1'
+    VERSION = '1.11.0'
   end
 end

data/support/.gitlab-ci.example.yml

@@ -8,7 +8,7 @@ dry-run:triage:
   script:
     - gem install gitlab-triage
     - gitlab-triage --help
-    - gitlab-triage --dry-run --token $API_TOKEN --source projects --source-id $CI_PROJECT_PATH
+    - gitlab-triage --dry-run --token $GITLAB_API_TOKEN --source projects --source-id $CI_PROJECT_PATH
   when: manual
   except:
     - schedules
@@ -17,6 +17,6 @@ run:triage:
   stage: triage
   script:
     - gem install gitlab-triage
-    - gitlab-triage --token $API_TOKEN --source projects --source-id $CI_PROJECT_PATH
+    - gitlab-triage --token $GITLAB_API_TOKEN --source projects --source-id $CI_PROJECT_PATH
   only:
     - schedules

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,7 +158,6 @@ 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/forbidden_labels_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

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

@@ -1,32 +0,0 @@
-require_relative 'base_conditions_filter'
-
-module Gitlab
-  module Triage
-    module Filters
-      class ForbiddenLabelsConditionsFilter < BaseConditionsFilter
-        def validate_condition(condition)
-          raise ArgumentError, 'condition must be an array containing forbidden label values' unless condition.is_a?(Array)
-        end
-
-        def initialize_variables(forbidden_labels)
-          @attribute = :labels
-          @forbidden_labels = forbidden_labels
-        end
-
-        def resource_value
-          @resource[@attribute]
-        end
-
-        def calculate
-          label_intersection.empty?
-        end
-
-        private
-
-        def label_intersection
-          resource_value & @forbidden_labels
-        end
-      end
-    end
-  end
-end