dri 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 345d930ab1d8693abc08cea84c56059acf4617b7b98b3d585ce6838c2be76ed5
-  data.tar.gz: 43fe7a822eb463770ade0125528e3a18a58bf12b1c8dd0c83daffffb4fac01ff
+  metadata.gz: 8718d907e41f0cfb472a255898ed513af0fe81ae4cfe782c7aa7d270cb0c2b9f
+  data.tar.gz: 718f976b309b6eb0cab9f65b32e58de5876edd5507aafcc20a2f098068bb5929
 SHA512:
-  metadata.gz: 799aeafefdbf86bca0a6b317806cd8054df97b2871bba345d9c3c44c0a0ae716d152f85afd1e5536b2dafb3e4399f2b757912558d6a59bc3661bb2e6699fc120
-  data.tar.gz: b0a1e74085cd70be58b8fcef39f436cf9c16b0d49c39d48833a86d74814b6fe7b654fb833be252c6c26bd68945691d4465f3c351ee41837a7454bb17b601e820
+  metadata.gz: 643631388b378a127bca182911c9dfb304a1134b568fb71c716976f637f31f2a8d5056c2e30f0f9e2a72e7528e9e7f58a0bda4c0cbc1066efab02c3159353777
+  data.tar.gz: 46514571671417008fe79dadc26cee33b97ad642e61822e2a2097f4e83d774290d1389f3d7d5c6a8ddf7be7a1974d733b4f5cacef3e7c0084af16a37db30ee0d

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.0.4

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dri (0.1.3)
+    dri (0.3.1)
+      gitlab (~> 4.18)
       httparty (~> 0.20.0)
       json (~> 2.6.1)
       markdown-tables (~> 1.1.1)
@@ -27,10 +28,14 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
+    gitlab (4.18.0)
+      httparty (~> 0.18)
+      terminal-table (>= 1.5.1)
     gitlab-styles (7.0.0)
       rubocop (~> 0.91, >= 0.91.1)
       rubocop-gitlab-security (~> 0.1.1)
@@ -44,8 +49,9 @@ GEM
       multi_xml (>= 0.5.2)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.1)
+    json (2.6.2)
     markdown-tables (1.1.1)
+    method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
@@ -56,6 +62,9 @@ GEM
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.6)
     rack (2.2.3)
     rainbow (3.1.1)
@@ -106,6 +115,8 @@ GEM
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     thor (1.0.1)
     timecop (0.9.5)
     tty-box (0.7.0)
@@ -150,6 +161,7 @@ PLATFORMS
 DEPENDENCIES
   dri!
   gitlab-styles (~> 7.0.0)
+  pry (~> 0.14.1)
   rake
   rspec (~> 3.10.0)
   timecop (~> 0.9.1)

data/dri.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency "gitlab", "~> 4.18"
   spec.add_dependency 'httparty', '~> 0.20.0'
   spec.add_dependency 'json', '~> 2.6.1'
   spec.add_dependency 'markdown-tables', '~> 1.1.1'
@@ -37,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-table', '~> 0.12.0'
 
   spec.add_development_dependency 'gitlab-styles', '~> 7.0.0'
+  spec.add_development_dependency "pry", "~> 0.14.1"
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.10.0'
   spec.add_development_dependency "timecop", "~> 0.9.1"

data/lib/dri/api_client.rb

@@ -4,9 +4,10 @@ require "httparty"
 require "json"
 require "tty-config"
 require 'cgi'
+require 'gitlab'
 
 module Dri
-  class ApiClient # rubocop:disable Metrics/ClassLength
+  class ApiClient
     API_URL                     = 'https://gitlab.com/api/v4'
     TESTCASES_PROJECT_ID        = '11229385'
     TRIAGE_PROJECT_ID           = '15291320'
@@ -15,41 +16,53 @@ module Dri
     INFRA_TEAM_PROD_PROJECT_ID  = '7444821'
 
     def initialize(config)
-      profile = config.read
-      @token = profile["settings"]["token"]
-    end
-
-    def header
-      @header ||= { 'Content-Type' => 'application/json', "Authorization" => "Bearer #{@token}" }
+      @token = config.read.dig("settings", "token")
     end
 
+    # Fetch triaged failures
+    #
+    # @param [String] emoji
+    # @param [String] state
+    # @return [Gitlab::ObjectifiedHash]
     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)
+      gitlab.issues(
+        GITLAB_PROJECT_ID,
+        order_by: "updated_at",
+        my_reaction_emoji: emoji,
+        scope: "all",
+        state: state
+      )
     end
 
