gitlab_quality-test_tooling 1.17.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8709476aafe6dc96d2b49d1d74b18b2e3dbf6c37cb8ebb0acd631d05dbfe2ac
-  data.tar.gz: 26d4d54613a522014b5f3b93f38c0cb62027c2e209573727265a5c2b630a6d9d
+  metadata.gz: 9549372e9bad8839b0f8ff6a0ca1646579d244cc596d74fbbdc1234bd1e5a176
+  data.tar.gz: 065ee0af0ea8e14fcf4719ede74ab1a5950c05f17caef3e070832bd4695089ae
 SHA512:
-  metadata.gz: 194294ffed245e88a96e35480485f98c1748a8417766cdca1cf737ece2b090a4e29efc444fa449f5f569e292333ba50954f7c07a72fbb2f9225c9195c4b6f411
-  data.tar.gz: 30cc7f3a5da1c15b5c3508e0850c007bddf9f22a85c9ec1361821be7bc330afd3869cd9fe74d3b424afc2d0ad2d180c4c0649b5f502f4740ca68f1b2c8119933
+  metadata.gz: c8e9cbbef843556bd9cbc6f510223627712fbe035ade98e7ce005f13dfe7082668d42a7018857d7015d3236aa970d0b049e5fdfffc9829b0021c0c5cabeb6297
+  data.tar.gz: bce2b74fe864a48a6ab3155595431e81f08cf3ae5c0069612165885b96819492a4258bb613fbd01ea35e51962c12f582be334e6554cfaf877bae617dcd690e5e

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.17.0)
-      activesupport (>= 6.1, < 7.1)
+    gitlab_quality-test_tooling (1.21.0)
+      activesupport (>= 6.1, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
       http (~> 5.0)
@@ -16,10 +16,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
@@ -28,7 +33,9 @@ GEM
       tins (~> 1.0)
     ast (2.4.2)
     backport (1.2.0)
+    base64 (0.2.0)
     benchmark (0.3.0)
+    bigdecimal (3.1.6)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     byebug (11.1.3)
@@ -41,6 +48,7 @@ GEM
     coderay (1.1.3)
     colored2 (3.1.2)
     concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.5)
@@ -65,6 +73,7 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     domain_name (0.6.20240107)
+    drb (2.2.1)
     e2mmap (0.1.0)
     faraday (2.9.0)
       faraday-net_http (>= 2.0, < 3.2)
@@ -119,7 +128,7 @@ GEM
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.6)
     json (2.7.1)
@@ -138,10 +147,11 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
-    minitest (5.21.2)
+    minitest (5.22.2)
     mize (0.4.1)
       protocol (~> 2.0)
     multi_xml (0.6.0)
+    mutex_m (0.2.0)
     nap (1.1.0)
     nenv (0.3.0)
     net-http (0.4.1)
@@ -318,4 +328,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.5.4
+   2.5.6

data/exe/generate-test-session

@@ -31,6 +31,10 @@ options = OptionParser.new do |opts|
     params[:issue_url_file] = issue_url_file
   end
 
+  opts.on('--pipeline-stages STAGES', String, 'Comma-separated list of pipeline stages to include in test session issue') do |pipeline_stages|
+    params[:pipeline_stages] = pipeline_stages.split(',')
+  end
+
   opts.on('--confidential', "Makes test session issue confidential") do
     params[:confidential] = true
   end

data/lefthook.yml

@@ -17,7 +17,8 @@ pre-push:
     # Changelog git trailer for the first commit of the branch
     changelog-on-first-commit:
       run: |
-        first_commit_message=$(git log --format=%B -n 1 $(git log main..HEAD --pretty=format:"%h" | tail -1))
+        git fetch origin main
+        first_commit_message=$(git log --format=%B -n 1 $(git log origin/main..HEAD --pretty=format:"%h" | tail -1))
         if ! echo ${first_commit_message} | grep "Changelog:"; then
           echo Could not find a Changelog: git trailer on the first commit for this branch.
           echo

data/lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb

@@ -6,19 +6,23 @@ module GitlabQuality
   module TestTooling
     module Concerns
       module FindSetDri
-        def set_dri_via_group(product_group, stage)
+        def test_dri(product_group, stage, section)
           parse_json_with_sets
+          fetch_section_sets(section)
           fetch_stage_sets(stage)
-
-          return @sets.sample['username'] if @stage_sets.empty?
-
           fetch_group_sets(product_group)
 
-          if @group_sets.empty?
-            @stage_sets.sample['username']
-          else
-            @group_sets.sample['username']
-          end
+          set_dris = if @group_sets.any?
+                       @group_sets
+                     elsif @stage_sets.any?
+                       @stage_sets
+                     elsif @section_sets.any?
+                       @section_sets
+                     else
+                       @sets
+                     end
+
+          set_dris.sample['username']
         end
 
         private
@@ -30,6 +34,15 @@ module GitlabQuality
           @sets = JSON.parse(response.body).select { |user| user['role'].include?('software-engineer-in-test') }
         end
 
+        def fetch_section_sets(section)
+          @section_sets = []
+          return if section.nil?
+
+          @section_sets = @sets.select do |user|
+            user['role'].include?(section.split("_").map(&:capitalize).join(" "))
+          end
+        end
+
         def fetch_stage_sets(stage)
           @stage_sets = @sets.select do |user|
             user['role'].include?(stage.split("_").map(&:capitalize).join(" "))

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

@@ -27,7 +27,7 @@ module GitlabQuality
 
           raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS
 
-          warn("#{error.class.name} #{error.message}")
+          warn("#{e.class.name} #{e.message}")
           warn("Sleeping for #{@retry_backoff} seconds before retrying...")
           sleep @retry_backoff
 

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

@@ -4,17 +4,18 @@ module GitlabQuality
   module TestTooling
     module GitlabClient
       class RepositoryFilesClient < GitlabClient
-        attr_reader :file_path
+        attr_reader :file_path, :ref
 
-        def initialize(file_path:, **kwargs)
+        def initialize(file_path:, ref:, **kwargs)
           @file_path = file_path
+          @ref = ref
 
           super
         end
 
         def file_contents
           handle_gitlab_client_exceptions do
-            client.file_contents(project, file_path.gsub(%r{^/}, ""))
+            client.file_contents(project, file_path.gsub(%r{^/}, ""), ref)
           end
         end
       end

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

@@ -7,15 +7,16 @@ module GitlabQuality
   module TestTooling
     module Report
       class GenerateTestSession < ReportAsIssue
-        def initialize(ci_project_token:, **kwargs)
+        def initialize(ci_project_token:, pipeline_stages: nil, **kwargs)
           super
           @ci_project_token = ci_project_token
+          @pipeline_stages = Set.new(pipeline_stages)
           @issue_type = 'issue'
         end
 
         private
 
-        attr_reader :ci_project_token
+        attr_reader :ci_project_token, :pipeline_stages
 
         # rubocop:disable Metrics/AbcSize
         def run!
@@ -27,6 +28,8 @@ module GitlabQuality
             TestResults::JsonTestResults.new(path).to_a
           end
 
+          tests = tests.select { |test| pipeline_stages.include? test.report["stage"] } unless pipeline_stages.empty?
+
           issue = gitlab.create_issue(
             title: "#{Time.now.strftime('%Y-%m-%d')} Test session report | #{Runtime::Env.qa_run_type}",
             description: generate_description(tests),
@@ -80,20 +83,10 @@ module GitlabQuality
         end
 
         def generate_failed_jobs_listing
-          failed_jobs = []
-
-          ci_project_client = Gitlab.client(
-            endpoint: Runtime::Env.ci_api_v4_url,
-            private_token: ci_project_token)
-
-          gitlab.handle_gitlab_client_exceptions do
-            failed_jobs = ci_project_client.pipeline_jobs(
-              Runtime::Env.ci_project_id,
-              Runtime::Env.ci_pipeline_id,
-              scope: 'failed')
-          end
+          failed_jobs = fetch_pipeline_failed_jobs
+          listings = failed_jobs.filter_map do |job|
+            next if pipeline_stages.any? && !pipeline_stages.include?(job.stage)
 
-          listings = failed_jobs.map do |job|
             allowed_to_fail = ' (allowed to fail)' if job.allow_failure
 
             "* [#{job.name}](#{job.web_url})#{allowed_to_fail}"
@@ -272,6 +265,23 @@ module GitlabQuality
           * https://dashboards.quality.gitlab.net/d/tR_SmBDVk/main-runs?orgId=1&refresh=1m&var-run_type=#{Runtime::Env.qa_run_type}
           MARKDOWN
         end
+
+        def fetch_pipeline_failed_jobs
+          failed_jobs = []
+
+          ci_project_client = Gitlab.client(
+            endpoint: Runtime::Env.ci_api_v4_url,
+            private_token: ci_project_token)
+
+          gitlab.handle_gitlab_client_exceptions do
+            failed_jobs = ci_project_client.pipeline_jobs(
+              Runtime::Env.ci_project_id,
+              Runtime::Env.ci_pipeline_id,
+              scope: 'failed')
+          end
+
+          failed_jobs
+        end
       end
     end
   end

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

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'active_support/core_ext/enumerable'
 require 'rubygems/text'
-require 'active_support/core_ext/integer/time'
 require 'amatch'
 
 module GitlabQuality
@@ -330,7 +328,7 @@ module GitlabQuality
         def new_issue_assignee_id(test)
           return unless test.product_group?
 
-          dri = set_dri_via_group(test.product_group, test.stage)
+          dri = test_dri(test.product_group, test.stage, test.section)
           puts "  => Assigning #{dri} as DRI for the issue."
 
           gitlab.find_user_id(username: dri)
@@ -339,7 +337,7 @@ module GitlabQuality
         def new_issue_due_date(test)
           return unless test.product_group?
 
-          Date.today + 1.month
+          Date.today.next_month
         end
 
         def update_reports(issue, test)

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

@@ -60,7 +60,6 @@ module GitlabQuality
           | Description | `#{test.name}` |
           | Test level | #{test.level} |
           | Hash | `#{test_hash(test)}` |
-          | Reference duration | #{test.run_time} seconds |
           | Expected duration | < #{test.max_duration_for_test} seconds |
           #{"| Test case | #{test.testcase} |" if test.testcase}
           DESCRIPTION

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

@@ -93,7 +93,7 @@ module GitlabQuality
             current_reports_content: reports_note&.body.to_s,
             test: test,
             reports_section_header: REPORT_SECTION_HEADER,
-            item_extra_content: found_label,
+            item_extra_content: "(#{test.run_time} seconds) #{found_label}",
             reports_extra_content: REPORTS_DOCUMENTATION
           )
         end

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

@@ -38,7 +38,7 @@ module GitlabQuality
               console_log = console_logger(source: source, level: Env.log_level)
               file_log = file_logger(source: source, path: log_path)
 
-              console_log.extend(ActiveSupport::Logger.broadcast(file_log))
+              ActiveSupport::BroadcastLogger.new(console_log, file_log, file_log)
             end
           end
 

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

@@ -6,86 +6,42 @@ module GitlabQuality
       module Processor
         class AddToBlockingProcessor < MetaProcessor
           BLOCKING_METADATA = ", :blocking%{suffix}"
+          BRANCH_PREFIX = 'blocking-promotion'
 
           class << self
-            # Execute the processor
+            # Creates the merge requests for promoting E2E tests to :blocking
             #
-            # @param [Hash] spec the spec to update
             # @param [TestMetaUpdater] context instance of TestMetaUpdater
-            def execute(spec, context) # rubocop:disable Metrics/AbcSize
+            def create_merge_requests(context)
               @context = context
-              @existing_mrs = nil
-              @file_path = spec["file_path"]
-              testcase = spec["testcase"]
-              devops_stage = spec["stage"]
-              product_group = spec["product_group"]
-              @example_name = spec["name"]
-              @mr_title = format("%{prefix} %{example_name}", prefix: '[PROMOTE TO BLOCKING]', example_name: example_name).truncate(72, omission: '')
 
-              @file_contents = context.get_file_contents(file_path)
+              context.processed_commits.each_value do |record|
+                branch, devops_stage, product_group, file, reviewer_id, assignee_handle = extract_data_from_record(record)
 
-              new_content, @changed_line_no = add_blocking_metadata
+                mr_title = format("%{prefix} %{file}", prefix: '[E2E] PROMOTE TO BLOCKING:', file: file).truncate(72, omission: '')
 
-              return unless proceed_with_merge_request?
-
-              branch = context.create_branch("blocking-promotion-#{SecureRandom.hex(4)}", example_name, context.ref)
-
-              context.commit_changes(branch, <<~COMMIT_MESSAGE, file_path, new_content)
-                Promote end-to-end test to blocking
-
-                #{"Promote to blocking: #{example_name}".truncate(72)}
-              COMMIT_MESSAGE
-
-              reviewer_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage)
-
-              gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
-
-              merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id, [reviewer_id]) do
-                <<~MARKDOWN
-                  ## What does this MR do?
-
-                  Promotes the test [`#{example_name}`](https://gitlab.com/#{context.project}/-/blob/#{context.ref}/#{file_path}#L#{changed_line_no + 1})
-                  to the blocking bucket
-
-                  This test was identified in the reliable e2e test report: #{context.report_issue}
-
-                  [Testcase link](#{testcase})
-
-                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
-
-                  /label ~"Quality" ~"QA" ~"type::maintenance"
-                  /label ~"devops::#{devops_stage}"
-                  #{context.label_from_product_group(product_group)}
-
-                  <div align="center">
-                  (This MR was automatically generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling) at #{Time.now.utc})
-                  </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.
+                merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id, [reviewer_id]) do
+                  merge_request_description(record, devops_stage, product_group)
+                end
 
-                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
+                context.post_note_on_merge_request(maintainer_note_on_merge_request(assignee_handle), merge_request.iid)
 
-              if merge_request
-                context.add_processed_record({ file_path => changed_line_no })
-                Runtime::Logger.info("  Created MR for promotion to blocking: #{merge_request.web_url}")
+                if merge_request
+                  Runtime::Logger.info("  Created MR for promotion to blocking: #{merge_request.web_url}")
+                  record[:merge_request] = merge_request
+                end
               end
-
-              merge_request
             end
 
-            # Performs post processing. Takes a list of MRs and posts them in a note on report_issue
+            # Performs post processing. Posts a list of MRs 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
+            # @param [TestMetaUpdater] context instance of TestMetaUpdater
+            def post_process(context)
+              web_urls = context.processed_commits.values.map { |value| "- #{value[:merge_request].web_url}\n" }.join
 
               return if web_urls.empty?
 
-              context.post_note_on_report_issue(<<~ISSUE_NOTE)
+              context.post_note_on_issue(<<~ISSUE_NOTE, context.report_issue)
                 The following merge requests have been created to promote stable specs to blocking:
 
                 #{web_urls}
@@ -94,34 +50,80 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title, :changed_line_no
+            attr_reader :context, :file_path, :file, :file_contents, :example_name, :mr_title, :changed_line_no
 
             # Checks if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
+            def proceed_with_commit?
               if changed_line_no.negative?
                 Runtime::Logger.info("  No lines were changed in #{file_path}. Will not proceed with creating MR.")
                 return false
-              elsif context.record_processed?(file_path, changed_line_no)
+              elsif context.commit_processed?(file_path, changed_line_no)
                 Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
                 return false
-              elsif existing_mrs&.any?
-                Runtime::Logger.info("  An open MR already exists for '#{example_name}':  #{existing_mrs.first['web_url']}. Will not proceed with creating MR.")
-                return false
               end
 
               true
             end
 
+            def commit_message
+              <<~COMMIT_MESSAGE
+                Promote end-to-end test to blocking
+
+                #{"Promote to blocking: #{example_name}".truncate(72)}
+              COMMIT_MESSAGE
+            end
+
+            def maintainer_note_on_merge_request(assignee_handle)
+              <<~MARKDOWN
+                @#{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
+            end
+
+            def merge_request_description(record, devops_stage, product_group)
+              <<~MARKDOWN
+                  ## What does this MR do?
+
+                  Promotes the following e2e tests to the blocking bucket:
+
+                  #{spec_details_from_commits(record[:commits])}
+
+                  This MR was created based on data from reliable e2e test report: #{context.report_issue}
+
+                  /label ~"Quality" ~"QA" ~"type::maintenance"
+                  /label ~"devops::#{devops_stage}"
+                  #{context.label_from_product_group(product_group)}
+
+                  <div align="center">
+                  (This MR was automatically generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling) at #{Time.now.utc})
+                  </div>
+              MARKDOWN
+            end
+
+            def extract_data_from_record(record)
+              first_spec = record[:commits].values.first
+              product_group = first_spec["product_group"]
+              devops_stage = first_spec["stage"]
+              reviewer_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage, first_spec["section"])
+
+              [record[:branch], devops_stage, product_group, first_spec["file"], reviewer_id, assignee_handle]
+            end
+
+            def gitlab_bot_user_id
+              context.user_id_for_username(Runtime::Env.gitlab_bot_username)
+            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
+            def add_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"
+                Runtime::Logger.info("Example '#{example_name}' is already blocking")
                 return [file_contents, -1]
               end
 

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

@@ -12,149 +12,193 @@ module GitlabQuality
             %{indentation}  type: %{quarantine_type}
             %{indentation}}%{suffix}
           META
+          BRANCH_PREFIX = 'quarantine'
 
           class << self
-            # Execute the processor
+            # Creates the merge requests to quarantine E2E tests
             #
-            # @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
+            def create_merge_requests(context)
               @context = context
-              @existing_mrs = nil
-              @file_path = spec["file_path"]
-              testcase = spec["testcase"]
-              devops_stage = spec["stage"]
-              product_group = spec["product_group"]
-              @failure_issue_url = spec["failure_issue"]
-              @example_name = spec["name"]
-              @issue_id = failure_issue_url.split('/').last # split url segment, last segment of path is the issue id
-              @mr_title = format("%{prefix} %{example_name}", prefix: '[QUARANTINE]', example_name: example_name).truncate(72, omission: '')
-              @failure_issue = context.fetch_issue(iid: issue_id)
 
-              @file_contents = context.get_file_contents(file_path)
+              context.processed_commits.each_value do |record|
+                branch, devops_stage, product_group, file = extract_data_from_record(record)
 
-              new_content, @changed_line_no = add_quarantine_metadata
+                mr_title = format("%{prefix} %{file}", prefix: '[E2E] QUARANTINE:', file: file).truncate(72, omission: '')
 
-              return unless proceed_with_merge_request?
+                gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
 
-              branch = context.create_branch("#{issue_id}-quarantine-#{SecureRandom.hex(4)}", example_name, context.ref)
+                merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id) do
+                  merge_request_description(record, devops_stage, product_group)
+                end
 
-              context.commit_changes(branch, <<~COMMIT_MESSAGE, file_path, new_content)
-                Quarantine end-to-end test
+                if merge_request
+                  Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+                  record[:merge_request] = merge_request
+                end
+              end
+            end
 
-                #{"Quarantine #{example_name}".truncate(72)}
-              COMMIT_MESSAGE
+            # Performs post processing. Posts a list of MRs in a note on report_issue and Slack.
+            # Also posts note on failure issues for un-quarantining of the quarantined
+            #
+            # @param [TestMetaUpdater] context instance of TestMetaUpdater
+            def post_process(context)
+              @context = context
 
-              gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
+              web_urls = context.processed_commits.values.map { |value| "- #{value[:merge_request].web_url}\n" }.join
 
-              merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id) do
-                <<~MARKDOWN
-                  ## What does this MR do?
+              return if web_urls.empty?
 
-                  Quarantines the test [`#{example_name}`](https://gitlab.com/#{context.project}/-/blob/#{context.ref}/#{file_path}#L#{changed_line_no + 1})
+              context.post_note_on_issue(mrs_created_note_for_report_issue(web_urls), context.report_issue)
 
-                  This test was identified in the reliable e2e test report: #{context.report_issue}
+              context.post_message_on_slack(mrs_created_message_for_slack(web_urls))
 
-                  [Testcase link](#{testcase})
+              post_unquarantine_note_on_failure_issue
+            end
 
-                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
+            private
 
-                  ### E2E Test Failure issue(s)
+            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
+              :mr_title, :failure_issue, :changed_line_no
 
-                  #{failure_issue_url}
+            # Checks if the failure issue is closed or if there is already an MR open
+            #
+            # @return [Boolean]
+            def proceed_with_commit?
+              if context.issue_is_closed?(failure_issue)
+                Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR.")
+                return false
+              elsif context.commit_processed?(file_path, changed_line_no)
+                Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
+              elsif failure_is_related_to_test_environment?
+                Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is environment related. Will not proceed with creating MR.")
+                return false
+              end
 
-                  ### Check-list
+              true
+            end
 
-                  - [ ] 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.
+            def failure_is_related_to_test_environment?
+              context.issue_scoped_label(failure_issue, 'failure')&.split('::')&.last == 'test-environment'
+            end
 
-                  <!-- Base labels. -->
-                  /label ~"Quality" ~"QA" ~"type::maintenance" ~"maintenance::pipelines"
+            def extract_data_from_record(record)
+              first_spec = record[:commits].values.first
+              [record[:branch], first_spec["stage"], first_spec["product_group"], first_spec["file"]]
+            end
+
+            # Posts note on failure issue to un-quarantine the test
+            #
+            def post_unquarantine_note_on_failure_issue
+              context.processed_commits.each_value do |record|
+                merge_request = record[:merge_request]
+                next unless merge_request
 
-                  <!--
-                  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}"
-                  #{context.label_from_product_group(product_group)}
+                record[:commits].each_value do |spec|
+                  devops_stage = spec["stage"]
+                  product_group = spec["product_group"]
+                  failure_issue = spec["failure_issue"]
 
-                  <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
+                  next unless failure_issue
 
-              if merge_request
-                context.add_processed_record({ file_path => changed_line_no })
-                Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+                  note = context.post_note_on_issue(unquarantine_note_for_failure(spec, product_group, devops_stage, merge_request),
+                    failure_issue)
+
+                  Runtime::Logger.info("  Posted note on failure issue for un-quarantine: #{failure_issue}") if note
+                end
               end
+            end
+
+            def merge_request_description(record, devops_stage, product_group)
+              <<~MARKDOWN
+                ## What does this MR do?
 
-              merge_request
+                Quarantines the following e2e tests:
+
+                #{spec_details_from_commits(record[:commits])}
+
+                This MR was created based on data from reliable e2e test report: #{context.report_issue}
+
+                ### 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}"
+                #{context.label_from_product_group(product_group)}
+
+                <div align="center">
+                (This MR was automatically generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling) at #{Time.now.utc})
+                </div>
+              MARKDOWN
             end
 
-            # 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
+            def commit_message
+              <<~COMMIT_MESSAGE
+                Quarantine end-to-end test
 
-              return if web_urls.empty?
+                #{"Quarantine #{example_name}".truncate(72)}
+              COMMIT_MESSAGE
+            end
 
-              context.post_note_on_report_issue(<<~ISSUE_NOTE)
+            def mrs_created_note_for_report_issue(web_urls)
+              <<~ISSUE_NOTE
 
                 The following merge requests have been created to quarantine the unstable tests:
 
                 #{web_urls}
               ISSUE_NOTE
+            end
+
+            def unquarantine_note_for_failure(spec, product_group, devops_stage, merge_request)
+              failure_issue_assignee_handle = get_failure_issue_assignee_handle(spec, product_group, devops_stage)
+              <<~ISSUE_NOTE
+                @#{failure_issue_assignee_handle} This test will be quarantined in #{merge_request.web_url} based on data from reliable e2e test report: #{context.report_issue}
+
+                Please take this issue forward to un-quarantine the test by either addressing the issue yourself or delegating it to the relevant product group.
+
+                If this issue is delegated, please make sure to update the assignee. Thanks.
+              ISSUE_NOTE
+            end
 
-              context.post_message_on_slack(<<~MSG)
+            def mrs_created_message_for_slack(web_urls)
+              <<~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.
+                Maintainers are requested to review and merge the above MRs. Thank you.
               MSG
             end
 
-            private
-
-            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
-              :issue_id, :mr_title, :failure_issue, :changed_line_no
+            def get_failure_issue_assignee_handle(spec, product_group, devops_stage)
+              return spec["failure_issue_assignee_handle"] if spec["failure_issue_assignee_handle"]
 
-            # Checks if the failure issue is closed or if there is already an MR open
-            #
-            # @return [Boolean]
-            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
-              if context.issue_is_closed?(failure_issue)
-                Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR.")
-                return false
-              elsif context.record_processed?(file_path, changed_line_no)
-                Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
-                return false
-              elsif existing_mrs&.any?
-                Runtime::Logger.info("  An open MR already exists for '#{example_name}':  #{existing_mrs.first['web_url']}. Will not proceed with creating MR.")
-                return false
-              end
-
-              true
+              _, assignee_handle = context.fetch_dri_id(product_group, devops_stage, nil)
+              assignee_handle
             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
+            def add_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|

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

@@ -10,12 +10,12 @@ module GitlabQuality
           class << self
             DESCRIPTION_REGEX = /('.*?')|(".*?")/
 
-            def execute
-              raise 'method not implemented'
+            def post_process
+              raise NotImplementedError, 'Subclass must implement this method'
             end
 
-            def post_process
-              raise 'method not implemented'
+            def create_merge_requests
+              raise NotImplementedError, 'Subclass must implement this method'
             end
 
             private_class_method :new
@@ -36,6 +36,65 @@ module GitlabQuality
               description_start_index = line.index(DESCRIPTION_REGEX)
               description_start_index + description_length
             end
+
+            # List specs in markdown with details such as link to code, testcase, metrics and failure issue
+            #
+            # @param [Hash<String,Hash>] commits The commits hash to use for spec details
+            # @return String
+            def spec_details_from_commits(commits)
+              commits.each_with_index.map do |(changed_line_number, spec), index|
+                <<~MARKDOWN
+                  #{index + 1}. [`#{spec['name']}`](https://gitlab.com/#{context.project}/-/blob/#{context.ref}/#{spec['file_path']}#L#{changed_line_number.to_i + 1})
+                      | [Testcase](#{spec['testcase']}) | [Spec metrics](#{context.single_spec_metrics_link(spec['name'])})
+                      #{failure_issue_text(spec)}
+                MARKDOWN
+              end.join("\n")
+            end
+
+            # Returns a string in markdown of failure issue and its link
+            #
+            # @param [Hash] spec the spec for failure issue
+            # @return [String]
+            def failure_issue_text(spec)
+              spec['failure_issue'].empty? ? '' : "| [Failure issue](#{spec['failure_issue']})"
+            end
+
+            # Creates a commit depending on the context provided and adds it to a Hash of created commits
+            #
+            # @param [Hash] spec the spec to update
+            # @param [TestMetaUpdater] context instance of TestMetaUpdater
+            def create_commit(spec, context) # rubocop:disable Metrics/AbcSize
+              @context = context
+              @file_path = spec["file_path"]
+              @file = spec["file"]
+              @example_name = spec["name"]
+              @failure_issue_url = spec["failure_issue"]
+
+              issue_id = failure_issue_url&.split('/')&.last # split url segment, last segment of path is the issue id
+              existing_branch = context.branch_for_file_path(file_path)
+
+              @file_contents = context.get_file_contents(file_path: file_path,
+                branch: existing_branch && existing_branch['name'])
+
+              @failure_issue = context.fetch_issue(iid: issue_id) if issue_id
+
+              spec['failure_issue_assignee_handle'] = @failure_issue['assignee']['username'] if @failure_issue && @failure_issue['assignee']
+
+              new_content, @changed_line_no = add_metadata
+
+              return unless proceed_with_commit?
+
+              branch = existing_branch ||
+                context.create_branch("#{self::BRANCH_PREFIX}-#{SecureRandom.hex(4)}", @file, context.ref)
+
+              context.commit_changes(branch, commit_message, file_path, new_content)
+
+              context.add_processed_commit(file_path, changed_line_no, branch, spec)
+            end
+
+            private
+
+            attr_reader :failure_issue_url, :failure_issue
           end
         end
       end

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

@@ -8,9 +8,10 @@ module GitlabQuality
       class TestMetaUpdater
         include TestTooling::Concerns::FindSetDri
 
-        attr_reader :project, :ref, :report_issue, :processed_records
+        attr_reader :project, :ref, :report_issue, :processed_commits
 
         TEST_PLATFORM_MAINTAINERS_SLACK_CHANNEL_ID = 'C0437FV9KBN' # test-platform-maintainers
+        BATCH_LIMIT = 10
 
         def initialize(token:, project:, specs_file:, processor:, ref: 'master', dry_run: false)
           @specs_file = specs_file
@@ -19,37 +20,85 @@ module GitlabQuality
           @ref = ref
           @dry_run = dry_run
           @processor = processor
-          @processed_records = {}
+          @processed_commits = {}
         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)
+              processor.create_commit(spec, self)
+              break if processed_commits.keys.count >= BATCH_LIMIT
             end
-            processor.post_process(results)
+
+            processor.create_merge_requests(self)
+
+            processor.post_process(self)
+          end
+        end
+
+        # Add processed commits.
+        #
+        # processed_commits has the following form. Note that each key in the :commits hash
+        # is the changed line number and the value is the spec changed.
+        #
+        # {
+        #   "/file/path/for/spec_1" =>
+        #     { :commits =>
+        #       {
+        #         "34" => {"stage"=> "create", "product_group" => "source_code".. },
+        #         "38" => {"stage"=> "create", "product_group" => "source_code".. }
+        #       },
+        #       :branch => #<Gitlab::ObjectifiedHash>
+        #     },
+        #   "/file/path/for/spec_2" =>
+        #     { :commits =>
+        #       {
+        #         "34" => {"stage"=> "create", "product_group" => "source_code".. },
+        #         "38" => {"stage"=> "create", "product_group" => "source_code".. }
+        #       },
+        #       :branch => #<Gitlab::ObjectifiedHash>
+        #     },
+        # }
+        #
+        # @param [<String>] file_path the file path to the spec
+        # @param [<Integer>] changed_line_no the changed line number for the commit
+        # @param [<Gitlab::ObjectifiedHash>] branch the branch for the commit
+        # @param [<Hash>] spec spec details hash
+        # @return [Hash<String,Hash>] processed_commits
+        def add_processed_commit(file_path, changed_line_no, branch, spec)
+          if processed_commits[file_path].nil?
+            processed_commits[file_path] = { commits: { changed_line_no.to_s => spec }, branch: branch }
+          elsif processed_commits[file_path][:commits][changed_line_no.to_s].nil?
+            processed_commits[file_path][:commits].merge!({ changed_line_no.to_s => spec })
           end
         end
 
-        # Add processed records
+        # Checks if changes have already been made to given file_path and line number
+        #
+        # @param [String] file_path path to the file
+        # @param [Integer] changed_line_no updated line number
+        # @return [Boolean]
+        def commit_processed?(file_path, changed_line_no)
+          processed_commits[file_path] && processed_commits[file_path][:commits][changed_line_no.to_s]
+        end
+
+        # Returns the branch for the given file_path
         #
-        # @param [Hash<String,Integer>] record the processed record
-        # @option record [String] :file_path the path to the spec file
-        # @option spec [Intenger] :changed_line_no the line number change in file_path
-        # @return [Hash<String,Integer>] processed_records
-        def add_processed_record(record)
-          @processed_records.merge!(record)
+        # @param [String] file_path path to the file
+        # @return [<Gitlab::ObjectifiedHash>]
+        def branch_for_file_path(file_path)
+          processed_commits[file_path] && processed_commits[file_path][:branch]
         end
 
         # Fetch contents of file from the repository
         #
         # @param [String] file_path path to the file
+        # @param [String] branch branch ref
         # @return [String] contents of the file
-        def get_file_contents(file_path)
-          repository_files = GitlabClient::RepositoryFilesClient.new(token: token, project: project, file_path: file_path)
+        def get_file_contents(file_path:, branch:)
+          repository_files = GitlabClient::RepositoryFilesClient.new(token: token, project: project, file_path: file_path, ref: branch || ref)
           repository_files.file_contents
         end
 
@@ -62,11 +111,17 @@ module GitlabQuality
           lines = content.split("\n")
 
           matched_lines = []
+          example_name_for_parsing = example_name.dup
 
           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)
