dri 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b398cef45fa101592e0abecf4d014969e4e26dac5b5e3fd9f7f774b6108618f
-  data.tar.gz: 96a6b402d7dfcccf9fe2e69e01a4ece8af13d56be0213dc8ffa3824ea9a5ed2a
+  metadata.gz: b5791162eb6afd6c20228dc94f5c247233a1f9703743fb671df15f0cef3258c2
+  data.tar.gz: 2629b72f72f18669b362b7f904bce44a4abc63b8fa421a4dbb515c1dd17ee8cb
 SHA512:
-  metadata.gz: 9d94573de9142a648b643819381244382a65fedd7c180ae5b78013ea2738204e54e543e43ed5ad6209c2a3ae5a3af4cd1ecb2a7937afa5607b3c04435ce5a2a2
-  data.tar.gz: 48e010a476d8b1a2b48b3b74ba485e7a9c533aa17f96e4639eead23e486f2a309a8f60fed3c282a9b85ec38154cc2bb0b26fdbf28d3389981d1bf26578336b87
+  metadata.gz: 6ffc4003b8ea2cc342c88a3f457f3ea9701f9dfe0e7ca0ff7a5f54e2ec1a8ccc896dea9e16bb4ea1655d3e9d1eadadaa0ef2d01652ffb4740fb94fcc01690397
+  data.tar.gz: f302fd36aa8cc2385e6c83e6de915481b3515097be2d5e7137ea63af3ef70e7462ad2a4f64a575777cd734b1320699b01c4efd99fd60941d59b0b8b65a4b005a

data/.gitlab/merge_request_templates/Release.md

@@ -1,6 +1,6 @@
 ## Diff
-<!-- Replace `v0.9.0` with the previous DRI release, and `6a9c4fcc150741d578ec75141d3706891b6694bc` with the latest commit from https://gitlab.com/gitlab-org/quality/dri/-/commits/master that will be included in the release -->
-https://gitlab.com/gitlab-org/quality/dri/-/compare/v0.9.0...6a9c4fcc150741d578ec75141d3706891b6694bc
+<!-- Replace `v0.9.0` with the previous DRI release, and `55ddcace1c166fa2323d4e556262eba6b274230a` with the latest commit from https://gitlab.com/gitlab-org/quality/dri/-/commits/master that will be included in the release -->
+https://gitlab.com/gitlab-org/quality/dri/-/compare/v0.9.0...55ddcace1c166fa2323d4e556262eba6b274230a
 
 ## Release Notes
 

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    dri (0.9.0)
+    dri (0.10.0)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
       httparty (~> 0.21.0)
       json (~> 2.6.1)
+      launchy (~> 2.4)
       markdown-tables (~> 1.1.1)
       pastel (~> 0.8.0)
       thor (~> 1.2.0)
@@ -22,12 +23,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     amatch (0.4.1)
       mize
@@ -52,11 +53,13 @@ GEM
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     kramdown (2.4.0)
       rexml
+    launchy (2.5.2)
+      addressable (~> 2.8)
     markdown-tables (1.1.1)
     method_source (1.0.0)
     mini_mime (1.1.2)
@@ -64,8 +67,8 @@ GEM
     mize (0.4.1)
       protocol (~> 2.0)
     multi_xml (0.6.0)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
@@ -75,12 +78,12 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
-    rack (3.0.4.2)
+    rack (3.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rouge (3.30.0)
+    rouge (4.1.1)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -103,7 +106,7 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.27.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     rubocop-gitlab-security (0.1.1)
       rubocop (>= 0.51)
@@ -120,9 +123,9 @@ GEM
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.13.0)
-    ruby_parser (3.20.0)
+    ruby_parser (3.20.1)
       sexp_processor (~> 4.16)
-    sexp_processor (4.16.1)
+    sexp_processor (4.17.0)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
@@ -131,7 +134,7 @@ GEM
     sync (0.5.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
+    thor (1.2.2)
     timecop (0.9.6)
     tins (1.32.1)
       sync
@@ -147,10 +150,10 @@ GEM
     tty-font (0.5.0)
     tty-logger (0.6.0)
       pastel (~> 0.8)
-    tty-markdown (0.7.1)
+    tty-markdown (0.7.2)
       kramdown (>= 1.16.2, < 3.0)
       pastel (~> 0.8)
-      rouge (~> 3.14)
+      rouge (>= 3.14, < 5.0)
       strings (~> 0.2.0)
       tty-color (~> 0.5)
       tty-screen (~> 0.8)
@@ -191,4 +194,4 @@ DEPENDENCIES
   webmock (~> 3.5)
 
 BUNDLED WITH
-   2.4.7
+   2.4.13

data/README.md

@@ -70,6 +70,7 @@ $ dri profile
 - [7. analyze](#7-analyze)
   - stacktraces
 - [8. version](#8-version)
+- [9. faq](#8-faq)
 
 #### 1. init
 
@@ -97,6 +98,11 @@ $ 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.
 
+There is the possibility to customise the timeframe for such failures by passing a
+`--start_date=DD-MM-YYYY` and `--end_date=DD-MM-YYYY`. It is also possible to pass
+a `--cutoff=HH:MM` to just show failures after a certain period of the day. The cutoff
+time will be converted to UTC.
+
 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.
 
@@ -228,6 +234,15 @@ $ dri version
 
 `dri` gem version.
 
+#### 9. faq
+
+```shell
+$ dri faq
+```
+
+Returns a list of questions and answers related to on-call operations. This leverages
+existing pages of documentation, redirecting directly to the relevant section to help
+with a problem.
 ## Copyright
 
 Copyright (c) 2022 GitLab, Inc. See [MIT License](LICENSE.txt) for further details.

data/dri.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "gitlab", "~> 4.19"
   spec.add_dependency 'httparty', '~> 0.21.0'
   spec.add_dependency 'json', '~> 2.6.1'
+  spec.add_dependency 'launchy', '~> 2.4'
   spec.add_dependency 'markdown-tables', '~> 1.1.1'
   spec.add_dependency 'pastel', '~> 0.8.0'
   spec.add_dependency 'thor', '~> 1.2.0'

data/faq.yaml

@@ -0,0 +1,21 @@
+---
+- question: "Which pipelines we currently have and what is their running cadence?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#qa-test-pipelines"
+- question: "Where can I find the rotation schedule?"
+  link: "https://gitlab.com/gitlab-org/quality/pipeline-triage#dri-weekly-rotation-schedule"
+- question: "What is the process to quarantine a test?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#quarantining-tests"
+- question: "What is the process to dequarantine a test?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#dequarantining-tests"
+- question: "What are the failure classification labels?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#classify-and-triage-the-test-failure"
+- question: "I have a correlation ID. How to find logs from various GitLab components?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#kibana-correlation-dashboards"
+- question: "Where do I find the MR that introduced a feature flag?"
+  link: "https://samdbeckham.gitlab.io/feature-flags/#%5B%7B%22type%22:%22filtered-search-term%22,%22value%22:%7B%22data%22:%22%22%7D%7D%5D"
+- question: "What to do when a failure needs escalation?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#failure-needs-escalation"
+- question: "I have an MR to fix the failure. How I make sure it is merged as soon as possible?"
+  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#fixing-the-test"
+
+

data/lib/dri/api_client.rb

@@ -160,15 +160,24 @@ module Dri
 
     # Fetch all new failures
     #
-    # @param [String] date
+    # @param [String] start_date
+    # @param [String] end_date
     # @param [String] state
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def fetch_all_new_failures(date:, state:)
+    def fetch_all_new_failures(start_date:, end_date:, state:)
       project_ids = [GITLAB_PROJECT_ID, CUSTOMERSDOT_PROJECT_ID]
       failures = []
 
+      start_date_iso = start_date.strftime('%Y-%m-%dT00:00:00Z')
+      end_date_iso = end_date.strftime('%Y-%m-%dT23:59:59Z')
+
       project_ids.each do |project_id|
-        failures += fetch_new_failures(project_id: project_id, date: date, state: state)
+        failures += fetch_new_failures(
+          project_id: project_id,
+          start_date: start_date_iso,
+          end_date: end_date_iso,
+          state: state
+        )
       end
 
       failures
@@ -177,17 +186,20 @@ module Dri
     # Fetch new failures for a given project
     #
     # @param [Integer] project_id
-    # @param [String] date
+    # @param [String] start_date
+    # @param [String] end_date
     # @param [String] state
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def fetch_new_failures(project_id:, date:, state:)
+    def fetch_new_failures(project_id:, start_date:, end_date:, state:)
       gitlab.issues(
         project_id,
         labels: FAILURE_NEW,
-        order_by: "updated_at",
+        order_by: "created_at",
+        sort: 'desc',
         state: state,
         scope: "all",
-        created_after: date,
+        created_after: start_date,
+        created_before: end_date,
         per_page: 100
       )
     end

data/lib/dri/cli.rb

@@ -77,6 +77,23 @@ module Dri
       end
     end
 
+    desc 'faq', 'Consult frequently ask questions while on-call'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+
+    def faq(*)
+      if options[:help]
+        invoke :help, ['faq']
+      else
+        begin
+          require_relative 'commands/faq'
+          Dri::Commands::FAQ.new(options).execute
+        rescue Dri::Commands::FAQ::ExitCommand
+          puts "Exiting faq command..."
+        end
+      end
+    end
+
     require_relative 'commands/fetch'
     register Dri::Commands::Fetch, 'fetch', 'fetch [SUBCOMMAND]', 'Fetch failures & testcases'
 

data/lib/dri/command.rb

@@ -16,6 +16,10 @@ module Dri
 
     def_delegators :command, :run
 
+    def initialize(*options)
+      @options = options
+    end
+
     def pastel(**options)
       Pastel.new(**options)
     end

data/lib/dri/commands/faq.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require 'tty-prompt'
+require 'launchy'
+
+module Dri
+  module Commands
+    class FAQ < Dri::Command
+      ExitCommand = Class.new(StandardError)
+
+      def execute(input: $stdin, output: $stdout)
+        root_dir = File.expand_path('../../..', __dir__)
+        faq_file = File.join(root_dir, 'faq.yaml')
+        faq_data = YAML.load_file(faq_file)
+
+        prompt = TTY::Prompt.new
+
+        choices = faq_data.map { |entry| { name: entry['question'], value: entry['link'] } }
+
+        url = prompt.select("Select a question:", choices)
+        raise ExitCommand if url.nil? || url.strip.empty?
+
+        begin
+          Launchy.open(url)
+        rescue Launchy::Error => e
+          puts "Failed to open URL: #{e.message}"
+          raise ExitCommand
+        end
+      end
+    end
+  end
+end

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

@@ -12,17 +12,11 @@ module Dri
         include Dri::Utils::Constants::Triage::Labels
         using Refinements
 
-        SORT_BY_OPTIONS = {
-          title: 0,
-          triaged: 1,
-          environment: 2,
-          author: 3,
-          url: 4
-        }.freeze
-
         def initialize(options)
           @options = options
-          @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
+          @start_date = @options[:start_date] ? Date.parse(@options[:start_date]) : Date.today
+          @end_date = @options[:end_date] ? Date.parse(@options[:end_date]) : Date.today
+          @cutoff_time = @options[:cutoff] ? Time.parse(options[:cutoff]).utc : nil
         end
 
         def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
@@ -35,26 +29,40 @@ module Dri
           environment = add_color('Environment', :bright_yellow)
           author = add_color('Author', :bright_yellow)
           url = add_color('URL', :bright_yellow)
+          updated_at = add_color('Updated at', :bright_yellow)
 
           sorted_failures = []
-          labels = [title, triaged, environment, author, url]
+          labels = { title: title, triaged: triaged, environment: environment, author: author, url: url,
+                     updated_at: updated_at }
           triaged_counter = 0
 
-          logger.info "Fetching today's failures..."
+          if @cutoff_time
+            @start_date = Time.new(
+              @start_date.year,
+              @start_date.month,
+              @start_date.day,
+              @cutoff_time.hour,
+              @cutoff_time.min, 0,
+              "+00:00"
+            )
+          end
+
+          logger.info "Fetching failures from #{@start_date} (UTC) to #{@end_date} (UTC)..."
 
           spinner.run do # rubocop:disable Metrics/BlockLength
-            failures = api_client.fetch_all_new_failures(date: @today_iso_format, state: 'opened')
+            failures = api_client.fetch_all_new_failures(start_date: @start_date, end_date: @end_date, state: 'opened')
 
             if failures.empty?
-              logger.info 'Life is great, there are no new failures today!'
+              logger.info "Life is great, there are no new failures between #{@start_date} and #{@end_date}!"
               exit 0
             end
 
             failures.each do |failure|
               project_id = failure.project_id
               title = failure.title.truncate(60)
-              author = failure.to_h.dig('author', 'username')
+              author = failure.to_h.dig('author', 'username').truncate(25)
               url = failure.web_url
+              updated_at = failure.updated_at
               triaged = add_color('x', :red)
               envs = failure.labels.select { |l| l.include?(FOUND) }.map do |l|
                 env = l.split(':').last.gsub('.gitlab.com', '')
@@ -63,6 +71,8 @@ module Dri
               end
               urgent = urgent_environments.all? { |env| envs.include?(env) }
 
+              next if @options[:urgent] && !urgent
+
               emoji_awards = api_client.fetch_awarded_emojis(failure.iid, project_id: project_id).find do |e|
                 e.name == emoji && e.to_h.dig('user', 'username') == username
               end
@@ -72,14 +82,11 @@ module Dri
                 triaged_counter += 1
               end
 
-              if @options[:urgent]
-                sorted_failures << [title, triaged, envs.first, author, url] if urgent
-              else
-                sorted_failures << [title, triaged, envs.first, author, url]
-              end
+              sorted_failures << { title: title, triaged: triaged, environment: envs.first, author: author, url: url,
+                                   updated_at: updated_at }
             end
 
-            sorted_failures.sort_by! { |failure| failure[SORT_BY_OPTIONS[@options[:sort_by]&.to_sym || :environment]] }
+            sorted_failures.sort_by! { |failure| failure[@options[:sort_by]&.to_sym || :environment] }
           end
 
           msg = if @options[:urgent]
@@ -92,7 +99,14 @@ module Dri
                   MSG
                 end
 
-          print_table(labels, sorted_failures, alignments: [:left, :center, :center, :left])
+          terminal_width = TTY::Screen.width
+
+          if terminal_width <= 210 # adjust the desired minimum width
+            labels.delete(:updated_at)
+            sorted_failures.map { |failure| failure.delete(:updated_at) }
+          end
+
+          print_table(labels.values, sorted_failures.map(&:values), alignments: [:left, :center, :center, :left, :left])
           output.puts(msg)
         end
       end

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

@@ -120,7 +120,6 @@ module Dri
               tests_exceed_threshold?(project_id: project_id, pipeline_id: pipeline_id, ops: ops)
           else
             contains_stage?(jobs, "qa") || contains_stage?(jobs, "test")
-            # Nightly pipeline does not execute full E2E suite if sanity fails so can't check tests count
           end
         end
 
@@ -161,8 +160,6 @@ module Dri
           case pipeline_name
           when "master"
             "e2e-package-and-test"
-          when "nightly"
-            pipeline_name
           when "pre_prod"
             "preprod-#{run_type(sanity)}"
           else

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

@@ -14,7 +14,6 @@ module Dri
             main
             canary
             master
-            nightly
             production
             staging-canary
             staging-ref

data/lib/dri/commands/fetch.rb

@@ -45,13 +45,20 @@ module Dri
         end
       end
 
-      desc 'failures', 'Display failures opened today'
+      desc 'failures', 'Display failures opened on a given period.'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'
       method_option :urgent, type: :boolean,
                              desc: 'Shows failures that quickly escalated'
       method_option :sort_by, type: :string,
                               desc: 'Shows failures in specified order'
+      method_option :start_date, type: :string,
+                                 desc: 'Fetch failures created after this date (YYYY-MM-DD)'
+      method_option :end_date, type: :string,
+                               desc: 'Fetch failures created before this date (YYYY-MM-DD)'
+      method_option :cutoff, type: :string,
+                             desc: 'Fetch failures created after this time (HH:MM)'
+
       def failures(*)
         if options[:help]
           invoke :help, ['failures']

data/lib/dri/commands/profile.rb

@@ -20,10 +20,12 @@ module Dri
         logger.info "🔎 Looking for profiles...\n"
 
         if config.exist?
+          width = handover_report_path.nil? ? 30 : 75
+
           frame_args = {
-            width: 30,
+            width: width,
             height: 10,
-            align: :center,
+            align: :left,
             padding: 1,
             border: :thick,
             title: { top_left: add_color('PROFILE:', :bright_cyan) }
@@ -37,10 +39,13 @@ module Dri
 
       def pretty_print_profile
         <<~PROFILE
-          #{add_color('User:', :bright_cyan)} #{username}\n #{add_color('Token:', :bright_cyan)} #{token}
+          #{add_color('User:', :bright_cyan)} #{username} 
+          #{add_color('Token:', :bright_cyan)} #{token}
           #{add_color('OpsToken:', :bright_cyan)} #{ops_token}
           #{add_color('Timezone:', :bright_cyan)} #{timezone}
           #{add_color('Emoji:', :bright_cyan)} #{emoji}
+          #{add_color('Report Path:', :bright_cyan)} #{handover_report_path}
+          
         PROFILE
       end
     end

data/lib/dri/report.rb

@@ -83,7 +83,6 @@ module Dri
         'canary.staging.gitlab.com' => '/quality/staging-canary',
         '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',

data/lib/dri/utils/constants.rb

@@ -63,12 +63,6 @@ module Dri
             project_id: "547",
             search_hours_ago: 12
           },
-          nightly: {
-            name: "nightly",
-            url: "https://gitlab.com/gitlab-org/quality/nightly",
-            project_id: "7523614",
-            search_hours_ago: 24
-          },
           pre_prod: {
             name: "pre.gitlab.com",
             url: "https://ops.gitlab.net/gitlab-org/quality/preprod",
@@ -85,7 +79,7 @@ module Dri
             name: "master",
             url: "https://gitlab.com/gitlab-org/gitlab",
             project_id: "278964",
-            search_hours_ago: 3
+            search_hours_ago: 24
           }
         }.freeze
     end

data/lib/dri/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dri
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: markdown-tables
   requirement: !ruby/object:Gem::Requirement
@@ -343,12 +357,14 @@ files:
 - bin/setup
 - dri.gemspec
 - exe/dri
+- faq.yaml
 - lib/dri.rb
 - lib/dri/api_client.rb
 - lib/dri/cli.rb
 - lib/dri/command.rb
 - lib/dri/commands/analyze.rb
 - lib/dri/commands/analyze/stack_traces.rb
+- lib/dri/commands/faq.rb
 - lib/dri/commands/fetch.rb
 - lib/dri/commands/fetch/failures.rb
 - lib/dri/commands/fetch/featureflags.rb