dri 0.1.0

data/lib/dri/command.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+require_relative 'command'
+require_relative 'api_client'
+
+require "tty-config"
+require "pastel"
+require 'forwardable'
+
+module Dri
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+    attr_reader :config, :emoji, :token, :username, :timezone, :profile
+
+    def pastel(**options)
+      Pastel.new(**options)
+    end
+
+    # Main configuration
+    def config
+      @config ||= begin
+        config = TTY::Config.new
+        config.filename = ".dri_profile"
+        config.extname = ".yml"
+        config.append_path Dir.pwd
+        config.append_path Dir.home
+        config
+      end
+    end
+
+    def api_client
+      ApiClient.new(config)
+    end
+
+    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 timezone
+      @timezone ||= profile["settings"]["timezone"]
+    end
+
+    def verify_config_exists
+      if !config.exist?
+        logger.error "Oops, could not find a configuration. Try using #{add_color('dri init', :yellow)} first."
+        exit 1
+      end
+    end
+
+    def add_color(str, *color)
+      @options[:no_color] ? str : pastel.decorate(str, *color)
+    end
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    def logger
+      require 'tty-logger'
+      TTY::Logger.new
+    end
+
+    def spinner
+      require 'tty-spinner'
+      TTY::Spinner.new("[:spinner] ⏳", format: :classic)
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+require 'tty-table'
+
+module Dri
+  module Commands
+    class Fetch
+      class Failures < Dri::Command
+        def initialize(options)
+          @options = options
+          @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          verify_config_exists
+
+          title = add_color('Title', :bright_yellow)
+          triaged = add_color('Triaged?', :bright_yellow)
+          author = add_color('Author', :bright_yellow)
+          url = add_color('URL', :bright_yellow)
+
+          failures = []
+          labels = [ title, triaged, author, url ]
+          triaged_counter = 0
+
+          logger.info "Fetching today\'s failures..."
+          
+          spinner.run do 
+
+            response = api_client.fetch_failures(date: @today_iso_format, state: 'opened')
+
+            if response.nil?
+              logger.info "Life is great, there are no new failures today!"
+              exit 0
+            end
+
+            response.each do |failure|
+              title = truncate(failure["title"], 60)
+              author = failure["author"]["username"]
+              url = failure["web_url"]
+              award_emoji_url = failure["_links"]["award_emoji"]
+              triaged = add_color('x', :red)
+
+              emoji_awards = api_client.fetch_awarded_emojis(award_emoji_url)
+
+              triaged = add_color('✓', :green) && triaged_counter += 1 if emoji_awards.find do |e| 
+                e['name'] == emoji && e['user']['username'] == @username 
+              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}."
+        end
+         
+        private
+
+        def truncate(string, max)
+          string.length > max ? "#{string[0...max]}..." : string
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+require 'pastel'
+
+module Dri
+  module Commands
+    class Fetch
+      class Testcases < Dri::Command
+
+        def initialize(options)
+          @options = options
+          @available_pipelines = %w(main canary master nightly production staging-canary staging-orchestrated staging-ref staging)
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          verify_config_exists
+
+          if @options[:filter_pipelines]
+            filtered_pipelines = prompt.multi_select("Select pipelines:", @available_pipelines)
+          end
+
+          logger.info "Fetching currently failing testcases..."
+
+          title_label = add_color('Title:', :bright_yellow)
+          url_label = add_color('URL:', :bright_yellow)
+          divider = add_color('---', :cyan)
+
+          spinner.start
+
+          pipelines = @options[:filter_pipelines] ? filtered_pipelines : @available_pipelines
+
+          pipelines.each do |pipeline|
+            logger.info "Fetching failing testcases in #{pipeline}\n"
+            response = api_client.fetch_failing_testcases(pipeline, state: 'opened')
+        
+            output.puts "♦♦♦♦♦ #{add_color(pipeline, :black, :on_white)}♦♦♦♦♦\n\n"
+
+            response.each do |pipeline|
+              output.puts "#{title_label} #{pipeline["title"]}\n#{url_label} #{pipeline["web_url"]}"
+              output.puts "#{divider}\n"
+            end 
+          end
+          
+          spinner.stop
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/fetch.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Dri
+  module Commands
+    class Fetch < Thor
+      namespace :fetch
+
+      desc 'testcases', 'Display failing testcases'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :filter_pipelines, type: :boolean,
+                           desc: 'Filter by pipeline'
+      def testcases(*)
+        if options[:help]
+          invoke :help, ['testcases']
+        else
+          require_relative 'fetch/testcases'
+          Dri::Commands::Fetch::Testcases.new(options).execute
+        end
+      end
+
+      desc 'failures', 'Display failures opened today'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def failures(*)
+        if options[:help]
+          invoke :help, ['failures']
+        else
+          require_relative 'fetch/failures'
+          Dri::Commands::Fetch::Failures.new(options).execute
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/init.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+require "tty-font"
+require "pastel"
+
+module Dri
+  module Commands
+    class Init < Dri::Command
+      def initialize(options)
+        font = TTY::Font.new(:doom)       
+        puts pastel.yellow(font.write("DRI"))
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        output.puts "🤖 Welcome to DRI 🤖\n"
+
+        logger.info "🔎 Scanning for existing configurations...\n"
+
+        if config.exist?
+          overwrite = prompt.yes?("There is already a configuration initialized. Would you like to overwrite it?")
+          unless overwrite
+            output.puts "Using existing configuration. To view configuration in use try  #{add_color('dri profile', :yellow)}."
+            exit 0
+          end
+        end
+
+        @username = prompt.ask("What is your GitLab username?")
+        @token = prompt.mask("Please provide your GitLab personal access token:")
+        @timezone = prompt.select("Choose your current timezone?", %w(EMEA AMER APAC))
+        @emoji = prompt.ask("Have a triage emoji?")
+
+        if (@emoji || @token || @username).nil?
+          logger.error "Please provide a username, token, timezone and emoji used for triage."
+          exit 1
+        end
+
+        config.set(:settings, :user, value: @username)
+        config.set(:settings, :token, value: @token)
+        config.set(:settings, :timezone, value: @timezone)
+        config.set(:settings, :emoji, value: @emoji)
+        config.write(force: true)
+
+        logger.success "✅ We're ready to go 🚀"      
+      end
+    end
+  end
+end

