dri 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990d9ed4c79b5b7c7ff2e5535dba71599a3189d4c742b918f98d3063a6e15c9f
-  data.tar.gz: 15e48f44496a55d5d13185409a91d9ddd525d127fd8dbe73265dc176c6d14634
+  metadata.gz: e6ee21fc2a0243e0850f7bab281b0611021807a1a4559e89433741b1faed40f2
+  data.tar.gz: 5b97afcdbc1e1e9307b084eab6e2afddbff94556cc102f2b174a0dedc3f51c33
 SHA512:
-  metadata.gz: 22a9838a3821c90cb24346f6f98b6158e2a71ec9bd0c4e7b5d9e447a75b676202be1d365e1603d7d12a8441f6b5d448f26337c33163b60f346819933da24fea3
-  data.tar.gz: 6b117a44436b2c4c064c3b19b22deb454a42c8d6d460492af7813e72299600d50ad2cef612e5e1f2a84566588f560d31c82da3c5c92b35f1d8749ea445e9664e
+  metadata.gz: f5b54fee2e4f0d99d0d013d0c9a211306eda149dabb6c0cedf05ec0c5a92274dd4038377fc270b6185782ba2dfdbe5c2be6028136c77a4e77dceb21989a82894
+  data.tar.gz: c2d5056697c04ea976e00db46f183cd716091e3681687ad369c6dc3c11dab7ecd5592022460948a19ce779da7b114c2c90c4ba3c712a0bfe6256524cf6859934

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dri (0.6.1)
+    dri (0.7.0)
       amatch (~> 0.4.1)
       gitlab (~> 4.18)
       httparty (~> 0.20.0)

data/README.md

@@ -146,6 +146,7 @@ $ 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.
+The report includes automatically both triaged failures and incidents.
 
 **Options**
 

data/lib/dri/api_client.rb

@@ -11,11 +11,12 @@ module Dri
   class ApiClient # rubocop:disable Metrics/ClassLength
     API_URL                     = "https://gitlab.com/api/v4"
     OPS_API_URL                 = "https://ops.gitlab.net/api/v4"
-    TESTCASES_PROJECT_ID        = "11229385"
-    TRIAGE_PROJECT_ID           = "15291320"
-    GITLAB_PROJECT_ID           = "278964"
-    FEATURE_FLAG_LOG_PROJECT_ID = "15208716"
-    INFRA_TEAM_PROD_PROJECT_ID  = "7444821"
+    TESTCASES_PROJECT_ID        = 11229385
+    TRIAGE_PROJECT_ID           = 15291320
+    GITLAB_PROJECT_ID           = 278964
+    FEATURE_FLAG_LOG_PROJECT_ID = 15208716
+    INFRA_TEAM_PROD_PROJECT_ID  = 7444821
+
     def initialize(config, ops = false)
       @token = config.read.dig("settings", "token")
       @ops_token = config.read.dig("settings", "ops_token")
@@ -42,12 +43,26 @@ module Dri
       )
     end
 
+    # Fetch triaged incidents
+    #
+    # @param [String] emoji
+    def fetch_triaged_incidents(emoji:)
+      gitlab.issues(
+        INFRA_TEAM_PROD_PROJECT_ID,
+        order_by: "updated_at",
+        my_reaction_emoji: emoji,
+        state: "all",
+        labels: "incident"
+      )
+    end
+
     # Fetch award emojis
     #
     # @param [Integer] issue_iid
+    # @param [Integer] project_id
     # @return [Array<Gitlab::ObjectifiedHash>]
-    def fetch_awarded_emojis(issue_iid)
-      gitlab.award_emojis(GITLAB_PROJECT_ID, issue_iid, "issue")
+    def fetch_awarded_emojis(issue_iid, project_id: GITLAB_PROJECT_ID)
+      gitlab.award_emojis(project_id, issue_iid, "issue")
     end
 
     # Fetch failing testcases
@@ -144,10 +159,11 @@ module Dri
     #
     # @param [Integer] issue_iid
     # @param [Integer] emoji_id
+    # @param [Integer] project_id
     # @return [Gitlab::ObjectifiedHash]
