confiner 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6f4bc89fcaa0b13753ab758e0c6f4dd5083c1c6509136c941d07a7f712dd6f
-  data.tar.gz: 7916aa6ccba90cc9898b5ad06080cf02bb2761b0f48697f5514e5fea18482049
+  metadata.gz: 6e9601fa7e82b448423188a4dde817864c6f7f57f1a1efd9aae67c1b2e8708c7
+  data.tar.gz: 23b2a999e52c58e5081fc9f4857e45a5a0c1783c0b1eca373f4ad4b57394a97f
 SHA512:
-  metadata.gz: ac49213f58a6378ced0bf2ecfb1a82e91a2e6252083efaefe6936d1bf6db7a9b5bb61a9d5e78f95e4a79247b17d0eee67877497921a3bd10bc45bf601d3af961
-  data.tar.gz: eb2a4a4ebd927e4a885dc1105adfecf3e383666b238fe531795b59a718176602bdc19ce3c198c44c6e252eb39fa04ed2a256dde3531648ba8f321a546b721f16
+  metadata.gz: 48ad12ecefe1473ec4d481f3ebce5d325b9a0a052af1705a9a69621ea78a6d2fb5461fa4a068a83808943dc055f71fec936f54764894bc7a94de6e810e6bbb68
+  data.tar.gz: f74349e0a4003152ab16e7e86b4c34b77c58376ad7550fdf1796d4f7bd9633f0fc177abc56133607c4ce3c6108ca43b4598eacaf44eaa029c6127e301f80410b

data/lib/confiner/cli.rb

@@ -110,6 +110,7 @@ module Confiner
     def process_rule(rule)
       log :rule, rule.keys.map { |k| "\t#{k}=#{rule[k]}" }.join(',')
 
+      rule['plugin']['args'] ||= {}
       rule['plugin']['args'].transform_keys!(&:to_sym) # 2.5 compatability
 
       plugin = Plugins.const_get(translate_plugin_name(rule['plugin']['name'])).new(**rule['plugin']['args'])

data/lib/confiner/logger.rb

@@ -4,9 +4,13 @@ module Confiner
   module Logger
     # Log something with a specific level
     def log(level, message, indentation = 1)
+      color = "\e[0;35m" # default purple
+      color = "\e[0;33m" if %i[warn warning].include?(level) # yellow
+      color = "\e[0;31m" if %i[err error fatal].include?(level) # red
+
       raise ArgumentError, 'Level must be less than 12 characters' if level.size > 12
 
-      output = "(#{Time.now.strftime('%F %H:%M:%S')})\t\e[0;35m#{level.to_s.upcase}#{' ' * (12 - level.size)}\e[m#{"\t" * indentation}#{message}"
+      output = "(#{Time.now.strftime('%F %H:%M:%S')})\t#{color}#{level.to_s.upcase}#{' ' * (12 - level.size)}\e[m#{"\t" * indentation}#{message}"
 
       Logger.log_to.puts(output)
     end

data/lib/confiner/plugins/debug.rb

@@ -12,6 +12,20 @@ module Confiner
       def action2
         log :debug, arg2
       end
+
+      def warn
+        log :warn, 'Warn'
+        log :warning, 'Warning'
+      end
+
+      def fatal
+        log :fatal, 'Fatal'
+      end
+
+      def error
+        log :err, 'Err'
+        log :error, 'Error'
+      end
     end
   end
 end

data/lib/confiner/plugins/gitlab.rb

@@ -14,7 +14,7 @@ module Confiner
                 :threshold => 3,                          # the failure / pass threshold
                 :endpoint => 'https://gitlab.com/api/v4', # the GitLab API Endpoint (e.g. https://gitlab.com/api/v4)
                 :pwd => '.',                              # the path of the working directory for the examples
-                :ref => 'master'                          # the default Git ref used when updating
+                :ref => 'main'                            # the default Git ref used when updating
 
       MERGE_REQUEST_TITLE = '[QUARANTINE] %s'
       QUARANTINE_METADATA = %(, quarantine: { issue: '%s', type: :investigating })
@@ -24,6 +24,8 @@ module Confiner
 
         ENV['GITLAB_API_HTTPARTY_OPTIONS'] = ENV.fetch('GITLAB_API_HTTPARTY_OPTIONS') { "{read_timeout: #{timeout}}" }
 
