dri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb31c263acfb2d576ed72028d207df2d36d76b1965ac00aa5228fbdd991a7524
+  data.tar.gz: 179c9389a9b3ce00a9f4ff357da3d1f4fdf3af9b22ec96a8d582dfb7d35bf17a
+SHA512:
+  metadata.gz: d38a554fad6c98a72992c2d5c97eae39f6ecebce78ff466174f20074a4aa74b436ee6fcff6192ad4800515056fd9e53ec049a5aa1f6dfa90fdcafa2489376256
+  data.tar.gz: 2f2994a17800bd2d1fbf02ed9724e9b0428e4ded12ae9516135d19a6b529982d3e36d2148e6ef9df4f6bc740355555831ed035b440d30d89f94fdf814e3a1a99

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.rb]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.dri_profile.yml
+handover_reports/*

data/.gitlab-ci.yml

@@ -0,0 +1,28 @@
+image: ruby:3.0.2
+
+stages:
+  - build
+  - test
+  - deploy
+
+before_script:
+  - gem install bundler:2.2.22
+  - bundle install
+
+build_gem:
+  stage: build
+  script:
+    - gem build
+
+rspec:
+  stage: test
+  script:
+    - bundle exec rspec
+
+deploy:
+  stage: deploy
+  script:
+    - gem push dri*.gem
+  rules:
+    - if: '$CI_COMMIT_TAG'
+      when: always

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dri.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    dri (0.1.0)
+      httparty (~> 0.20.0)
+      json (~> 2.6.1)
+      markdown-tables (~> 1.1.1)
+      pastel (~> 0.8.0)
+      thor (~> 1.0.1)
+      tty-box (~> 0.7.0)
+      tty-config (~> 0.4.0)
+      tty-editor (~> 0.6)
+      tty-font (~> 0.5)
+      tty-logger (~> 0.6.0)
+      tty-prompt (~> 0.23.1)
+      tty-spinner (~> 0.9)
+      tty-table (~> 0.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.1)
+    markdown-tables (1.1.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    thor (1.0.1)
+    timecop (0.9.5)
+    tty-box (0.7.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-config (0.4.0)
+    tty-cursor (0.7.1)
+    tty-editor (0.7.0)
+      tty-prompt (~> 0.22)
+    tty-font (0.5.0)
+    tty-logger (0.6.0)
+      pastel (~> 0.8)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (2.1.0)
+    unicode_utils (1.4.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dri!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  timecop (~> 0.9.1)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 GitLab, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# DRI
+
+So, are you the **D**irectly **R**esponsible **I**ndividual for GitLab's QA pipelines this week? Looking for a gem to help triage and report failing tests? Look no further.
+
+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
+
+... and more.
+
+## Installation
+
+To install the `dri` gem:
+
+```shell
+$ gem install dri
+```
+
+And then execute `dri` to see all available options:
+
+```shell
+$ dri
+```
+
+## Usage
+
+### Configuration
+
+To use `dri` fully it is necessary to have:
+
+- a Personal Access Token
+- a triage emoji
+
+The emoji is the [Award/My Reaction](https://docs.gitlab.com/ee/user/award_emojis.html) emoji associated with the failure issues to group all failures triaged on a given day. This emoji is a personal choice. Note that the same emoji should be used only while triaging failures and not associated with other issues out of the scope of triage.
+
+To set up your personal profile:
+
+```shell
+$ dri init
+```
+
+To verify the profile is correctly set:
+
+```shell
+$ dri profile
+```
+
+### Commands
+
+- [1. init](#1-init)
+- [2. profile](#2-profile)
+- [3. fetch](#3-fetch)
+  - failures
+  - testcases
+- [4. publish](#4-publish)
+  - report
+- [5. rm](#5-rm)
+  - emoji
+- [6. version](#6-version)
+
+#### 1. init
+
+```shell
+$ dri init
+```
+
+Initializes the `dri` CLI with necessary configurations to run smoothly.
+
+#### 2. profile
+
+```shell
+$ dri profile
+```
+
+Shows the current profile associated after initial configuration.
+Pass the option `--edit` to edit the current profile.
+
+#### 3. fetch
+
+```shell
+$ 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.
+
+```shell
+$ dri fetch testcases
+```
+
+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)
+
+#### 4. publish
+
+```shell
+$ dri publish report
+```
+
+Publishes a handover report on the latest triage issue, in the [pipeline-triage](https://gitlab.com/gitlab-org/quality/pipeline-triage) project.
+
+**Options**
+
+```shell
+$ 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
+```
+
+#### 5. rm
+
+```shell
+$ dri rm emoji
+```
+
+Removes the triage emoji from all triaged issues.
+
+#### 6. version
+
+```shell
+$ dri version
+```
+
+`dri` gem version.
+
+## Copyright
+
+Copyright (c) 2022 GitLab, Inc. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dri"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dri.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/dri/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dri"
+  spec.license       = "MIT"
+  spec.version       = Dri::VERSION
+  spec.authors       = ["GitLab Quality"]
+  spec.email         = ["quality+dri@gitlab.com"]
+
+  spec.summary       = %q{CLI app to help triage GitLab QA pipelines}
+  spec.homepage      = 'https://gitlab.com/gitlab-org/quality/dri'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tty-config", "~> 0.4.0"
+  spec.add_dependency "tty-font", "~> 0.5"
+  spec.add_dependency "tty-prompt", "~> 0.23.1"
+  spec.add_dependency "tty-spinner", "~> 0.9"
+  spec.add_dependency "tty-table", "~> 0.12.0"
+  spec.add_dependency 'tty-box', '~> 0.7.0'
+  spec.add_dependency 'tty-logger', '~> 0.6.0'
+  spec.add_dependency "tty-editor", "~> 0.6"
+  spec.add_dependency "pastel", "~> 0.8.0"
+  spec.add_dependency "thor", "~> 1.0.1"
+  spec.add_dependency "markdown-tables", "~> 1.1.1"  
+  spec.add_dependency 'json', '~> 2.6.1'
+  spec.add_dependency 'httparty', '~> 0.20.0'
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+end

data/exe/dri

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'dri/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Dri::CLI.start
+rescue Dri::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/lib/dri/api_client.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+require "tty-config"
+
+module Dri
+  class ApiClient
+    
+    API_URL              = 'https://gitlab.com/api/v4'
+    TESTCASES_PROJECT_ID = '11229385'
+    TRIAGE_PROJECT_ID    = '34185524'
+    GITLAB_PROJECT_ID    = '278964'
+
+    def initialize(config)
+      profile = config.read
+      @token = profile["settings"]["token"]
+    end
+
+    def header
+      @header ||= { 'Content-Type' => 'application/json', "Authorization" => "Bearer #{@token}" }
+    end
+
+    def fetch_triaged_failures(emoji:, state:)
+      url = ["#{API_URL}/issues"]
+      url << "?order_by=updated_at&my_reaction_emoji=#{emoji}"
+      url << "&scope=all&state=#{state}"
+
+      fetch_json(url.join)
+    end
+
+    def fetch_awarded_emojis(url)
+      fetch_json(url)
+    end
+
+    def fetch_failing_testcases(pipeline, state:)
+      url = ["#{API_URL}/projects/"]
+      url << "#{TESTCASES_PROJECT_ID}/issues?labels=#{pipeline}::failed"
+      url << "&state=#{state}&not[labels]=quarantine"
+      url << "&scope=all"
+
+      fetch_json(url.join)
+    end
+
+    def fetch_related_mrs(issue_iid:)
+      url = ["#{API_URL}/projects/"]
+      url << "#{GITLAB_PROJECT_ID}/issues/"
+      url << "#{issue_iid}/related_merge_requests"
+
+      fetch_json(url.join)
+    end
+
+    def fetch_current_triage_issue
+      url = ["#{API_URL}/projects/"]
+      url << "#{TRIAGE_PROJECT_ID}/issues?state=opened"
+      url << "&order_by=updated_at"
+
+      fetch_json(url.join)
+    end
+
+    def post_triage_report_note(iid:, body:)
+      url = ["#{API_URL}/projects/"]
+      url << "#{TRIAGE_PROJECT_ID}/issues/#{iid}/notes"
+
+      post_json(url.join, body)
+    end
+
+    def fetch_failures(date:, state:)
+      url = ["#{API_URL}/issues"]
+      url << "?labels=failure::new"
+      url << "&order_by=updated_at&state=#{state}"
+      url << "&scope=all"
+      url << "&created_after=#{date}"
+
+      fetch_json(url.join)
+    end
+
+    def fetch_failure_notes(issue_iid:)
+      url = ["#{API_URL}/projects/"]
+      url << "#{GITLAB_PROJECT_ID}/issues/"
+      url << "#{issue_iid}/notes?per_page=15"
+
+      fetch_json(url.join)
+    end
+
+    def delete_award_emoji(url)
+      delete_json(url)
+    end
+
+    private
+
+    def post_json(url, body)
+      options = {
+        body: { body: body },
+        headers: {
+          "Authorization" => "Bearer #{@token}"
+        }
+      }
+
+      response =  HTTParty.post(url, options)      
+      handle_response(response)
+    end
+
+    def delete_json(url)
+      response = HTTParty.delete(url, headers: header)
+      handle_response(response)
+    end
+
+    def handle_response(response)
+      #puts response.to_json
+      response
+    end
+
+    def fetch_json(url)
+      response =  HTTParty.get(url, headers: header)
+
+      if response.code != 200
+        puts "Response error code \"#{response.code}\" - Unable to sync with GitLab"
+        exit 1
+      end
+
+      handle_response(JSON.parse(response.body))
+    end
+  end
+end

data/lib/dri/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'thor'
+require "pastel"
+require "tty-font"
+
+module Dri
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def help(*args)
+      font = TTY::Font.new(:doom)
+      pastel = Pastel.new(enabled: !options[:no_color])
+      puts pastel.yellow(font.write("DRI"))
+      super
+    end
+
+    class_option :no_color, type: :boolean, default: false,
+                              desc: "Disable colorization in output"
+
+    desc 'version', 'dri version'
+    def version
+      require_relative 'version'
+      puts "v#{Dri::VERSION}"
+    end
+    map %w(--version -v) => :version
+
+    require_relative 'commands/rm'
+    register Dri::Commands::Rm, 'rm', 'rm [SUBCOMMAND]', 'Remove triage-related items'
+
+    desc 'profile', 'View current user settings'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    method_option :edit, type: :string, banner: "editor",
+                         desc: "Open the holdings configuration file for " \
+                               "editing in EDITOR, or the default editor " \
+                               "if not specified."
+    def profile(*)
+      if options[:help]
+        invoke :help, ['profile']
+      else
+        require_relative 'commands/profile'
+        Dri::Commands::Profile.new(options).execute
+      end
+    end
+
+    desc 'init', 'Create a configuration to use dri'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def init(*)
+      if options[:help]
+        invoke :help, ['init']
+      else
+        require_relative 'commands/init'
+        Dri::Commands::Init.new(options).execute
+      end
+    end
+
+    require_relative 'commands/fetch'
+    register Dri::Commands::Fetch, 'fetch', 'fetch [SUBCOMMAND]', 'Fetch failures & testcases'
+
+    require_relative 'commands/publish'
+    register Dri::Commands::Publish, 'publish', 'publish [SUBCOMMAND]', 'Publish report for handover'
+  end
+end