gitlab_quality-test_tooling 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd181fe7622793361cd772d2f949d1a8922f4b0762c2d50ae9f839fdfd69bb86
-  data.tar.gz: aaa900d8e19eff7ae0016bda52bf6dc3722aa4e4fe288f16c16d6685254c831a
+  metadata.gz: bc2b98142fc0891fe937da031f64a665ef016c153263b01b7c9820b284967800
+  data.tar.gz: 588d0cec55fb89405d61d6e41528343929d948fe6fb03717edf2e895fe727e5c
 SHA512:
-  metadata.gz: 5b5e1a85230726944574ec3c92c9fbe0e8a547776a6a7f7ce07d4db1889abf1a23b35a8b13b55d79eaf90eb3b7cfac4ec47960efa9eedaa509ffa02dd9655077
-  data.tar.gz: 47f438135b5ac5d4cc2cfc95a30e6a917f6de4c714bd8f42ed74c4d51439af925ac1424bf2105e71c76cd581f5faf287d8d0a415bf4c220df36df2fd85ec6149
+  metadata.gz: 2402289c4b5282ad62289b7560b0faadc8cabc675d7e0262b38e6582cee5e2e6a2711ab053dc677d2e32d917c8a29608e8b90b485d977d4fe244c6a7e4c47505
+  data.tar.gz: 4bebf905075eb9b8ca2fb707c004d78746d8d8e518a6e10ee7d1085a2e3450b8a33d672a9ef382103deaf996591bd1f7c6b5d86f2249276a7a576a61074acbd7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (2.5.0)
+    gitlab_quality-test_tooling (2.7.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/gitlab_client.rb

@@ -9,10 +9,11 @@ module GitlabQuality
         RETRY_BACK_OFF_DELAY = 60
         MAX_RETRY_ATTEMPTS = 3
 
-        def initialize(token:, project:, **_kwargs)
+        def initialize(token:, project:, endpoint: nil, **_kwargs)
           @token = token
           @project = project
           @retry_backoff = 0
+          @endpoint = endpoint
         end
 
         def handle_gitlab_client_exceptions
@@ -76,11 +77,11 @@ module GitlabQuality
 
         private
 
-        attr_reader :project, :token
+        attr_reader :project, :token, :endpoint
 
         def client
           @client ||= Gitlab.client(
-            endpoint: Runtime::Env.gitlab_api_base,
+            endpoint: endpoint || Runtime::Env.gitlab_api_base,
             private_token: token
           )
         end

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

@@ -122,6 +122,45 @@ 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(project, sha)
+          handle_gitlab_client_exceptions do
+            client.commit(project, sha)
+          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
+
+        def find_commit_diff(project, sha)
+          handle_gitlab_client_exceptions do
+            client.commit_diff(project, sha)
+          end
+        end
+
+        def find_deployments(project, environment:, status:, order_by: 'id', sort: 'desc')
+          handle_gitlab_client_exceptions do
+            client.deployments(
+              project,
+              environment: environment,
+              status: status,
+              order_by: order_by,
+              sort: sort
+            )
+          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,28 @@ 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
+
+        # The project contains record of the deployments we use to determine the commit diff
+        OPS_RELEASES_METADATA_PROJECT = 'gitlab-org/release/metadata'
+
+        # Naming of the environments are different between `gitlab-org/release/metadata` and `gitlab-org/quality`
+        # This maps the gitlab-org/quality environment names to the equivalent in `gitlab-org/release/metadata`
+        ENVIRONMENT_MAPPING = {
+          'production' => 'gprd',
+          'canary' => 'gprd-cny',
+          'staging' => 'gstg',
+          'staging-canary' => 'gstg-cny',
+          'staging-ref' => 'gstg-ref',
+          'preprod' => 'pre',
+          'release' => 'release'
+        }.freeze
+
         MultipleIssuesFound = Class.new(StandardError)
 
         def initialize(
@@ -47,7 +69,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :max_diff_ratio, :system_logs, :base_issue_labels, :exclude_labels_for_search, :metrics_files
+        attr_reader :max_diff_ratio, :system_logs, :base_issue_labels, :exclude_labels_for_search, :metrics_files, :ops_gitlab_client
 
         def run!
           puts "Reporting test failures in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
@@ -271,14 +293,142 @@ module GitlabQuality
 
         def new_issue_description(test)
           super + [
-            "\n### Stack trace",
+            "\n#{commit_diff_section}",
+            "### 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 commit_diff_section
+          "### Commit diff\n#{generate_diff_link}"
+        end
+
+        def generate_diff_link
+          initialize_gitlab_ops_client
+
+          if Runtime::Env.ci_pipeline_url.include?('ops.gitlab.net')
+            pipeline = ops_gitlab_client.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i)
+            generate_ops_gitlab_diff(pipeline)
+          else
+            pipeline = gitlab.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i)
+            generate_gitlab_diff(pipeline)
+          end
+        end
+
+        def generate_ops_gitlab_diff(pipeline)
+          deployment_info = fetch_deployment_info(pipeline)
+
+          return deployment_info if deployment_info.is_a?(String)
+
+          source_gitlab_ee_sha = fetch_deployment_gitlab_ee_sha(ops_gitlab_client, deployment_info[:source].sha)
+          target_gitlab_ee_sha = fetch_deployment_gitlab_ee_sha(ops_gitlab_client, deployment_info[:target].sha)
+
+          if source_gitlab_ee_sha == target_gitlab_ee_sha
+            "No diff"
+          else
+            "https://gitlab.com/gitlab-org/security/gitlab/-/compare/#{target_gitlab_ee_sha}...#{source_gitlab_ee_sha}"
+          end
+        end
+
+        def fetch_deployment_info(pipeline)
+          pipeline_deploy_version = Runtime::Env.ci_pipeline_name.match(/(\d+\.\d+\.\d+)(?:-|$)/)&.captures&.first
+          deployments = fetch_deployments(ops_gitlab_client, pipeline)
+          found_deployment = find_matching_deployment(pipeline_deploy_version, deployments)
+
+          return 'No matching deployment found to generate a diff link.' unless found_deployment
+
+          {
+            source: found_deployment[:deployment],
+            target: deployments[found_deployment[:index] + 1]
+          }
+        end
+
+        def fetch_deployments(client, pipeline)
+          ops_environment = pipeline.web_url.match(%r{gitlab-org/quality/([^/-]+(?:-[^/-]+)*?)(?:/-)?/pipelines})[1]
+
+          raise "Environment '#{ops_environment}' is not supported" unless ENVIRONMENT_MAPPING.key?(ops_environment)
+
+          environment = ENVIRONMENT_MAPPING[ops_environment]
+
+          client.find_deployments(
+            OPS_RELEASES_METADATA_PROJECT,
+            environment: environment,
+            status: 'success'
+          )
+        end
+
+        def initialize_gitlab_ops_client
+          @ops_gitlab_client = GitlabClient::IssuesClient.new(
+            endpoint: Runtime::Env.ci_api_v4_url,
+            token: Runtime::Env.gitlab_ci_token,
+            project: OPS_RELEASES_METADATA_PROJECT
+          )
+        end
+
+        def find_matching_deployment(pipeline_deploy_version, deployments)
+          return nil unless pipeline_deploy_version
+          return nil unless deployments
+
+          target_timestamp = extract_timestamp(pipeline_deploy_version)
+          return nil unless target_timestamp
+
+          matching_deployment = nil
+
+          deployments.each_with_index do |deployment, index|
+            deployment_version = extract_deployment_version(ops_gitlab_client, deployment)
+            next unless deployment_version
+
+            deployment_timestamp = extract_timestamp(deployment_version)
+            next unless deployment_timestamp
+
+            # Stop searching if the deployment timestamp is older than the target timestamp
+            break if deployment_timestamp && deployment_timestamp < target_timestamp
+
+            if deployment_version == pipeline_deploy_version
+              matching_deployment = { deployment: deployment, index: index }
+              break
+            end
+          end
+
+          matching_deployment
+        end
+
+        def extract_timestamp(version)
+          version.match(/\d{12}$/)&.to_s
+        end
+
+        def extract_deployment_version(client, deployment)
+          commit = client.find_commit(OPS_RELEASES_METADATA_PROJECT, deployment.sha)
+          version_match = commit.message&.match(/Product-Version: ([\d.]+)/)
+          version_match&.[](1)
+        end
+
+        def fetch_deployment_gitlab_ee_sha(client, deployment_sha)
+          commit_diff = client.find_commit_diff(OPS_RELEASES_METADATA_PROJECT, deployment_sha).first
+          diffs_content = commit_diff.diff.lines.select { |line| line.start_with?('+') }.map { |line| line[1..] }.join
+
+          begin
+            JSON.parse(diffs_content).dig('releases', 'gitlab-ee', 'sha')
+          rescue JSON::ParserError
+            raise "Failed to parse the diffs content"
+          end
+        end
+
+        def generate_gitlab_diff(pipeline)
+          pipeline_sha = pipeline.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
+
+          "https://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 +472,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 +536,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/runtime/env.rb

@@ -19,9 +19,11 @@ module GitlabQuality
           'CI_PROJECT_NAME' => :ci_project_name,
           'CI_PROJECT_PATH' => :ci_project_path,
           'CI_PIPELINE_ID' => :ci_pipeline_id,
+          'CI_PIPELINE_NAME' => :ci_pipeline_name,
           'CI_PIPELINE_URL' => :ci_pipeline_url,
           'SLACK_QA_CHANNEL' => :slack_qa_channel,
-          'DEPLOY_VERSION' => :deploy_version
+          'DEPLOY_VERSION' => :deploy_version,
+          'QA_GITLAB_CI_TOKEN' => :gitlab_ci_token
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|

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

@@ -11,7 +11,9 @@ module GitlabQuality
           "unexpected token at 'GitLab is not responding'",
           "GitLab: Internal API error (502).",
           "could not be found (502)",
-          "Error reference number: 502"
+          "Error reference number: 502",
+          "(502): `GitLab is not responding`",
+          "<head><title>502 Bad Gateway</title></head>"
         ].freeze
 
         SHARED_EXAMPLES_CALLERS = %w[include_examples it_behaves_like].freeze

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.5.0"
+    VERSION = "2.7.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.7.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control