+        raise ArgumentError, 'Missing private_token' if private_token.nil?
+
         @gitlab_client = ::Gitlab.client(private_token: private_token, endpoint: endpoint)
       end
 
@@ -34,11 +36,13 @@ module Confiner
         # store the examples from the pipelines
         @examples = get_examples
 
-        @examples.select(&:failed?).map(&:name).uniq.each do |failed_example|
+        quarantines = @examples.select(&:failed?).map(&:name).uniq.each_with_object([]) do |failed_example, quarantines|
           # count the number of failures consecutively for this example
 
           number_of_failures = @examples.select { _1.name == failed_example && _1.failed? }.size
           if number_of_failures >= threshold
+            quarantines << failed_example
+
             example = @examples.find { _1.name == failed_example }
 
             log :quarantine, "Quarantining #{failed_example} (#{number_of_failures} >= #{threshold})", 3
@@ -67,6 +71,12 @@ module Confiner
           end
         end
 
+        if quarantines.any?
+          log :quarantine, "Found #{quarantines.size} candidates to be quarantined", 3
+        else
+          log :quarantine, 'Found no candidates to be quarantined', 3
+        end
+
         log :gitlab, 'Done with Quarantine Process', 2
       end
 
@@ -84,8 +94,8 @@ module Confiner
       def get_last_n_runs(threshold:)
         pipelines = [] # collection of both passing and failing pipelines
 
-        pipelines << @gitlab_client.pipelines(project_id, per_page: threshold, status: :success)
-        pipelines << @gitlab_client.pipelines(project_id, per_page: threshold, status: :failed)
+        pipelines << @gitlab_client.pipelines(project_id, per_page: threshold, status: :success, ref: ref)
+        pipelines << @gitlab_client.pipelines(project_id, per_page: threshold, status: :failed, ref: ref)
       end
 
       # Get examples from pipelines
@@ -184,7 +194,7 @@ module Confiner
       # @param [Gitlab::ObjectifiedHash] failure_issue the existing failure issue
       # @return [Gitlab::ObjectifiedHash] the new branch
       def create_branch(failure_issue, example)
-        branch = @gitlab_client.create_branch(target_project, "#{failure_issue['iid']}-quarantine-#{example.name.tr(' ', '-')}", ref)
+        branch = @gitlab_client.create_branch(target_project, "#{failure_issue['iid']}-quarantine-#{example.name.gsub(/\W/, '-')}", ref)
 
         log :branch, "Created branch #{branch['name']} (#{branch['web_url']})", 4
 
@@ -228,13 +238,15 @@ module Confiner
           end
         end
 
+        meets_or_exceeds_threshold = occurrences.size > threshold ? 'exceeds' : 'meets'
+
         description = <<~MARKDOWN
           ## What does this MR do?
 
-          Quarantines the test `#{example.name}` (#{example.file}:#{changed_line_number})
+          Quarantines the test `#{example.name}` (https://gitlab.com/#{target_project}/-/blob/#{ref}/#{example.file}#L#{changed_line_number})
 
-          This test has been found by [Confiner](https://gitlab.com/gitlab-org/quality/confiner) to have been failing for
-          more than (or equal to) #{threshold} times.  This test has failed #{occurrences.size} times.
+          This test has been found by [Confiner](https://gitlab.com/gitlab-org/quality/confiner) to have failed
+          #{occurrences.size} times, which #{meets_or_exceeds_threshold} the threshold of #{threshold} times.
 
           #{markdown_occurrences.join("\n")}
 

data/lib/confiner/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Confiner
+  VERSION = '0.2.3'
+end

data/lib/confiner.rb

@@ -7,7 +7,5 @@ loader.push_dir(__dir__)
 loader.setup
 
 module Confiner
-  VERSION = '0.2.0'
-
   module Plugins; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confiner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +82,7 @@ files:
 - lib/confiner/plugin.rb
 - lib/confiner/plugins/debug.rb
 - lib/confiner/plugins/gitlab.rb
+- lib/confiner/version.rb
 homepage: https://gitlab.com/gitlab-org/quality/confiner
 licenses:
 - MIT