confiner 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f422b15043676a7b0404bdf5ab6c632bf51fe142d28700953fa8c84516f0ae1
-  data.tar.gz: ff789be11d0c34fdfd4cd218540b5ec3d489b965ac228fbc21836ad15044ee50
+  metadata.gz: 2aec5b597e2386e03ac5df865c2a0adc622a13ec580047e9a320a5ddf80d486b
+  data.tar.gz: 41d27a7ae0f3e5fb86a8d19d00593a043bd08eefb9d9304d531f4ab46e81c726
 SHA512:
-  metadata.gz: 79765878d4d9e6d259223857a506c7c2e29c702456be764fc9b4c6cf09e3b7fc0cbad4be7b244d1c3e62d80b07c9204bf46eb2d6ad2507111b01d70030175ec8
-  data.tar.gz: a3657b3f2c129067ba22946691c138d5248dfd9d2b62fcb17b9bb3d3ddb56cd2a0c7d1a6d1ce9e9a66c22855b7569ccd4f38120f6636474a85591ed76796ec9a
+  metadata.gz: a265ca1e725d8075bdd17dfb67ffb2e74fccc171581255b71789f6491e9da2cdb7ee0737073d7dbe3cf02dc9e0cbc85ae9f05538e7021ef5d8eb2ffef53e4961
+  data.tar.gz: 35ba5a29c7bed14503fb81db7d791b392167630fe7f8780eb8e93277e0a4dde156d8d358abc68dfe2910eb7ee12fb4338f91d7b627ea5c86f639a2d98c56131d

data/lib/confiner/cli.rb

@@ -17,7 +17,7 @@ module Confiner
       @rules = []
 
       # default logging to standard out
-      Logger.log_to $stdout
+      Logger.log_to = $stdout
 
       if options.include?('--')
         @plugin_options = options[options.index('--')..]
@@ -65,7 +65,7 @@ module Confiner
         end
 
         opts.on('-o OUTPUT', '--output-to OUTPUT', 'File to output the log to') do |output_to|
-          log_to(output_to)
+          Logger.log_to = output_to
         end
       end
 
@@ -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,17 +4,26 @@ 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(File.open(Logger.log_to.strip, 'a+t')) if Logger.log_to.is_a?(String)
       Logger.log_to.puts(output)
     end
 
     # Where to output the log
-    def self.log_to(file = $stdout)
-      @out_file ||= file
+    def self.log_to
+      @out_file
+    end
+
+    def self.log_to=(file)
+      file = File.open(file.strip, 'a+t') if file.is_a?(String)
+
+      @out_file = file
     end
 
     def run(action)

data/lib/confiner/plugin.rb

@@ -21,8 +21,11 @@ module Confiner
             arg.each do |a, default_value|
               attr_writer a
 
+              default = default_value
+              default = ENV[default_value[1..]] if default_value[0] == '$'
+
               define_method(a) do
-                instance_variable_get("@#{a}") || instance_variable_set("@#{a}", default_value)
+                instance_variable_get("@#{a}") || instance_variable_set("@#{a}", default)
               end
             end
           else
@@ -34,6 +37,8 @@ module Confiner
 
     def initialize(**args)
       args.each do |k, v|
+        v = ENV[v[1..]] if v[0] == '$' # get environment variable
+
         self.public_send(:"#{k}=", v)
       end
     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
 
@@ -184,7 +186,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 +230,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.2'
+end

data/lib/confiner.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confiner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-03-04 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