-    def delete_award_emoji(issue_iid, emoji_id)
+    def delete_award_emoji(issue_iid, emoji_id:, project_id: GITLAB_PROJECT_ID)
       gitlab.delete_award_emoji(
-        GITLAB_PROJECT_ID,
+        project_id,
         issue_iid,
         "issue",
         emoji_id

data/lib/dri/command.rb

@@ -60,6 +60,10 @@ module Dri
       @timezone ||= profile["settings"]["timezone"]
     end
 
+    def handover_report_path
+      @handover_report_path ||= profile["settings"]["handover_report_path"]
+    end
+
     def verify_config_exists
       return if config.exist?
 

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

@@ -61,7 +61,7 @@ module Dri
           bridges = api_client.pipeline_bridges(project_id, pipeline_id)
           return if bridges.empty? # If downstream pipeline doesn't exist, which triggers the QA tests, return
 
-          bridges.first["downstream_pipeline"]
+          bridges.find { |it| it.name == "e2e:package-and-test" }&.downstream_pipeline
         end
 
         # Get jobs from a pipeline
@@ -136,6 +136,14 @@ module Dri
                              pipeline_id: pipeline.id, ops: ops)
         end
 
+        # Master pipeline run
+        #
+        # @param [String] pipeline_name
+        # @return [Boolean]
+        def master?(pipeline_name)
+          pipeline_name == "master"
+        end
+
         # Constructs allure report url for each pipeline
         # @param [String] pipeline_name
         # @param [Integer] pipeline_id
@@ -151,7 +159,7 @@ module Dri
         def allure_bucket_name(pipeline_name, sanity)
           case pipeline_name
           when "master"
-            "package-and-qa"
+            "e2e-package-and-test"
           when "nightly"
             pipeline_name
           when "pre_prod"
@@ -182,16 +190,19 @@ module Dri
           url.include?("ops.gitlab.net")
         end
 
-        def notify_slack_job_name(pipeline_name, ops)
-          return "notify-slack-qa-fail" if ops
-
-          pipeline_name.to_s.include?("master") ? "notify_slack" : "notify-slack-fail"
+        # Slack notification job name
+        #
+        # @param [Boolean] ops
+        # @return [String]
+        def notify_job_name(ops)
+          ops ? "notify-slack-qa-fail" : "notify-slack-fail"
         end
 
         # Returns child pipeline if it is master pipeline
+        # @param [String] pipeline_name
         # @param [Gitlab::ObjectifiedHash] pipeline
-        def pipeline_with_qa_tests(pipeline)
-          if pipeline.web_url.to_s.include?("gitlab-qa-mirror")
+        def pipeline_with_qa_tests(pipeline_name, pipeline)
+          if master?(pipeline_name)
             bridge_pipeline(pipeline.project_id, pipeline.id)
           else
             pipeline
@@ -202,9 +213,13 @@ module Dri
         # @param [Hash] details
         # @param [Boolean] ops
         def options(details, ops)
-          options = { order_by: "updated_at", scope: "finished",
-                      updated_after: past_timestamp(details[:search_hours_ago]) }
-          options.merge(username: "gitlab-bot") if ops
+          options = {
+            order_by: "updated_at",
+            scope: "finished",
+            ref: "master",
+            updated_after: past_timestamp(details[:search_hours_ago])
+          }
+          options.merge(username: "gitlab-bot") if ops || master?(details[:name])
           options
         end
 
@@ -218,7 +233,7 @@ module Dri
         # @param [Hash] details Pipeline environment details
         # @return [Array] Array of last executed pipeline details
         # rubocop:disable Metrics/PerceivedComplexity
