dri 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb31c263acfb2d576ed72028d207df2d36d76b1965ac00aa5228fbdd991a7524
-  data.tar.gz: 179c9389a9b3ce00a9f4ff357da3d1f4fdf3af9b22ec96a8d582dfb7d35bf17a
+  metadata.gz: e352230c90233014a517cb67addf17a051a2b2eb05c93f0e88bcaab45c40e723
+  data.tar.gz: 51bbd9e7f07e20668fa8b6161e41b3995ae47b8d1866be6ad81fd07fc0c37bf1
 SHA512:
-  metadata.gz: d38a554fad6c98a72992c2d5c97eae39f6ecebce78ff466174f20074a4aa74b436ee6fcff6192ad4800515056fd9e53ec049a5aa1f6dfa90fdcafa2489376256
-  data.tar.gz: 2f2994a17800bd2d1fbf02ed9724e9b0428e4ded12ae9516135d19a6b529982d3e36d2148e6ef9df4f6bc740355555831ed035b440d30d89f94fdf814e3a1a99
+  metadata.gz: 00b8bcfe9d1d884523f2f5d3963cfa8ab3b7f33f04f819fd17b253838bf899d67394de91524d3dfa40ff692b48c5768f039dc8b6ed44abbcd5faa14b1606eb60
+  data.tar.gz: 58a9c606cd89a5282f25b9fe89fcf16bcf9c70d53df868876884d10149e34786de5c3341d216dd227bbb3d44e16649e26032117c1f12e33e61de52168fd54ebe

data/README.md

@@ -7,9 +7,9 @@ Welcome to your new gem! DRI is a CLI ready to help:
 - Fetching failing test cases by pipeline
 - Reporting at the end of the timezone shift
 - View today's newest and untriaged failures
-- Take actions on failures
+- Mark actions on failures
 
-... and more.
+... and more
 
 ## Installation
 
