gitlab_quality-test_tooling 1.27.1 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34edb6377d3304f4b061a5704e9ba865cd550209c7fefda3c66b6734f2b95ce5
-  data.tar.gz: e00f10eaf9690f803168a86da44417b5bdc02f074773819f6deb6fa466bef23e
+  metadata.gz: ca3b15faac90436068b21df05071cbcd06dd1a71d33b3220a58d17201a893a2d
+  data.tar.gz: dee6c41cfe097f6af193890eee46a95a17f1fa7724377fb8529f75142931bbb1
 SHA512:
-  metadata.gz: 3ced20afebe7dbdcc5e47fcc3c864db514bd2d2b4920d6085683c201444243e5ec023cde39c7d333d28acd6a2539f35dfe6af21ee881d2442f48e5c4335b164c
-  data.tar.gz: 9d279b982fb6438e064db0336b532fbd0ba7e803e16b65e678576fca037120cc7a327bba21d6ab3400122e6aee18060e900eb14d1063aed77f61d57df73f8cab
+  metadata.gz: ab45b4d7059cfb911b103f952f0e072dd578057a24fb539ac322087b09d4cd646ecdeb0c7a528427cd378f67a056d374a663c1effb62945a2001b18fea26af8c
+  data.tar.gz: 387923350e8554c3fd99d17d3a1ea502768d4cfc251805a5c76a17bca950ef28e616ec161eb329c0482b678f5e3a037c3235ca6562eb93008e57c6963838a3ba

data/.rubocop.yml

@@ -8,8 +8,8 @@ inherit_from:
   <% end %>
 
 AllCops:
-  # Target the current Ruby version. For example, "2.7" or "3.0".
-  TargetRubyVersion: <%= RUBY_VERSION[/^\d+\.\d+/, 0] %>
+  # The oldest supported Ruby version.
+  TargetRubyVersion: 3.1
   Exclude:
     - 'vendor/**/*'
     - 'tmp/**/*'
@@ -63,3 +63,12 @@ Layout/SpaceBeforeFirstArg:
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+
+# Short-hand Hash syntax does not work prior 3.1.
+# See https://gitlab.com/gitlab-org/gitlab/-/issues/435940#note_1703307479
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+# Anonymous block forwarding does not work prior 3.1.
+Naming/BlockForwarding:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.27.1)
+    gitlab_quality-test_tooling (1.29.0)
       activesupport (>= 7.0, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -330,4 +330,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.5.4
+   2.5.6

data/exe/post-to-slack

@@ -7,6 +7,7 @@ require "optparse"
 require_relative "../lib/gitlab_quality/test_tooling"
 
 params = {}
+summary_table_opts = {}
 
 messages = []
 gitlab_api_token = nil
@@ -30,8 +31,24 @@ options = OptionParser.new do |opts|
     messages << message
   end
 
+  opts.on('-s', '--sort-by SORT', String,
+    'Used with the `--include-summary-table` flag — An optional sort for the test summary table. This flag must be positioned before `--include-summary-table`') do |sort_by|
+    valid_options = ["Dev Stage", "Total", "Failures", "Errors", "Skipped", "Result"].freeze
+
+    raise ArgumentError, "Invalid sort option: #{sort_by}. Valid options are: #{valid_options.join(', ')}" unless valid_options.include?(sort_by)
+
+    summary_table_opts[:sort_by] = sort_by
+  end
+
+  opts.on('-d', '--sort-direction [asc|desc]', String,
+    'Used with the `--sort-by` flag — Define the sort direction of the test summary table (default: `asc`)') do |sort_direction|
+    raise ArgumentError, "Invalid sort direction: #{sort_direction}. Valid options are: asc, desc" unless %w[asc desc].include?(sort_direction.downcase)
+
+    summary_table_opts[:sort_direction] = sort_direction.downcase.to_sym
+  end
+
   opts.on('-t', '--include-summary-table FILES', String, 'Add a test summary table based on RSpec report files (JUnit XML)') do |files|
-    messages << GitlabQuality::TestTooling::SummaryTable.create(input_files: files)
+    params[:summary_table_files] = files
   end
 
   opts.on('-j', '--include-failed-jobs-table', 'Add a list of failed jobs in the pipeline') do
@@ -71,9 +88,10 @@ options = OptionParser.new do |opts|
   opts.parse(ARGV)
 end
 
-params[:message] = messages.join("\n")
-
 if params.any?
+  messages << GitlabQuality::TestTooling::SummaryTable.create(input_files: params.delete(:summary_table_files), **summary_table_opts) if params.key?(:summary_table_files)
+  params[:message] = messages.join("\n")
+
   GitlabQuality::TestTooling::Slack::PostToSlack.new(**params).invoke!
 else
   puts options

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

@@ -18,6 +18,10 @@ module GitlabQuality
             client.file_contents(project, file_path.gsub(%r{^/}, ""), ref)
           end
         end
+
+        def file_contents_at_line(line_number)
+          file_contents.lines(chomp: true)[line_number - 1]
+        end
       end
     end
   end

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

@@ -9,8 +9,9 @@ module GitlabQuality
         module IssueReports
           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>\S+)\)/
