gitlab_quality-test_tooling 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd181fe7622793361cd772d2f949d1a8922f4b0762c2d50ae9f839fdfd69bb86
-  data.tar.gz: aaa900d8e19eff7ae0016bda52bf6dc3722aa4e4fe288f16c16d6685254c831a
+  metadata.gz: 279a7eab459c664263a3506753c09d78111784af48af599cab26ed8928f54e2a
+  data.tar.gz: '06388341bfbb2c868ae25569af2597666f64cdb7e980465078a78778081ca107'
 SHA512:
-  metadata.gz: 5b5e1a85230726944574ec3c92c9fbe0e8a547776a6a7f7ce07d4db1889abf1a23b35a8b13b55d79eaf90eb3b7cfac4ec47960efa9eedaa509ffa02dd9655077
-  data.tar.gz: 47f438135b5ac5d4cc2cfc95a30e6a917f6de4c714bd8f42ed74c4d51439af925ac1424bf2105e71c76cd581f5faf287d8d0a415bf4c220df36df2fd85ec6149
+  metadata.gz: cd37eca775b6899df0e476d11499ee491a8ea4278d88bf8f9584feb3cb8d1245da3319aa534ed4743c06ca1bd7da7a4eefcf619aa26688eb895bf3168d58eb9d
+  data.tar.gz: 58f7c549202b39a20d6d5b5fc117e9017a044ee2e6bff63f07b82dda9650ed819f43407f20a5363d638b986fb8860d69c2452ea68bdf7fe5b7e33e70abb281b4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (2.5.0)
+    gitlab_quality-test_tooling (2.6.0)
       activesupport (>= 7.0, < 7.2)
       amatch (~> 0.4.1)
       fog-google (~> 1.24, >= 1.24.1)

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

@@ -122,6 +122,21 @@ module GitlabQuality
           end
         end
 
+        def find_pipeline(project, pipeline_id)
+          handle_gitlab_client_exceptions do
+            client.pipeline(project, pipeline_id)
+          end
+        end
+
+        def find_commit_parent(project, sha)
+          handle_gitlab_client_exceptions do
+            # In a merged results commit, the first parent is the one from
+            # the main branch, and the second parent is from the branch
+            # itself (more likely to have caused the issue)
+            client.commit(project, sha).parent_ids.last
+          end
+        end
+
         private
 
         attr_reader :token, :project

data/lib/gitlab_quality/test_tooling/report/concerns/issue_reports.rb

@@ -113,11 +113,11 @@ module GitlabQuality
             end
           end
 
-          def initial_reports_section(test)
+          def initial_reports_section(test, item_extra_content: nil)
             <<~REPORTS
             ### Reports (1)
 
-            #{ReportsList.report_list_item(test)}
+            #{ReportsList.report_list_item(test, item_extra_content: item_extra_content)}
             REPORTS
           end
 

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

@@ -26,6 +26,13 @@ module GitlabQuality
         NEW_ISSUE_LABELS = Set.new(%w[test failure::new priority::2 automation:bot-authored]).freeze
         SCREENSHOT_IGNORED_ERRORS = ['500 Internal Server Error', 'fabricate_via_api!', 'Error Code 500'].freeze
 
+        # Map commits to security fork (gitlab-org/security/gitlab) for gitlab-org/gitlab since security patches exist
+        # there before being released to the public repository
+        DIFF_PROJECT_MAPPINGS = {
+          'gitlab-org/gitlab' => 'gitlab-org/security/gitlab',
+          'gitlab-org/customers-gitlab-com' => 'gitlab-org/customers-gitlab-com'
+        }.freeze
+
         MultipleIssuesFound = Class.new(StandardError)
 
         def initialize(
@@ -271,14 +278,27 @@ module GitlabQuality
 
         def new_issue_description(test)
           super + [
-            "\n### Stack trace",
+            "\n#{compare_against_previous_commit}",
+            "### Stack trace",
             "```\n#{test.full_stacktrace}\n```",
             screenshot_section(test),
             system_log_errors_section(test),
-            initial_reports_section(test)
+            initial_reports_section(test, item_extra_content: screenshot_artifact_url(test))
           ].compact.join("\n\n")
         end
 
+        def compare_against_previous_commit
+          pipeline_sha = gitlab.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i).sha
+          parent_sha = gitlab.find_commit_parent(project, pipeline_sha)
+          diff_project = if DIFF_PROJECT_MAPPINGS.key?(project)
+                           DIFF_PROJECT_MAPPINGS[project]
+                         else
+                           raise "Project #{project} is not supported for commit diff links"
+                         end
+
+          "### Commit diff\nhttps://gitlab.com/#{diff_project}/-/compare/#{parent_sha}...#{pipeline_sha}"
+        end
+
         def system_log_errors_section(test)
           correlation_id = test.failures.first['correlation_id']
           section = ''
@@ -322,7 +342,7 @@ module GitlabQuality
           state_event = issue.state == 'closed' ? 'reopen' : nil
 
           issue_attrs = {
-            description: increment_reports(current_reports_content: issue.description, test: test).to_s,
+            description: increment_reports(current_reports_content: issue.description, test: test, item_extra_content: screenshot_artifact_url(test)).to_s,
             labels: up_to_date_labels(test: test, issue: issue)
           }
           issue_attrs[:state_event] = state_event if state_event
@@ -386,6 +406,13 @@ module GitlabQuality
             .filter_map { |e| failure_to_ignore.find { |m| e['message'].include?(m) } }
             .compact
         end
+
+        def screenshot_artifact_url(test)
+          ci_job_url = test.ci_job_url
+          screenshot_path = test.screenshot_image[%r{qa/.*$}]
+
+          "|| [Screenshot](#{ci_job_url}/artifacts/file/#{screenshot_path})"
+        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.5.0"
+    VERSION = "2.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control