gitlab_quality-test_tooling 1.19.1 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beeb1678e873990d65b474eeda84dd957becfa69e7868d83d9db5394aa9e71be
-  data.tar.gz: 8a932d572750522124c0fa24950db55a1d9e5de66e476cde0f1c17a7fb16f9d0
+  metadata.gz: 94c648574a575a2a7d23ce07a46731500edbd858ae8196e6b50ac104d260b88e
+  data.tar.gz: '0468936a09caafa090ea0f91a20bb952314a7ebabd2704d35d760901ef3f8939'
 SHA512:
-  metadata.gz: a5bf865481746bcf4e54d10e2b19b5b8ac63aefb151eb285b47566aae82e3fcf7d30ccd90603bc8a44c3fa06996f4a6bc3486575fe6aa002cf596f4e5bd0e366
-  data.tar.gz: bc1857f7fbf20040a2c4c0e4c696b3d31410b07b664f5aedcc2a5535d8c5e1ec1e5e52b8dda6fe906b1253ba218615cfbe9cb2234c130de27f3d605e8979fcff
+  metadata.gz: 24f5968a3038b68a6dc44ec7d9873ad759a73454ac8fed7bca965e0c139cb2e25324ad4a3aea841e6f302b141fa5799abae4eebdb2d58d2b04fa3f09b099b1f8
+  data.tar.gz: 2d943ff87a109e8951e2889cb6ed34321fcde844d311494de5a9f6808dee4fe80014b81d42765a244fa8338ddf2599852bb46824f50996a0db709ffd664bb5ea

data/Gemfile.lock

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

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

@@ -83,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}"
@@ -275,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/test_meta/processor/add_to_blocking_processor.rb

@@ -6,53 +6,40 @@ 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
+            # @return [Array<Gitlab::ObjectifiedHash>]
+            def create_merge_requests(context) # rubocop:disable Metrics/AbcSize
               @context = context
-              @existing_mrs = nil
-              @file_path = spec["file_path"]
-              testcase = spec["testcase"]
-              product_section = spec["section"]
-              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)
+              created_merge_requests = []
+              context.processed_commits.each_value do |record|
+                branch = record[:branch]
+                first_spec = record[:commits].values.first
+                devops_stage = first_spec["stage"]
+                product_section = first_spec["section"]
+                product_group = first_spec["product_group"]
+                file = first_spec["file"]
 
-              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?
+                reviewer_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage, product_section)
 
-              branch = context.create_branch("blocking-promotion-#{SecureRandom.hex(4)}", example_name, context.ref)
+                gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
 
-              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, product_section)
-
-              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
+                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}
+                  Promotes the following e2e tests to the blocking bucket:
 
-                  [Testcase link](#{testcase})
+                  #{mr_spec_details_from_commits(record[:commits])}
 
-                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
+                  This MR was created based on data from reliable e2e test report: #{context.report_issue}
 
                   /label ~"Quality" ~"QA" ~"type::maintenance"
                   /label ~"devops::#{devops_stage}"
@@ -61,26 +48,27 @@ module GitlabQuality
                   <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
+                  MARKDOWN
+                end
 
-              context.post_note_on_merge_request(<<~MARKDOWN, merge_request.iid)
+                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
+                MARKDOWN
 
-              if merge_request
-                context.add_processed_record({ file_path => changed_line_no })
-                Runtime::Logger.info("  Created MR for promotion to blocking: #{merge_request.web_url}")
+                if merge_request
+                  Runtime::Logger.info("  Created MR for promotion to blocking: #{merge_request.web_url}")
+                  created_merge_requests << merge_request
+                end
               end
 
-              merge_request
+              created_merge_requests
             end
 
             # Performs post processing. Takes a list of MRs and posts them in a note on report_issue
             #
-            # @param [Gitlab::ObjectifiedHash] merge_requests
+            # @param [Array<Gitlab::ObjectifiedHash>] merge_requests
             def post_process(merge_requests)
               web_urls = merge_requests.compact.map { |mr| "- #{mr.web_url}\n" }.join
 
@@ -95,34 +83,39 @@ 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
+
             # 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,95 +12,39 @@ 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
+            # @return [Array<Gitlab::ObjectifiedHash>]
+            def create_merge_requests(context) # rubocop:disable Metrics/AbcSize
               @context = context
-              @existing_mrs = nil
-              @file_path = spec["file_path"]
-              testcase = spec["testcase"]
-              devops_stage = spec["stage"]
-              product_group = spec["product_group"]
-              @failure_issue_url = spec["failure_issue"]
-              @example_name = spec["name"]
-              @issue_id = failure_issue_url.split('/').last # split url segment, last segment of path is the issue id
-              @mr_title = format("%{prefix} %{example_name}", prefix: '[QUARANTINE]', example_name: example_name).truncate(72, omission: '')
-              @failure_issue = context.fetch_issue(iid: issue_id)
 
-              @file_contents = context.get_file_contents(file_path)
+              created_merge_requests = []
+              context.processed_commits.each_value do |record|
+                branch = record[:branch]
+                first_spec = record[:commits].values.first
+                devops_stage = first_spec["stage"]
+                product_group = first_spec["product_group"]
+                file = first_spec["file"]
 
-              new_content, @changed_line_no = add_quarantine_metadata
+                mr_title = format("%{prefix} %{file}", prefix: '[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)
-
-              context.commit_changes(branch, <<~COMMIT_MESSAGE, file_path, new_content)
-                Quarantine end-to-end test
-
-                #{"Quarantine #{example_name}".truncate(72)}
-              COMMIT_MESSAGE
-
-              gitlab_bot_user_id = context.user_id_for_username(Runtime::Env.gitlab_bot_username)
-
-              merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id) do
-                <<~MARKDOWN
-                  ## What does this MR do?
-
-                  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}
-
-                  [Testcase link](#{testcase})
-
-                  [Spec metrics link](#{context.single_spec_metrics_link(example_name)})
-
-                  ### 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}"
-                  #{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
+                merge_request = context.create_merge_request(mr_title, branch, gitlab_bot_user_id) do
+                  merge_request_description(record, devops_stage, product_group)
+                end
 
-              if merge_request
-                context.add_processed_record({ file_path => changed_line_no })
-                Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+                if merge_request
+                  Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+                  created_merge_requests << merge_request
+                end
               end
 
-              merge_request
+              created_merge_requests
             end
 
             # Performs post processing. Takes a list of MRs and posts them in a note on report_issue and Slack
@@ -131,30 +75,80 @@ module GitlabQuality
             private
 
             attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
-              :issue_id, :mr_title, :failure_issue, :changed_line_no
+              :mr_title, :failure_issue, :changed_line_no
 
             # Checks if the failure issue is closed or if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
+            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.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.")
+              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
 
               true
             end
 
+            def failure_is_related_to_test_environment?
+              context.issue_scoped_label(failure_issue, 'failure')&.split('::')&.last == 'test-environment'
+            end
+
+            def merge_request_description(record, devops_stage, product_group)
+              <<~MARKDOWN
+                  ## What does this MR do?
+
+                  Quarantines the following e2e tests:
+
+                  #{mr_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
+
+            def commit_message
+              <<~COMMIT_MESSAGE
+                Quarantine end-to-end test
+
+                #{"Quarantine #{example_name}".truncate(72)}
+              COMMIT_MESSAGE
+            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,63 @@ 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 mr_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
+
+              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,7 +8,7 @@ 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
 
@@ -19,37 +19,84 @@ 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)
             end
-            processor.post_process(results)
+
+            created_merge_requests = processor.create_merge_requests(self)
+
+            processor.post_process(created_merge_requests)
+          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 +109,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 +148,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
@@ -243,15 +296,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/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.19.1"
+    VERSION = "1.20.1"
   end
 end

metadata

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