gitlab_quality-test_tooling 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d4626e6b818482d139f6256f13044ae3434b93989c377526485aae69f32b9eb
-  data.tar.gz: 148291a52850f6b6b5612dc0e1c46d2a6af0115d771c3ad3c9d1a0af7dbe2280
+  metadata.gz: 8364acd36abab9ce89c0846c346b893ca041a6a740ced7dc5c784da5990ea74c
+  data.tar.gz: 9468d8b559aeec587f9c3722e4f6e9d539d790828f9ecc7f815cc39ca22f2657
 SHA512:
-  metadata.gz: a2fca44f7bf0ccda3cf905e561b8d52f7462df04c35f54a92d61fed7f4e6121e82bd2d3d60757f46b1c8d2cd30e788ac72aad4fd9d96e5607e50960437c7c58c
-  data.tar.gz: 29a5e42c5c8f34b76e2aabb6280f0150a4aedf5d34a43bf44aef4be25aacb71d6a5f1bd9942f0593ec90626db3079cc2ad2fd4ee40ef084e9de9bd738cd427d4
+  metadata.gz: 4d287ca74d5fe7bc1bd9acd25541eb6f150f717f95f9e8c0bdf7a53ac139f3dab5186565ec74f2f7279e50dd47268d22121eb94ba2e3955cc5f6de33e7a952c0
+  data.tar.gz: e2954fea3d65bdce6e72f26a201965f45cc3aab583a34af9835f4d42f71540ad21582f4f8a96a12cd377a949644ab458ea213febfb2e6e90fbdc25c1867ddb72

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.14.1)
+    gitlab_quality-test_tooling (1.15.0)
       activesupport (>= 6.1, < 7.1)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)

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

@@ -9,7 +9,7 @@ module GitlabQuality
             client.create_branch(project, branch_name, ref)
           end
 
-          Runtime::Logger.debug("Created branch #{branch['name']} (#{branch['web_url']})")
+          Runtime::Logger.debug("Created branch #{branch['name']} (#{branch['web_url']})") if branch
           branch
         end
       end

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

@@ -5,11 +5,13 @@ module GitlabQuality
     module GitlabClient
       class CommitsClient < GitlabClient
         def create(branch_name, file_path, new_content, message)
-          commit = client.create_commit(project, branch_name, message, [
-            { action: :update, file_path: file_path, content: new_content }
-          ])
+          commit = handle_gitlab_client_exceptions do
+            client.create_commit(project, branch_name, message, [
+              { action: :update, file_path: file_path, content: new_content }
+            ])
+          end
 
-          Runtime::Logger.debug("Created commit #{commit['id']} (#{commit['web_url']}) on #{branch_name}")
+          Runtime::Logger.debug("Created commit #{commit['id']} (#{commit['web_url']}) on #{branch_name}") if commit
           commit
         end
       end

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

@@ -22,7 +22,7 @@ module GitlabQuality
           # If so, we want it to terminate at that point
           raise
         rescue SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout,
-          Gitlab::Error::InternalServerError, Gitlab::Error::Parsing => e
+          Gitlab::Error::InternalServerError, Gitlab::Error::BadRequest, Gitlab::Error::ResponseError, Gitlab::Error::Parsing => e
           @retry_backoff += RETRY_BACK_OFF_DELAY
 
           raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS

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

@@ -5,10 +5,12 @@ module GitlabQuality
     module GitlabClient
       class MergeRequestsClient < GitlabClient
         def find_merge_request_changes(merge_request_iid:)
-          client.merge_request_changes(project, merge_request_iid)
+          handle_gitlab_client_exceptions do
+            client.merge_request_changes(project, merge_request_iid)
+          end
         end
 
-        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id: nil)
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id: nil, reviewer_ids: [])
           attrs = {
             source_branch: source_branch,
             target_branch: target_branch,
@@ -16,7 +18,8 @@ module GitlabQuality
             labels: labels,
             assignee_id: assignee_id,
             squash: true,
-            remove_source_branch: true
+            remove_source_branch: true,
+            reviewer_ids: reviewer_ids
           }.compact
 
           merge_request = handle_gitlab_client_exceptions do

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

@@ -26,10 +26,11 @@ 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:, assignee_id:)
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id:, reviewer_ids:)
           puts "A merge request would be created with title: #{title} " \
                "source_branch: #{source_branch} target_branch: #{target_branch} " \
-               "description: #{description} labels: #{labels}, assignee_id: #{assignee_id}"
+               "description: #{description} labels: #{labels}, assignee_id: #{assignee_id}" \
+               "reviewer_ids: #{reviewer_ids}"
         end
       end
     end

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

@@ -268,7 +268,7 @@ module GitlabQuality
           if stacktrace_match
             stacktrace_match[:stacktrace].gsub(/^\s*#.*$/, '').gsub(/^[[:space:]]+/, '').strip
           else
-            puts "  => [DEBUG] Stacktrace doesn't match the regex (#{regex}):\n----------------\n#{stacktrace}\n----------------\n"
+            puts "  => [DEBUG] Stacktrace doesn't match the regex (#{regex})!"
           end
         end
 

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

@@ -33,6 +33,10 @@ module GitlabQuality
           env_var_value_if_defined('QA_LOG_LEVEL')&.upcase || 'INFO'
         end
 
+        def gitlab_bot_username
+          env_var_value_if_defined('GITLAB_BOT_USERNAME') || 'gitlab-bot'
+        end
+
         def log_path
           env_var_value_if_defined('QA_LOG_PATH') || host_artifacts_dir
         end

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

@@ -14,38 +14,39 @@ module GitlabQuality
             # @param [TestMetaUpdater] context instance of TestMetaUpdater
             def execute(spec, context) # rubocop:disable Metrics/AbcSize
               @context = context
-
+              @existing_mrs = nil
               @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
+              new_content, @changed_line_no = add_blocking_metadata
 
-              return if changed_line_no.negative?
+              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}
+                #{"Promote to blocking: #{example_name}".truncate(72)}
               COMMIT_MESSAGE
 