-    def fetch_awarded_emojis(url)
-      fetch_json(url)
+    # Fetch award emojis
+    #
+    # @param [Integer] issue_iid
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def fetch_awarded_emojis(issue_iid)
+      gitlab.award_emojis(GITLAB_PROJECT_ID, issue_iid, "issue")
     end
 
+    # Fetch failing testcases
+    #
+    # @param [String] pipeline
+    # @param [String] state
+    # @return [Array<Gitlab::ObjectifiedHash>]
     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)
+      gitlab.issues(
+        TESTCASES_PROJECT_ID,
+        labels: "#{pipeline}::failed",
+        state: state,
+        scope: "all",
+        "not[labels]": "quarantine"
+      ).auto_paginate
     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)
+    # Fetch related issue mrs
+    #
+    # @param [Integer] issue_iid
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def fetch_related_mrs(issue_iid)
+      gitlab.related_issue_merge_requests(GITLAB_PROJECT_ID, issue_iid)
     end
 
     # Fetch MRs
@@ -63,104 +76,91 @@ module Dri
     # @option options [String] milestone
     # @option options [String] labels
     def fetch_mrs(project_id:, **options)
-      uri = URI(API_URL)
-      uri.query = HTTParty::HashConversions.to_params(options)
-
-      # CGI.escape('gitlab-org/gitlab') => 'gitlab-org%2Fgitlab'
-      uri.path = File.join(uri.path, 'projects', CGI.escape(project_id), 'merge_requests')
-
-      fetch_json(uri.to_s)
+      gitlab.merge_requests(project_id, per_page: 100, **options).auto_paginate
     end
 
+    # Fetch current triage issue
+    #
+    # @return [Gitlab::ObjectifiedHash]
     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)
+      gitlab.issues(TRIAGE_PROJECT_ID, state: "opened", order_by: "updated_at")
     end
 
+    # Create triage report note
+    #
+    # @param [Integer] iid
+    # @param [String] body
+    # @return [Gitlab::ObjectifiedHash]
     def post_triage_report_note(iid:, body:)
-      url = ["#{API_URL}/projects/"]
-      url << "#{TRIAGE_PROJECT_ID}/issues/#{iid}/notes"
-
-      post_json(url.join, body)
+      gitlab.create_issue_note(TRIAGE_PROJECT_ID, iid, body)
     end
 
+    # Fetch new failures
+    #
+    # @param [String] date
+    # @param [String] state
+    # @return [Array<Gitlab::ObjectifiedHash>]
     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}"
-      url << "&per_page=100"
-
-      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)
+      gitlab.issues(
+        GITLAB_PROJECT_ID,
+        labels: "failure::new",
+        order_by: "updated_at",
+        state: state,
+        scope: "all",
+        created_after: date,
+        per_page: 100
+      )
+    end
+
+    # Fetch failure notes
+    #
+    # @param [Integer] issue_iid
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def fetch_failure_notes(issue_iid)
+      gitlab.issue_notes(GITLAB_PROJECT_ID, issue_iid, per_page: 100).auto_paginate
     end
 
-    def fetch_feature_flag_logs(date:, page:)
-      url = ["#{API_URL}/projects/"]
-      url << "#{FEATURE_FLAG_LOG_PROJECT_ID}/issues"
-      url << "?created_after=#{date}"
-      url << "&per_page=100"
-      url << "&page=#{page}"
-
-      fetch_json(url.join)
+    # Delete award emoji
+    #
+    # @param [Integer] issue_iid
+    # @param [Integer] emoji_id
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_award_emoji(issue_iid, emoji_id)
+      gitlab.delete_award_emoji(
+        GITLAB_PROJECT_ID,
+        issue_iid,
+        "issue",
+        emoji_id
+      )
+    end
+
+    # Fetch feature flag log issues
+    #
+    # @param [String] date
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def fetch_feature_flag_logs(date)
+      gitlab.issues(FEATURE_FLAG_LOG_PROJECT_ID, created_after: date, per_page: 100).auto_paginate
     end
 
+    # Fetch ongoing incidents
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
     def incidents
-      url = ["#{API_URL}/projects/"]
-      url << "#{INFRA_TEAM_PROD_PROJECT_ID}/issues"
-      url << "?order_by=updated_at&state=opened"
-      url << "&labels=incident"
-
-      fetch_json(url.join)
+      gitlab.issues(INFRA_TEAM_PROD_PROJECT_ID, order_by: "updated_at", state: "opened", labels: "incident")
     end
 
     private
 