-        def fetch_pipeline(pipeline_name:, details:) # rubocop:disable Metrics/CyclomaticComplexity
+        def fetch_pipeline(pipeline_name:, details:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
           ops = ops_pipeline?(details[:url])
           options = options(details, ops)
           # instance is ops.gitlab.net or gitlab.com
@@ -228,18 +243,15 @@ module Dri
 
           # Return empty data to the table if no matching pipelines were found from the query
           response.each do |pipeline|
-            pipeline_to_scan = pipeline_with_qa_tests(pipeline) # Fetch child pipeline if it is master
+            pipeline_to_scan = pipeline_with_qa_tests(pipeline_name, pipeline) # Fetch child pipeline if it is master
             next if pipeline_to_scan.nil?
 
             pipeline_jobs = jobs(project_id: pipeline.project_id, pipeline_id: pipeline_to_scan.id, ops: ops)
-            next unless contains_job?(pipeline_jobs, job_name: notify_slack_job_name(pipeline_name, ops))
+            next unless master?(pipeline_name) || contains_job?(pipeline_jobs, job_name: notify_job_name(ops))
 
             # Need to know if it is a sanity or a full run to construct allure report url
-            sanity = sanity?(pipeline_jobs: pipeline_jobs, pipeline: pipeline_to_scan,
-                             ops: ops)
-
+            sanity = sanity?(pipeline_jobs: pipeline_jobs, pipeline: pipeline_to_scan, ops: ops)
             next if sanity.nil? # To filter out some "clean up" pipelines present in live environments
-
             next if sanity && @options[:full_runs_only] # Filter out sanity runs if --full-runs-only option is passed
 
             name = ops ? "#{pipeline_name}_#{run_type(sanity)}" : pipeline_name

data/lib/dri/commands/fetch.rb

@@ -19,7 +19,7 @@ module Dri
         end
       end
 
-      desc 'triaged', 'Command description...'
+      desc 'triaged', 'Display triaged failures'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'
       def triaged(*)

data/lib/dri/commands/init.rb

@@ -34,6 +34,8 @@ module Dri
         @ops_token = prompt.mask("Please provide your ops.gitlab.net personal access token:")
         @timezone = prompt.select("Choose your current timezone?", %w[EMEA AMER APAC])
         @emoji = prompt.ask("Have a triage emoji?")
+        @handover_report_path = prompt.ask("Please provide a path for handover report",
+                                           default: "#{Dir.pwd}/handover_reports")
 
         if (@emoji || @token || @username || @ops_token).nil?
           logger.error "Please provide a username, gitlab token, ops token, timezone and emoji used for triage."
@@ -45,6 +47,7 @@ module Dri
         config.set(:settings, :ops_token, value: @ops_token)
         config.set(:settings, :timezone, value: @timezone)
         config.set(:settings, :emoji, value: @emoji)
+        config.set(:settings, :handover_report_path, value: @handover_report_path)
         config.write(force: true)
 
         logger.success "✅ We're ready to go 🚀"

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

@@ -28,20 +28,21 @@ module Dri
           verify_config_exists
           report = Dri::Report.new(config)
 
-          logger.info "Fetching triaged failures with award emoji #{emoji}..."
+          logger.info "Fetching triaged failures and incidents with award emoji #{emoji}..."
 
           spinner.start
 
           issues = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+          incidents = api_client.fetch_triaged_incidents(emoji: emoji)
 
           spinner.stop
 
-          if issues.empty?
-            logger.warn "Found no issues associated with \"#{emoji}\" emoji. Will exit. Bye 👋"
+          if issues.empty? && incidents.empty?
+            logger.warn "Found no issues nor incidents associated with \"#{emoji}\" emoji. Will exit. Bye 👋"
             exit 1
           end
 
-          logger.info 'Assembling the failures report... '
+          logger.info 'Assembling the handover report... '
           # sets each failure on the table
           action_options = [
             'pinged SET',
@@ -71,18 +72,38 @@ module Dri
             report.add_failure(issue, actions)
           end
 
+          unless incidents.empty?
+            incidents.each do |issue|
+              report.add_incident(issue)
+            end
+          end
+
           if @options[:format] == 'list'
             # generates markdown list with failures
-            format_style = Utils::MarkdownLists.make_list(report.labels, report.failures) unless report.failures.empty?
+            unless report.failures.empty?
+              failure_report = Utils::MarkdownLists.make_list(report.labels, report.failures)
+            end
+            # generates markdown list with incidents
+            unless report.incidents.empty?
+              incidents_report = Utils::MarkdownLists.make_list(report.labels_incidents, report.incidents)
+            end
           else
             # generates markdown table with rows as failures
             unless report.failures.empty?
-              format_style = MarkdownTables.make_table(
+              failure_report = MarkdownTables.make_table(
                 report.labels,
                 report.failures,
                 is_rows: true, align: %w[l l l l l]
               )
             end
+            # generates markdown table with rows as incidents
+            unless report.incidents.empty?
+              incidents_report = MarkdownTables.make_table(
+                report.labels_incidents,
+                report.incidents,
+                is_rows: true, align: %w[l l l l]
+              )
+            end
           end
 
           spinner.stop
@@ -131,7 +152,7 @@ module Dri
           end
 
           report.set_header(timezone, username)
-          note = "#{report.header}\n\n#{format_style}"
+          note = "#{report.header}\n\n#{failure_report}\n\n#{incidents_report}"
 
           note += feature_flag_note if @options[:feature_flags]
 
@@ -141,8 +162,8 @@ module Dri
 
             spinner.start
 
-            FileUtils.mkdir_p("#{Dir.pwd}/handover_reports")
-            report_path = "handover_reports/report-#{@date}-#{@time}.md"
+            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

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

@@ -20,25 +20,35 @@ module Dri
             exit 0
           end
 
-          logger.info "Removing #{emoji} from issues..."
+          logger.info "Removing #{emoji} emoji from issues..."
 
           spinner.start
 
-          issues_with_award_emoji = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+          failures_with_award_emoji = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+          incidents_with_award_emoji = api_client.fetch_triaged_incidents(emoji: emoji)
+
+          issues_with_award_emoji = failures_with_award_emoji + incidents_with_award_emoji
 
           spinner.stop
 
+          cleared_issues_counter = 0
           issues_with_award_emoji.each do |issue|
-            logger.info "Removing #{emoji} from #{issue.web_url}..."
-
-            response = api_client.fetch_awarded_emojis(issue.iid)
+            logger.info "Removing #{emoji} emoji from #{issue.web_url}"
 
+            response = api_client.fetch_awarded_emojis(issue.iid, project_id: issue.project_id)
             emoji_found = response.find { |e| e.name == emoji && e.to_h.dig('user', 'username') == username }
 
-            api_client.delete_award_emoji(issue.iid, emoji_found.id) unless emoji_found.nil?
+            if emoji_found.nil?
+              logger.error "Emoji #{add_color(emoji, :red)} not found for username: #{add_color(username, :red)}"
+              next
+            else
+              api_client.delete_award_emoji(issue.iid, emoji_id: emoji_found.id, project_id: issue.project_id)
+              cleared_issues_counter += 1
+            end
           end
+
           output.puts "Done! ✅"
-          logger.success "Removed #{emoji} from #{issues_with_award_emoji.size} issue(s)."
+          logger.success "Removed #{emoji} from #{cleared_issues_counter} issue(s)."
         end
       end
     end

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

@@ -12,7 +12,7 @@ module Dri
         end
 
         def execute(input: $stdin, output: $stdout)
-          FileUtils.rm_rf("#{Dir.pwd}/handover_reports")
+          FileUtils.rm_rf(handover_report_path) if prompt.yes?("Remove everything in #{handover_report_path}?")
         end
       end
     end

data/lib/dri/report.rb

@@ -4,11 +4,13 @@ module Dri
   class Report # rubocop:disable Metrics/ClassLength
     using Refinements
 
-    attr_reader :header, :failures, :labels
+    attr_reader :header, :failures, :labels, :labels_incidents, :incidents
 
     def initialize(config)
       @labels = ['Title', 'Issue', 'Pipelines', 'Stack Trace', 'Actions']
+      @labels_incidents = %w[Incident Service Status URL]
       @failures = []
+      @incidents = []
       @date = Date.today
       @today = Date.today.strftime("%Y-%m-%d")
       @weekday = Date.today.strftime("%A")
@@ -21,6 +23,21 @@ module Dri
       @header = "# #{timezone}, #{@weekday} - #{@date}\n posted by: @#{username}"
     end
 
+    def add_incident(incident)
+      title = incident["title"]
+      url = incident["web_url"]
+      labels = incident["labels"]
+      status = 'N/A'
+      service = 'N/A'
+
+      labels.each do |label|
+        status = label.gsub!('Incident::', ' ').to_s if label.include? "Incident::"
+        service = label.gsub!('Service::', ' ').to_s if label.include? "Service::"
+      end
+
+      @incidents << [title, service, status, url]
+    end
+
     def add_failure(failure, actions_opts = [])
       iid = failure["iid"]
       title = format_title(failure["title"])

data/lib/dri/utils/constants.rb

@@ -49,9 +49,9 @@ module Dri
           },
           master: {
             name: "master",
-            url: "https://gitlab.com/gitlab-org/gitlab-qa-mirror",
-            project_id: "14707715",
-            search_hours_ago: 6
+            url: "https://gitlab.com/gitlab-org/gitlab",
+            project_id: "278964",
+            search_hours_ago: 3
           }
         }.freeze
     end

data/lib/dri/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch