dri 0.10.2 → 1.1.0

data/lib/dri/commands/fetch.rb

@@ -14,7 +14,6 @@ module Dri
         if options[:help]
           invoke :help, ['featureflags']
         else
-          require_relative 'fetch/featureflags'
           Dri::Commands::Fetch::FeatureFlags.new(options).execute
         end
       end
@@ -26,7 +25,6 @@ module Dri
         if options[:help]
           invoke :help, ['triaged']
         else
-          require_relative 'fetch/triaged'
           Dri::Commands::Fetch::Triaged.new(options).execute
         end
       end
@@ -40,7 +38,6 @@ module Dri
         if options[:help]
           invoke :help, ['testcases']
         else
-          require_relative 'fetch/testcases'
           Dri::Commands::Fetch::Testcases.new(options).execute
         end
       end
@@ -48,8 +45,6 @@ module Dri
       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,
@@ -63,33 +58,10 @@ module Dri
         if options[:help]
           invoke :help, ['failures']
         else
-          require_relative 'fetch/failures'
           Dri::Commands::Fetch::Failures.new(options).execute
         end
       end
 
-      desc 'quarantines', 'Display open quarantine MRs'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      def quarantines(*)
-        if options[:help]
-          invoke :help, ['quarantines']
-        else
-          require_relative 'fetch/quarantines'
-          Dri::Commands::Fetch::Quarantines.new(options, search: '[QUARANTINE]').execute
-        end
-      end
-
-      desc 'dequarantines', 'Display open dequarantine MRs'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
-      def dequarantines(*)
-        return invoke :help, %w[quarantines] if options[:help]
-
-        require_relative 'fetch/quarantines'
-        Dri::Commands::Fetch::Quarantines.new(options, search: '[DEQUARANTINE]').execute
-      end
-
       desc 'pipelines', 'Display status of pipelines'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display pipelines usage information'
@@ -98,7 +70,6 @@ module Dri
       def pipelines(*)
         return invoke :help, %w[pipelines] if options[:help]
 
-        require_relative 'fetch/pipelines'
         Dri::Commands::Fetch::Pipelines.new(options).execute
       end
 
@@ -109,7 +80,6 @@ module Dri
       def runbooks(*args)
         return invoke :help, %w[runbooks] if options[:help]
 
-        require_relative 'fetch/runbooks'
         Dri::Commands::Fetch::Runbooks.new(options).execute(folder: args.first)
       end
     end

data/lib/dri/commands/incidents.rb

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-require_relative '../utils/table'
-require_relative '../utils/constants'
-
 module Dri
   module Commands
     class Incidents < Dri::Command
       include Dri::Utils::Table
       include Dri::Utils::Constants::Triage::Labels
-      using Refinements
+      using Refinements::String
 
       def initialize(options)
         @options = options
       end
 
