gitlab_quality-test_tooling 1.14.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14bec41f34b3f27d3e5c1c6fe900e918a78d1fbf2e2e44f05e18abb68e533e35
-  data.tar.gz: 2613da07d940b2b4c9ee096600417a963fbf670bd5b9b3ecb44263f50775e486
+  metadata.gz: b8709476aafe6dc96d2b49d1d74b18b2e3dbf6c37cb8ebb0acd631d05dbfe2ac
+  data.tar.gz: 26d4d54613a522014b5f3b93f38c0cb62027c2e209573727265a5c2b630a6d9d
 SHA512:
-  metadata.gz: 220ca8d8ced57c9a2294f83ae4bfaacdf293ed4945bd5c986075001a0c302c98b8ddc1aa27bd735b9df8c474a56b9795f8fb44e2a35396d5900799dca0720237
-  data.tar.gz: 90af1e3e738f9196bbd8dfa20b4bb973e875e1b1d24eb1e2b6a4de5186e2fb17cfe3eff2b76e02c683e7509a806daf34b71bd8fff0499e23ca0ad0959cc54176
+  metadata.gz: 194294ffed245e88a96e35480485f98c1748a8417766cdca1cf737ece2b090a4e29efc444fa449f5f569e292333ba50954f7c07a72fbb2f9225c9195c4b6f411
+  data.tar.gz: 30cc7f3a5da1c15b5c3508e0850c007bddf9f22a85c9ec1361821be7bc330afd3869cd9fe74d3b424afc2d0ad2d180c4c0649b5f502f4740ca68f1b2c8119933

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.14.2)
+    gitlab_quality-test_tooling (1.17.0)
       activesupport (>= 6.1, < 7.1)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -318,4 +318,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.4.2
+   2.5.4

data/exe/flaky-test-issues

@@ -19,10 +19,6 @@ options = OptionParser.new do |opts|
     params[:project] = project
   end
 
-  opts.on('-m', '--merge_request_iid MERGE_REQUEST_IID', String, 'An integer merge request IID') do |merge_request_iid|
-    params[:merge_request_iid] = merge_request_iid
-  end
-
   opts.on('--base-issue-labels BASE_ISSUE_LABELS', String,
     'Comma-separated labels (without tilde) to add to new flaky test issues') do |base_issue_labels|
     params[:base_issue_labels] = base_issue_labels.split(',')
@@ -32,6 +28,10 @@ options = OptionParser.new do |opts|
     params[:token] = token
   end
 
+  opts.on('-r', '--related-issues-file RELATED_ISSUES_FILE', String, 'The file path for the related issues') do |related_issues_file|
+    params[:related_issues_file] = related_issues_file
+  end
+
   opts.on('--dry-run', "Perform a dry-run (don't create issues)") do
     params[:dry_run] = true
   end

data/lefthook.yml

@@ -13,3 +13,16 @@ pre-push:
     rubocop:
       run: bundle exec rubocop
       glob: '*.rb'
+
+    # Changelog git trailer for the first commit of the branch
+    changelog-on-first-commit:
+      run: |
+        first_commit_message=$(git log --format=%B -n 1 $(git log main..HEAD --pretty=format:"%h" | tail -1))
+        if ! echo ${first_commit_message} | grep "Changelog:"; then
+          echo Could not find a Changelog: git trailer on the first commit for this branch.
+          echo
+          echo Please add a trailer by amending the git commit message.
+          echo
+          echo See https://docs.gitlab.com/ee/development/changelog.html#overview for more info.
+          exit 1
+        fi

data/lib/gitlab_quality/test_tooling/gitlab_client/gitlab_client.rb

@@ -15,7 +15,7 @@ module GitlabQuality
           @retry_backoff = 0
         end
 
-        def handle_gitlab_client_exceptions # rubocop:disable Metrics/AbcSize
+        def handle_gitlab_client_exceptions
           yield
         rescue Gitlab::Error::NotFound
           # This error could be raised in assert_user_permission!
@@ -27,12 +27,20 @@ module GitlabQuality
 
           raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS
 
-          warn_exception(e)
+          warn("#{error.class.name} #{error.message}")
           warn("Sleeping for #{@retry_backoff} seconds before retrying...")
           sleep @retry_backoff
 
           retry
         rescue StandardError => e
+          post_exception_to_slack(e) if Runtime::Env.ci_commit_ref_name == Runtime::Env.default_branch
+
+          raise e
+        end
+
+        def post_exception_to_slack(error)
+          return unless ENV['CI_SLACK_WEBHOOK_URL']
+
           pipeline = Runtime::Env.pipeline_from_project_name
           channel = case pipeline
                     when "canary"
@@ -42,9 +50,6 @@ module GitlabQuality
                     else
                       "qa-#{pipeline}"
                     end
-          error_msg = warn_exception(e)
-
-          return unless Runtime::Env.ci_commit_ref_name == Runtime::Env.default_branch
 
           slack_options = {
             slack_webhook_url: ENV.fetch('CI_SLACK_WEBHOOK_URL', nil),
@@ -54,7 +59,7 @@ module GitlabQuality
             message: <<~MSG
               An unexpected error occurred while reporting test results in issues.
               The error occurred in job: #{Runtime::Env.ci_job_url}
-              `#{error_msg}`
+              `#{error.class.name} #{error.message}`
             MSG
           }
           puts "Posting Slack message to channel: #{channel}"
@@ -79,12 +84,6 @@ module GitlabQuality
             private_token: token
           )
         end
-
-        def warn_exception(error)
-          error_msg = "#{error.class.name} #{error.message}"
-          warn(error_msg)
-          error_msg
-        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/gitlab_client/issues_client.rb

@@ -48,6 +48,12 @@ module GitlabQuality
           end
         end
 
+        def find_issue_notes(iid:)
+          handle_gitlab_client_exceptions do
+            client.issue_notes(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+          end
+        end
+
         def find_issue_discussions(iid:)
           handle_gitlab_client_exceptions do
             client.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
@@ -75,12 +81,6 @@ module GitlabQuality
           end
         end
 
-        def find_issue_notes(iid:)
-          handle_gitlab_client_exceptions do
-            client.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
-          end
-        end
-
         def create_issue_note(iid:, note:)
           handle_gitlab_client_exceptions do
             client.create_issue_note(project, iid, note)

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb

@@ -10,7 +10,7 @@ module GitlabQuality
           end
         end
 
-        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id: nil)
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id: nil, reviewer_ids: [])
           attrs = {
             source_branch: source_branch,
             target_branch: target_branch,
@@ -18,7 +18,8 @@ module GitlabQuality
             labels: labels,
             assignee_id: assignee_id,
             squash: true,
-            remove_source_branch: true
+            remove_source_branch: true,
+            reviewer_ids: reviewer_ids
           }.compact
 
           merge_request = handle_gitlab_client_exceptions do

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb

@@ -26,10 +26,11 @@ module GitlabQuality
           puts "The following note would have been updated id: #{id} with body: #{note} for mr_iid: #{merge_request_iid}"
         end
 
-        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id:)
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id:, reviewer_ids:)
           puts "A merge request would be created with title: #{title} " \
                "source_branch: #{source_branch} target_branch: #{target_branch} " \
-               "description: #{description} labels: #{labels}, assignee_id: #{assignee_id}"
+               "description: #{description} labels: #{labels}, assignee_id: #{assignee_id}" \
+               "reviewer_ids: #{reviewer_ids}"
         end
       end
     end

data/lib/gitlab_quality/test_tooling/report/concerns/issue_reports.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/object/blank'
+
 module GitlabQuality
   module TestTooling
     module Report
       module Concerns
         module IssueReports
-          JOB_URL_REGEX                = %r{(?<job_url>https://(?<host>[\w.]+)/(?<project_path>[\w\-./]+)/-/jobs/\d+)}
+          JOB_URL_REGEX = %r{(?<job_url>https://(?<host>[\w.]+)/(?<project_path>[\w\-./]+)/-/jobs/\d+)}
           FAILED_JOB_DESCRIPTION_REGEX = /First happened in #{JOB_URL_REGEX}\./m
-          REPORT_ITEM_REGEX            = /^1\. \d{4}-\d{2}-\d{2}: #{JOB_URL_REGEX} \((?<pipeline_url>.+)\)$/
+          REPORT_ITEM_REGEX = /^1\. \d{4}-\d{2}-\d{2}: #{JOB_URL_REGEX} \((?<pipeline_url>\S+)\)/
+          LATEST_REPORTS_TO_SHOW = 10
 
           def initial_reports_section(test)
             <<~REPORTS
@@ -17,22 +20,21 @@ module GitlabQuality
             REPORTS
           end
 
-          def add_report_to_issue_description(issue, test)
-            issue_description = issue.description
-
-            # We include the number of reports in the header, for visibility.
-            new_issue_description =
-              if issue_description.include?('### Reports')
-                # We count the number of existing reports.
-                reports_count = issue_description
-                  .scan(REPORT_ITEM_REGEX)
-                  .size.to_i + 1
-                issue_description.sub(/^### Reports.*$/, "### Reports (#{reports_count})")
-              else # For issue with the legacy format, we add the Reports section
-                update_legacy_issue_description(issue_description)
-              end
+          def increment_reports(
+            current_reports_content:,
+            test:,
+            reports_section_header: '### Reports',
+            item_extra_content: nil,
+            reports_extra_content: nil)
+            preserved_content = current_reports_content.split(reports_section_header).first&.strip
+            reports = report_lines(current_reports_content) + [report_list_item(test, item_extra_content: item_extra_content)]
 
-            [new_issue_description, report_list_item(test)].join("\n")
+            [
+              preserved_content,
+              "#{reports_section_header} (#{reports.size})",
+              reports_list(reports),
+              reports_extra_content
+            ].reject(&:blank?).compact.join("\n\n")
           end
 
           def failed_issue_job_url(issue)
@@ -49,8 +51,28 @@ module GitlabQuality
 
           private
 
-          def report_list_item(test)
-            "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
+          def report_lines(content)
+            content.lines.grep(REPORT_ITEM_REGEX).map(&:strip)
+          end
+
+          def reports_list(reports)
+            sorted_reports = reports.sort.reverse
+
+            if sorted_reports.size > LATEST_REPORTS_TO_SHOW
+              [
+                "Last 10 reports:",
+                sorted_reports[...LATEST_REPORTS_TO_SHOW].join("\n"),
+                "<details><summary>See #{sorted_reports.size - LATEST_REPORTS_TO_SHOW} more reports</summary>",
+                sorted_reports[LATEST_REPORTS_TO_SHOW..].join("\n"),
+                "</details>"
+              ].join("\n\n")
+            else
+              sorted_reports.join("\n")
+            end
+          end
+
+          def report_list_item(test, item_extra_content: nil)
+            "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')}) #{item_extra_content}".strip
           end
 
           def job_urls_from_description(issue_description, regex)
@@ -60,15 +82,6 @@ module GitlabQuality
             end
           end
 
-          def update_legacy_issue_description(issue_description)
-            test_captures = issue_description.scan(JOB_URL_REGEX)
-            reports_count = test_captures.size.to_i + 1
-
-            updated_description = "#{issue_description}\n\n### Reports (#{reports_count})\n"
-            updated_description = [updated_description, *test_captures_to_report_items(test_captures)].join("\n") unless test_captures.empty?
-            updated_description
-          end
-
           def test_captures_to_report_items(test_captures)
             test_captures.map do |ci_job_url, _, _|
               report_list_item(GitlabQuality::TestTooling::TestResult::JsonTestResult.new(

data/lib/gitlab_quality/test_tooling/report/concerns/utils.rb

@@ -16,7 +16,7 @@ module GitlabQuality
           end
 
           def new_issue_title(test)
-            "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
+            "[Test] #{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
           end
 
           def partial_file_path(path)

data/lib/gitlab_quality/test_tooling/report/flaky_test_issue.rb

@@ -13,11 +13,19 @@ module GitlabQuality
       #   - Find issue by test hash
       #   - Reopen issue if it already exists, but is closed
       class FlakyTestIssue < ReportAsIssue
+        include Concerns::GroupAndCategoryLabels
         include Concerns::IssueReports
 
-        NEW_ISSUE_LABELS      = Set.new(['type::maintenance', 'priority::3', 'severity::3', 'failure::flaky-test']).freeze
-        FOUND_IN_MR_LABEL     = 'found:in MR'
-        FOUND_IN_MASTER_LABEL = 'found:master'
+        IDENTITY_LABELS       = ['test', 'failure::flaky-test', 'automation:bot-authored'].freeze
+        NEW_ISSUE_LABELS      = Set.new(['type::maintenance', 'priority::3', 'severity::3', *IDENTITY_LABELS]).freeze
+        SEARCH_LABELS         = ['test'].freeze
+        FOUND_IN_MR_LABEL     = '~"found:in MR"'
+        FOUND_IN_MASTER_LABEL = '~"found:master"'
+        REPORT_SECTION_HEADER = '### Flakiness reports'
+        REPORTS_DOCUMENTATION = <<~DOC
+          Flaky tests were detected, please refer to the [Flaky tests documentation](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html)
+          to learn more about how to reproduce them.
+        DOC
 
         def initialize(
           token:,
@@ -25,18 +33,16 @@ module GitlabQuality
           base_issue_labels: nil,
           confidential: false,
           dry_run: false,
-          merge_request_iid: nil,
           project: nil,
           **_kwargs)
           super(token: token, input_files: input_files, project: project, confidential: confidential, dry_run: dry_run)
 
           @base_issue_labels = Set.new(base_issue_labels)
-          @merge_request_iid = merge_request_iid
         end
 
         private
 
-        attr_reader :base_issue_labels, :merge_request_iid
+        attr_reader :base_issue_labels
 
         def run!
           puts "Reporting flaky tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
@@ -44,62 +50,91 @@ module GitlabQuality
           TestResults::Builder.new(files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
-            test_results.each do |test|
-              next if test.status != 'passed' # We only want failed tests that passed in the end
-
-              create_flaky_issue(test)
-            end
+            process_test_results(test_results)
           end
         end
 
-        def new_issue_title(test)
-          "Flaky test in #{super}"
-        end
+        def process_test_results(test_results)
+          test_results.each do |test|
+            next unless test_is_applicable?(test)
 
-        def new_issue_labels(_test)
-          found_label =
-            if !merge_request_iid || merge_request_iid.empty?
-              FOUND_IN_MASTER_LABEL
-            else
-              FOUND_IN_MR_LABEL
-            end
+            puts " => Reporting flakiness for test '#{test.name}'..."
 
-          NEW_ISSUE_LABELS + base_issue_labels + [found_label]
+            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: SEARCH_LABELS)
+            issues << create_issue(test) if issues.empty?
+
+            update_reports(issues, test)
+            collect_issues(test, issues)
+          end
         end
 
-        def new_issue_description(test)
-          super + [
-            "Flaky tests were detected, please refer to the [Flaky tests documentation](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html) " \
-            "to learn more about how to reproduce them.",
-            initial_reports_section(test)
-          ].compact.join("\n\n")
+        def test_is_applicable?(test)
+          test.status == 'passed' # We only want failed tests that passed in the end
         end
 
-        def create_flaky_issue(test)
-          puts "   => Finding existing issues for flaky test '#{test.name}' (run time: #{test.run_time} seconds)..."
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (base_issue_labels + super).to_a
+        end
 
-          issues = find_issues_by_hash(test_hash(test))
+        def update_reports(issues, test)
           issues.each do |issue|
-            puts "   => Existing issue link #{issue.web_url}."
+            puts "   => Adding the flaky test to the existing issue: #{issue.web_url}"
+            add_report_to_issue(issue: issue, test: test, related_issues: (issues - [issue]))
+          end
+        end
 
-            puts "   => Adding the flaky test to the existing issue..."
-            add_report_to_issue(issue, test)
+        def add_report_to_issue(issue:, test:, related_issues:)
+          reports_note = existing_reports_note(issue: issue)
+          note_body = [
+            report_body(reports_note: reports_note, test: test),
+            identity_labels_quick_action,
+            relate_issues_quick_actions(related_issues)
+          ].join("\n")
+
+          if reports_note
+            gitlab.edit_issue_note(
+              issue_iid: issue.iid,
+              note_id: reports_note.id,
+              note: note_body
+            )
+          else
+            gitlab.create_issue_note(iid: issue.iid, note: note_body)
+          end
+        end
 
-            if issue.state == 'closed'
-              puts "   => Issue is closed. Reopening it."
-              reopen_issue(issue)
-            end
+        def existing_reports_note(issue:)
+          gitlab.find_issue_notes(iid: issue.iid).find do |note|
+            note.body.start_with?(REPORT_SECTION_HEADER)
           end
+        end
 
-          create_issue(test) unless issues.any?
+        def report_body(reports_note:, test:)
+          increment_reports(
+            current_reports_content: reports_note&.body.to_s,
+            test: test,
+            reports_section_header: REPORT_SECTION_HEADER,
+            item_extra_content: found_label,
+            reports_extra_content: REPORTS_DOCUMENTATION
+          )
+        end
+
+        def found_label
+          if ENV.key?('CI_MERGE_REQUEST_IID')
+            FOUND_IN_MR_LABEL
+          else
+            FOUND_IN_MASTER_LABEL
+          end
         end
 
-        def add_report_to_issue(issue, test)
-          gitlab.edit_issue(iid: issue.iid, options: { description: add_report_to_issue_description(issue, test) })
+        def identity_labels_quick_action
+          labels_list = IDENTITY_LABELS.map { |label| %(~"#{label}") }.join(' ')
+          %(/label #{labels_list})
         end
 
-        def reopen_issue(issue)
-          gitlab.edit_issue(iid: issue.iid, options: { state_event: 'reopen' })
+        def relate_issues_quick_actions(issues)
+          issues.map do |issue|
+            "/relate #{issue.web_url}"
+          end.join("\n")
         end
       end
     end

data/lib/gitlab_quality/test_tooling/report/generate_test_session.rb

@@ -205,12 +205,9 @@ module GitlabQuality
 
         def generate_test_text(testcase, tests_with_same_testcase, passed)
           text = tests_with_same_testcase.map(&:name).uniq.join(', ')
-          encoded_text = ERB::Util.url_encode(text)
 
           if testcase && !passed
-            # Workaround for reducing system notes on testcase issues
-            # The first regex extracts the link to the issues list page from a link to a single issue show page by removing the issue id.
-            "[#{text}](#{testcase.match(%r{[\s\S]+/[^/\d]+})}?state=opened&search=#{encoded_text})"
+            "[#{text}](#{testcase})"
           else
             text
           end

data/lib/gitlab_quality/test_tooling/report/knapsack_report_issue.rb

@@ -99,7 +99,6 @@ module GitlabQuality
         end
 
         def update_issue(issue:, spec_run_time:)
-          state_event = issue.state == 'closed' ? 'reopen' : nil
           updated_description = <<~MARKDOWN.chomp
           #{issue.description}
 
@@ -110,8 +109,6 @@ module GitlabQuality
             description: updated_description
           }
 
-          issue_attrs[:state_event] = state_event if state_event
-
           gitlab.edit_issue(iid: issue.iid, options: issue_attrs)
           puts "  => Added a report in #{issue.web_url}!"
         end

data/lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb

@@ -190,8 +190,8 @@ module GitlabQuality
         end
 
         def failure_issues(test)
-          find_issues_for_test(
-            test,
+          find_issues_by_hash(
+            test_hash(test),
             state: 'opened',
             labels: base_issue_labels + Set.new(%w[test]),
             not_labels: exclude_labels_for_search
@@ -268,7 +268,7 @@ module GitlabQuality
           if stacktrace_match
             stacktrace_match[:stacktrace].gsub(/^\s*#.*$/, '').gsub(/^[[:space:]]+/, '').strip
           else
-            puts "  => [DEBUG] Stacktrace doesn't match the regex (#{regex}):\n----------------\n#{stacktrace}\n----------------\n"
+            puts "  => [DEBUG] Stacktrace doesn't match the regex (#{regex})!"
           end
         end
 
@@ -347,7 +347,7 @@ module GitlabQuality
           state_event = issue.state == 'closed' ? 'reopen' : nil
 
           issue_attrs = {
-            description: add_report_to_issue_description(issue, test),
+            description: increment_reports(current_reports_content: issue.description, test: test),
             labels: up_to_date_labels(test: test, issue: issue)
           }
           issue_attrs[:state_event] = state_event if state_event
@@ -356,10 +356,6 @@ module GitlabQuality
           puts "  => Added a report in '#{issue.title}': #{issue.web_url}!"
         end
 
-        def new_issue_title(test)
-          "Failure in #{super}"
-        end
-
         def screenshot_section(test)
           return unless test.screenshot?
 

data/lib/gitlab_quality/test_tooling/report/report_as_issue.rb

@@ -60,7 +60,7 @@ module GitlabQuality
           | Description | `#{test.name}` |
           | Test level | #{test.level} |
           | Hash | `#{test_hash(test)}` |
-          | Duration | #{test.run_time} seconds |
+          | Reference duration | #{test.run_time} seconds |
           | Expected duration | < #{test.max_duration_for_test} seconds |
           #{"| Test case | #{test.testcase} |" if test.testcase}
           DESCRIPTION
@@ -142,8 +142,10 @@ module GitlabQuality
           labels
         end
 
-        def find_issues_by_hash(test_hash)
-          search_options = { search: test_hash }
+        def find_issues_by_hash(test_hash, labels: Set.new, not_labels: Set.new, state: nil)
+          search_options = { search: test_hash, labels: labels.to_a, not: { labels: not_labels.to_a } }
+          search_options[:state] = state if state
+          search_options[:in] = 'description'
           gitlab.find_issues(options: search_options)
         end
 

data/lib/gitlab_quality/test_tooling/report/slow_test_issue.rb

@@ -10,16 +10,21 @@ module GitlabQuality
       # - Find issue by title (with test description or test file)
       # - Add test metadata, duration to the issue with group and category labels
       class SlowTestIssue < ReportAsIssue
-        include TestTooling::Concerns::FindSetDri
         include Concerns::GroupAndCategoryLabels
+        include Concerns::IssueReports
 
-        NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'rspec profiling', 'rspec:slow test']).freeze
-        SEARCH_LABELS = %w[test maintenance::performance].freeze
+        IDENTITY_LABELS       = ['test', 'rspec:slow test', 'rspec profiling', 'automation:bot-authored'].freeze
+        NEW_ISSUE_LABELS      = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3']).freeze
+        SEARCH_LABELS         = ['test'].freeze
+        FOUND_IN_MR_LABEL     = '~"found:in MR"'
+        FOUND_IN_MASTER_LABEL = '~"found:master"'
+        REPORT_SECTION_HEADER = '### Slowness reports'
+        REPORTS_DOCUMENTATION = <<~DOC
+          Slow tests were detected, please see the [test speed best practices guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#test-speed)
+          to improve them. More context available about this issue in the [top slow tests guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#top-slow-tests).
 
-        JOB_URL_REGEX = %r{(?<job_url>https://(?<host>[\w.]+)/(?<project_path>[\w\-./]+)/-/jobs/\d+)}
-        REPORT_ITEM_REGEX = /^1\. \d{4}-\d{2}-\d{2}: #{JOB_URL_REGEX} \((?<pipeline_url>.+)\)$/
-
-        MultipleIssuesFound = Class.new(StandardError)
+          Add `allowed_to_be_slow: true` to the RSpec test if this is a legit slow test and close the issue.
+        DOC
 
         private
 
@@ -29,99 +34,87 @@ module GitlabQuality
           TestResults::Builder.new(files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
-            test_results.each do |test|
-              create_slow_issue(test) if test.slow_test?
-            end
+            process_test_results(test_results)
           end
         end
 
-        def new_issue_title(test)
-          "Slow test in #{super}"
-        end
+        def process_test_results(test_results)
+          test_results.each do |test|
+            next unless test.slow_test?
 
-        def new_issue_description(test)
-          super +
-            <<~DESCRIPTION.chomp
-              Slow tests were detected, please see the [test speed best practices guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#test-speed)
-              to improve them. More context available about this issue in the [top slow tests guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#top-slow-tests).
+            puts " => Reporting slowness for test '#{test.name}'..."
 
-              Add `allowed_to_be_slow: true` to the RSpec test if this is a legit slow test and close the issue.
+            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: SEARCH_LABELS)
+            issues << create_issue(test) if issues.empty?
 
-              #{reports_section(test)}
-            DESCRIPTION
+            update_reports(issues, test)
+            collect_issues(test, issues)
+          end
         end
 
-        def reports_section(test)
-          <<~REPORTS
-          ### Reports (1)
-
-          #{report_list_item(test)}
-          REPORTS
+        def test_is_applicable?(test)
+          test.slow_test?
         end
 
-        def report_list_item(test)
-          "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
+        def update_reports(issues, test)
+          issues.each do |issue|
+            puts "   => Adding the slow test to the existing issue: #{issue.web_url}"
+            add_report_to_issue(issue: issue, test: test, related_issues: (issues - [issue]))
+          end
         end
 
-        def slow_test_issues(test)
-          find_issues_for_test(
-            test,
-            state: 'opened',
-            labels: SEARCH_LABELS
-          )
+        def add_report_to_issue(issue:, test:, related_issues:)
+          reports_note = existing_reports_note(issue: issue)
+          note_body = [
+            report_body(reports_note: reports_note, test: test),
+            identity_labels_quick_action,
+            relate_issues_quick_actions(related_issues)
+          ].join("\n")
+
+          if reports_note
+            gitlab.edit_issue_note(
+              issue_iid: issue.iid,
+              note_id: reports_note.id,
+              note: note_body
+            )
+          else
+            gitlab.create_issue_note(iid: issue.iid, note: note_body)
+          end
         end
 
-        def create_slow_issue(test)
-          puts "   => Finding existing issues for slow test '#{test.name}' (run time: #{test.run_time} seconds)..."
+        def existing_reports_note(issue:)
+          gitlab.find_issue_notes(iid: issue.iid).find do |note|
+            note.body.start_with?(REPORT_SECTION_HEADER)
+          end
+        end
 
-          issues = slow_test_issues(test)
+        def report_body(reports_note:, test:)
+          increment_reports(
+            current_reports_content: reports_note&.body.to_s,
+            test: test,
+            reports_section_header: REPORT_SECTION_HEADER,
+            item_extra_content: found_label,
+            reports_extra_content: REPORTS_DOCUMENTATION
+          )
+        end
 
-          if issues.blank?
-            issues << create_issue(test)
+        def found_label
+          if ENV.key?('CI_MERGE_REQUEST_IID')
+            FOUND_IN_MR_LABEL
           else
-            issues.each do |issue|
-              puts "   => Existing issue link #{issue['web_url']}"
-
-              update_reports(issue, test)
-            end
+            FOUND_IN_MASTER_LABEL
           end
-
-          collect_issues(test, issues)
-        rescue MultipleIssuesFound => e
-          warn(e.message)
         end
 
-        def update_reports(issue, test)
-          # We reopen closed issues to not lose any history
-          state_event = issue.state == 'closed' ? 'reopen' : nil
-
-          issue_attrs = {
-            description: up_to_date_issue_description(issue.description, test)
-          }
-
-          issue_attrs[:state_event] = state_event if state_event
-
-          gitlab.edit_issue(iid: issue.iid, options: issue_attrs)
-          puts "  => Added a report in '#{issue.title}': #{issue.web_url}!"
+        def identity_labels_quick_action
+          labels_list = IDENTITY_LABELS.map { |label| %(~"#{label}") }.join(' ')
+          %(/label #{labels_list})
         end
 
-        def up_to_date_issue_description(issue_description, test)
-          new_issue_description =
-            if issue_description.include?('### Reports')
-              # We count the number of existing reports.
-              reports_count = issue_description
-                .scan(REPORT_ITEM_REGEX)
-                .size.to_i + 1
-              issue_description.sub(/^### Reports.*$/, "### Reports (#{reports_count})")
-            else # For issue with the legacy format, we add the Reports section
-              reports_count = issue_description
-                .scan(JOB_URL_REGEX)
-                .size.to_i + 1
-
-              "#{issue_description}\n\n### Reports (#{reports_count})"
-            end
-
-          "#{new_issue_description}\n#{report_list_item(test)}"
+        def relate_issues_quick_actions(issues)
+          issues.map do |issue|
+            "/relate #{issue.web_url}"
+          end.join("\n")
         end
       end
     end

data/lib/gitlab_quality/test_tooling/runtime/env.rb

@@ -33,6 +33,10 @@ module GitlabQuality
           env_var_value_if_defined('QA_LOG_LEVEL')&.upcase || 'INFO'
         end
 
+        def gitlab_bot_username
+          env_var_value_if_defined('GITLAB_BOT_USERNAME') || 'gitlab-bot'
+        end
+
         def log_path
           env_var_value_if_defined('QA_LOG_PATH') || host_artifacts_dir
         end

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_blocking_processor.rb

@@ -14,41 +14,48 @@ module GitlabQuality
             # @param [TestMetaUpdater] context instance of TestMetaUpdater
             def execute(spec, context) # rubocop:disable Metrics/AbcSize
               @context = context
-
+              @existing_mrs = nil
               @file_path = spec["file_path"]
+              testcase = spec["testcase"]
               devops_stage = spec["stage"]
               product_group = spec["product_group"]
               @example_name = spec["name"]
-              @mr_title = format("%{prefix} %{example_name}", prefix: '[PROMOTE TO BLOCKING]', example_name: example_name)
-
-              return unless proceed_with_merge_request?
+              @mr_title = format("%{prefix} %{example_name}", prefix: '[PROMOTE TO BLOCKING]', example_name: example_name).truncate(72, omission: '')
 
               @file_contents = context.get_file_contents(file_path)
 
-              new_content, changed_line_no = add_blocking_metadata
+              new_content, @changed_line_no = add_blocking_metadata
 
-              return if changed_line_no.negative?
+              return unless proceed_with_merge_request?
 
               branch = context.create_branch("blocking-promotion-#{SecureRandom.hex(4)}", example_name, context.ref)
 
               context.commit_changes(branch, <<~COMMIT_MESSAGE, file_path, new_content)
                 Promote end-to-end test to blocking
 
-                Promote to blocking: #{example_name}
+                #{"Promote to blocking: #{example_name}".truncate(72)}
               COMMIT_MESSAGE
 
-              assignee_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage)
+              reviewer_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage)
+
+              gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
 
-              merge_request = context.create_merge_request(mr_title, branch, assignee_id) do
+              merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id, [reviewer_id]) do
                 <<~MARKDOWN
                   ## What does this MR do?
 
                   Promotes the test [`#{example_name}`](https://gitlab.com/#{context.project}/-/blob/#{context.ref}/#{file_path}#L#{changed_line_no + 1})
                   to the blocking bucket
 
+                  This test was identified in the reliable e2e test report: #{context.report_issue}
+
+                  [Testcase link](#{testcase})
+
+                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
 
                   /label ~"Quality" ~"QA" ~"type::maintenance"
                   /label ~"devops::#{devops_stage}"
+                  #{context.label_from_product_group(product_group)}
 
                   <div align="center">
                   (This MR was automatically generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling) at #{Time.now.utc})
@@ -62,6 +69,11 @@ module GitlabQuality
                 If you think this MR should not be merged, please close it and add a note of the reason to the blocking report: #{context.report_issue}
               MARKDOWN
 
+              if merge_request
+                context.add_processed_record({ file_path => changed_line_no })
+                Runtime::Logger.info("  Created MR for promotion to blocking: #{merge_request.web_url}")
+              end
+
               merge_request
             end
 
@@ -82,15 +94,20 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title
+            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title, :changed_line_no
 
             # Checks if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_merge_request?
-              open_mrs = context.existing_merge_requests(title: mr_title)
-              if open_mrs&.any?
-                puts "  An open MR already exists for '#{example_name}':  #{open_mrs.first['web_url']}. Will not proceed with creating MR."
+            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
+              if changed_line_no.negative?
+                Runtime::Logger.info("  No lines were changed in #{file_path}. Will not proceed with creating MR.")
+                return false
+              elsif context.record_processed?(file_path, changed_line_no)
+                Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
+              elsif existing_mrs&.any?
+                Runtime::Logger.info("  An open MR already exists for '#{example_name}':  #{existing_mrs.first['web_url']}. Will not proceed with creating MR.")
                 return false
               end
 
@@ -109,8 +126,8 @@ module GitlabQuality
               end
 
               context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
-                if line.include?(',')
-                  line[line.index(',')] = format(BLOCKING_METADATA, suffix: ',')
+                if line.sub(DESCRIPTION_REGEX, '').include?(',')
+                  line[line.index(',', end_of_description_index(line))] = format(BLOCKING_METADATA, suffix: ',')
                 else
                   line[line.rindex(' ')] = format(BLOCKING_METADATA, suffix: ' ')
                 end

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_quarantine_processor.rb

@@ -24,30 +24,34 @@ module GitlabQuality
             # @param [TestMetaUpdater] context instance of TestMetaUpdater
             def execute(spec, context) # rubocop:disable Metrics/AbcSize
               @context = context
-
+              @existing_mrs = nil
               @file_path = spec["file_path"]
+              testcase = spec["testcase"]
               devops_stage = spec["stage"]
+              product_group = spec["product_group"]
               @failure_issue_url = spec["failure_issue"]
               @example_name = spec["name"]
               @issue_id = failure_issue_url.split('/').last # split url segment, last segment of path is the issue id
-              @mr_title = format("%{prefix} %{example_name}", prefix: '[QUARANTINE]', example_name: example_name)
+              @mr_title = format("%{prefix} %{example_name}", prefix: '[QUARANTINE]', example_name: example_name).truncate(72, omission: '')
               @failure_issue = context.fetch_issue(iid: issue_id)
 
-              return unless proceed_with_merge_request?
-
               @file_contents = context.get_file_contents(file_path)
 
-              new_content, changed_line_no = add_quarantine_metadata
+              new_content, @changed_line_no = add_quarantine_metadata
+
+              return unless proceed_with_merge_request?
 
               branch = context.create_branch("#{issue_id}-quarantine-#{SecureRandom.hex(4)}", example_name, context.ref)
 
               context.commit_changes(branch, <<~COMMIT_MESSAGE, file_path, new_content)
                 Quarantine end-to-end test
 
-                Quarantine #{example_name}
+                #{"Quarantine #{example_name}".truncate(72)}
               COMMIT_MESSAGE
 
-              context.create_merge_request(mr_title, branch) do
+              gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
+
+              merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id) do
                 <<~MARKDOWN
                   ## What does this MR do?
 
@@ -55,6 +59,10 @@ module GitlabQuality
 
                   This test was identified in the reliable e2e test report: #{context.report_issue}
 
+                  [Testcase link](#{testcase})
+
+                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
+
                   ### E2E Test Failure issue(s)
 
                   #{failure_issue_url}
@@ -79,12 +87,20 @@ module GitlabQuality
                   `qa/specs/features/browser_ui/3_create/web_ide/add_file_template_spec.rb`.
                   -->
                   /label ~"devops::#{devops_stage}"
+                  #{context.label_from_product_group(product_group)}
 
                   <div align="center">
                   (This MR was automatically generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling) at #{Time.now.utc})
                   </div>
                 MARKDOWN
               end
+
+              if merge_request
+                context.add_processed_record({ file_path => changed_line_no })
+                Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+              end
+
+              merge_request
             end
 
             # Performs post processing. Takes a list of MRs and posts them in a note on report_issue and Slack
@@ -114,20 +130,21 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name, :issue_id, :mr_title, :failure_issue
+            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
+              :issue_id, :mr_title, :failure_issue, :changed_line_no
 
             # Checks if the failure issue is closed or if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_merge_request?
+            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
               if context.issue_is_closed?(failure_issue)
-                puts "  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR."
+                Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR.")
                 return false
-              end
-
-              open_mrs = context.existing_merge_requests(title: mr_title)
-              if open_mrs.any?
-                puts "  An open MR already exists for '#{example_name}':  #{open_mrs.first['web_url']}. Will not proceed with creating MR."
+              elsif context.record_processed?(file_path, changed_line_no)
+                Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
+              elsif existing_mrs&.any?
+                Runtime::Logger.info("  An open MR already exists for '#{example_name}':  #{existing_mrs.first['web_url']}. Will not proceed with creating MR.")
                 return false
               end
 
@@ -143,8 +160,8 @@ module GitlabQuality
               context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
                 indentation = context.indentation(line)
 
-                if line.include?(',') && line.split.last != 'do'
-                  line[line.index(',')] = format(QUARANTINE_METADATA.rstrip, issue_url: failure_issue_url, indentation: indentation, suffix: ',', quarantine_type: quarantine_type)
+                if line.sub(DESCRIPTION_REGEX, '').include?(',') && line.split.last != 'do'
+                  line[line.rindex(',')] = format(QUARANTINE_METADATA.rstrip, issue_url: failure_issue_url, indentation: indentation, suffix: ',', quarantine_type: quarantine_type)
                 else
                   line[line.rindex(' ')] = format(QUARANTINE_METADATA.rstrip, issue_url: failure_issue_url, indentation: indentation, suffix: ' ', quarantine_type: quarantine_type)
                 end
@@ -160,8 +177,6 @@ module GitlabQuality
               case context.issue_scoped_label(failure_issue, 'failure')&.split('::')&.last
               when 'new', 'investigating'
                 ':investigating'
-              when 'external-dependency'
-                ':external_dependency'
               when 'broken-test'
                 ':broken'
               when 'bug'

data/lib/gitlab_quality/test_tooling/test_meta/processor/meta_processor.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/filters'
+
 module GitlabQuality
   module TestTooling
     module TestMeta
       module Processor
         class MetaProcessor
           class << self
+            DESCRIPTION_REGEX = /('.*?')|(".*?")/
+
             def execute
               raise 'method not implemented'
             end
@@ -15,6 +19,23 @@ module GitlabQuality
             end
 
             private_class_method :new
+
+            # Fetch existing MRs for given mr title
+            #
+            # @return [Array<Gitlab::ObjectifiedHash>]
+            def existing_mrs
+              @existing_mrs ||= context.existing_merge_requests(title: mr_title)
+            end
+
+            # Returns the index of the end of test description
+            #
+            # @param [String] line The line containing the test description
+            # @return [Integer]
+            def end_of_description_index(line)
+              description_length = line.match(DESCRIPTION_REGEX)[0].length
+              description_start_index = line.index(DESCRIPTION_REGEX)
+              description_start_index + description_length
+            end
           end
         end
       end

data/lib/gitlab_quality/test_tooling/test_meta/test_meta_updater.rb

@@ -8,7 +8,7 @@ module GitlabQuality
       class TestMetaUpdater
         include TestTooling::Concerns::FindSetDri
 
-        attr_reader :project, :ref, :report_issue
+        attr_reader :project, :ref, :report_issue, :processed_records
 
         TEST_PLATFORM_MAINTAINERS_SLACK_CHANNEL_ID = 'C0437FV9KBN' # test-platform-maintainers
 
@@ -19,6 +19,7 @@ module GitlabQuality
           @ref = ref
           @dry_run = dry_run
           @processor = processor
+          @processed_records = {}
         end
 
         def invoke!
@@ -33,10 +34,20 @@ module GitlabQuality
           end
         end
 
+        # Add processed records
+        #
+        # @param [Hash<String,Integer>] record the processed record
+        # @option record [String] :file_path the path to the spec file
+        # @option spec [Intenger] :changed_line_no the line number change in file_path
+        # @return [Hash<String,Integer>] processed_records
+        def add_processed_record(record)
+          @processed_records.merge!(record)
+        end
+
         # Fetch contents of file from the repository
         #
-        # [String] file_path path to the file
-        # [String] contents of the file
+        # @param [String] file_path path to the file
+        # @return [String] contents of the file
         def get_file_contents(file_path)
           repository_files = GitlabClient::RepositoryFilesClient.new(token: token, project: project, file_path: file_path)
           repository_files.file_contents
@@ -110,8 +121,10 @@ module GitlabQuality
         # @param [String] example_name the example
         # @param [Gitlab::ObjectifiedHash] branch the branch
         # @param [Integer] assignee_id
+        # @param [Array<Integer>] reviewer_ids
+        # @param [String] labels comma seperated list of labels
         # @return [Gitlab::ObjectifiedHash] the created merge request
-        def create_merge_request(title, branch, assignee_id = nil, labels = '')
+        def create_merge_request(title, branch, assignee_id = nil, reviewer_ids = [], labels = '')
           description = yield
 
           merge_request_client.create_merge_request(
@@ -120,7 +133,8 @@ module GitlabQuality
             target_branch: ref,
             description: description,
             labels: labels,
-            assignee_id: assignee_id)
+            assignee_id: assignee_id,
+            reviewer_ids: reviewer_ids)
         end
 
         # Check if issue is closed
@@ -179,7 +193,15 @@ module GitlabQuality
         def fetch_dri_id(product_group, devops_stage)
           assignee_handle = ENV.fetch('QA_TEST_DRI_HANDLE', nil) || set_dri_via_group(product_group, devops_stage)
 
-          [issue_client.find_user_id(username: assignee_handle), assignee_handle]
+          [user_id_for_username(assignee_handle), assignee_handle]
+        end
+
+        # Fetch id for the given GitLab username/handle
+        #
+        # @param [String] username
+        # @return [Integer]
+        def user_id_for_username(username)
+          issue_client.find_user_id(username: username)
         end
 
         # Post a message on Slack
@@ -221,6 +243,34 @@ module GitlabQuality
           merge_request_client.find(options: { search: title, in: 'title', state: 'opened' })
         end
 
+        # Checks if changes has already been made to given file and line number
+        #
+        # @param [String] file_path path to the file
+        # @param [Integer] changed_line_no updated line number
+        # @return [Boolean]
+        def record_processed?(file_path, changed_line_no)
+          processed_records[file_path] && processed_records[file_path] == changed_line_no
+        end
+
+        # Infers product group label from the provided product group
+        #
+        # @param [String] product_group product group
+        # @return [String]
+        def label_from_product_group(product_group)
+          label = labels_inference.infer_labels_from_product_group(product_group).to_a.first
+
+          label ? %(/label ~"#{label}") : ''
+        end
+
+        # Returns the link to the Grafana dashboard for single spec metrics
+        #
+        # @param [String] example_name the full example name
+        # @return [String]
+        def single_spec_metrics_link(example_name)
+          base_url = "https://dashboards.quality.gitlab.net/d/cW0UMgv7k/single-spec-metrics?orgId=1&var-run_type=All&var-name="
+          base_url + CGI.escape(example_name)
+        end
+
         private
 
         attr_reader :token, :specs_file, :dry_run, :processor
@@ -250,6 +300,13 @@ module GitlabQuality
             project: project
           )
         end
+
+        # Returns a cached instance of GitlabQuality::TestTooling::LabelsInference
+        #
+        #  @return [GitlabQuality::TestTooling::LabelsInference]
+        def labels_inference
+          @labels_inference ||= GitlabQuality::TestTooling::LabelsInference.new
+        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.14.2"
+    VERSION = "1.17.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.17.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control