+          REPORT_ITEM_REGEX = /^1\. (?<report_date>\d{4}-\d{2}-\d{2}): #{JOB_URL_REGEX} \((?<pipeline_url>\S+)\) ?(?<extra_content>.*)$/
           LATEST_REPORTS_TO_SHOW = 10
+          DAILY_REPORTS_THRESHOLDS = 10
 
           class ReportsList
             def initialize(preserved_content:, section_header:, reports:, extra_content:)
@@ -21,7 +22,12 @@ module GitlabQuality
             end
 
             def self.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
+              ReportListItem.new(job_url: test.ci_job_url, extra_content: item_extra_content)
+            end
+
+            def self.parse_report_date_from_string(date_string)
+              parsed_time = Time.strptime(date_string, '%F')
+              Time.utc(parsed_time.year, parsed_time.month, parsed_time.day)
             end
 
             def reports_count
@@ -32,21 +38,27 @@ module GitlabQuality
               [
                 preserved_content,
                 "#{section_header} (#{reports_count})",
-                reports_list(reports),
+                reports_list,
                 extra_content
               ].reject(&:blank?).compact.join("\n\n")
             end
 
+            def spiked_in_short_period?
+              latest_report = sorted_reports.first
+
+              reports_for_latest_report_day = sorted_reports.count { |report| report.report_date == latest_report.report_date }
+
+              reports_for_latest_report_day >= DAILY_REPORTS_THRESHOLDS
+            end
+
             private
 
             attr_reader :preserved_content, :section_header, :reports, :extra_content
 
-            def reports_list(reports)
-              sorted_reports = reports.sort.reverse
-
+            def reports_list
               if sorted_reports.size > LATEST_REPORTS_TO_SHOW
                 [
-                  "Last 10 reports:",
+                  "Last #{LATEST_REPORTS_TO_SHOW} 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"),
@@ -56,6 +68,41 @@ module GitlabQuality
                 sorted_reports.join("\n")
               end
             end
+
+            def sorted_reports
+              @sorted_reports ||= reports.sort.reverse
+            end
+          end
+
+          class ReportListItem
+            attr_reader :report_date
+
+            def initialize(job_url:, report_date: now, pipeline_url: default_pipeline_url, extra_content: '')
+              @job_url = job_url
+              @report_date = report_date
+              @pipeline_url = pipeline_url
+              @extra_content = extra_content
+            end
+
+            def to_s
+              "1. #{report_date}: #{job_url} (#{pipeline_url}) #{extra_content}".strip
+            end
+
+            def <=>(other)
+              to_s <=> other.to_s
+            end
+
+            private
+
+            attr_reader :job_url, :pipeline_url, :extra_content
+
+            def default_pipeline_url
+              ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')
+            end
+
+            def now
+              Time.new.utc.strftime('%F')
+            end
           end
 
           def initial_reports_section(test)
@@ -98,7 +145,13 @@ module GitlabQuality
           private
 
           def report_lines(content)
-            content.lines.grep(REPORT_ITEM_REGEX).map(&:strip)
+            content.lines.filter_map do |line|
+              match = line.match(REPORT_ITEM_REGEX)
+              next unless match
+
+              match_data_hash = match.named_captures.transform_keys(&:to_sym)
+              ReportListItem.new(**match_data_hash.slice(:job_url, :report_date, :pipeline_url, :extra_content))
+            end
           end
 
           def job_urls_from_description(issue_description, regex)

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

@@ -10,16 +10,9 @@ module GitlabQuality
       # - For every passed test in the report:
       #   - Find issue by test hash or create a new issue if no issue was found
       #   - Add a failure report in the "Failure reports" note
-      class FailedTestIssue < ReportAsIssue
-        include Concerns::GroupAndCategoryLabels
-        include Concerns::IssueReports
-
+      class FailedTestIssue < HealthProblemReporter
         IDENTITY_LABELS       = ['test', 'automation:bot-authored'].freeze
         NEW_ISSUE_LABELS      = Set.new(['type::maintenance', 'failure::new', 'priority::3', 'severity::3', *IDENTITY_LABELS]).freeze
-        SEARCH_LABELS         = ['test'].freeze
-        FOUND_IN_MR_LABEL     = '~"found:in MR"'
-        FOUND_IN_MASTER_LABEL = '~"found:master"'
-        REPORTS_DISCUSSION_HEADER = '### Failure reports'
         REPORT_SECTION_HEADER = '#### Failure reports'
 
         FAILURE_STACKTRACE_REGEX = %r{(?:(?:.*Failure/Error:(?<stacktrace>.+))|(?<stacktrace>.+))}m
@@ -42,93 +35,36 @@ module GitlabQuality
 
         attr_reader :base_issue_labels, :max_diff_ratio
 
-        def run!
-          puts "Reporting failed tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
-
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
-            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
-
-            process_test_results(test_results)
-          end
-        end
-
-        def process_test_results(test_results)
-          test_results.each do |test|
-            next unless test_is_applicable?(test)
-
-            puts " => Reporting failure for test '#{test.name}'..."
-
-            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: SEARCH_LABELS)
-
-            if issues.empty?
-              issues << create_issue(test)
-            else
-              # Keep issues description up-to-date
-              update_issues(issues, test)
-            end
-
-            update_reports(issues, test)
-            collect_issues(test, issues)
-          end
+        def problem_type
+          'failed'
         end
 
         def test_is_applicable?(test)
           test.status == 'failed'
         end
 
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          (base_issue_labels + super).to_a
+        def report_in_discussion?
+          true
         end
 
-        def update_reports(issues, test)
-          issues.each do |issue|
-            puts "   => Adding the failed test to the existing issue: #{issue.web_url}"
-            add_report_to_issue(issue: issue, test: test, related_issues: (issues - [issue]))
-          end
+        def identity_labels
+          IDENTITY_LABELS
         end
 
-        def add_report_to_issue(issue:, test:, related_issues:) # rubocop:disable Metrics/AbcSize:
-          reports_discussion = find_or_create_reports_discussion(issue: issue)
-          current_reports_note = find_failure_discussion_note(issue: issue, test: test, reports_discussion: reports_discussion)
-          new_reports_list = add_report_for_test(current_reports_content: current_reports_note&.body.to_s, test: test)
-
-          note_body = [
-            new_reports_list.to_s,
-            identity_labels_quick_action,
-            relate_issues_quick_actions(related_issues)
-          ].join("\n")
-
-          if current_reports_note
-            gitlab.edit_issue_note(
-              issue_iid: issue.iid,
-              note_id: current_reports_note.id,
-              note: note_body
-            )
-          else
-            gitlab.add_note_to_issue_discussion_as_thread(
-              iid: issue.iid,
-              discussion_id: reports_discussion.id,
-              note: note_body
-            )
-          end
-        rescue MultipleNotesFound => e
-          warn(e.message)
+        def report_section_header
+          REPORT_SECTION_HEADER
         end
 
-        def find_or_create_reports_discussion(issue:)
-          reports_discussion = existing_reports_discussion(issue: issue)
-          return reports_discussion if reports_discussion
-
-          gitlab.create_issue_discussion(iid: issue.iid, note: REPORTS_DISCUSSION_HEADER)
+        def reports_extra_content(test)
+          "##### Stack trace\n\n```\n#{test.full_stacktrace}\n```"
         end
 
-        def existing_reports_discussion(issue:)
-          gitlab.find_issue_discussions(iid: issue.iid).find do |discussion|
-            next if discussion.individual_note
-            next unless discussion.notes.first
+        def health_problem_status_label_quick_action(reports_list)
+          '/label ~"severity::1"' if reports_list.spiked_in_short_period?
+        end
 
-            discussion.notes.first.body.start_with?(REPORTS_DISCUSSION_HEADER)
-          end
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (base_issue_labels + super).to_a
         end
 
         def find_failure_discussion_note(issue:, test:, reports_discussion:)
@@ -208,35 +144,6 @@ module GitlabQuality
             puts "  => [DEBUG] Failure stacktrace:\n----------------\n#{test_stacktrace}\n----------------\n"
           end
         end
-
-        def add_report_for_test(current_reports_content:, test:)
-          increment_reports(
-            current_reports_content: current_reports_content,
-            test: test,
-            reports_section_header: REPORT_SECTION_HEADER,
-            item_extra_content: found_label,
-            reports_extra_content: "##### Stack trace\n\n```\n#{test.full_stacktrace}\n```"
-          )
-        end
-
-        def found_label
-          if ENV.key?('CI_MERGE_REQUEST_IID')
-            FOUND_IN_MR_LABEL
-          else
-            FOUND_IN_MASTER_LABEL
-          end
-        end
-
-        def identity_labels_quick_action
-          labels_list = IDENTITY_LABELS.map { |label| %(~"#{label}") }.join(' ')
-          %(/label #{labels_list})
-        end
-
-        def relate_issues_quick_actions(issues)
-          issues.map do |issue|
-            "/relate #{issue.web_url}"
-          end.join("\n")
-        end
       end
     end
   end

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

@@ -11,15 +11,9 @@ module GitlabQuality
       # - For every passed test in the report:
       #   - Find issue by test hash or create a new issue if no issue was found
       #   - Add a flakiness report in the "Flakiness reports" note
-      class FlakyTestIssue < ReportAsIssue
-        include Concerns::GroupAndCategoryLabels
-        include Concerns::IssueReports
-
+      class FlakyTestIssue < HealthProblemReporter
         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 reproducibility instructions](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html#how-to-reproduce-a-flaky-test-locally)
@@ -38,108 +32,28 @@ module GitlabQuality
 
         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}`."
-
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
-            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
-
-            process_test_results(test_results)
-          end
-        end
-
-        def process_test_results(test_results)
-          test_results.each do |test|
-            next unless test_is_applicable?(test)
-
-            puts " => Reporting flakiness for test '#{test.name}'..."
-
-            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: SEARCH_LABELS)
-
-            if issues.empty?
-              issues << create_issue(test)
-            else
-              # Keep issues description up-to-date
-              update_issues(issues, test)
-            end
-
-            update_reports(issues, test)
-            collect_issues(test, issues)
-          end
+        def problem_type
+          'flaky'
         end
 
         def test_is_applicable?(test)
           test.status == 'passed' # We only want failed tests that passed in the end
         end
 
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          (base_issue_labels + super).to_a
+        def identity_labels
+          IDENTITY_LABELS
         end
 
-        def update_reports(issues, test)
-          issues.each do |issue|
-            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
+        def report_section_header
+          REPORT_SECTION_HEADER
         end
 
-        def add_report_to_issue(issue:, test:, related_issues:)
-          current_reports_note = existing_reports_note(issue: issue)
-          new_reports_list = add_report_for_test(current_reports_content: current_reports_note&.body.to_s, test: test)
-
-          note_body = [
-            new_reports_list.to_s,
-            flakiness_status_labels_quick_action(new_reports_list.reports_count),
-            identity_labels_quick_action,
-            relate_issues_quick_actions(related_issues)
-          ].join("\n")
-
-          if current_reports_note
-            gitlab.edit_issue_note(
-              issue_iid: issue.iid,
-              note_id: current_reports_note.id,
-              note: note_body
-            )
-          else
-            gitlab.create_issue_note(iid: issue.iid, note: note_body)
-          end
-        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
-
-        def add_report_for_test(current_reports_content:, test:)
-          increment_reports(
-            current_reports_content: current_reports_content,
-            test: test,
-            reports_section_header: REPORT_SECTION_HEADER,
-            item_extra_content: found_label,
-            reports_extra_content: REPORTS_DOCUMENTATION
-          )
+        def reports_extra_content(_test)
+          REPORTS_DOCUMENTATION
         end
 
-        def found_label
-          if ENV.key?('CI_MERGE_REQUEST_IID')
-            FOUND_IN_MR_LABEL
-          else
-            FOUND_IN_MASTER_LABEL
-          end
-        end
-
-        # The report count is based on the percentiles of flakiness issues.
-        #
-        # See https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/blob/main/scripts/unhealthy_test_issues_statistics.rb
-        # to gather these statistics.
-        #
-        # x <= P90       => flakiness::4
-        # P90 < x <= P95 => flakiness::3
-        # P95 < x <= P99 => flakiness::2
-        # > P99          => flakiness::1
-        def flakiness_status_labels_quick_action(reports_count)
-          case reports_count
+        def health_problem_status_label_quick_action(reports_list)
+          case reports_list.reports_count
           when 399..Float::INFINITY
             '/label ~"flakiness::1"'
           when 37..398
@@ -151,15 +65,8 @@ module GitlabQuality
           end
         end
 
-        def identity_labels_quick_action
-          labels_list = IDENTITY_LABELS.map { |label| %(~"#{label}") }.join(' ')
-          %(/label #{labels_list})
-        end
-
-        def relate_issues_quick_actions(issues)
-          issues.map do |issue|
-            "/relate #{issue.web_url}"
-          end.join("\n")
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (base_issue_labels + super).to_a
         end
       end
     end

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

@@ -25,7 +25,7 @@ module GitlabQuality
           tests = Dir.glob(files).flat_map do |path|
             puts "Loading tests in #{path}"
 
-            TestResults::JsonTestResults.new(path).to_a
+            TestResults::JsonTestResults.new(path: path).to_a
           end
 
           tests = tests.select { |test| pipeline_stages.include? test.report["stage"] } unless pipeline_stages.empty?

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

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      # Base class for specific health problems reporting.
+      # Uses the API to create GitLab issues for any passed test coming from JSON test reports.
+      # We expect the test reports to come from a new RSpec process where we retried failing specs.
+      #
+      # - Takes the JSON test reports like rspec-*.json
+      # - Takes a project where flaky test issues should be created
+      # - For every passed test in the report:
+      #   - Find issue by test hash or create a new issue if no issue was found
+      #   - Add a flakiness report in the "Flakiness reports" note
+      class HealthProblemReporter < ReportAsIssue
+        include Concerns::GroupAndCategoryLabels
+        include Concerns::IssueReports
+
+        BASE_SEARCH_LABELS = ['test'].freeze
+        FOUND_IN_MR_LABEL     = '~"found:in MR"'
+        FOUND_IN_MASTER_LABEL = '~"found:master"'
+
+        private
+
+        def problem_type
+          'unhealthy'
+        end
+
+        def test_is_applicable?(_test)
+          false
+        end
+
+        def report_in_discussion?
+          false
+        end
+
+        def identity_labels
+          []
+        end
+
+        def search_labels
+          BASE_SEARCH_LABELS
+        end
+
+        def report_section_header
+          ''
+        end
+
+        def find_failure_discussion_note(_issue:, _test:, _reports_discussion:)
+          nil
+        end
+
+        def reports_extra_content(_test)
+          ''
+        end
+
+        def health_problem_status_label_quick_action(_reports_count)
+          ''
+        end
+
+        def item_extra_content(_test)
+          found_label
+        end
+
+        def run!
+          puts "Reporting tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+
+          TestResults::Builder.new(file_glob: files, token: token, project: project).test_results_per_file do |test_results|
+            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
+
+            process_test_results(test_results)
+          end
+        end
+
+        def process_test_results(test_results)
+          test_results.each do |test|
+            next unless test_is_applicable?(test)
+
+            puts " => Reporting #{problem_type} test '#{test.name}'..."
+
+            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: search_labels)
+
+            if issues.empty?
+              issues << create_issue(test)
+            else
+              # Keep issues description up-to-date
+              update_issues(issues, test)
+            end
+
+            update_reports(issues, test)
+            collect_issues(test, issues)
+          end
+        end
+
+        def update_reports(issues, test)
+          issues.each do |issue|
+            puts "   => Reporting #{problem_type} test to existing issue: #{issue.web_url}"
+            add_report_to_issue(issue: issue, test: test, related_issues: (issues - [issue]))
+          end
+        end
+
+        def add_report_to_issue(issue:, test:, related_issues:) # rubocop:disable Metrics/AbcSize -- FIXME
+          current_reports_note =
+            if report_in_discussion?
+              reports_discussion = find_or_create_reports_discussion(issue: issue)
+
+              find_failure_discussion_note(issue: issue, test: test, reports_discussion: reports_discussion)
+            else
+              existing_reports_note(issue: issue)
+            end
+
+          new_reports_list = add_report_for_test(current_reports_content: current_reports_note&.body.to_s, test: test)
+
+          note_body = [
+            new_reports_list.to_s,
+            health_problem_status_label_quick_action(new_reports_list),
+            identity_labels_quick_action,
+            relate_issues_quick_actions(related_issues)
+          ].join("\n")
+
+          if current_reports_note
+            gitlab.edit_issue_note(
+              issue_iid: issue.iid,
+              note_id: current_reports_note.id,
+              note: note_body
+            )
+          elsif report_in_discussion?
+            gitlab.add_note_to_issue_discussion_as_thread(
+              iid: issue.iid,
+              discussion_id: reports_discussion.id,
+              note: note_body
+            )
+          else
+            gitlab.create_issue_note(iid: issue.iid, note: note_body)
+          end
+        rescue MultipleNotesFound => e
+          warn(e.message)
+        end
+
+        def find_or_create_reports_discussion(issue:)
+          reports_discussion = existing_reports_discussion(issue: issue)
+          return reports_discussion if reports_discussion
+
+          gitlab.create_issue_discussion(iid: issue.iid, note: report_section_header)
+        end
+
+        def existing_reports_discussion(issue:)
+          gitlab.find_issue_discussions(iid: issue.iid).find do |discussion|
+            next if discussion.individual_note
+            next unless discussion.notes.first
+
+            discussion.notes.first.body.start_with?(report_section_header)
+          end
+        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
+
+        def add_report_for_test(current_reports_content:, test:)
+          increment_reports(
+            current_reports_content: current_reports_content,
+            test: test,
+            reports_section_header: report_section_header,
+            item_extra_content: item_extra_content(test),
+            reports_extra_content: reports_extra_content(test)
+          )
+        end
+
+        def found_label
+          if ENV.key?('CI_MERGE_REQUEST_IID')
+            FOUND_IN_MR_LABEL
+          else
+            FOUND_IN_MASTER_LABEL
+          end
+        end
+
+        def identity_labels_quick_action
+          return if identity_labels.empty?
+
+          %(/label #{identity_labels.map { |label| %(~"#{label}") }.join(' ')})
+        end
+
+        def relate_issues_quick_actions(issues)
+          issues.map do |issue|
+            "/relate #{issue.web_url}"
+          end.join("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module GitlabQuality
         def run!
           puts "Reporting slow tests in MR #{merge_request_iid}"
 
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
+          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
             @slow_tests += slow_related_tests(find_slow_tests(test_results))

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

@@ -52,7 +52,7 @@ module GitlabQuality
         def run!
           puts "Reporting test failures in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
+          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
             process_test_results(test_results)
           end

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

@@ -10,6 +10,7 @@ module GitlabQuality
 
         def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
           @project = project
+          @token = token
           @gitlab = (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
           @files = Array(input_files)
           @confidential = confidential
@@ -28,7 +29,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
+        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger, :token
 
         def run!
           raise NotImplementedError
@@ -120,12 +121,15 @@ module GitlabQuality
         end
 
         def update_issue(issue, test)
-          issue_attrs = {
-            description: new_issue_description(test)
-          }
-          return if issue.description == issue_attrs[:description]
+          issue_attrs = {}
 
-          gitlab.edit_issue(iid: issue.iid, options: issue_attrs)
+          new_description = new_issue_description(test)
+          issue_attrs[:description] = new_description unless issue.description == new_description
+
+          new_labels = up_to_date_labels(test: test, issue: issue).to_a
+          issue_attrs[:labels] = new_labels unless issue.labels == new_labels
+
+          gitlab.edit_issue(iid: issue.iid, options: issue_attrs) unless issue_attrs.empty?
         end
 
         def issue_labels(issue)
@@ -152,6 +156,8 @@ module GitlabQuality
             labels.delete_if { |label| label.include?('quarantine') }
           end
 
+          labels << 'rspec-shared-examples' if test.calls_shared_examples?
+
           labels
         end
 

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

@@ -36,7 +36,7 @@ module GitlabQuality
           puts "Reporting test results in `#{files.join(',')}` as test cases in project `#{test_case_project}` " \
                "and issues in project `#{results_issue_project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
+          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
             puts "Reporting tests in #{test_results.path}"
 
             test_results.each do |test|

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

@@ -9,15 +9,9 @@ module GitlabQuality
       # - Takes a project where slow issues should be created
       # - 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 Concerns::GroupAndCategoryLabels
-        include Concerns::IssueReports
-
+      class SlowTestIssue < HealthProblemReporter
         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)
@@ -28,104 +22,28 @@ module GitlabQuality
 
         private
 
-        def run!
-          puts "Reporting slow tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
-
-          TestResults::Builder.new(files).test_results_per_file do |test_results|
-            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
-
-            process_test_results(test_results)
-          end
-        end
-
-        def process_test_results(test_results)
-          test_results.each do |test|
-            next unless test.slow_test?
-
-            puts " => Reporting slowness for test '#{test.name}'..."
-
-            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: SEARCH_LABELS)
-
-            if issues.empty?
-              issues << create_issue(test)
-            else
-              # Keep issues description up-to-date
-              update_issues(issues, test)
-            end
-
-            update_reports(issues, test)
-            collect_issues(test, issues)
-          end
+        def problem_type
+          'slow'
         end
 
         def test_is_applicable?(test)
           test.slow_test?
         end
 
-        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
+        def identity_labels
+          IDENTITY_LABELS
         end
 
-        def add_report_to_issue(issue:, test:, related_issues:)
-          current_reports_note = existing_reports_note(issue: issue)
-          new_reports_list = add_report_for_test(current_reports_content: current_reports_note&.body.to_s, test: test)
-
-          note_body = [
-            new_reports_list.to_s,
-            slowness_status_labels_quick_action(new_reports_list.reports_count),
-            identity_labels_quick_action,
-            relate_issues_quick_actions(related_issues)
-          ].join("\n")
-
-          if current_reports_note
-            gitlab.edit_issue_note(
-              issue_iid: issue.iid,
-              note_id: current_reports_note.id,
-              note: note_body
-            )
-          else
-            gitlab.create_issue_note(iid: issue.iid, note: note_body)
-          end
-        end
-
-        def existing_reports_note(issue:)
-          gitlab.find_issue_notes(iid: issue.iid).find do |note|
-            note.body.start_with?(REPORT_SECTION_HEADER)
-          end
+        def report_section_header
+          REPORT_SECTION_HEADER
         end
 
-        def add_report_for_test(current_reports_content:, test:)
-          increment_reports(
-            current_reports_content: current_reports_content,
-            test: test,
-            reports_section_header: REPORT_SECTION_HEADER,
-            item_extra_content: "(#{test.run_time} seconds) #{found_label}",
-            reports_extra_content: REPORTS_DOCUMENTATION
-          )
+        def reports_extra_content(_test)
+          REPORTS_DOCUMENTATION
         end
 
-        def found_label
-          if ENV.key?('CI_MERGE_REQUEST_IID')
-            FOUND_IN_MR_LABEL
-          else
-            FOUND_IN_MASTER_LABEL
-          end
-        end
-
-        # The report count is based on the percentiles of slowness issues.
-        #
-        # See https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/blob/main/scripts/unhealthy_test_issues_statistics.rb
-        # to gather these statistics.
-        #
-        # P75       => slowness::4
-        # P90       => slowness::3
-        # P95       => slowness::2
-        # Above P95 => slowness::1
-        def slowness_status_labels_quick_action(reports_count)
-          case reports_count
+        def health_problem_status_label_quick_action(reports_list)
+          case reports_list.reports_count
           when 40..Float::INFINITY
             '/label ~"slowness::1"'
           when 28..39
@@ -137,15 +55,8 @@ module GitlabQuality
           end
         end
 
-        def identity_labels_quick_action
-          labels_list = IDENTITY_LABELS.map { |label| %(~"#{label}") }.join(' ')
-          %(/label #{labels_list})
-        end
-
-        def relate_issues_quick_actions(issues)
-          issues.map do |issue|
-            "/relate #{issue.web_url}"
-          end.join("\n")
+        def item_extra_content(test)
+          "(#{test.run_time} seconds) #{found_label}"
         end
       end
     end

data/lib/gitlab_quality/test_tooling/summary_table.rb

@@ -6,15 +6,16 @@ require 'table_print'
 module GitlabQuality
   module TestTooling
     class SummaryTable
-      def self.create(input_files:)
-        "```\n#{TablePrint::Printer.table_print(collect_results(input_files))}```\n"
+      def self.create(input_files:, **options)
+        "```\n#{TablePrint::Printer.table_print(collect_results(input_files, **options))}```\n"
       end
 
       # rubocop:disable Metrics/AbcSize
-      def self.collect_results(input_files)
-        stage_wise_results = []
+      def self.collect_results(input_files, **options)
+        sort_by = options[:sort_by]
+        sort_direction = options[:sort_direction]
 
-        Dir.glob(input_files).each do |report_file|
+        stage_wise_results = Dir.glob(input_files).each_with_object([]) do |report_file, stage_wise_results|
           stage_hash = {}
           stage_hash["Dev Stage"] = File.basename(report_file, ".*").capitalize
 
@@ -29,6 +30,9 @@ module GitlabQuality
           stage_wise_results << stage_hash
         end
 
+        stage_wise_results.sort_by! { |stage_hash| stage_hash[sort_by] } if sort_by
+        stage_wise_results.reverse! if sort_direction == :desc
+
         stage_wise_results
       end
       # rubocop:enable Metrics/AbcSize

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/test_metrics.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module GitlabQuality
   module TestTooling
     module TestMetricsExporter
@@ -11,7 +13,7 @@ module GitlabQuality
           return @time if defined?(@time)
 
           created_at = Time.strptime(env('CI_PIPELINE_CREATED_AT'), '%Y-%m-%dT%H:%M:%S%z') if env('CI_PIPELINE_CREATED_AT')
-          @time = (created_at || Time.now).utc.strftime('%Y-%m-%dT%H:%M:%S%z')
+          @time = Time.parse((created_at || Time.now).utc.strftime('%Y-%m-%d %H:%M:%S %z'))
         end
 
         # rubocop:disable Metrics/AbcSize

data/lib/gitlab_quality/test_tooling/test_result/base_test_result.rb

@@ -9,10 +9,15 @@ module GitlabQuality
           '403 Forbidden - Your account has been blocked'
         ].freeze
 
+        SHARED_EXAMPLES_CALLERS = %w[include_examples it_behaves_like].freeze
+
         attr_reader :report
 
-        def initialize(report)
+        def initialize(report:, token: nil, project: nil, ref: 'master')
           @report = report
+          @token = token
+          @project = project
+          @ref = ref
         end
 
         def stage
@@ -27,6 +32,10 @@ module GitlabQuality
           raise NotImplementedError
         end
 
+        def line_number
+          raise NotImplementedError
+        end
+
         def section
           raise NotImplementedError
         end
@@ -57,6 +66,26 @@ module GitlabQuality
             return message_lines.empty? ? message : message_lines.join("\n")
           end
         end
+
+        def calls_shared_examples?
+          reported_line = files_client.file_contents_at_line(line_number)
+
+          return false unless reported_line
+
+          SHARED_EXAMPLES_CALLERS.any? { |caller_method| reported_line.strip.start_with?(caller_method) }
+        end
+
+        def files_client
+          @files_client ||= GitlabClient::RepositoryFilesClient.new(
+            token: token,
+            project: project,
+            file_path: file,
+            ref: ref)
+        end
+
+        private
+
+        attr_reader :token, :project, :ref
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_results/base_test_results.rb

@@ -8,8 +8,11 @@ module GitlabQuality
 
         attr_reader :path
 
-        def initialize(path)
+        def initialize(path:, token: nil, project: nil, ref: 'master')
           @path = path
+          @token = token
+          @project = project
+          @ref = ref
           @results = parse
           @testcases = process
         end
@@ -24,7 +27,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :results, :testcases
+        attr_reader :results, :testcases, :token, :project, :ref
 
         def parse
           raise NotImplementedError

data/lib/gitlab_quality/test_tooling/test_results/builder.rb

@@ -4,8 +4,11 @@ module GitlabQuality
   module TestTooling
     module TestResults
       class Builder
-        def initialize(file_glob)
+        def initialize(file_glob:, token: nil, project: nil, ref: 'master')
           @file_glob = file_glob
+          @token = token
+          @project = project
+          @ref = ref
         end
 
         def test_results_per_file
@@ -15,9 +18,9 @@ module GitlabQuality
             test_results =
               case extension
               when '.json'
-                TestResults::JsonTestResults.new(path)
+                TestResults::JsonTestResults.new(path: path, token: token, project: project, ref: ref)
               when '.xml'
-                TestResults::JUnitTestResults.new(path)
+                TestResults::JUnitTestResults.new(path: path, token: token, project: project, ref: ref)
               else
                 raise "Unknown extension #{extension}"
               end
@@ -28,7 +31,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :file_glob
+        attr_reader :file_glob, :token, :project, :ref
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_results/j_unit_test_results.rb

@@ -18,7 +18,7 @@ module GitlabQuality
 
         def process
           results.xpath('//testcase').map do |test|
-            GitlabQuality::TestTooling::TestResult::JUnitTestResult.new(test)
+            GitlabQuality::TestTooling::TestResult::JUnitTestResult.new(report: test, project: project, token: token)
           end
         end
       end

data/lib/gitlab_quality/test_tooling/test_results/json_test_results.rb

@@ -20,7 +20,7 @@ module GitlabQuality
 
         def process
           results['examples'].map do |test|
-            GitlabQuality::TestTooling::TestResult::JsonTestResult.new(test)
+            GitlabQuality::TestTooling::TestResult::JsonTestResult.new(report: test, project: project, token: token)
           end
         end
       end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.27.1"
+    VERSION = "1.29.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.27.1
+  version: 1.29.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -440,6 +440,7 @@ files:
 - lib/gitlab_quality/test_tooling/report/failed_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/flaky_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/generate_test_session.rb
+- lib/gitlab_quality/test_tooling/report/health_problem_reporter.rb
 - lib/gitlab_quality/test_tooling/report/issue_logger.rb
 - lib/gitlab_quality/test_tooling/report/knapsack_report_issue.rb
 - lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb