gitlab_quality-test_tooling 1.13.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5576ca28a8e8cbf76564017a53418fd059747789bbbb8146835285d8f5b37c
-  data.tar.gz: b1d7c6dd581dccabe91f64687b420a83f5561aa407e1e4583e7a5146183890f4
+  metadata.gz: 9d4626e6b818482d139f6256f13044ae3434b93989c377526485aae69f32b9eb
+  data.tar.gz: 148291a52850f6b6b5612dc0e1c46d2a6af0115d771c3ad3c9d1a0af7dbe2280
 SHA512:
-  metadata.gz: d245b9be5a9a127630d934096277c339e649e9e719727f871d8b794245b385e6f4dbfba3175c546f44b2ee833099ef5398738dcaa631bab39b44eb9734fe338f
-  data.tar.gz: 33a391d891853d45e75198462d504641d090e0f619e31a9fbf5c613b4fe5cef6443d6b465e9e2ffc27d643a3d8d8426030bb10c872a83ca0a2def1b0232ae0ae
+  metadata.gz: a2fca44f7bf0ccda3cf905e561b8d52f7462df04c35f54a92d61fed7f4e6121e82bd2d3d60757f46b1c8d2cd30e788ac72aad4fd9d96e5607e50960437c7c58c
+  data.tar.gz: 29a5e42c5c8f34b76e2aabb6280f0150a4aedf5d34a43bf44aef4be25aacb71d6a5f1bd9942f0593ec90626db3079cc2ad2fd4ee40ef084e9de9bd738cd427d4

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.13.0)
-      activesupport (>= 6.1, < 7.2)
+    gitlab_quality-test_tooling (1.14.1)
+      activesupport (>= 6.1, < 7.1)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
       http (~> 5.0)
       nokogiri (~> 1.10)
       parallel (>= 1, < 2)
       rainbow (>= 3, < 4)
+      rspec-parameterized (~> 1.0.0)
       table_print (= 1.5.7)
       zeitwerk (>= 2, < 3)
 
@@ -20,15 +21,16 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.4)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     amatch (0.4.1)
       mize
       tins (~> 1.0)
     ast (2.4.2)
     backport (1.2.0)
-    benchmark (0.2.1)
+    benchmark (0.3.0)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
     byebug (11.1.3)
     claide (1.1.0)
     claide-plugins (0.9.2)
@@ -38,60 +40,60 @@ GEM
     climate_control (1.2.0)
     coderay (1.1.3)
     colored2 (3.1.2)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
-    danger (9.3.0)
+    danger (9.4.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.13.0)
+      git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 5.0)
+      octokit (>= 4.0)
       terminal-table (>= 1, < 4)
     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)
-      unf (>= 0.0.5, < 1.0.0)
+    domain_name (0.6.20240107)
     e2mmap (0.1.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-http-cache (2.5.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-http-cache (2.5.1)
       faraday (>= 0.8)
-    faraday-net_http (3.0.2)
-    ffi (1.15.5)
+    faraday-net_http (3.1.0)
+      net-http
+    ffi (1.16.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
     formatador (1.1.0)
-    git (1.13.2)
+    git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     gitlab (4.19.0)
       httparty (~> 0.20)
       terminal-table (>= 1.5.1)
-    gitlab-dangerfiles (3.8.0)
+    gitlab-dangerfiles (3.13.0)
       danger (>= 8.4.5)
       danger-gitlab (>= 8.0.0)
       rake
-    gitlab-styles (10.0.0)
-      rubocop (~> 1.43.0)
+    gitlab-styles (10.1.0)
+      rubocop (~> 1.50.2)
       rubocop-graphql (~> 0.18)
       rubocop-performance (~> 1.15)
       rubocop-rails (~> 2.17)
-      rubocop-rspec (~> 2.18)
-    guard (2.18.0)
+      rubocop-rspec (~> 2.22)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -105,7 +107,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (1.0.1)
+    hashdiff (1.1.0)
     http (5.1.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
@@ -117,45 +119,52 @@ GEM
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.6.3)
+    jaro_winkler (1.5.6)
+    json (2.7.1)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    lefthook (1.3.11)
+    lefthook (1.6.1)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    lumberjack (1.2.8)
+    lumberjack (1.2.10)
     method_source (1.0.0)
-    mini_mime (1.1.2)
-    mini_portile2 (2.8.1)
-    minitest (5.18.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.21.2)
     mize (0.4.1)
       protocol (~> 2.0)
     multi_xml (0.6.0)
     nap (1.1.0)
     nenv (0.3.0)
+    net-http (0.4.1)
+      uri
     no_proxy_fix (0.1.2)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.16.0)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (5.6.1)
+    octokit (8.0.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     open4 (1.3.4)
-    parallel (1.23.0)
-    parser (3.2.2.1)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
+      racc
+    proc_to_ast (0.1.0)
+      coderay
+      parser
+      unparser
     protocol (2.0.0)
       ruby_parser (~> 3.0)
     pry (0.14.2)
@@ -164,20 +173,20 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.1)
-    racc (1.6.2)
-    rack (3.0.7)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.8)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rbs (2.8.4)
     rchardet (1.8.0)
-    regexp_parser (2.8.0)
+    regexp_parser (2.9.0)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -187,44 +196,59 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.43.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.1)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
     rubocop-graphql (0.19.0)
       rubocop (>= 0.87, < 2)
-    rubocop-performance (1.17.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.19.1)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rails (2.23.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.20.0)
-      rubocop (~> 1.33)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    ruby_parser (3.20.3)
+    ruby_parser (3.21.0)
+      racc (~> 1.5)
       sexp_processor (~> 4.16)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    sexp_processor (4.17.0)
+    sexp_processor (4.17.1)
     shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -235,7 +259,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.49.0)
+    solargraph (0.50.0)
       backport (~> 1.2)
       benchmark
       bundler (~> 2.0)
@@ -255,23 +279,24 @@ GEM
     table_print (1.5.7)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    tilt (2.1.0)
-    timecop (0.9.6)
+    thor (1.3.0)
+    tilt (2.3.0)
+    timecop (0.9.8)
     tins (1.32.1)
       sync
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
+    unparser (0.6.12)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.2.4)
+    uri (0.13.0)
     webmock (3.7.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.34)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby

data/README.md

@@ -188,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/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/gitlab_client/merge_requests_dry_client.rb

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

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

@@ -25,7 +25,7 @@ module GitlabQuality
 
         ENV_VARIABLES.each do |env_name, method_name|
           define_method(method_name) do
-            env_var_value_if_defined(env_name) || (instance_variable_get("@#{method_name}") if instance_variable_defined?("@#{method_name}"))
+            env_var_value_if_defined(env_name) || (instance_variable_get(:"@#{method_name}") if instance_variable_defined?(:"@#{method_name}"))
           end
         end
 

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,256 @@
+# 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
+          if iid
+            issue_client.create_issue_note(iid: iid, note: note)
+          else
+            Runtime::Logger.info("#{self.class.name}##{__method__} Note was NOT posted on report issue: #{report_issue}")
+          end
+        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: project)
+        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.13.0"
+    VERSION = "1.14.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -201,7 +201,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: amatch
   requirement: !ruby/object:Gem::Requirement
@@ -342,6 +342,20 @@ 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
@@ -356,6 +370,7 @@ executables:
 - slow-test-issues
 - slow-test-merge-request-report-note
 - update-screenshot-paths
+- update-test-meta
 extensions: []
 extra_rdoc_files: []
 files:
@@ -383,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
@@ -436,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