+            regex = /^\s?#{Regexp.escape(string_within_quotes)}/ if string_within_quotes
+
+            if !example_name_for_parsing.empty? && regex && example_name_for_parsing.match(regex)
+              example_name_for_parsing.sub!(regex, '')
+              matched_lines << [line, line_index]
+            end
           rescue StandardError => e
             puts "Error: #{e}"
           end
@@ -95,10 +150,10 @@ module GitlabQuality
         # Create a branch from the ref
         #
         # @param [String] name_prefix the prefix to attach to the branch name
-        # @param [String] example_name the example
+        # @param [String] name the branch name
         # @return [Gitlab::ObjectifiedHash] the new branch
-        def create_branch(name_prefix, example_name, ref)
-          branch_name = [name_prefix, example_name.gsub(/\W/, '-')]
+        def create_branch(name_prefix, name, ref)
+          branch_name = [name_prefix, name.gsub(/\W/, '-')]
           @branches_client ||= (dry_run ? GitlabClient::BranchesDryClient : GitlabClient::BranchesClient).new(token: token, project: project)
           @branches_client.create(branch_name.join('-'), ref)
         end
@@ -162,16 +217,17 @@ module GitlabQuality
           issue_client.find_issues(iid: iid).first
         end
 
-        # Post note on report_issue
+        # Post note on isse
         #
         # @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