data/lib/dri/commands/profile.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+require 'tty-box'
+
+module Dri
+  module Commands
+    class Profile < Dri::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        if config.exist? && @options["edit"]
+          editor.open(config.source_file)
+          return
+        end
+
+        logger.info "🔎 Looking for profiles...\n"
+
+        if config.exist?
+          box = TTY::Box.frame(width: 30, height: 10, align: :center, padding: 1, title: {top_left: add_color('PROFILE:', :bright_cyan)}, border: :thick) do
+            pretty_print_profile
+          end
+          print box
+          output.puts "☝️ To modify this profile try passing #{add_color('dri profile --edit', :yellow)}.\n"
+        else
+          logger.error "Oops.. Profile not found. Try creating one using #{add_color('dri init', :yellow)}."
+        end
+      end
+
+      def pretty_print_profile
+        "#{add_color('User:', :bright_cyan)} #{username}\n #{add_color('Token:', :bright_cyan)} #{token}\n #{add_color('Timezone:', :bright_cyan)} #{timezone}\n #{add_color('Emoji:', :bright_cyan)} #{emoji}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+require_relative '../../command'
+require_relative '../../utils/markdown_lists'
+require_relative "../../report"
+
+require 'markdown-tables'
+require 'fileutils'
+require "uri"
+
+module Dri
+  module Commands
+    class Publish
+      class Report < Dri::Command
+        def initialize(options)
+          @options = options
+
+          @date = Date.today
+          @time = Time.now.to_i
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          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') 
+          spinner.stop
+
+          if issues.empty?
+            logger.warn "Found no issues associated with \"#{emoji}\" emoji. Will exit. Bye 👋"
+            exit 1
+          end
+
+          logger.info "Assembling the report... "
+          # sets each failure on the table 
+          spinner.start
+          issues.each do |issue|
+            report.add_failure(issue)
+          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 
+            # 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?
+          end
+
+          report.set_header(timezone, username)
+          note = "#{report.header}\n\n#{format_style}"
+
+          spinner.stop
+
+          # creates an .md file with the report locally in /handover_reports
+          if @options[:dry_run]
+            logger.info "Downloading the report... "
+
+            spinner.start
+
+            FileUtils.mkdir_p("#{Dir.pwd}/handover_reports")
+            report_path = "handover_reports/report-#{@date}-#{@time}.md"
+
+            File.open(report_path, 'a') do |out_file|
+              out_file.puts note
+            end
+          
+            spinner.stop
+
+            output.puts "Done! ✅\n"
+            logger.success "Report is ready at: #{report_path}"
+            exit 0
+          end
+
+          # 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)
+
+          output.puts "Done! ✅\n"
+          logger.success "Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/dri/-/issues/#{current_issue_iid} 🎉"
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/publish.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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'
+      def report(*)
+        if options[:help]
+          invoke :help, ['report']
+        else
+          require_relative 'publish/report'
+          Dri::Commands::Publish::Report.new(options).execute
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Dri
+  module Commands
+    class Rm
+      class Emoji < 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 all #{emoji} award emojis from issues?"
+
+          unless remove
+            logger.info "Emojis kept in place 👍"
+            exit 0
+          end
+
+          logger.info "Removing #{emoji} from issues..."
+
+          spinner.start
+
+          issues_with_award_emoji = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+
+          spinner.stop
+
+          issues_with_award_emoji.each do |issue|
+            logger.info "Removing #{emoji} from #{issue["web_url"]}..."
+
+            award_emoji_url = issue["_links"]["award_emoji"]
+
+            response = api_client.fetch_awarded_emojis(award_emoji_url)
+
+            emoji_found = response.find { |e| e['name'] == emoji && e['user']['username'] == username }
+
+            if !emoji_found.nil?
+              url = "#{award_emoji_url}/#{emoji_found["id"]}"
+              api_client.delete_award_emoji(url)
+            end
+          end
+          output.puts "Done! ✅"
+          logger.success "Removed #{emoji} from #{issues_with_award_emoji.size} issue(s)."
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/rm.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Dri
+  module Commands
+    class Rm < Thor
+
+      namespace :rm
+
+      desc 'emoji', 'Remove triage emoji from all failures'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def emoji(*)
+        if options[:help]
+          invoke :help, ['emoji']
+        else
+          require_relative 'rm/emoji'
+          Dri::Commands::Rm::Emoji.new(options).execute
+        end
+      end
+    end
+  end
+end