-    def post_json(url, body)
-      options = {
-        body: { body: body },
-        headers: {
-          "Authorization" => "Bearer #{@token}"
-        }
-      }
+    attr_reader :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)
-      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))
+    # Gitlab client
+    #
+    # @return [Gitlab::Client]
+    def gitlab
+      @gitlab ||= Gitlab.client(
+        endpoint: API_URL,
+        private_token: token
+      )
     end
   end
 end

data/lib/dri/command.rb

@@ -2,6 +2,7 @@
 
 require_relative 'command'
 require_relative 'api_client'
+require_relative 'gitlab/issues'
 
 require 'dri/refinements/truncate'
 

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

@@ -40,20 +40,19 @@ module Dri
           spinner.run do # rubocop:disable Metrics/BlockLength
             response = api_client.fetch_failures(date: @today_iso_format, state: 'opened')
 
-            if response.nil?
+            if response.empty?
               logger.info 'Life is great, there are no new failures today!'
               exit 0
             end
 
             response.each do |failure|
-              title = failure['title'].truncate(60)
-              author = failure['author']['username']
-              url = failure['web_url']
-              award_emoji_url = failure['_links']['award_emoji']
+              title = failure.title.truncate(60)
+              author = failure.to_h.dig('author', 'username')
+              url = failure.web_url
               triaged = add_color('x', :red)
 
-              emoji_awards = api_client.fetch_awarded_emojis(award_emoji_url).find do |e|
-                (e['name'] == emoji) && (e['user']['username'] == username)
+              emoji_awards = api_client.fetch_awarded_emojis(failure.iid).find do |e|
+                e.name == emoji && e.to_h.dig('user', 'username') == username
               end
 
               if emoji_awards
@@ -62,7 +61,7 @@ module Dri
               end
 
               if @options[:urgent]
-                labels = failure['labels']
+                labels = failure.labels
 
                 labels.each do |label|
                   if label.include?('found:canary.gitlab.com' && 'found:canary.staging.gitlab.com')

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

@@ -35,44 +35,37 @@ module Dri
 
           logger.info "Fetching today's feature flag changes..."
 
-          spinner.run do # rubocop:disable Metrics/BlockLength
-            page = 1
-            loop do # rubocop:disable Metrics/BlockLength
-              response = api_client.fetch_feature_flag_logs(date: @today_iso_format, page: page)
-
-              if response.nil? && page == 1
-                logger.info 'It\'s been quiet...no feature flag changes for today 👀'
-                exit 0
-              end
+          spinner.run do
+            response = api_client.fetch_feature_flag_logs(@today_iso_format)
+            if response.empty?
+              logger.info 'It\'s been quiet...no feature flag changes for today 👀'
+              break
+            end
 
-              response.each do |feature_flag|
-                summary = feature_flag['title']
+            response.each do |feature_flag|
+              summary = feature_flag.title
 
-                substrings = ["set to \"true\"", "set to \"false\""]
-                next unless substrings.any? { |substr| summary.include?(substr) }
+              substrings = ["set to \"true\"", "set to \"false\""]
+              next unless substrings.any? { |substr| summary.include?(substr) }
 
-                changed_on = feature_flag['description'][/(?<=Changed on \(in UTC\): ).+?(?=\n)/].delete('`')
-                url = feature_flag['web_url']
+              changed_on = feature_flag.description[/(?<=Changed on \(in UTC\): ).+?(?=\n)/].delete('`')
+              url = feature_flag.web_url
 
-                feature_flag_data = [summary, changed_on, url]
+              feature_flag_data = [summary, changed_on, url]
 
-                labels = feature_flag['labels']
-                host_label = labels.select { |label| /^host::/.match(label) }.join('')
+              labels = feature_flag.labels
+              host_label = labels.select { |label| /^host::/.match(label) }.join('')
 
-                case host_label
-                when PRODUCTION
-                  prod_feature_flags << feature_flag_data
-                when STAGING
-                  staging_feature_flags << feature_flag_data
-                when STAGING_REF
-                  staging_ref_feature_flags << feature_flag_data
-                when PREPROD
-                  preprod_feature_flags << feature_flag_data
-                end
+              case host_label
+              when PRODUCTION
+                prod_feature_flags << feature_flag_data
+              when STAGING
+                staging_feature_flags << feature_flag_data
+              when STAGING_REF
+                staging_ref_feature_flags << feature_flag_data
+              when PREPROD
+                preprod_feature_flags << feature_flag_data
               end
