gitlab_quality-test_tooling 1.12.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b88e790bd74462ff96779cb28d8f8f2cdadd99356e3889f50ec56ed7f5ea691d
-  data.tar.gz: 865098baec02cb4f7cf6634fc7e7cb45a0394261957d9b0cdc33b9c0efd74c29
+  metadata.gz: 970354551e0118a942865386f3e844762cf1fdfb06cfc02aa7bca602e55abc8f
+  data.tar.gz: f512f45f80e5a3949b07a237c1f29c6bc73fcd8e320a92b6b3fcd0a23ccc311f
 SHA512:
-  metadata.gz: 1bdaa39d9a6e2ea9000d3318d54e1c3385c552fa967b86780f697ee10becf7e6f0cc3c8edf19a7ac7d29988babaf6ad735a1191d7132ed7f635939cde3575fa6
-  data.tar.gz: 3edfd0209db270145f48338dbf0ebc1785176f8fd158fef8880b13b3280e8a569437d30f26234203bb58bbb6b111992265209882df4c783b83342b942d2d7d00
+  metadata.gz: 639c54db934d3fb5ee5cc57264957a6ffff2714fff9dce6517701b7ff4e5ce74fca87a518f35b1e8d52852952d875f6b9aa45e79a506fbb9416d9712bba2ab95
+  data.tar.gz: 1dbfcfab9f4161827ae2775a69f6203008cc4ea07dc23424a971c5451a354ebb28d7a698e922aecf8ca321a9612a05e5adf966c1bc0e38686c249aaa87ce6446

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.12.0)
+    gitlab_quality-test_tooling (1.14.0)
       activesupport (>= 6.1, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -9,6 +9,7 @@ PATH
       nokogiri (~> 1.10)
       parallel (>= 1, < 2)
       rainbow (>= 3, < 4)
+      rspec-parameterized (~> 1.0.0)
       table_print (= 1.5.7)
       zeitwerk (>= 2, < 3)
 
@@ -29,6 +30,8 @@ GEM
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.2.1)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
     byebug (11.1.3)
     claide (1.1.0)
     claide-plugins (0.9.2)
@@ -59,6 +62,7 @@ GEM
     danger-gitlab (8.0.0)
       danger
       gitlab (~> 4.2, >= 4.2.0)
+    debug_inspector (1.2.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
     domain_name (0.5.20190701)
@@ -156,6 +160,10 @@ GEM
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
+    proc_to_ast (0.1.0)
+      coderay
+      parser
+      unparser
     protocol (2.0.0)
       ruby_parser (~> 3.0)
     pry (0.14.2)
@@ -190,6 +198,17 @@ GEM
     rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
+    rspec-parameterized (1.0.0)
+      rspec-parameterized-core (< 2)
+      rspec-parameterized-table_syntax (< 2)
+    rspec-parameterized-core (1.0.0)
+      parser
+      proc_to_ast
+      rspec (>= 2.13, < 4)
+      unparser
+    rspec-parameterized-table_syntax (1.0.1)
+      binding_of_caller
+      rspec-parameterized-core (< 2)
     rspec-support (3.12.0)
     rubocop (1.43.0)
       json (~> 2.3)
@@ -266,6 +285,9 @@ GEM
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
+    unparser (0.6.8)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
     webmock (3.7.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/README.md

@@ -141,6 +141,21 @@ Usage: exe/slow-test-issues [options]
     -h, --help                       Show the usage
 ```
 
+### `exe/knapsack-report-issues`
+
+```shell
+Purpose: Create spec run time issue when a spec file almost caused job timeout because it ran significantly longer than what Knapsack expected.
+Usage: exe/knapsack-report-issues [options]
+    -i, --input-file INPUT_FILE      Knapsack actual run time report file path glob
+    -e EXPECTED_REPORT,              Knapsack expected report file path
+        --expected-report
+    -p, --project PROJECT            Can be an integer or a group/project string
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
+        --dry-run                    Perform a dry-run (don't create issues)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
 ### `exe/flaky-test-issues`
 
 ```shell
@@ -173,6 +188,22 @@ Usage: exe/slow-test-merge-request-report-note [options]
     -h, --help                       Show the usage
 ```
 
+### `exe/update-test-meta`
+
+```shell
+Purpose: Add quarantine or reliable meta to specs
+Usage: exe/update-test-meta [options]
+    -u INPUT_FILES,                  File with list of unstable specs (JSON) to quarantine
+        --unstable-specs-file
+    -s INPUT_FILES,                  File with list of stable specs (JSON) to add :reliable meta
+        --stable-specs-file
+    -p, --project PROJECT            Can be an integer or a group/project string
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
+        --dry-run                    Perform a dry-run (don't create branches, commits or MRs)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
 ## Development
 
 ### Initial setup

data/exe/knapsack-report-issues

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "optparse"
+
+require_relative "../lib/gitlab_quality/test_tooling"
+
+params = {}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on("-i", "--input-file INPUT_FILE", String, "Knapsack actual run time report file path glob") do |input_file|
+    params[:input_files] = input_file
+  end
+
+  opts.on("-e", "--expected-report EXPECTED_REPORT", String, "Knapsack expected report file path") do |report_path|
+    params[:expected_report] = report_path.strip
+  end
+
+  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
+    params[:project] = project
+  end
+
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT') do |token|
+    params[:token] = token
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't create issues)") do
+    params[:dry_run] = true
+  end
+
+  opts.on_tail('-v', '--version', 'Show the version') do
+    require_relative "../lib/gitlab_quality/test_tooling/version"
+    puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Show the usage') do
+    puts "Purpose: Create spec run time issue when a spec file almost caused job timeout because it ran significantly longer than what Knapsack expected."
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+if params.any?
+  GitlabQuality::TestTooling::Report::KnapsackReportIssue.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/exe/update-test-meta

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "optparse"
+
+require_relative "../lib/gitlab_quality/test_tooling"
+
+params = {}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on('-u', '--unstable-specs-file INPUT_FILES', String, 'File with list of unstable specs (JSON) to quarantine') do |unstable_specs_file|
+    params[:unstable_specs_file] = unstable_specs_file
+  end
+
+  opts.on('-s', '--stable-specs-file INPUT_FILES', String, 'File with list of stable specs (JSON) to add :blocking meta') do |stable_specs_file|
+    params[:stable_specs_file] = stable_specs_file
+  end
+
+  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
+    params[:project] = project
+  end
+
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT') do |token|
+    params[:token] = token
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't create branches, commits or MRs)") do
+    params[:dry_run] = true
+  end
+
+  opts.on_tail('-v', '--version', 'Show the version') do
+    require_relative "../lib/gitlab_quality/test_tooling/version"
+    puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Show the usage') do
+    puts "Purpose: Add quarantine or blocking meta to specs"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+if params.any?
+  if params[:unstable_specs_file] && params[:stable_specs_file]
+    puts "Please provide only one of one of -u and -s"
+    exit 1
+  elsif !params[:unstable_specs_file] && !params[:stable_specs_file]
+    puts "Please provide at least one of one of -u and -s"
+    exit 1
+  end
+
+  if params[:unstable_specs_file]
+    params[:specs_file] = params.delete(:unstable_specs_file)
+    params[:processor] = GitlabQuality::TestTooling::TestMeta::Processor::AddToQuarantineProcessor
+  else
+    params[:specs_file] = params.delete(:stable_specs_file)
+    params[:processor] = GitlabQuality::TestTooling::TestMeta::Processor::AddToBlockingProcessor
+  end
+
+  GitlabQuality::TestTooling::TestMeta::TestMetaUpdater.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module KnapsackReports
+      class SpecRunTime
+        attr_reader :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration
+
+        ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD = 1.5 # actual run time is longer than expected by 50% +
+        SPEC_WEIGHT_PERCENTAGE_TRESHOLD = 15 # a spec file takes 15%+ of the total test suite run time
+        SUITE_DURATION_THRESHOLD = 70 * 60 # if test suite takes more than 70 minutes, job risks timing out
+
+        def initialize(file:, expected:, actual:, expected_suite_duration:, actual_suite_duration:)
+          @file = file
+          @expected = expected.to_f
+          @actual = actual.to_f
+          @expected_suite_duration = expected_suite_duration.to_f
+          @actual_suite_duration = actual_suite_duration.to_f
+        end
+
+        def should_report?
+          # guideline proposed in https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/issues/354
+          exceed_actual_to_expected_ratio_threshold? && test_suite_bottleneck?
+        end
+
+        def ci_pipeline_url_markdown
+          "[#{ci_pipeline_id}](#{ci_pipeline_url})"
+        end
+
+        def ci_pipeline_created_at
+          ENV.fetch('CI_PIPELINE_CREATED_AT', nil)
+        end
+
+        def ci_job_link_markdown
+          "[#{ci_job_name}](#{ci_job_url})"
+        end
+
+        def file_link_markdown
+          "[#{file}](#{file_link})"
+        end
+
+        def actual_percentage
+          (actual / actual_suite_duration * 100).round(2)
+        end
+
+        def name
+          nil
+        end
+
+        private
+
+        def exceed_actual_to_expected_ratio_threshold?
+          actual / expected >= ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD
+        end
+
+        def test_suite_bottleneck?
+          # now we only report bottlenecks when they risk causing job timeouts
+          return unless actual_suite_duration > SUITE_DURATION_THRESHOLD
+
+          actual_percentage > SPEC_WEIGHT_PERCENTAGE_TRESHOLD
+        end
+
+        def ci_job_url
+          ENV.fetch('CI_JOB_URL', nil)
+        end
+
+        def ci_job_name
+          ENV.fetch('CI_JOB_NAME_SLUG', nil)
+        end
+
+        def ci_pipeline_id
+          ENV.fetch('CI_PIPELINE_IID', nil)
+        end
+
+        def ci_pipeline_url
+          ENV.fetch('CI_PIPELINE_URL', nil)
+        end
+
+        def file_link
+          "#{Runtime::Env.file_base_url}#{file}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module KnapsackReports
+      class SpecRunTimeReport
+        attr_reader :expected_report, :actual_report
+
+        def initialize(expected_report_path:, actual_report_path:)
+          @expected_report = parse(expected_report_path)
+          @actual_report = parse(actual_report_path)
+        end
+
+        def filtered_report
+          @filtered_report = actual_report.keys.filter_map do |spec_file|
+            expected_run_time = expected_report[spec_file]
+            actual_run_time = actual_report[spec_file]
+
+            if expected_run_time.nil?
+              puts "#{spec_file} missing from the expected Knapsack report, skipping."
+              next
+            end
+
+            spec_run_time = SpecRunTime.new(
+              file: spec_file,
+              expected: expected_run_time,
+              actual: actual_run_time,
+              expected_suite_duration: expected_test_suite_run_time_total,
+              actual_suite_duration: actual_test_suite_run_time_total
+            )
+
+            spec_run_time if spec_run_time.should_report?
+          end
+        end
+
+        private
+
+        def parse(report_path)
+          JSON.parse(File.read(report_path))
+        end
+
+        def expected_test_suite_run_time_total
+          @expected_test_suite_run_time_total ||=
+            expected_report.reduce(0) do |total_run_time, (_spec_file, run_time)|
+              total_run_time + run_time
+            end
+        end
+
+        def actual_test_suite_run_time_total
+          @actual_test_suite_run_time_total ||=
+            actual_report.reduce(0) do |total_run_time, (_spec_file, run_time)|
+              total_run_time + run_time
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,28 @@ module GitlabQuality
 
             @pipeline ||= Runtime::Env.pipeline_from_project_name
           end
+
+          def readable_duration(duration_in_seconds)
+            minutes = (duration_in_seconds / 60).to_i
+            seconds = (duration_in_seconds % 60).round(2)
+
+            min_output = normalize_duration_output(minutes, 'minute')
+            sec_output = normalize_duration_output(seconds, 'second')
+
+            "#{min_output} #{sec_output}".strip
+          end
+
+          private
+
+          def normalize_duration_output(number, unit)
+            if number <= 0
+              ""
+            elsif number <= 1
+              "#{number} #{unit}"
+            else
+              "#{number} #{unit}s"
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      # Uses the API to create GitLab issues for spec run time exceeding Knapsack expectation
+      #
+      # - Takes the expected and actual Knapsack JSON reports from the knapsack output
+      # - Takes a project where issues should be created
+      # - For every test file reported with unexpectedly long run time:
+      #   - Find issue by test file name, and if found:
+      #     - Reopen issue if it already exists, but is closed
+      #     - Update the issue with the new run time data
+      #   - If not found:
+      #     - Create a new issue with the run time data
+      class KnapsackReportIssue < ReportAsIssue
+        NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'knapsack_report']).freeze
+        SEARCH_LABELS = %w[test maintenance::performance knapsack_report].freeze
+        JOB_TIMEOUT_EPIC_URL = 'https://gitlab.com/groups/gitlab-org/quality/engineering-productivity/-/epics/19'
+
+        def initialize(token:, input_files:, expected_report:, project: nil, dry_run: false)
+          super
+
+          @expected_report = expected_report
+        end
+
+        private
+
+        attr_reader :expected_report
+
+        def run!
+          puts "Reporting spec file exceeding Knapsack expectaton issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+
+          search_and_create_issue
+        end
+
+        def search_and_create_issue
+          filtered_report = KnapsackReports::SpecRunTimeReport.new(
+            expected_report_path: expected_report_path,
+            actual_report_path: actual_report_path
+          ).filtered_report
+
+          puts "=> Reporting #{filtered_report.count} spec files exceeding Knapsack expectation."
+
+          filtered_report.each do |spec_with_run_time|
+            existing_issues = find_issues_for_test(spec_with_run_time, labels: SEARCH_LABELS)
+
+            if existing_issues.empty?
+              puts "Creating issue for #{spec_with_run_time.file}"
+              create_issue(spec_with_run_time)
+            else
+              update_issue(issue: existing_issues.last, spec_run_time: spec_with_run_time)
+            end
+          end
+        end
+
+        def expected_report_path
+          return if expected_report.nil? || !File.exist?(expected_report)
+
+          expected_report
+        end
+
+        def actual_report_path
+          return if files.nil? || !File.exist?(files.first)
+
+          files.first
+        end
+
+        def new_issue_labels(_spec_run_time)
+          NEW_ISSUE_LABELS
+        end
+
+        def new_issue_title(spec_run_time)
+          "Job timeout risk: #{spec_run_time.file} ran much longer than expected"
+        end
+
+        def new_issue_description(spec_run_time)
+          <<~MARKDOWN.chomp
+          /epic #{JOB_TIMEOUT_EPIC_URL}
+
+          ### Why was this issue created?
+
+          #{spec_run_time.file_link_markdown} was reported to have:
+
+          1. exceeded Knapsack's expected runtime by at least 50%, and
+          2. been identified as a notable pipeline bottleneck and a job timeout risk
+
+          ### Suggested steps for investigation
+
+          1. To reproduce in CI by running test files in the same order, you can follow the steps listed [here](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html#recreate-job-failure-in-ci-by-forcing-the-job-to-run-the-same-set-of-test-files).
+          1. Identify if a specific test case is stalling the run time. Hint: You can search the job's log for `Starting example group #{spec_run_time.file}` and view the elapsed time after each test case in the proceeding lines starting with `[RSpecRunTime]`.
+          1. If the test file is large, consider refactoring it into multiple files to allow better test parallelization across runners.
+          1. If the run time cannot be fixed in time, consider quarantine the spec(s) to restore performance.
+
+          ### Run time details
+
+          #{run_time_detail(spec_run_time)}
+          MARKDOWN
+        end
+
+        def update_issue(issue:, spec_run_time:)
+          state_event = issue.state == 'closed' ? 'reopen' : nil
+          updated_description = <<~MARKDOWN.chomp
+          #{issue.description}
+
+          #{run_time_detail(spec_run_time)}
+          MARKDOWN
+
+          issue_attrs = {
+            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
+
+        def run_time_detail(spec_run_time)
+          <<~MARKDOWN.chomp
+            - Reported from pipeline #{spec_run_time.ci_pipeline_url_markdown} created at `#{spec_run_time.ci_pipeline_created_at}`
+
+            | Field | Value |
+            | ------ | ------ |
+            | Job URL| #{spec_run_time.ci_job_link_markdown} |
+            | Job total RSpec suite run time | expected: `#{readable_duration(spec_run_time.expected_suite_duration)}`, actual: `#{readable_duration(spec_run_time.actual_suite_duration)}` |
+            | Spec file run time | expected: `#{readable_duration(spec_run_time.expected)}`, actual: `#{readable_duration(spec_run_time.actual)}` |
+            | Spec file weight | `#{spec_run_time.actual_percentage}%` of total suite run time |
+          MARKDOWN
+        end
+
+        def assert_input_files!(_files)
+          missing_expected_report_msg = "Missing a valid expected Knapsack report."
+          missing_actual_report_msg = "Missing a valid actual Knapsack report."
+
+          abort missing_expected_report_msg if expected_report_path.nil?
+          abort missing_actual_report_msg if actual_report_path.nil?
+        end
+      end
+    end
+  end
+end

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

@@ -64,8 +64,6 @@ module GitlabQuality
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
             process_test_results(test_results)
           end
-
-          write_issues_log_file
         end
 
         def test_metric_collections

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

@@ -19,7 +19,11 @@ module GitlabQuality
         def invoke!
           validate_input!
 
-          run!
+          issue_url = run!
+
+          write_issues_log_file
+
+          issue_url
         end
 
         private
@@ -162,7 +166,12 @@ module GitlabQuality
         def issue_match_test?(issue, test)
           issue_title = issue.title.strip
           test_file_path_found = !test.file.to_s.empty? && issue_title.include?(partial_file_path(test.file))
-          issue_title.include?(test.name) || test_file_path_found
+
+          if test.name
+            issue_title.include?(test.name) || test_file_path_found
+          else
+            test_file_path_found
+          end
         end
 
         def pipeline_name_label

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

@@ -33,8 +33,6 @@ module GitlabQuality
               create_slow_issue(test) if test.slow_test?
             end
           end
-
-          write_issues_log_file
         end
 
         def new_issue_title(test)

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMeta
+      module Processor
+        class AddToBlockingProcessor < MetaProcessor
+          BLOCKING_METADATA = ", :blocking%{suffix}"
+
+          class << self
+            # Execute the processor
+            #
+            # @param [Hash] spec the spec to update
+            # @param [TestMetaUpdater] context instance of TestMetaUpdater
+            def execute(spec, context) # rubocop:disable Metrics/AbcSize
+              @context = context
+
+              @file_path = spec["file_path"]
+              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?
+
+              @file_contents = context.get_file_contents(file_path)
+
+              new_content, changed_line_no = add_blocking_metadata
+
+              return if changed_line_no.negative?
+
+              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}
+              COMMIT_MESSAGE
+
+              assignee_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage)
+
+              merge_request = context.create_merge_request(mr_title, branch, assignee_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
+
+
+                  /label ~"Quality" ~"QA" ~"type::maintenance"
+                  /label ~"devops::#{devops_stage}"
+
+                  <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
+
+              context.post_note_on_merge_request(<<~MARKDOWN, merge_request.iid)
+                @#{assignee_handle} Please review this MR, approve and assign it to a maintainer.
+
+                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
+
+              merge_request
+            end
+
+            # Performs post processing. Takes a list of MRs and posts them in a note on report_issue
+            #
+            # @param [Gitlab::ObjectifiedHash] merge_requests
+            def post_process(merge_requests)
+              web_urls = merge_requests.compact.map { |mr| "- #{mr.web_url}\n" }.join
+
+              return if web_urls.empty?
+
+              context.post_note_on_report_issue(<<~ISSUE_NOTE)
+                The following merge requests have been created to promote stable specs to blocking:
+
+                #{web_urls}
+              ISSUE_NOTE
+            end
+
+            private
+
+            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title
+
+            # 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."
+                return false
+              end
+
+              true
+            end
+
+            # Add blocking metadata to the file content and replace it
+            #
+            # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
+            def add_blocking_metadata # rubocop:disable Metrics/AbcSize
+              matched_lines = context.find_example_match_lines(file_contents, example_name)
+
+              if matched_lines.any? { |line| line[0].include?(':blocking') }
+                puts "Example '#{example_name}' is already blocking"
+                return [file_contents, -1]
+              end
+
+              context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
+                if line.include?(',')
+                  line[line.index(',')] = format(BLOCKING_METADATA, suffix: ',')
+                else
+                  line[line.rindex(' ')] = format(BLOCKING_METADATA, suffix: ' ')
+                end
+
+                line
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMeta
+      module Processor
+        class AddToQuarantineProcessor < MetaProcessor
+          QUARANTINE_METADATA = <<~META
+            ,
+            %{indentation}quarantine: {
+            %{indentation}  issue: '%{issue_url}',
+            %{indentation}  type: %{quarantine_type}
+            %{indentation}}%{suffix}
+          META
+
+          class << self
+            # Execute the processor
+            #
+            # @param [Hash<String,String>] spec the spec to update
+            # @option spec [String] :file_path the path to the spec file
+            # @option spec [String] :stage the stage of the test
+            # @option spec [String] :failure_issue the issue url of the failure
+            # @option spec [String] :name the name of the example
+            # @param [TestMetaUpdater] context instance of TestMetaUpdater
+            def execute(spec, context) # rubocop:disable Metrics/AbcSize
+              @context = context
+
+              @file_path = spec["file_path"]
+              devops_stage = spec["stage"]
+              @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)
+              @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
+
+              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}
+              COMMIT_MESSAGE
+
+              context.create_merge_request(mr_title, branch) do
+                <<~MARKDOWN
+                  ## What does this MR do?
+
+                  Quarantines the test [`#{example_name}`](https://gitlab.com/#{context.project}/-/blob/#{context.ref}/#{file_path}#L#{changed_line_no + 1})
+
+                  This test was identified in the reliable e2e test report: #{context.report_issue}
+
+                  ### E2E Test Failure issue(s)
+
+                  #{failure_issue_url}
+
+                  ### Check-list
+
+                  - [ ] General code guidelines check-list
+                    - [ ] [Code review guidelines](https://docs.gitlab.com/ee/development/code_review.html)
+                    - [ ] [Style guides](https://docs.gitlab.com/ee/development/contributing/style_guides.html)
+                  - [ ] Quarantine test check-list
+                    - [ ] Follow the [Quarantining Tests guide](https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#quarantining-tests).
+                    - [ ] Confirm the test has a [`quarantine:` tag with the specified quarantine type](https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#quarantined-test-types).
+                    - [ ] Note if the test should be [quarantined for a specific environment](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/execution_context_selection.html#quarantine-a-test-for-a-specific-environment).
+                    - [ ] (Optionally) In case of an emergency (e.g. blocked deployments), consider adding labels to pick into auto-deploy (~"Pick into auto-deploy" ~"priority::1" ~"severity::1").
+                  - [ ] To ensure a faster turnaround, ask in the `#quality_maintainers` Slack channel for someone to review and merge the merge request, rather than assigning it directly.
+
+                  <!-- Base labels. -->
+                  /label ~"Quality" ~"QA" ~"type::maintenance" ~"maintenance::pipelines"
+
+                  <!--
+                  Choose the stage that appears in the test path, e.g. ~"devops::create" for
+                  `qa/specs/features/browser_ui/3_create/web_ide/add_file_template_spec.rb`.
+                  -->
+                  /label ~"devops::#{devops_stage}"
+
+                  <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
+            end
+
+            # Performs post processing. Takes a list of MRs and posts them in a note on report_issue and Slack
+            #
+            # @param [Gitlab::ObjectifiedHash] merge_requests
+            def post_process(merge_requests)
+              web_urls = merge_requests.compact.map { |mr| "- #{mr.web_url}\n" }.join
+
+              return if web_urls.empty?
+
+              context.post_note_on_report_issue(<<~ISSUE_NOTE)
+
+                The following merge requests have been created to quarantine the unstable tests:
+
+                #{web_urls}
+              ISSUE_NOTE
+
+              context.post_message_on_slack(<<~MSG)
+                *Action Required!* The following merge requests have been created to quarantine the unstable tests identified
+                in the reliable test report: #{context.report_issue}
+
+                #{web_urls}
+
+                Maintainers are requested to review and merge. Thank you.
+              MSG
+            end
+
+            private
+
+            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name, :issue_id, :mr_title, :failure_issue
+
+            # Checks if the failure issue is closed or if there is already an MR open
+            #
+            # @return [Boolean]
+            def proceed_with_merge_request?
+              if context.issue_is_closed?(failure_issue)
+                puts "  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."
+                return false
+              end
+
+              true
+            end
+
+            # Add quarantine metadata to the file content and replace it
+            #
+            # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
+            def add_quarantine_metadata # rubocop:disable Metrics/AbcSize
+              matched_lines = context.find_example_match_lines(file_contents, example_name)
+
+              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)
+                else
+                  line[line.rindex(' ')] = format(QUARANTINE_METADATA.rstrip, issue_url: failure_issue_url, indentation: indentation, suffix: ' ', quarantine_type: quarantine_type)
+                end
+
+                line
+              end
+            end
+
+            # Returns the quarantine type based on the failure scoped label
+            #
+            # @return [String]
+            def quarantine_type
+              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'
+                ':bug'
+              when 'flaky-test'
+                ':flaky'
+              when 'stale-test'
+                ':stale'
+              when 'test-environment'
+                ':test_environment'
+              else
+                ':investigating'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMeta
+      module Processor
+        class MetaProcessor
+          class << self
+            def execute
+              raise 'method not implemented'
+            end
+
+            def post_process
+              raise 'method not implemented'
+            end
+
+            private_class_method :new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module TestMeta
+      class TestMetaUpdater
+        include TestTooling::Concerns::FindSetDri
+
+        attr_reader :project, :ref, :report_issue
+
+        TEST_PLATFORM_MAINTAINERS_SLACK_CHANNEL_ID = 'C0437FV9KBN' # test-platform-maintainers
+
+        def initialize(token:, project:, specs_file:, processor:, ref: 'master', dry_run: false)
+          @specs_file = specs_file
+          @token = token
+          @project = project
+          @ref = ref
+          @dry_run = dry_run
+          @processor = processor
+        end
+
+        def invoke!
+          JSON.parse(File.read(specs_file)).tap do |contents|
+            @report_issue = contents['report_issue']
+
+            results = []
+            contents['specs'].each do |spec|
+              results << processor.execute(spec, self)
+            end
+            processor.post_process(results)
+          end
+        end
+
+        # Fetch contents of file from the repository
+        #
+        # [String] file_path path to the file
+        # [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
+        end
+
+        # Find all lines that contain any part of the example name
+        #
+        # @param [String] content the content of the spec file
+        # @param [String] example_name the name of example to find
+        # @return [Array<String, Integer>] first value holds the matched line, the second value holds the line number of matched line
+        def find_example_match_lines(content, example_name)
+          lines = content.split("\n")
+
+          matched_lines = []
+
+          lines.each_with_index do |line, line_index|
+            string_within_quotes = spec_desc_string_within_quotes(line)
+
+            matched_lines << [line, line_index] if string_within_quotes && example_name.include?(string_within_quotes)
+          rescue StandardError => e
+            puts "Error: #{e}"
+          end
+
+          matched_lines
+        end
+
+        # Update the provided matched_line with content from the block if given
+        #
+        # @param [Array<String, Integer>] matched_line first value holds the line content, the second value holds the line number
+        # @param [String] content full orignal content of the spec file
+        # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
+        def update_matched_line(matched_line, content)
+          lines = content.split("\n")
+
+          begin
+            resulting_line = block_given? ? yield(matched_line[0]) : matched_line[0]
+            lines[matched_line[1]] = resulting_line
+          rescue StandardError => e
+            puts "Error: #{e}"
+          end
+
+          [lines.join("\n") << "\n", matched_line[1]]
+        end
+
+        # Create a branch from the ref
+        #
+        # @param [String] name_prefix the prefix to attach to the branch name
+        # @param [String] example_name the example
+        # @return [Gitlab::ObjectifiedHash] the new branch
+        def create_branch(name_prefix, example_name, ref)
+          branch_name = [name_prefix, example_name.gsub(/\W/, '-')]
+          @branches_client ||= (dry_run ? GitlabClient::BranchesDryClient : GitlabClient::BranchesClient).new(token: token, project: project)
+          @branches_client.create(branch_name.join('-'), ref)
+        end
+
+        # Commit changes to a branch
+        #
+        # @param [Gitlab::ObjectifiedHash] branch the branch to commit to
+        # @param [String] message the message to commit
+        # @param [String] new_content the new content to commit
+        # @return [Gitlab::ObjectifiedHash] the commit
+        def commit_changes(branch, message, file_path, new_content)
+          @commits_client ||= (dry_run ? GitlabClient::CommitsDryClient : GitlabClient::CommitsClient)
+                                .new(token: token, project: project)
+          @commits_client.create(branch['name'], file_path, new_content, message)
+        end
+
+        # Create a Merge Request with a given branch
+        #
+        # @param [String] title_prefix the prefix of the title
+        # @param [String] example_name the example
+        # @param [Gitlab::ObjectifiedHash] branch the branch
+        # @param [Integer] assignee_id
+        # @return [Gitlab::ObjectifiedHash] the created merge request
+        def create_merge_request(title, branch, assignee_id = nil, labels = '')
+          description = yield
+
+          merge_request_client.create_merge_request(
+            title: title,
+            source_branch: branch['name'],
+            target_branch: ref,
+            description: description,
+            labels: labels,
+            assignee_id: assignee_id)
+        end
+
+        # Check if issue is closed
+        #
+        # @param [Gitlab::ObjectifiedHash] issue the issue
+        # @return [Boolean] True or False
+        def issue_is_closed?(issue)
+          issue['state'] == 'closed'
+        end
+
+        # Get scoped label from issue
+        #
+        # @param [Gitlab::ObjectifiedHash] issue the issue
+        # @param [String] scope
+        # @return [String] scoped label
+        def issue_scoped_label(issue, scope)
+          issue['labels'].detect { |label| label.match(/#{scope}::/) }
+        end
+
+        # Fetch an issue
+        #
+        # @param [String] iid: The iid of the issue
+        # @return [Gitlab::ObjectifiedHash]
+        def fetch_issue(iid:)
+          issue_client.find_issues(iid: iid).first
+        end
+
+        # Post note on report_issue
+        #
+        # @param [String] note the note to post
+        # @return [Gitlab::ObjectifiedHash]
+        def post_note_on_report_issue(note)
+          iid = report_issue.split('/').last # split url segment, last segment of path is the issue id
+          issue_client.create_issue_note(iid: iid, note: note)
+        end
+
+        # Post a note of merge reqest
+        #
+        # @param [String] note
+        # @param [Integer] merge_request_iid
+        # @return [Gitlab::ObjectifiedHash]
+        def post_note_on_merge_request(note, merge_request_iid)
+          merge_request_client.create_note(note: note, merge_request_iid: merge_request_iid)
+        end
+
+        # Fetch the id for the dri of the product group and stage
+        # The first item returned is the id of the assignee and the second item is the handle
+        #
+        # @param [String] product_group
+        # @param [String] devops_stage
+        # @return [Array<Integer, String>]
+        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]
+        end
+
+        # Post a message on Slack
+        #
+        # @param [String] message the message to post
+        # @return [HTTP::Response]
+        def post_message_on_slack(message)
+          channel = ENV.fetch('SLACK_QA_CHANNEL', nil) || TEST_PLATFORM_MAINTAINERS_SLACK_CHANNEL_ID
+          slack_options = {
+            slack_webhook_url: ENV.fetch('CI_SLACK_WEBHOOK_URL', nil),
+            channel: channel,
+            username: "GitLab Quality Test Tooling",
+            icon_emoji: ':warning:',
+            message: message
+          }
+          puts "Posting Slack message to channel: #{channel}"
+
+          (dry_run ? GitlabQuality::TestTooling::Slack::PostToSlackDry : GitlabQuality::TestTooling::Slack::PostToSlack).new(**slack_options).invoke!
+        end
+
+        # Provide indentaiton based on the given line
+        #
+        # @param[String] line the line to use for indentation
+        # @return[String] indentation
+        def indentation(line)
+          # Indent the same number of spaces as the current line
+          no_of_spaces = line[/\A */].size
+          # If the first char on current line is not a quote, add two more spaces
+          no_of_spaces += /['"]/.match?(line.lstrip[0]) ? 0 : 2
+
+          " " * no_of_spaces
+        end
+
+        # Returns and existing merge request with the given title
+        #
+        # @param [String] title: Title of the merge request
+        # @return [Array<Gitlab::ObjectifiedHash>] Merge requests
+        def existing_merge_requests(title:)
+          merge_request_client.find(options: { search: title, in: 'title', state: 'opened' })
+        end
+
+        private
+
+        attr_reader :token, :specs_file, :dry_run, :processor
+
+        # Returns any test description string within single or double quotes
+        #
+        # @param [String] line the line to check for any quoted string
+        # @return [String] the match or nil if no match
+        def spec_desc_string_within_quotes(line)
+          match = line.match(/(?:it|describe|context|\s)+ ['"]([^'"]*)['"]/)
+          match ? match[1] : nil
+        end
+
+        # Returns the GitlabIssueClient or GitlabIssueDryClient based on the value of dry_run
+        #
+        # @return [GitlabIssueDryClient | GitlabIssueClient]
+        def issue_client
+          @issue_client ||= (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: "gitlab-org/gitlab")
+        end
+
+        # Returns the MergeRequestDryClient or MergeRequest based on the value of dry_run
+        #
+        # @return [MergeRequestDryClient | MergeRequest]
+        def merge_request_client
+          @merge_request_client ||= (dry_run ? GitlabClient::MergeRequestsDryClient : GitlabClient::MergeRequestsClient).new(
+            token: token,
+            project: project
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.12.0"
+    VERSION = "1.14.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.14.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -342,12 +342,27 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A collection of test-related tools.
 email:
 - quality@gitlab.com
 executables:
 - flaky-test-issues
 - generate-test-session
+- knapsack-report-issues
 - post-to-slack
 - prepare-stage-reports
 - relate-failure-issue
@@ -355,6 +370,7 @@ executables:
 - slow-test-issues
 - slow-test-merge-request-report-note
 - update-screenshot-paths
+- update-test-meta
 extensions: []
 extra_rdoc_files: []
 files:
@@ -374,6 +390,7 @@ files:
 - Rakefile
 - exe/flaky-test-issues
 - exe/generate-test-session
+- exe/knapsack-report-issues
 - exe/post-to-slack
 - exe/prepare-stage-reports
 - exe/relate-failure-issue
@@ -381,6 +398,7 @@ files:
 - exe/slow-test-issues
 - exe/slow-test-merge-request-report-note
 - exe/update-screenshot-paths
+- exe/update-test-meta
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
 - lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb
@@ -396,6 +414,8 @@ files:
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/repository_files_client.rb
+- lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb
+- lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb
 - lib/gitlab_quality/test_tooling/labels_inference.rb
 - lib/gitlab_quality/test_tooling/report/concerns/group_and_category_labels.rb
 - lib/gitlab_quality/test_tooling/report/concerns/issue_reports.rb
@@ -404,6 +424,7 @@ files:
 - 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/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
 - lib/gitlab_quality/test_tooling/report/prepare_stage_reports.rb
 - lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb
@@ -431,6 +452,10 @@ files:
 - lib/gitlab_quality/test_tooling/system_logs/log_types/rails/graphql_log.rb
 - lib/gitlab_quality/test_tooling/system_logs/shared_fields.rb
 - lib/gitlab_quality/test_tooling/system_logs/system_logs_formatter.rb
+- lib/gitlab_quality/test_tooling/test_meta/processor/add_to_blocking_processor.rb
+- lib/gitlab_quality/test_tooling/test_meta/processor/add_to_quarantine_processor.rb
+- lib/gitlab_quality/test_tooling/test_meta/processor/meta_processor.rb
+- lib/gitlab_quality/test_tooling/test_meta/test_meta_updater.rb
 - lib/gitlab_quality/test_tooling/test_metric/json_test_metric.rb
 - lib/gitlab_quality/test_tooling/test_metrics/json_test_metric_collection.rb
 - lib/gitlab_quality/test_tooling/test_result/base_test_result.rb