+        def post_note_on_issue(note, issue_url)
+          iid = issue_url&.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}")
+            Runtime::Logger.info("#{self.class.name}##{__method__} Note was NOT posted on issue: #{issue_url}")
+            nil
           end
         end
 
@@ -190,8 +246,8 @@ module GitlabQuality
         # @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)
+        def fetch_dri_id(product_group, devops_stage, section)
+          assignee_handle = ENV.fetch('QA_TEST_DRI_HANDLE', nil) || test_dri(product_group, devops_stage, section)
 
           [user_id_for_username(assignee_handle), assignee_handle]
         end
@@ -243,15 +299,6 @@ module GitlabQuality
           merge_request_client.find(options: { search: title, in: 'title', state: 'opened' })
         end
 
-        # Checks if changes has already been made to given file and line number
-        #
-        # @param [String] file_path path to the file
-        # @param [Integer] changed_line_no updated line number
-        # @return [Boolean]
-        def record_processed?(file_path, changed_line_no)
-          processed_records[file_path] && processed_records[file_path] == changed_line_no
-        end
-
         # Infers product group label from the provided product group
         #
         # @param [String] product_group product group

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

@@ -22,6 +22,10 @@ module GitlabQuality
           raise NotImplementedError
         end
 
+        def section
+          raise NotImplementedError
+        end
+
         def category
           raise NotImplementedError
         end

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

@@ -111,6 +111,10 @@ module GitlabQuality
           report['feature_category']
         end
 
+        def section
+          report['section']
+        end
+
         def category
           report['category']
         end

data/lib/gitlab_quality/test_tooling/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.21.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-25 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.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: amatch
   requirement: !ruby/object:Gem::Requirement