-      def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
+      def execute(_input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
         verify_config_exists
 
         incident = add_color('Incident', :bright_yellow)

data/lib/dri/commands/init.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-
 require "tty-font"
 
 module Dri
@@ -14,7 +12,7 @@ module Dri
         puts pastel.yellow(font.write("DRI"))
       end
 
-      def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
+      def execute(_input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
         output.puts "🤖 Welcome to DRI 🤖\n"
 
         logger.info "🔎 Scanning for existing configurations...\n"

data/lib/dri/commands/profile.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-
 require 'tty-box'
 
 module Dri
@@ -11,7 +9,7 @@ module Dri
         @options = options
       end
 
-      def execute(input: $stdin, output: $stdout)
+      def execute(_input: $stdin, output: $stdout)
         if config.exist? && @options["edit"]
           editor.open(config.source_file)
           return
@@ -39,13 +37,13 @@ module Dri
 
       def pretty_print_profile
         <<~PROFILE
-          #{add_color('User:', :bright_cyan)} #{username} 
+          #{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/commands/publish/report.rb

@@ -1,14 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../../command'
-require_relative '../../utils/markdown_lists'
-require_relative '../../utils/constants'
-require_relative '../../report'
-require_relative '../../feature_flag_report'
-
 require 'markdown-tables'
 require 'fileutils'
 require 'uri'
+require 'date'
 
 module Dri
   module Commands
@@ -24,7 +19,7 @@ module Dri
           @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
         end
 
-        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+        def execute(_input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
           verify_config_exists
           report = Dri::Report.new(config)
 
@@ -161,43 +156,34 @@ module Dri
             logger.info 'Downloading the report... '
 
             spinner.start
-
-            FileUtils.mkdir_p(handover_report_path)
-            report_path = "#{handover_report_path.chomp('/')}/report-#{@date}-#{@time}.md"
-
-            File.open(report_path, 'a') do |out_file|
-              out_file.puts note
-            end
-
+            report_md = File.join(handover_report_path, "report-#{@date}-#{@time}.md")
+            File.write(report_md, note)
             spinner.stop
 
             output.puts "Done! ✅\n"
-            logger.success "Report is ready at: #{report_path}"
+            logger.success "Report is ready at: #{report_md}"
             exit 0
           end
 
           # sends note to the weekly triage report
           issues = api_client.fetch_current_triage_issue
-          current_issue_iid = issues.first.iid
+          current_issue_iid = issues.iid
 
           note_action = 'posted'
           posted_note = nil
           if @options[:update]
-            report_file = File.read("handover_reports/.tmp/report-#{@date}.json")
-            report_json = JSON.parse(report_file) if report_file
+            unless File.exist?(report_json_file)
+              return logger.warn("Update action requires initial publish to be executed first!")
+            end
+
+            report_json = JSON.parse(File.read(report_json_file))
             posted_note = api_client.update_triage_report_note(
               iid: current_issue_iid, note_id: report_json['id'], body: note
             )
             note_action = 'updated'
           else
             posted_note = api_client.post_triage_report_note(iid: current_issue_iid, body: note)
-
-            FileUtils.mkdir_p("#{Dir.pwd}/handover_reports/.tmp")
-            report_path = "handover_reports/.tmp/report-#{@date}.json"
-
-            File.open(report_path, 'w') do |out_file|
-              out_file.write(posted_note.to_h.to_json)
-            end
+            File.write(report_json_file, posted_note.to_h.to_json)
           end
 
           output.puts "Done! ✅\n"
@@ -208,6 +194,18 @@ module Dri
 
         private
 
+        def report_json_file
+          @report_json ||= File.join(handover_tmp_dir, "report-#{@date}.json")
+        end
+
+        def handover_tmp_dir
+          @handover_tmp_dir ||= File.join(handover_report_path, ".tmp").tap { |dir| FileUtils.mkdir_p(dir) }
+        end
+
+        def handover_report_path
+          @handover_report_path ||= super.tap { |dir| FileUtils.mkdir_p(dir) }
+        end
+
         def format_feature_flag_changes(env, changes, labels, format_type)
           unless format_type == :table || format_type == :list
             raise ArgumentError, 'format_type must be one of type :table or :list'

data/lib/dri/commands/publish.rb

@@ -23,7 +23,6 @@ module Dri
         if options[:help]
           invoke :help, ['report']
         else
-          require_relative 'publish/report'
           Dri::Commands::Publish::Report.new(options).execute
         end
       end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../../command'
-
 module Dri
   module Commands
     class Rm
@@ -10,7 +8,7 @@ module Dri
           @options = options
         end
 
-        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
+        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?"

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../../command'
 require 'fileutils'
 
 module Dri
@@ -11,7 +10,7 @@ module Dri
           @options = options
         end
 
-        def execute(input: $stdin, output: $stdout)
+        def execute(*)
           verify_config_exists
 
           remove = prompt.yes? "Are you sure you want to remove existing profile?"

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../../command'
 require 'fileutils'
 
 module Dri
@@ -11,7 +10,7 @@ module Dri
           @options = options
         end
 
-        def execute(input: $stdin, output: $stdout)
+        def execute(*)
           FileUtils.rm_rf(handover_report_path) if prompt.yes?("Remove everything in #{handover_report_path}?")
         end
       end

data/lib/dri/commands/rm.rb

@@ -14,7 +14,6 @@ module Dri
         if options[:help]
           invoke :help, ['profile']
         else
-          require_relative 'rm/profile'
           Dri::Commands::Rm::Profile.new(options).execute
         end
       end
@@ -26,7 +25,6 @@ module Dri
         if options[:help]
           invoke :help, ['reports']
         else
-          require_relative 'rm/reports'
           Dri::Commands::Rm::Reports.new(options).execute
         end
       end
@@ -38,7 +36,6 @@ module Dri
         if options[:help]
           invoke :help, ['emoji']
         else
-          require_relative 'rm/emoji'
           Dri::Commands::Rm::Emoji.new(options).execute
         end
       end

data/lib/dri/commands/view/fast_quarantine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dri
+  module Commands
+    class View
+      class FastQuarantine < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(*)
+          verify_config_exists
+
+          logger.info "Fetching fast quarantined tests..."
+
+          file_content = api_client.get_fast_quarantine_tests
+
+          file_content.each_line do |line|
+            puts "• #{line}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/view.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Dri
+  module Commands
+    class View < Thor
+      namespace :view
+
+      desc 'fastquarantine', 'View fast-quarantine tests'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def fastquarantine(*)
+        if options[:help]
+          invoke :help, ['fastquarantine']
+        else
+          Dri::Commands::View::FastQuarantine.new(options).execute
+        end
+      end
+    end
+  end
+end

data/lib/dri/feature_flag_report.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './utils/constants'
-
 module Dri
   class FeatureFlagReport
     include Dri::Utils::Constants::FeatureFlag::Labels
@@ -26,7 +24,7 @@ module Dri
       feature_flag_data = [summary, changed_on, url]
 
       labels = feature_flag.labels
-      host_label = labels.select { |label| /^host::/.match(label) }.join('')
+      host_label = labels.select { |label| /^host::/.match(label) }.join
 
       case host_label
       when PRODUCTION

data/lib/dri/refinements/gitlab.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Gitlab gem refinement for related merge requests
+# TODO: Add method upstream (https://github.com/NARKOZ/gitlab/pull/683)
+module Dri
+  module Refinements
+    module Gitlab
+      refine ::Gitlab::Client::Issues do
+        # List related merge requests
+        #
+        # @example
+        #   Gitlab.related_issue_merge_requests(3, 42)
+        #
+        # @param  [Integer, String] project The ID or name of a project.
+        # @param  [Integer] id The ID of an issue.
+        def related_issue_merge_requests(project, id)
+          get("/projects/#{url_encode project}/issues/#{id}/related_merge_requests")
+        end
+      end
+    end
+  end
+end

data/lib/dri/refinements/string.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dri
+  module Refinements
+    module String
+      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
+  end
+end

data/lib/dri/report.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './utils/constants'
-
 module Dri
   class Report # rubocop:disable Metrics/ClassLength
     include Dri::Utils::Constants::Triage::Labels
-    using Refinements
+    using Refinements::String
 
     attr_reader :header, :failures, :labels, :labels_incidents, :incidents
 
@@ -63,66 +61,17 @@ module Dri
 
       failure_type = filter_failure_type_labels(labels)
       assigned_status = assigned?(failure["assignees"])
-      pipelines = filter_pipeline_labels(labels)
-
-      linked_pipelines = link_pipelines(project_id, iid, pipelines, description)
+      pipelines = format_pipelines(labels)
 
       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_status}#{actions_fixes}"]
+      @failures << [title, emojified_link, pipelines, stack_trace, "#{actions_status}#{actions_fixes}"]
     end
 
     private
 
-    def link_pipelines(project_id, 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' => '/quality/staging-canary',
-        'main' => '/gitlab-org/gitlab-qa-mirror',
-        'master' => '/gitlab-org/gitlab-qa-mirror',
-        '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(project_id, iid)
-
-      return if pipelines.empty?
-
-      pipelines.each do |pipeline|
-        next unless label_pipeline_map.has_key?(pipeline)
-
-        pipeline_in_notes_found = false
-        pipeline_link = ''
-        pipeline_markdown = pipeline.gsub(/.gitlab.com/, '')
-
-        failure_notes.each do |note|
-          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) }
-        end
-
-        unless pipeline_link.empty?
-          pipeline_link_sanitized = pipeline_link.join.strip
-          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) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity/MethodLength
+    def actions_status_template(failure_type, assigned_status, actions_opts) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity/
       quarantined = ''
       reproduced = ''
       transient = ''