data/lib/dri/report.rb

@@ -0,0 +1,121 @@
+module Dri
+  class Report
+    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") 
+      @weekday = Date.today.strftime("%A")
+      @header = nil
+
+      @api_client = ApiClient.new(config)
+    end
+
+    def set_header(timezone, username)
+      @header = "# #{timezone}, #{@weekday} - #{@date}\n posted by: @#{username}"
+    end
+
+    def add_failure(failure)
+      iid = failure["iid"]
+      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'})"
+
+      failure_type = filter_failure_type_labels(labels)
+      assigned_status = assigned?(assignees)
+      pipelines = filter_pipeline_labels(labels)
+
+      linked_pipelines = link_pipelines(iid, pipelines)
+
+      actions = ""
+      actions.concat actions_status_template(failure_type, assigned_status)
+      actions.concat actions_fixes_template(related_mrs)
+
+      @failures << [title, emojified_link, linked_pipelines, stack_trace, actions]
+    end
+
+    private
+
+    def link_pipelines(iid, pipelines)
+      failure_notes = @api_client.fetch_failure_notes(issue_iid: iid)
+
+      linked = ""
+              
+      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
+          end
+
+          linked << pipeline
+      end
+      linked
+    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>"
+    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>"
+      end
+      actions_fixes_template.concat '</ul>'
+      actions_fixes_template
+    end
+
+    def assigned?(assignees)
+      assignees.empty? ?  'Assigned :x:' : 'Assigned :white_check_mark:'
+    end
+
+    def filter_pipeline_labels(labels)
+      pipelines = []
+
+      labels.each do |label|
+        matchers = { 'found:' => ' ', '.gitlab.com' => ' ' }
+  
+        if label.include? "found:"
+          pipeline = label.gsub(/found:|.gitlab.com/) { |match| matchers[match] }
+          pipelines << pipeline.strip
+        end
+      end
+      pipelines
+    end
+
+    def filter_failure_type_labels(labels)
+      labels.each do |label|
+        @type = label.gsub!('failure::', ' ').to_s if label.include? "failure::"
+      end
+      @type
+    end
+
+    def classify_failure_emoji(created_at)
+      new_failure_emoji = ':boom:'
+      known_failure_emoji = ':fire_engine:'
+
+      if created_at.include? @today
+        new_failure_emoji
+      else
+       known_failure_emoji
+      end
+    end
+  end
+end