dri 0.1.2 → 0.3.0

data/lib/dri/commands/publish/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../command'
 require_relative '../../utils/markdown_lists'
 require_relative "../../report"
@@ -17,14 +19,14 @@ module Dri
           @time = Time.now.to_i
         end
 
-        def execute(input: $stdin, output: $stdout)
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
           verify_config_exists
           report = Dri::Report.new(config)
 
           logger.info "Fetching triaged failures with award emoji #{emoji}..."
 
           spinner.start
-          issues = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened') 
+          issues = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
           spinner.stop
 
           if issues.empty?
@@ -33,25 +35,46 @@ module Dri
           end
 
           logger.info "Assembling the report... "
-          # sets each failure on the table 
-          action_options = ["pinged SET", "reproduced", "transient", "quarantined"]
+          # sets each failure on the table
+          action_options = [
+            "pinged SET",
+            "reproduced",
+            "transient",
+            "quarantined",
+            "active investigation",
+            "blocking pipelines",
+            "awaiting for a fix to merge",
+            "notified the team",
+            "due to feature flag"
+          ]
 
           spinner.start
           issues.each do |issue|
             actions = []
 
             if @options[:actions]
-              actions = prompt.multi_select("Please mark the actions on #{add_color(issue['title'], :yellow)}: ", action_options)
+              actions = prompt.multi_select(
+                "Please mark the actions on #{add_color(issue['title'], :yellow)}: ",
+                action_options,
+                per_page: 9
+              )
             end
+
             report.add_failure(issue, actions)
           end
 
           if @options[:format] == 'list'
             # generates markdown list with failures
             format_style = Utils::MarkdownLists.make_list(report.labels, report.failures) unless report.failures.empty?
-          else 
+          else
             # generates markdown table with rows as failures
-            format_style = MarkdownTables.make_table(report.labels, report.failures, is_rows: true, align: %w[c l c l l]) unless report.failures.empty?
+            unless report.failures.empty?
+              format_style = MarkdownTables.make_table(
+                report.labels,
+                report.failures,
+                is_rows: true, align: %w[l l l l l]
+              )
+            end
           end
 
           report.set_header(timezone, username)
@@ -71,7 +94,7 @@ module Dri
             File.open(report_path, 'a') do |out_file|
               out_file.puts note
             end
-          
+
             spinner.stop
 
             output.puts "Done! ✅\n"
@@ -82,10 +105,13 @@ module Dri
           # sends note to the weekly triage report
           issues = api_client.fetch_current_triage_issue
           current_issue_iid = issues[0]["iid"]
-          response = api_client.post_triage_report_note(iid: current_issue_iid, body: note)
+
+          api_client.post_triage_report_note(iid: current_issue_iid, body: note)
 
           output.puts "Done! ✅\n"
-          logger.success "Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues/#{current_issue_iid} 🎉"
+          logger.success(<<~MSG)
+            Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues/#{current_issue_iid} 🎉
+          MSG
         end
       end
     end

data/lib/dri/commands/publish.rb

@@ -5,16 +5,15 @@ require 'thor'
 module Dri
   module Commands
     class Publish < Thor
-
       namespace :publish
 
       desc 'report', 'Generate a report'
       method_option :dry_run, type: :boolean,
-                           desc: 'Generates a report locally'
-      method_option :format, aliases: '-f', type: :string, :default => "table",
-                           desc: 'Formats the report'
+                              desc: 'Generates a report locally'
+      method_option :format, aliases: '-f', type: :string, default: "table",
+                             desc: 'Formats the report'
       method_option :actions, type: :boolean,
-                           desc: 'Updates actions on failures'
+                              desc: 'Updates actions on failures'
       def report(*)
         if options[:help]
           invoke :help, ['report']

data/lib/dri/commands/rm/emoji.rb

@@ -10,9 +10,9 @@ module Dri
           @options = options
         end
 
-        def execute(input: $stdin, output: $stdout)
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
           verify_config_exists
-          
+
           remove = prompt.yes? "Are you sure you want to remove all #{emoji} award emojis from issues?"
 
           unless remove
@@ -29,7 +29,7 @@ module Dri
           spinner.stop
 
           issues_with_award_emoji.each do |issue|
-            logger.info "Removing #{emoji} from #{issue["web_url"]}..."
+            logger.info "Removing #{emoji} from #{issue['web_url']}..."
 
             award_emoji_url = issue["_links"]["award_emoji"]
 
@@ -37,8 +37,8 @@ module Dri
 
             emoji_found = response.find { |e| e['name'] == emoji && e['user']['username'] == username }
 
-            if !emoji_found.nil?
-              url = "#{award_emoji_url}/#{emoji_found["id"]}"
+            unless emoji_found.nil?
+              url = "#{award_emoji_url}/#{emoji_found['id']}"
               api_client.delete_award_emoji(url)
             end
           end

data/lib/dri/commands/rm/profile.rb

@@ -13,7 +13,7 @@ module Dri
 
         def execute(input: $stdin, output: $stdout)
           verify_config_exists
-          
+
           remove = prompt.yes? "Are you sure you want to remove existing profile?"
 
           unless remove
@@ -22,7 +22,7 @@ module Dri
           end
 
           logger.info "Removing profile..."
-          
+
           FileUtils.rm("#{Dir.pwd}/.dri_profile.yml")
 
           logger.success "Done ✅"

data/lib/dri/commands/rm.rb

@@ -5,7 +5,6 @@ require 'thor'
 module Dri
   module Commands
     class Rm < Thor
-
       namespace :rm
 
       desc 'profile', 'Command description...'

data/lib/dri/refinements/truncate.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Refinements
+  refine String do
+    # Truncate string to limit of _n_ characters
+    # @param [Integer] limit the limit of characters
+    # @return [String] the resulting string after truncation
+    def truncate(limit = 50)
+      return freeze if size <= limit
+
+      # limit - 3 for the ellipses
+      self[0...(limit - 3)] << '...'
+    end
+  end
+end

data/lib/dri/report.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Dri
-  class Report
+  class Report # rubocop:disable Metrics/ClassLength
     attr_reader :header, :failures, :labels
 
     def initialize(config)
       @labels = ['Title', 'Issue', 'Pipelines', 'Stack Trace', 'Actions']
       @failures = []
       @date = Date.today
-      @today = Date.today.strftime("%Y-%m-%d") 
+      @today = Date.today.strftime("%Y-%m-%d")
       @weekday = Date.today.strftime("%A")
       @header = nil
 
@@ -19,20 +21,24 @@ module Dri
 
     def add_failure(failure, actions_opts = [])
       iid = failure["iid"]
-      title = failure["title"]
+      title = format_title(failure["title"])
       link = failure["web_url"]
       labels = failure["labels"]
       created_at = failure["created_at"]
       assignees = failure["assignees"]
-      award_emoji_url = failure["_links"]["award_emoji"]
       description = failure["description"]
 
       related_mrs = @api_client.fetch_related_mrs(issue_iid: iid)
       emoji = classify_failure_emoji(created_at)
       emojified_link = "#{emoji} #{link}"