@@ -184,6 +133,15 @@ module Dri
       pipelines
     end
 
+    def format_pipelines(labels)
+      labels.filter_map do |label|
+        next unless label.include?(FOUND)
+
+        sanitized_label = label.gsub(FOUND, ' ').strip
+        sanitized_label.gsub(/.gitlab.com/, '')
+      end.join(', ')
+    end
+
     def filter_failure_type_labels(labels)
       labels.each do |label|
         @type = label.gsub!(FAILURE, ' ').to_s if label.include? FAILURE

data/lib/dri/support/configuration.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "tzinfo"
+require "tty-config"
+
+module Dri
+  module Support
+    class Configuration
+      include Utils::Helpers
+
+      TZ = {
+        "AMER" => "America/New_York",
+        "EMEA" => "Europe/London",
+        "APAC" => "Asia/Tokyo"
+      }.freeze
+
+      def initialize
+        @config = TTY::Config.new do |conf|
+          conf.filename = ".dri_profile"
+          conf.extname = ".yml"
+          conf.append_path Dir.home
+          conf.append_path Dir.pwd
+        end
+      end
+
+      attr_reader :config
+
+      def profile
+        @profile ||= config.read
+      end
+
+      def emoji
+        @emoji ||= profile["settings"]["emoji"]
+      end
+
+      def username
+        @username ||= profile["settings"]["user"]
+      end
+
+      def token
+        @token ||= profile["settings"]["token"]
+      end
+
+      def ops_token
+        @ops_token ||= profile["settings"]["ops_token"]
+      end
+
+      def handover_report_path
+        @handover_report_path ||= profile["settings"]["handover_report_path"] || File.join(Dir.home,
+                                                                                           ".handover_reports")
+      end
+
+      def timezone
+        @timezone ||= profile["settings"]["timezone"]
+      end
+
+      def tz
+        @tz ||= TZInfo::Timezone.get(profile["settings"]["tz"] || TZ[timezone])
+      end
+    end
+  end
+end

