gitlab_quality-test_tooling 1.5.1 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba60bceafbfb950d7cc588d11b14b457f74cdf3f39271b33b171d7de935c6a2
-  data.tar.gz: 3129a7a6da1a0c6f46df06ccd69f4d6d84a2f926a1dca268ea73455054fdbf4d
+  metadata.gz: ecfb78e3fc7f1f23f118c98b16cdf1c104774734d08c4ff04dd6e4c7b25ae703
+  data.tar.gz: 4ef1ed6d2f559f427f0c26e92b90f631b5f407b7b604914c3b17786563675966
 SHA512:
-  metadata.gz: 0cfd0c911a463fe793c701ae13bef14dcd4e5220bc0e41819126e6659f1bcb6589ce1dba5baa33f6410f92a8ddc6414623cb7952638f66a3d79a55099089f1a6
-  data.tar.gz: 12600147b76a659a725662119d08318999a85f1483a5d68bb6da14f464085f3d67fc6748a2f94dcee9bef82357c62a17f874d3a3feb2ee6961fbcb094f61aec0
+  metadata.gz: 345e33ac54c7a917bb735a715e63bb8fcbe23464186aab1d02697ae1904f894a31ee4c04e2fb793262a04a4e768518e21eb5d0214616a337ca4f526a3a14af42
+  data.tar.gz: 5cf0dff6f8b7ff0f9526027fb3cc1efef03cf2ca1cf655d29054ff8075217e7221936b666e619e18cc09eaa003d3b70a65f1927124c6efb8c2f1516da9f00f27

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.5.1)
+    gitlab_quality-test_tooling (1.5.3)
       activesupport (>= 6.1, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -15,7 +15,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7.3)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module GitlabQuality
   module TestTooling
     module Report

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

@@ -15,6 +15,7 @@ module GitlabQuality
             merge_request_iid: merge_request_iid)
           @files = Array(input_files)
           @merge_request_iid = merge_request_iid
+          @slow_tests = []
         end
 
         def invoke!
@@ -25,7 +26,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab_merge_request, :files, :project, :merge_request_iid
+        attr_reader :gitlab_merge_request, :files, :project, :merge_request_iid, :slow_tests
 
         def run!
           puts "Reporting slow tests in MR #{merge_request_iid}"
@@ -33,21 +34,26 @@ module GitlabQuality
           TestResults::Builder.new(files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
-            upsert_mr_note(slow_related_tests(slow_tests(test_results))) if should_create_mr_note?(test_results)
+            @slow_tests += slow_related_tests(find_slow_tests(test_results))
           end
+
+          @slow_tests.uniq!
+          @slow_tests.reject!(&:failed?)
+
+          return unless @slow_tests.any?
+
+          upsert_mr_note(@slow_tests)
         end
 
-        def should_create_mr_note?(test_results)
-          gitlab_merge_request.merge_request_changed_files.any? &&
-            slow_tests(test_results).any? &&
-            slow_related_tests(slow_tests(test_results)).any?
+        def related_test?(slow_test)
+          base_file = slow_test.file.split('/').last.gsub('_spec.rb', '')
+
+          merge_request_changed_files.any? { |change| change =~ /#{base_file}/ }
         end
 
         def slow_related_tests(slow_test_results)
-          slow_test_results.select do |slow_test_result|
-            base_file = slow_test_result.file.split('/').last.gsub('_spec.rb', '')
-
-            merge_request_changed_files.any? { |change| change =~ /#{base_file}/ }
+          slow_test_results.select do |slow_test|
+            related_test?(slow_test)
           end
         end
 
@@ -55,7 +61,7 @@ module GitlabQuality
           @merge_request_changed_files ||= gitlab_merge_request.merge_request_changed_files
         end
 
-        def slow_tests(test_results)
+        def find_slow_tests(test_results)
           test_results.select(&:slow_test?)
         end
 
@@ -66,7 +72,8 @@ module GitlabQuality
             ":tools: #{SLOW_TEST_NOTE_SOURCE_CODE}\n",
             ":recycle: #{SLOW_TEST_NOTE_FEEDBACK}\n",
             "---\n",
-            ':snail: Slow tests detected in this merge request, might be related with changed RSpec files.',
+            ":snail: Slow tests detected in this merge request. These slow tests might be related to this merge request's changes.",
+            "<details><summary>Click to expand</summary>\n",
             '| Job | File | Name | Duration | Expected duration |',
             '| --- | --- | --- | --- | --- |'
           ]
@@ -83,7 +90,7 @@ module GitlabQuality
         end
 
         def build_note(slow_test)
-          rows = note_header + slow_test_rows(slow_test)
+          rows = note_header + slow_test_rows(slow_test) + ["\n</details>"]
 
           rows.join("\n")
         end
@@ -105,11 +112,13 @@ module GitlabQuality
         end
 
         def add_slow_test_rows(gitlab_note, slow_tests)
+          gitlab_note.gsub!("\n\n</details>", "")
+
           slow_tests.each do |slow_test|
             gitlab_note += "\n#{slow_test_table_row(slow_test)}" unless note_comment_includes_slow_test?(gitlab_note, slow_test)
           end
 
-          gitlab_note
+          "#{gitlab_note}\n\n</details>"
         end
 
         def upsert_mr_note(slow_tests)

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

@@ -126,7 +126,10 @@ module GitlabQuality
             return
           end
 
-          super
+          created_issue = super
+          test.failure_issue ||= created_issue.web_url
+
+          created_issue
         end
 
         def pipeline_issues_with_similar_stacktrace(test)

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

@@ -16,6 +16,9 @@ module GitlabQuality
         NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'rspec profiling', 'rspec:slow test']).freeze
         SEARCH_LABELS = %w[test maintenance::performance].freeze
 
+        JOB_URL_REGEX = %r{(?<job_url>https://(?<host>[\w.]+)/(?<project_path>[\w\-./]+)/-/jobs/\d+)}
+        REPORT_ITEM_REGEX = /^1\. \d{4}-\d{2}-\d{2}: #{JOB_URL_REGEX} \((?<pipeline_url>.+)\)$/
+
         MultipleIssuesFound = Class.new(StandardError)
 
         private
@@ -45,9 +48,23 @@ module GitlabQuality
               to improve them. More context available about this issue in the [top slow tests guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#top-slow-tests).
 
               Add `allowed_to_be_slow: true` to the RSpec test if this is a legit slow test and close the issue.
+
+              #{reports_section(test)}
             DESCRIPTION
         end
 
+        def reports_section(test)
+          <<~REPORTS
+          ### Reports (1)
+
+          #{report_list_item(test)}
+          REPORTS
+        end
+
+        def report_list_item(test)
+          "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
+        end
+
         def create_slow_issue(test)
           puts "   => Finding existing issues for slow test '#{test.name}' (run time: #{test.run_time} seconds)..."
 
@@ -58,6 +75,8 @@ module GitlabQuality
           else
             issues.each do |issue|
               puts "   => Existing issue link #{issue['web_url']}"
+
+              update_reports(issue, test)
             end
           end
 
@@ -65,6 +84,39 @@ module GitlabQuality
         rescue MultipleIssuesFound => e
           warn(e.message)
         end
+
+        def update_reports(issue, test)
+          # We reopen closed issues to not lose any history
+          state_event = issue.state == 'closed' ? 'reopen' : nil
+
+          issue_attrs = {
+            description: up_to_date_issue_description(issue.description, test)
+          }
+
+          issue_attrs[:state_event] = state_event if state_event
+
+          gitlab.edit_issue(iid: issue.iid, options: issue_attrs)
+          puts "  => Added a report in '#{issue.title}': #{issue.web_url}!"
+        end
+
+        def up_to_date_issue_description(issue_description, test)
+          new_issue_description =
+            if issue_description.include?('### Reports')
+              # We count the number of existing reports.
+              reports_count = issue_description
+                .scan(REPORT_ITEM_REGEX)
+                .size.to_i + 1
+              issue_description.sub(/^### Reports.*$/, "### Reports (#{reports_count})")
+            else # For issue with the legacy format, we add the Reports section
+              reports_count = issue_description
+                .scan(JOB_URL_REGEX)
+                .size.to_i + 1
+
+              "#{issue_description}\n\n### Reports (#{reports_count})"
+            end
+
+          "#{new_issue_description}\n#{report_list_item(test)}"
+        end
       end
     end
   end

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

@@ -3,6 +3,7 @@
 require 'forwardable'
 require 'fileutils'
 require 'rainbow'
+require 'active_support'
 require 'active_support/logger'
 
 module GitlabQuality

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

@@ -33,6 +33,10 @@ module GitlabQuality
           status == 'pending'
         end
 
+        def failed?
+          status == 'failed'
+        end
+
         def ci_job_url
           report.fetch('ci_job_url', '')
         end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.5.1"
+    VERSION = "1.5.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.3
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control