-   
-      stack_blob = description.empty? ? "No stack trace found" : description.split("### Stack trace").last.gsub(/\n|`|!|\[|\]/, '').squeeze(" ")[0...250]
-      stack_trace = ":link:[`#{stack_blob}...`](#{link + '#stack-trace'})"
+
+      stack_blob = if description.empty?
+                     "No stack trace found"
+                   else
+                     description.split("### Stack trace").last.gsub(/\n|`|!|\[|\]/, '').squeeze(" ")[0...250]
+                   end
+
+      stack_trace = ":link:[`#{stack_blob}...`](#{link}#stack-trace)"
 
       failure_type = filter_failure_type_labels(labels)
       assigned_status = assigned?(assignees)
@@ -40,21 +46,20 @@ module Dri
 
       linked_pipelines = link_pipelines(iid, pipelines, description)
 
-      actions = ""
-      actions.concat actions_status_template(failure_type, assigned_status, actions_opts)
-      actions.concat actions_fixes_template(related_mrs)
+      actions_status = actions_status_template(failure_type, assigned_status, actions_opts)
+      actions_fixes = actions_fixes_template(related_mrs)
 
-      @failures << [title, emojified_link, linked_pipelines, stack_trace, actions]
+      @failures << [title, emojified_link, linked_pipelines, stack_trace, "#{actions_status}#{actions_fixes}"]
     end
 
     private
 
-    def link_pipelines(iid, pipelines, description)
+    def link_pipelines(iid, pipelines, description) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
       linked = []
       label_pipeline_map = {
         'gitlab.com' => '/quality/production',
         'canary.gitlab.com' => '/quality/canary',
-       # 'canary.staging.gitlab.com' => '',
+        'canary.staging.gitlab.com' => '/quality/staging-canary',
         'main' => '/gitlab-org/gitlab-qa-mirror',
         'master' => '/gitlab-org/gitlab-qa-mirror',
         'nightly' => '/quality/nightly',
@@ -66,79 +71,91 @@ module Dri
 
       failure_notes = @api_client.fetch_failure_notes(issue_iid: iid)
 
-      return if pipelines.empty? 
-              
+      return if pipelines.empty?
+
       pipelines.each do |pipeline|
-        next if !label_pipeline_map.has_key? pipeline
+        next unless label_pipeline_map.has_key?(pipeline)
 
         pipeline_in_notes_found = false
         pipeline_link = ''
-        pipeline_link_sanitized = ''
-        pipeline_markdown = ''
+        pipeline_markdown = pipeline.gsub(/.gitlab.com/, '')
 
         failure_notes.each do |note|
-          if note["body"].include? label_pipeline_map.fetch(pipeline)
-            pipeline_in_notes_found = true
-            pipeline_link = URI.extract(note["body"], %w(https))
-            break
-          end
+          next unless note["body"].include?(label_pipeline_map.fetch(pipeline))
+
+          pipeline_in_notes_found = true
+          pipeline_link = URI.extract(note["body"], %w[https])
         end
-          
+
         unless pipeline_in_notes_found
-          links_description = URI.extract(description, %w(https))
-          pipeline_link = links_description.select { |link| link.include? label_pipeline_map.fetch(pipeline) } 
+          links_description = URI.extract(description, %w[https])
+          pipeline_link = links_description.select { |link| link.include? label_pipeline_map.fetch(pipeline) }
         end
 
-        if !pipeline_link.empty?
+        unless pipeline_link.empty?
           pipeline_link_sanitized = pipeline_link.join.strip.chop
-          pipeline_markdown = "[#{pipeline.gsub(/.gitlab.com/, '')}](#{pipeline_link_sanitized})"
-          linked << pipeline_markdown
+          pipeline_markdown = "[#{pipeline_markdown}](#{pipeline_link_sanitized})"
         end
+
+        linked << pipeline_markdown
       end
       linked.join(', ')
     end
 
-    def actions_status_template(failure_type, assigned_status, actions_opts)
-      notified_set = ''
+    def actions_status_template(failure_type, assigned_status, actions_opts) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity/MethodLength
       quarantined = ''
       reproduced = ''
       transient = ''
+      active_investigation = ''
+      blocking_pipelines = ''
+      wait_for_fix = ''
+      notified_team = ''
+      feature_flag = ''
 
       notified_set = '<li>[x] notified SET</li>' if actions_opts.include? 'pinged SET'
       quarantined = '<li>[x] quarantined</li>' if actions_opts.include? 'quarantined'
       reproduced = '<li>[x] reproduced</li>' if actions_opts.include? 'reproduced'
       transient = '<li>[x] transient</li>' if actions_opts.include? 'transient'
+      active_investigation = '<li>[x] active investigation</li>' if actions_opts.include? 'active investigation'
+      blocking_pipelines = '<li>[x] is blocking pipelines</li>' if actions_opts.include? 'blocking pipelines'
+      wait_for_fix = '<li>[x] waiting for fix to merge</li>' if actions_opts.include? 'awaiting for a fix to merge'
+      notified_team = '<li>[x] notified the team</li>' if actions_opts.include? 'notified the team'
+      feature_flag = '<li>[x] due to feature flag</li>' if actions_opts.include? 'due to feature flag'
 
-      action_status = "<i>Status:</i><ul>"
+      action_status = ["<i>Status:</i><ul>"]
       action_status << "<li>#{failure_type}</li>"
       action_status << "</li><li>#{assigned_status}</li>"
       action_status << notified_set
       action_status << quarantined
       action_status << reproduced
       action_status << transient
+      action_status << active_investigation
+      action_status << blocking_pipelines
+      action_status << wait_for_fix
+      action_status << notified_team
+      action_status << feature_flag
 
-      action_status
+      action_status.join
     end
 
     def actions_fixes_template(related_mrs)
-      actions_fixes_template = '<ul><i>Potential fixes:</i><br>'
-      related_mrs.each do |mr|
-        actions_fixes_template.concat "<li>[#{mr["title"]}](#{mr["web_url"]})</li>"
+      mrs = related_mrs.each_with_object(['<i>Potential fixes:</i><br>']) do |mr, fixes|
+        fixes << "<li>[#{mr['title'].truncate(40)}](#{mr['web_url']})</li>"
       end
-      actions_fixes_template.concat '</ul>'
-      actions_fixes_template
+
+      "<ul>#{mrs.join}</ul>"
     end
 
     def assigned?(assignees)
-      assignees.empty? ?  'Assigned :x:' : 'Assigned :white_check_mark:'
+      assignees.empty? ? 'Assigned :x:' : 'Assigned :white_check_mark:'
     end
 
     def filter_pipeline_labels(labels)
       pipelines = []
 
       labels.each do |label|
-        matchers = { 'found:' => ' '}
-  
+        matchers = { 'found:' => ' ' }
+
         if label.include? "found:"
           pipeline = label.gsub(/found:/) { |match| matchers[match] }
           pipelines << pipeline.strip
@@ -161,8 +178,20 @@ module Dri
       if created_at.include? @today
         new_failure_emoji
       else
-       known_failure_emoji
+        known_failure_emoji
       end
     end
+
+    # Turns something like:
+    #    Failure in browser_ui/3_create/merge_request/create_merge_request_spec.rb | Create a merge request
+    # into
+    #    Failure&nbsp;in&nbsp;`browser_ui/3_create/merge_request/create_merge_request_spec.rb` | Create a merge request
+    def format_title(title)
+      path, desc = title.split('|')
+      path = "Failure in `#{path.strip}`" if path.delete_prefix!('Failure in ')
+      path = path.strip.gsub(' ', '&nbsp;') if desc
+
+      "#{path} | #{desc}"
+    end
   end
-end
+end

data/lib/dri/templates/incidents/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/dri/utils/markdown_lists.rb

@@ -1,20 +1,18 @@
+# frozen_string_literal: true
 
 module Dri
   module Utils
     class MarkdownLists
       def self.make_list(labels, items)
-        @list = ""
-
-        @list.concat "<ul>"
-        items.each do |item|          
+        list = items.each_with_object([]) do |item, arr|
           item.zip(labels).each do |element, label|
-            @list.concat "<li><b>#{label}</b>:<br> #{element}</li>"
+            arr << "<li><b>#{label}</b>:<br> #{element}</li>"
           end
-          @list.concat "<hr>" 
+          arr << "<hr>"
         end
-        @list.concat "</ul>"
+
+        "<ul>#{list.join}</ul>"
       end
-      @list
     end
   end
-end
+end

data/lib/dri/utils/table.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'tty-table'
+
+module Dri
+  module Utils
+    module Table
+      def print_table(headers, rows, alignments: [])
+        if alignments.empty?
+          (1..headers.size).each do
+            alignments.push(:center)
+          end
+        end
+
+        table = TTY::Table.new(headers, rows)
+        puts table.render(:ascii, resize: true, multiline: true, alignments: alignments)
+      end
+    end
+  end
+end

data/lib/dri/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dri
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/lib/dri.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "dri/version"
 
 module Dri