-              assignee_id, assignee_handle = context.fetch_dri_id(product_group, devops_stage)
+              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, assignee_id) do
+              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}
 
                   /label ~"Quality" ~"QA" ~"type::maintenance"
                   /label ~"devops::#{devops_stage}"
@@ -62,6 +63,11 @@ module GitlabQuality
                 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
 
+              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}")
+              end
+
               merge_request
             end
 
@@ -82,15 +88,20 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title
+            attr_reader :context, :file_path, :file_contents, :example_name, :mr_title, :changed_line_no
 
             # 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."
+            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
+              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)
+                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
 

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

@@ -24,7 +24,7 @@ module GitlabQuality
             # @param [TestMetaUpdater] context instance of TestMetaUpdater
             def execute(spec, context) # rubocop:disable Metrics/AbcSize
               @context = context
-
+              @existing_mrs = nil
               @file_path = spec["file_path"]
               devops_stage = spec["stage"]
               @failure_issue_url = spec["failure_issue"]
@@ -33,21 +33,23 @@ module GitlabQuality
               @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
+              new_content, @changed_line_no = add_quarantine_metadata
+
+              return unless proceed_with_merge_request?
 
               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}
+                #{"Quarantine #{example_name}".truncate(72)}
               COMMIT_MESSAGE
 
-              context.create_merge_request(mr_title, branch) do
+              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?
 
@@ -85,6 +87,13 @@ module GitlabQuality
                   </div>
                 MARKDOWN
               end
+
+              if merge_request
+                context.add_processed_record({ file_path => changed_line_no })
+                Runtime::Logger.info("  Created MR for quarantine: #{merge_request.web_url}")
+              end
+
+              merge_request
             end
 
             # Performs post processing. Takes a list of MRs and posts them in a note on report_issue and Slack
@@ -114,20 +123,21 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name, :issue_id, :mr_title, :failure_issue
+            attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
+              :issue_id, :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?
+            def proceed_with_merge_request? # rubocop:disable Metrics/AbcSize
               if context.issue_is_closed?(failure_issue)
-                puts "  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR."
+                Runtime::Logger.info("  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."
+              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
 
@@ -144,7 +154,7 @@ module GitlabQuality
                 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)
+                  line[line.rindex(',')] = 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

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/filters'
+
 module GitlabQuality
   module TestTooling
     module TestMeta
@@ -15,6 +17,13 @@ module GitlabQuality
             end
 
             private_class_method :new
+
+            # Fetch existing MRs for given mr title
+            #
+            # @return [Array<Gitlab::ObjectifiedHash>]
+            def existing_mrs
+              @existing_mrs ||= context.existing_merge_requests(title: mr_title)
+            end
           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
+        attr_reader :project, :ref, :report_issue, :processed_records
 
         TEST_PLATFORM_MAINTAINERS_SLACK_CHANNEL_ID = 'C0437FV9KBN' # test-platform-maintainers
 
@@ -19,6 +19,7 @@ module GitlabQuality
           @ref = ref
           @dry_run = dry_run
           @processor = processor
+          @processed_records = {}
         end
 
         def invoke!
@@ -33,10 +34,20 @@ module GitlabQuality
           end
         end
 
+        # Add processed records
+        #
+        # @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)
+        end
+
         # Fetch contents of file from the repository
         #
-        # [String] file_path path to the file
-        # [String] contents of the file
+        # @param [String] file_path path to the file
+        # @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)
           repository_files.file_contents
@@ -110,8 +121,10 @@ module GitlabQuality
         # @param [String] example_name the example
         # @param [Gitlab::ObjectifiedHash] branch the branch
         # @param [Integer] assignee_id
+        # @param [Array<Integer>] reviewer_ids
+        # @param [String] labels comma seperated list of labels
         # @return [Gitlab::ObjectifiedHash] the created merge request
-        def create_merge_request(title, branch, assignee_id = nil, labels = '')
+        def create_merge_request(title, branch, assignee_id = nil, reviewer_ids = [], labels = '')
           description = yield
 
           merge_request_client.create_merge_request(
@@ -120,7 +133,8 @@ module GitlabQuality
             target_branch: ref,
             description: description,
             labels: labels,
-            assignee_id: assignee_id)
+            assignee_id: assignee_id,
+            reviewer_ids: reviewer_ids)
         end
 
         # Check if issue is closed
@@ -179,7 +193,15 @@ module GitlabQuality
         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]
+          [user_id_for_username(assignee_handle), assignee_handle]
+        end
+
+        # Fetch id for the given GitLab username/handle
+        #
+        # @param [String] username
+        # @return [Integer]
+        def user_id_for_username(username)
+          issue_client.find_user_id(username: username)
         end
 
         # Post a message on Slack
@@ -221,6 +243,15 @@ 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
+
         private
 
         attr_reader :token, :specs_file, :dry_run, :processor

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.14.1"
+    VERSION = "1.15.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control