data/lib/dri/support/influxdb_tools.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dri
+  module Support
+    # Common tools for use with influxdb metrics setup
+    #
+    module InfluxdbTools
+      # @return [String] bucket for storing metrics from main runs
+      INFLUX_MAIN_TEST_METRICS_BUCKET = "e2e-test-stats-main"
+
+      private
+
+      # Query client
+      #
+      # @return [QueryApi]
+      def query_api
+        return nil unless influx_client
+
+        @query_api ||= influx_client.create_query_api
+      end
+
+      # InfluxDb client
+      #
+      # @return [InfluxDB2::Client]
+      def influx_client
+        return nil unless ENV["QA_INFLUXDB_URL"] && ENV["QA_INFLUXDB_TOKEN"]
+
+        @influx_client ||= InfluxDB2::Client.new(
+          ENV.fetch("QA_INFLUXDB_URL", nil),
+          ENV.fetch("QA_INFLUXDB_TOKEN", nil),
+          bucket: INFLUX_MAIN_TEST_METRICS_BUCKET,
+          org: "gitlab-qa"
+        )
+      end
+    end
+  end
+end

data/lib/dri/utils/constants.rb

@@ -11,13 +11,14 @@ module Dri
         FEATURE_FLAG_LOG_PROJECT_ID = 15208716
         INFRA_TEAM_PROD_PROJECT_ID  = 7444821
         RUNBOOKS_PROJECT_ID         = 41045213
+        FAST_QUARANTINE_PROJECT_ID  = 45427186
       end
 
       module Triage
         module Labels
           FOUND = 'found:'
           FAILURE = 'failure::'
-          FAILURE_NEW = "#{FAILURE}new"
+          FAILURE_NEW = "#{FAILURE}new".freeze
           QA = "QA"
           INCIDENT = 'Incident::'
           SERVICE = 'Service::'

data/lib/dri/utils/helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "tty-logger"
+
+module Dri
+  module Utils
+    module Helpers
+      def logger
+        @logger ||= TTY::Logger.new
+      end
+
+      module_function :logger
+    end
+  end
+end