gitlab_quality-test_tooling 1.14.0 → 1.17.0

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

@@ -24,30 +24,34 @@ 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"]
+              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)
+              @mr_title = format("%{prefix} %{example_name}", prefix: '[QUARANTINE]', example_name: example_name).truncate(72, omission: '')
               @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?
 
@@ -55,6 +59,10 @@ module GitlabQuality
 
                   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}
@@ -79,12 +87,20 @@ module GitlabQuality
                   `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
+
+              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 +130,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
 
@@ -143,8 +160,8 @@ module GitlabQuality
               context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
                 indentation = context.indentation(line)
 
-                if line.include?(',') && line.split.last != 'do'
-                  line[line.index(',')] = format(QUARANTINE_METADATA.rstrip, issue_url: failure_issue_url, indentation: indentation, suffix: ',', quarantine_type: quarantine_type)
+                if line.sub(DESCRIPTION_REGEX, '').include?(',') && line.split.last != 'do'
+                  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
@@ -160,8 +177,6 @@ module GitlabQuality
               case context.issue_scoped_label(failure_issue, 'failure')&.split('::')&.last
               when 'new', 'investigating'
                 ':investigating'
-              when 'external-dependency'
-                ':external_dependency'
               when 'broken-test'
                 ':broken'
               when 'bug'

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

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/filters'
+
 module GitlabQuality
   module TestTooling
     module TestMeta
       module Processor
         class MetaProcessor
           class << self
+            DESCRIPTION_REGEX = /('.*?')|(".*?")/
+
             def execute
               raise 'method not implemented'
             end
@@ -15,6 +19,23 @@ 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
+
+            # Returns the index of the end of test description
+            #
+            # @param [String] line The line containing the test description
+            # @return [Integer]
+            def end_of_description_index(line)
+              description_length = line.match(DESCRIPTION_REGEX)[0].length
+              description_start_index = line.index(DESCRIPTION_REGEX)
+              description_start_index + description_length
+            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
@@ -153,8 +167,12 @@ module GitlabQuality
         # @param [String] note the note to post
         # @return [Gitlab::ObjectifiedHash]
         def post_note_on_report_issue(note)
-          iid = report_issue.split('/').last # split url segment, last segment of path is the issue id
-          issue_client.create_issue_note(iid: iid, note: note)
+          iid = report_issue&.split('/')&.last # split url segment, last segment of path is the issue id
+          if iid
+            issue_client.create_issue_note(iid: iid, note: note)
+          else
+            Runtime::Logger.info("#{self.class.name}##{__method__} Note was NOT posted on report issue: #{report_issue}")
+          end
         end
 
         # Post a note of merge reqest
@@ -175,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
@@ -217,6 +243,34 @@ 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
+        # @return [String]
+        def label_from_product_group(product_group)
+          label = labels_inference.infer_labels_from_product_group(product_group).to_a.first
+
+          label ? %(/label ~"#{label}") : ''
+        end
+
+        # Returns the link to the Grafana dashboard for single spec metrics
+        #
+        # @param [String] example_name the full example name
+        # @return [String]
+        def single_spec_metrics_link(example_name)
+          base_url = "https://dashboards.quality.gitlab.net/d/cW0UMgv7k/single-spec-metrics?orgId=1&var-run_type=All&var-name="
+          base_url + CGI.escape(example_name)
+        end
+
         private
 
         attr_reader :token, :specs_file, :dry_run, :processor
@@ -234,7 +288,7 @@ module GitlabQuality
         #
         # @return [GitlabIssueDryClient | GitlabIssueClient]
         def issue_client
-          @issue_client ||= (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: "gitlab-org/gitlab")
+          @issue_client ||= (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
         end
 
         # Returns the MergeRequestDryClient or MergeRequest based on the value of dry_run
@@ -246,6 +300,13 @@ module GitlabQuality
             project: project
           )
         end
+
+        # Returns a cached instance of GitlabQuality::TestTooling::LabelsInference
+        #
+        #  @return [GitlabQuality::TestTooling::LabelsInference]
+        def labels_inference
+          @labels_inference ||= GitlabQuality::TestTooling::LabelsInference.new
+        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.14.0"
+    VERSION = "1.17.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.0
+  version: 1.17.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -201,7 +201,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: amatch
   requirement: !ruby/object:Gem::Requirement