gitlab_quality-test_tooling 1.5.2 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421778dfb1e380d4b8e0fc3e43a8d4147d50c0a11304ac36e964aeaf99330404
-  data.tar.gz: 1f09fb87a864818b6728364454c0f8b9043cc73c5cec1ce4aa0104261d5dbfea
+  metadata.gz: acc009f4f6d5f4be05fa85cd3fffc68778d415d970ca96f22ace03c8a86f9488
+  data.tar.gz: 5c31655a8245c632e595431fb99ec14852bfd4f9b9778d09e8b8d0ae3393dbc1
 SHA512:
-  metadata.gz: 7cdbc73cd4ac08dc3f78a27b4575ec3a6005b7cfd95577bd61c8868d6836b3f1d549b1744d27d6cc2939e08d9b777eb74e84e4fb473952c7a9c982dc7a9b719e
-  data.tar.gz: ddd08dc76c0a45cae09283f0a2c8b91a731a203ffa624cac641254b4933b49585d585b5ada0169f85cccd4c59af562ffca9b16df5d733ee98d38f0c15af08334
+  metadata.gz: 754b2ed722bc050515ceb9f4691bc49da1e63c27c1ff44b3cd97bc597d6691f947a2390b63b41e980b4229332817671bc9cad351fee4455d424ce66f1d54cf03
+  data.tar.gz: ff2b356903435078c53b6234e69d57e272c9f367cd01518158fda38a94372ceeb1fe1e2f2cebec16e2aaa0dd4db9c98592c36631c858119d3340cf4bcd961bda

data/Gemfile.lock

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

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

@@ -86,7 +86,9 @@ module GitlabQuality
           begin
             issue = find_issue_and_update_reports(test)
 
-            create_issue(test) unless issue || test.quarantine?
+            issue = create_issue(test) unless issue || test.quarantine?
+
+            issue
           rescue MultipleIssuesFound => e
             warn(e.message)
           end

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

@@ -160,7 +160,7 @@ module GitlabQuality
           when 'customers-gitlab-com'
             'found:customers.stg.gitlab.com'
           else
-            raise "No `found:*` label for the `#{pipeline}` pipeline!"
+            puts "  => [DEBUG] No `found:*` label for the `#{pipeline}` pipeline!"
           end
         end
 

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/report/update_screenshot_path.rb

@@ -16,8 +16,8 @@ module GitlabQuality
 
         def invoke!
           Dir.glob(input_files).each do |input_file|
-            rewrite_schreenshot_paths_in_junit_file(input_file)
-            rewrite_schreenshot_paths_in_json_file(input_file.gsub('.xml', '.json'))
+            rewrite_screenshot_paths_in_junit_file(input_file)
+            rewrite_screenshot_paths_in_json_file(input_file.gsub('.xml', '.json'))
           end
         end
 
@@ -25,7 +25,7 @@ module GitlabQuality
 
         attr_reader :input_files
 
-        def rewrite_schreenshot_paths_in_junit_file(junit_file)
+        def rewrite_screenshot_paths_in_junit_file(junit_file)
           File.write(
             junit_file,
             rewrite_each_junit_screenshot_path(junit_file).to_s
@@ -34,7 +34,7 @@ module GitlabQuality
           puts "Saved #{junit_file}"
         end
 
-        def rewrite_schreenshot_paths_in_json_file(json_file)
+        def rewrite_screenshot_paths_in_json_file(json_file)
           File.write(
             json_file,
             JSON.pretty_generate(
@@ -58,7 +58,7 @@ module GitlabQuality
             examples = report['examples']
 
             examples.each do |example|
-              next unless example['screenshot'].present?
+              next unless example['screenshot'].present? && example['screenshot']['image'].present?
 
               example['screenshot']['image'] =
                 remove_container_absolute_path_prefix(example.dig('screenshot', 'image'), test_artifacts_directory(json_file))

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.5.2"
+    VERSION = "1.5.4"
   end
 end

metadata

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