@@ -55,10 +55,13 @@ $ dri profile
 - [3. fetch](#3-fetch)
   - failures
   - testcases
+  - triaged
 - [4. publish](#4-publish)
   - report
 - [5. rm](#5-rm)
   - emoji
+  - profile
+  - reports
 - [6. version](#6-version)
 
 #### 1. init
@@ -87,6 +90,9 @@ $ dri fetch failures
 Fetches today's opened failures and lists them according to their triage status.
 Helpful to understand if there are missing recent failures to be reviewed.
 
+To surface most urgent issues pass the `--urgent` flag to see issues that are both
+in `canary` and `staging-canary` pipelines just during today's timespan.
+
 ```shell
 $ dri fetch testcases
 ```
@@ -95,6 +101,12 @@ Fetches test cases that failing currently and groups them by pipeline.
 To filter the pipelines, pass the `--filter-pipelines` options to multi-select the pipelines you wish to consult.
 (Use `Space` to select an option)
 
+```shell
+$ dri fetch triaged
+```
+
+Fetches triaged failures which use the triage emoji specified in `dri profile`.
+
 #### 4. publish
 
 ```shell
@@ -109,8 +121,22 @@ Publishes a handover report on the latest triage issue, in the [pipeline-triage]
 $ dri publish report --format=list # formats the report in a list
 $ dri publish report --format=table # formats the report in a table (default)
 $ dri publish report --dry-run # the report is only generated locally
+$ dri publish report --actions # activate the actions prompt for each failure
 ```
 
+**Note:** These options above can be combined like:
+
+```shell
+$ dri publish report --format=list --dry-run --actions
+```
+
+**Actions**
+
+When using `--actions` a set of actions are prompt on each failure. Use `Space` to
+mark several actions: `pinged SET`, `quarantined`, `reproduced`, `transient`.
+Hitting `Enter` without a selected action will skip marking the actions for a given
+failure.
+
 #### 5. rm
 
 ```shell
@@ -119,6 +145,20 @@ $ dri rm emoji
 
 Removes the triage emoji from all triaged issues.
 
+```shell
+$ dri rm reports
+```
+
+When using `$ dri publish report --dry-run` to download the reports locally instead
+of uploading to the latest Pipeline Triage Issue, an `/handover_reports/` folder
+created to store these reports. This command removes this folder and subsequent reports stored in it.
+
+```shell
+$ dri rm profile
+```
+
+Removes the profile currently in use.
+
 #### 6. version
 
 ```shell

data/lib/dri/api_client.rb

@@ -9,7 +9,7 @@ module Dri
     
     API_URL              = 'https://gitlab.com/api/v4'
     TESTCASES_PROJECT_ID = '11229385'
-    TRIAGE_PROJECT_ID    = '34185524'
+    TRIAGE_PROJECT_ID    = '15291320'
     GITLAB_PROJECT_ID    = '278964'
 
     def initialize(config)

data/lib/dri/commands/fetch/failures.rb

@@ -22,6 +22,7 @@ module Dri
           url = add_color('URL', :bright_yellow)
 
           failures = []
+          urgent = []
           labels = [ title, triaged, author, url ]
           triaged_counter = 0
 
@@ -49,13 +50,29 @@ module Dri
                 e['name'] == emoji && e['user']['username'] == @username 
               end
 
+              if @options[:urgent]
+                labels = failure["labels"]
+
+                labels.each do |label|
+                  if label.include? ("found:canary.gitlab.com" && "found:canary.staging.gitlab.com")
+                    urgent << [title, triaged, author, url]
+                  end
+                end
+              end
+
               failures << [title, triaged, author, url]
             end
           end
 
-          table = TTY::Table.new(labels, failures)
-          puts table.render(:ascii, resize: true, alignments: [:center, :center, :center, :center])
-          output.puts "\nFound: #{failures.size} failures, of these #{triaged_counter} have been triaged with a #{emoji}."
+          if @options[:urgent]
+            table = TTY::Table.new(labels, urgent)
+            puts table.render(:ascii, resize: true, alignments: [:center, :center, :center, :center])
+            output.puts "\nFound: #{urgent.size} urgent failures, found in both canary.gitlab.com and canary.staging.gitlab.com."
+          else
+            table = TTY::Table.new(labels, failures)
+            puts table.render(:ascii, resize: true, alignments: [:center, :center, :center, :center])
+            output.puts "\nFound: #{failures.size} failures, of these #{triaged_counter} have been triaged with a #{emoji}."
+          end
         end
          
         private

data/lib/dri/commands/fetch/triaged.rb

@@ -0,0 +1,61 @@
+require_relative '../../command'
+require 'tty-table'
+
+module Dri
+  module Commands
+    class Fetch
+      class Triaged < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          verify_config_exists
+
+          title = add_color('Title', :bright_yellow)
+          url = add_color('URL', :bright_yellow)
+          type_label = add_color('Type', :bright_yellow)
+
+          table_labels = [ title, url, type_label ]
+          failures_triaged = []
+
+          logger.info "Fetching your triaged failures..."
+          spinner.start 
+
+          response = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+
+          if response.empty?
+            logger.info "There are no failures triaged yet with #{add_color(emoji, :black, :on_white)}."
+            exit 0
+          end
+
+          response.each do |triaged|
+            title = truncate(triaged["title"], 90)
+            url = triaged["web_url"]
+            labels = triaged["labels"]
+            type = ""
+
+            labels.each do |label|
+              type = label.gsub!('failure::', ' ').to_s if label.include? "failure::"
+            end
+
+            labels = triaged["labels"]
+  
+            failures_triaged << [title, url, type]
+          end
+
+          spinner.stop
+
+          table = TTY::Table.new(table_labels,failures_triaged)
+          puts table.render(:ascii, resize: true, alignments: [:center, :center, :center])
+        end
+
+        private
+
+        def truncate(string, max)
+          string.length > max ? "#{string[0...max]}..." : string
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/fetch.rb

@@ -7,6 +7,18 @@ module Dri
     class Fetch < Thor
       namespace :fetch
 
+      desc 'triaged', 'Command description...'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def triaged(*)
+        if options[:help]
+          invoke :help, ['triaged']
+        else
+          require_relative 'fetch/triaged'
+          Dri::Commands::Fetch::Triaged.new(options).execute
+        end
+      end
+
       desc 'testcases', 'Display failing testcases'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'
@@ -24,6 +36,8 @@ module Dri
       desc 'failures', 'Display failures opened today'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'
+      method_option :urgent, type: :boolean,
+                           desc: 'Shows failures that quickly escalated'
       def failures(*)
         if options[:help]
           invoke :help, ['failures']

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

@@ -34,9 +34,16 @@ module Dri
 
           logger.info "Assembling the report... "
           # sets each failure on the table 
+          action_options = ["pinged SET", "reproduced", "transient", "quarantined"]
+
           spinner.start
           issues.each do |issue|
-            report.add_failure(issue)
+            actions = []
+
+            if @options[:actions]
+              actions = prompt.multi_select("Please mark the actions on #{add_color(issue['title'], :yellow)}: ", action_options)
+            end
+            report.add_failure(issue, actions)
           end
 
           if @options[:format] == 'list'
@@ -78,7 +85,7 @@ module Dri
           response = 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/dri/-/issues/#{current_issue_iid} 🎉"
+          logger.success "Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues/#{current_issue_iid} 🎉"
         end
       end
     end

data/lib/dri/commands/publish.rb

@@ -13,6 +13,8 @@ module Dri
                            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'
       def report(*)
         if options[:help]
           invoke :help, ['report']

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require 'fileutils'
+
+module Dri
+  module Commands
+    class Rm
+      class Profile < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          verify_config_exists
+          
+          remove = prompt.yes? "Are you sure you want to remove existing profile?"
+
+          unless remove
+            logger.info "Profile kept in place 👍"
+            exit 0
+          end
+
+          logger.info "Removing profile..."
+          
+          FileUtils.rm("#{Dir.pwd}/.dri_profile.yml")
+
+          logger.success "Done ✅"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require 'fileutils'
+
+module Dri
+  module Commands
+    class Rm
+      class Reports < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          FileUtils.rm_rf("#{Dir.pwd}/handover_reports")
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/rm.rb

@@ -8,6 +8,30 @@ module Dri
 
       namespace :rm
 
+      desc 'profile', 'Command description...'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def profile(*)
+        if options[:help]
+          invoke :help, ['profile']
+        else
+          require_relative 'rm/profile'
+          Dri::Commands::Rm::Profile.new(options).execute
+        end
+      end
+
+      desc 'reports', 'Command description...'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def reports(*)
+        if options[:help]
+          invoke :help, ['reports']
+        else
+          require_relative 'rm/reports'
+          Dri::Commands::Rm::Reports.new(options).execute
+        end
+      end
+
       desc 'emoji', 'Remove triage emoji from all failures'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'

data/lib/dri/report.rb

@@ -17,7 +17,7 @@ module Dri
       @header = "# #{timezone}, #{@weekday} - #{@date}\n posted by: @#{username}"
     end
 
-    def add_failure(failure)
+    def add_failure(failure, actions_opts = [])
       iid = failure["iid"]
       title = failure["title"]
       link = failure["web_url"]
@@ -38,10 +38,10 @@ module Dri
       assigned_status = assigned?(assignees)
       pipelines = filter_pipeline_labels(labels)
 
-      linked_pipelines = link_pipelines(iid, pipelines)
+      linked_pipelines = link_pipelines(iid, pipelines, description)
 
       actions = ""
-      actions.concat actions_status_template(failure_type, assigned_status)
+      actions.concat actions_status_template(failure_type, assigned_status, actions_opts)
       actions.concat actions_fixes_template(related_mrs)
 
       @failures << [title, emojified_link, linked_pipelines, stack_trace, actions]
@@ -49,28 +49,75 @@ module Dri
 
     private
 
-    def link_pipelines(iid, pipelines)
+    def link_pipelines(iid, pipelines, description)
+      linked = []
+      label_pipeline_map = {
+        'gitlab.com' => '/quality/production',
+        'canary.gitlab.com' => '/quality/canary',
+       # 'canary.staging.gitlab.com' => '',
+        'main' => '/gitlab-org/gitlab-qa-mirror',
+        'master' => '/gitlab-org/gitlab-qa-mirror',
+        'nightly' => '/quality/nightly',
+        'pre.gitlab.com' => '/quality/preprod',
+        'staging-ref' => '/quality/staging-ref',
+        'staging.gitlab.com' => '/quality/staging',
+        'release' => '/quality/release'
+      }
+
       failure_notes = @api_client.fetch_failure_notes(issue_iid: iid)
 
-      linked = ""
+      return if pipelines.empty? 
               
       pipelines.each do |pipeline|
-          failure_notes.each do |note|
-            if note["body"].include? pipeline
-              pipeline_link = URI.extract(note["body"], %w(https))
-              pipeline_link_sanitized = pipeline_link.join.strip
-              pipeline = "[#{pipeline}](#{pipeline_link_sanitized})"
-              break
-            end
+        next if !label_pipeline_map.has_key? pipeline
+
+        pipeline_in_notes_found = false
+        pipeline_link = ''
+        pipeline_link_sanitized = ''
+        pipeline_markdown = ''
+
+        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
+        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) } 
+        end
 
-          linked << pipeline
+        if !pipeline_link.empty?
+          pipeline_link_sanitized = pipeline_link.join.strip.chop
+          pipeline_markdown = "[#{pipeline.gsub(/.gitlab.com/, '')}](#{pipeline_link_sanitized})"
+          linked << pipeline_markdown
+        end
       end
-      linked
+      linked.join(', ')
     end
 
-    def actions_status_template(failure_type, assigned_status)
-      "<i>Status:</i><ul><li>#{failure_type}</li><li>#{assigned_status}</li><li>[ ] notified SET</li><li>[ ] quarantined</li></ul>"
+    def actions_status_template(failure_type, assigned_status, actions_opts)
+      notified_set = ''
+      quarantined = ''
+      reproduced = ''
+      transient = ''
+
+      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'
+
+      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
     end
 
     def actions_fixes_template(related_mrs)
@@ -90,10 +137,10 @@ module Dri
       pipelines = []
 
       labels.each do |label|
-        matchers = { 'found:' => ' ', '.gitlab.com' => ' ' }
+        matchers = { 'found:' => ' '}
   
         if label.include? "found:"
-          pipeline = label.gsub(/found:|.gitlab.com/) { |match| matchers[match] }
+          pipeline = label.gsub(/found:/) { |match| matchers[match] }
           pipelines << pipeline.strip
         end
       end

data/lib/dri/version.rb

@@ -1,3 +1,3 @@
 module Dri
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-config
@@ -276,12 +276,15 @@ files:
 - lib/dri/commands/fetch.rb
 - lib/dri/commands/fetch/failures.rb
 - lib/dri/commands/fetch/testcases.rb
+- lib/dri/commands/fetch/triaged.rb
 - lib/dri/commands/init.rb
 - lib/dri/commands/profile.rb
 - lib/dri/commands/publish.rb
 - lib/dri/commands/publish/report.rb
 - lib/dri/commands/rm.rb
 - lib/dri/commands/rm/emoji.rb
+- lib/dri/commands/rm/profile.rb
+- lib/dri/commands/rm/reports.rb
 - lib/dri/report.rb
 - lib/dri/utils/markdown_lists.rb
 - lib/dri/version.rb