-
-              page += 1
-              break if response.count < 100 || response.nil?
             end
           end
 

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

@@ -37,8 +37,8 @@ module Dri
             )
 
             mrs = response.each_with_object([]) do |mr, found_mrs|
-              title = mr['title'][13..].truncate(60) # remove the "[QUARANTINE] " prefix
-              url = mr['web_url']
+              title = mr.title[13..].truncate(60) # remove the "[QUARANTINE] " prefix
+              url = mr.web_url
 
               found_mrs << [title, url]
             end

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

@@ -47,8 +47,8 @@ module Dri
 
             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']}"
+            response.each do |test_case|
+              output.puts "#{title_label} #{test_case.title}\n#{url_label} #{test_case.web_url}"
               output.puts "#{divider}\n"
             end
           end

data/lib/dri/commands/incidents.rb

@@ -31,13 +31,13 @@ module Dri
 
           if response.nil?
             logger.info 'Hooray, no active incidents 🎉.'
-            exit 0
+            break
           end
 
           response.each do |incident|
-            title = incident['title'].truncate(70)
-            url = incident['web_url']
-            labels = incident['labels']
+            title = incident.title.truncate(70)
+            url = incident.web_url
+            labels = incident.labels
             status = "N/A"
             service = "N/A"
 

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

@@ -29,18 +29,13 @@ module Dri
           spinner.stop
 
           issues_with_award_emoji.each do |issue|
-            logger.info "Removing #{emoji} from #{issue['web_url']}..."
+            logger.info "Removing #{emoji} from #{issue.web_url}..."
 
-            award_emoji_url = issue["_links"]["award_emoji"]
+            response = api_client.fetch_awarded_emojis(issue.iid)
 
-            response = api_client.fetch_awarded_emojis(award_emoji_url)
+            emoji_found = response.find { |e| e.name == emoji && e.to_h.dig('user', 'username') == username }
 
-            emoji_found = response.find { |e| e['name'] == emoji && e['user']['username'] == username }
-
-            unless emoji_found.nil?
-              url = "#{award_emoji_url}/#{emoji_found['id']}"
-              api_client.delete_award_emoji(url)
-            end
+            api_client.delete_award_emoji(issue.iid, emoji_found.id) unless emoji_found.nil?
           end
           output.puts "Done! ✅"
           logger.success "Removed #{emoji} from #{issues_with_award_emoji.size} issue(s)."

data/lib/dri/gitlab/issues.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Gitlab gem monkeypatch for related merge requests
+# TODO: Add method upstream
+#
+class Gitlab::Client
+  module Issues
+    # 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

data/lib/dri/report.rb

@@ -30,7 +30,7 @@ module Dri
       assignees = failure["assignees"]
       description = failure["description"]
 
-      related_mrs = @api_client.fetch_related_mrs(issue_iid: iid)
+      related_mrs = @api_client.fetch_related_mrs(iid)
       emoji = classify_failure_emoji(created_at)
       emojified_link = "#{emoji} #{link}"
 
@@ -71,7 +71,7 @@ module Dri
         'release' => '/quality/release'
       }
 
-      failure_notes = @api_client.fetch_failure_notes(issue_iid: iid)
+      failure_notes = @api_client.fetch_failure_notes(iid)
 
       return if pipelines.empty?
 
@@ -83,10 +83,10 @@ module Dri
         pipeline_markdown = pipeline.gsub(/.gitlab.com/, '')
 
         failure_notes.each do |note|
-          next unless note["body"].include?(label_pipeline_map.fetch(pipeline))
+          next unless note.body.include?(label_pipeline_map.fetch(pipeline))
 
           pipeline_in_notes_found = true
-          pipeline_link = URI.extract(note["body"], %w[https])
+          pipeline_link = URI.extract(note.body, %w[https])
         end
 
         unless pipeline_in_notes_found
@@ -193,7 +193,7 @@ module Dri
       path = "Failure in `#{path.strip}`" if path.delete_prefix!('Failure in ')
       path = path.strip.gsub(' ', ' ') if desc
 
-      "#{path} | #{desc}"
+      [path, desc].compact.join(' | ')
     end
   end
 end

data/lib/dri/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -305,6 +333,7 @@ files:
 - lib/dri/commands/rm/emoji.rb
 - lib/dri/commands/rm/profile.rb
 - lib/dri/commands/rm/reports.rb
+- lib/dri/gitlab/issues.rb
 - lib/dri/refinements/truncate.rb
 - lib/dri/report.rb
 - lib/dri/templates/incidents/.gitkeep