gitlab_quality-test_tooling 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 279a7eab459c664263a3506753c09d78111784af48af599cab26ed8928f54e2a
-  data.tar.gz: '06388341bfbb2c868ae25569af2597666f64cdb7e980465078a78778081ca107'
+  metadata.gz: 8547ed9407707737f7d776f263543f3681e19706d7705591968f2e0ec348ed88
+  data.tar.gz: 84f1fb8007ce5c5dd96a1782cfa7b75207d456df2b9c163ddde5900f3efe6ad2
 SHA512:
-  metadata.gz: cd37eca775b6899df0e476d11499ee491a8ea4278d88bf8f9584feb3cb8d1245da3319aa534ed4743c06ca1bd7da7a4eefcf619aa26688eb895bf3168d58eb9d
-  data.tar.gz: 58f7c549202b39a20d6d5b5fc117e9017a044ee2e6bff63f07b82dda9650ed819f43407f20a5363d638b986fb8860d69c2452ea68bdf7fe5b7e33e70abb281b4
+  metadata.gz: 43e26da079892ae22a44025b4c96a076b65499e1ab1a5574da130132e9c70358ed12ae9ba123bb645b757b8e177bb59c11fd036f5e8d9d14e22620c5c0616958
+  data.tar.gz: f236ba27bc98161951cc4d98e4ff22321eeee476b6e305c0b67e2d58b09f6329a0361c9d834c20ff3efa86b41f5763733eb278c755fffa1e5fa49d25c556c1a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (2.6.0)
+    gitlab_quality-test_tooling (2.8.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

@@ -128,6 +128,12 @@ module GitlabQuality
           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
@@ -137,6 +143,24 @@ module GitlabQuality
           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/group_and_category_labels.rb

@@ -5,20 +5,14 @@ module GitlabQuality
     module Report
       module Concerns
         module GroupAndCategoryLabels
-          def labels_inference
-            @labels_inference ||= GitlabQuality::TestTooling::LabelsInference.new
-          end
-
-          def new_issue_labels(test)
-            debug_line = '  => [DEBUG] '
-            debug_line += "product_group: #{test&.product_group}; " if test.respond_to?(:product_group)
-            debug_line += "feature_category: #{test&.feature_category}" if test.respond_to?(:feature_category)
-            puts debug_line
+          def group_and_category_labels_for_test(test)
+            labels_inference = GitlabQuality::TestTooling::LabelsInference.new
+            new_labels       = Set.new
 
-            new_labels = self.class::NEW_ISSUE_LABELS
             new_labels += labels_inference.infer_labels_from_product_group(test.product_group) if test.respond_to?(:product_group)
             new_labels += labels_inference.infer_labels_from_feature_category(test.feature_category) if test.respond_to?(:feature_category)
-            up_to_date_labels(test: test, new_labels: new_labels)
+
+            new_labels
           end
         end
       end

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

@@ -15,6 +15,10 @@ module GitlabQuality
             "#{title[...MAX_TITLE_LENGTH - 3]}..."
           end
 
+          def label_names_to_label_quick_action(label_names)
+            %(/label #{label_names.map { |label| %(~"#{label}") }.join(' ')})
+          end
+
           def new_issue_title(test)
             "[Test] #{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
           end

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

@@ -57,7 +57,7 @@ module GitlabQuality
           current_reports_note = find_failure_discussion_note(issue: issue, test: test, reports_discussion: reports_discussion)
 
           new_reports_list = new_reports_list(current_reports_note: current_reports_note, test: test)
-          note_body        = new_note_body(
+          note_body        = append_quick_actions_to_note(
             new_reports_list: new_reports_list,
             related_issues: related_issues,
             options: {
@@ -105,6 +105,14 @@ module GitlabQuality
           IDENTITY_LABELS
         end
 
+        def new_issue_labels(test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS + group_and_category_labels_for_test(test))
+        end
+
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (base_issue_labels + super).to_a
+        end
+
         def report_section_header
           REPORT_SECTION_HEADER
         end
@@ -139,10 +147,6 @@ module GitlabQuality
           quick_actions.join("\n")
         end
 
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          (base_issue_labels + super).to_a
-        end
-
         def find_failure_discussion_note(issue:, test:, reports_discussion:)
           return unless reports_discussion
 

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

@@ -44,6 +44,14 @@ module GitlabQuality
           IDENTITY_LABELS
         end
 
+        def new_issue_labels(test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS)
+        end
+
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (base_issue_labels + super).to_a
+        end
+
         def report_section_header
           REPORT_SECTION_HEADER
         end
@@ -52,22 +60,22 @@ module GitlabQuality
           REPORTS_DOCUMENTATION
         end
 
-        def health_problem_status_label_quick_action(reports_list, **)
+        def health_problem_status_label_quick_action(reports_list, options: {})
           case reports_list.reports_count
           when 399..Float::INFINITY
-            '/label ~"flakiness::1"'
+            label_names = Set.new(['flakiness::1'])
+            label_names += group_and_category_labels_for_test(options[:test]) if options.key?(:test)
+            label_names_to_label_quick_action(label_names)
           when 37..398
-            '/label ~"flakiness::2"'
+            label_names = Set.new(['flakiness::2'])
+            label_names += group_and_category_labels_for_test(options[:test]) if options.key?(:test)
+            label_names_to_label_quick_action(label_names)
           when 13..36
             '/label ~"flakiness::3"'
           else
             '/label ~"flakiness::4"'
           end
         end
-
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          (base_issue_labels + super).to_a
-        end
       end
     end
   end

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

@@ -45,6 +45,10 @@ module GitlabQuality
           []
         end
 
+        def new_issue_labels(_test)
+          []
+        end
+
         def search_labels
           BASE_SEARCH_LABELS
         end
@@ -57,10 +61,6 @@ module GitlabQuality
           ''
         end
 
-        def health_problem_status_label_quick_action(*)
-          ''
-        end
-
         def item_extra_content(_test)
           found_label
         end
@@ -115,7 +115,13 @@ module GitlabQuality
           current_reports_note = existing_reports_note(issue_iid: issue.iid)
 
           new_reports_list = new_reports_list(current_reports_note: current_reports_note, test: test)
-          note_body        = new_note_body(new_reports_list: new_reports_list, related_issues: related_issues)
+          note_body        = append_quick_actions_to_note(
+            new_reports_list: new_reports_list,
+            related_issues: related_issues,
+            options: {
+              test: test
+            }
+          )
 
           if current_reports_note
             gitlab.edit_issue_note(
@@ -138,7 +144,7 @@ module GitlabQuality
           )
         end
 
-        def new_note_body(new_reports_list:, related_issues:, options: {})
+        def append_quick_actions_to_note(new_reports_list:, related_issues:, options: {})
           report = new_reports_list
 
           quick_actions = [
@@ -164,10 +170,15 @@ module GitlabQuality
           end
         end
 
+        # Defined in subclasses
+        def health_problem_status_label_quick_action(*)
+          ''
+        end
+
         def identity_labels_quick_action
           return if identity_labels.empty?
 
-          %(/label #{identity_labels.map { |label| %(~"#{label}") }.join(' ')})
+          label_names_to_label_quick_action(identity_labels)
         end
 
         def relate_issues_quick_actions(issues)

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

@@ -39,6 +39,10 @@ module GitlabQuality
           search_and_create_issue
         end
 
+        def new_issue_labels(test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS + group_and_category_labels_for_test(test))
+        end
+
         def search_and_create_issue
           filtered_report = KnapsackReports::SpecRunTimeReport.new(
             token: token,

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

@@ -33,6 +33,21 @@ module GitlabQuality
           '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(
@@ -54,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}`."
@@ -65,6 +80,14 @@ module GitlabQuality
           end
         end
 
+        def new_issue_labels(test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS + group_and_category_labels_for_test(test))
+        end
+
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
+          (Set.new(base_issue_labels) + (super << pipeline_name_label)).to_a
+        end
+
         def test_metric_collections
           @test_metric_collections ||= Dir.glob(metrics_files).map do |path|
             TestMetrics::JsonTestMetricCollection.new(path)
@@ -278,7 +301,7 @@ module GitlabQuality
 
         def new_issue_description(test)
           super + [
-            "\n#{compare_against_previous_commit}",
+            "\n#{commit_diff_section}",
             "### Stack trace",
             "```\n#{test.full_stacktrace}\n```",
             screenshot_section(test),
@@ -287,8 +310,123 @@ module GitlabQuality
           ].compact.join("\n\n")
         end
 
-        def compare_against_previous_commit
-          pipeline_sha = gitlab.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i).sha
+        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]
@@ -296,7 +434,7 @@ module GitlabQuality
                            raise "Project #{project} is not supported for commit diff links"
                          end
 
-          "### Commit diff\nhttps://gitlab.com/#{diff_project}/-/compare/#{parent_sha}...#{pipeline_sha}"
+          "https://gitlab.com/#{diff_project}/-/compare/#{parent_sha}...#{pipeline_sha}"
         end
 
         def system_log_errors_section(test)
@@ -318,10 +456,6 @@ module GitlabQuality
           section
         end
 
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          (Set.new(base_issue_labels) + (super << pipeline_name_label)).to_a
-        end
-
         def new_issue_assignee_id(test)
           return unless test.product_group?
 

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

@@ -144,6 +144,9 @@ module GitlabQuality
           gitlab.edit_issue(iid: issue.iid, options: { labels: labels.to_a })
         end
 
+        # Infer labels from the test, and optionally from the issue and new_labels in arguments
+        #
+        # Called when we're updating a test health issue with a new test report.
         def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
           labels = issue_labels(issue)
           labels |= new_labels.to_set

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

@@ -34,6 +34,10 @@ module GitlabQuality
           IDENTITY_LABELS
         end
 
+        def new_issue_labels(test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS)
+        end
+
         def report_section_header
           REPORT_SECTION_HEADER
         end
@@ -42,12 +46,16 @@ module GitlabQuality
           REPORTS_DOCUMENTATION
         end
 
-        def health_problem_status_label_quick_action(reports_list, **)
+        def health_problem_status_label_quick_action(reports_list, options: {})
           case reports_list.reports_count
           when 6099..Float::INFINITY
-            '/label ~"slowness::1"'
+            label_names = Set.new(['slowness::1'])
+            label_names += group_and_category_labels_for_test(options[:test]) if options.key?(:test)
+            label_names_to_label_quick_action(label_names)
           when 2177..6098
-            '/label ~"slowness::2"'
+            label_names = Set.new(['slowness::2'])
+            label_names += group_and_category_labels_for_test(options[:test]) if options.key?(:test)
+            label_names_to_label_quick_action(label_names)
           when 521..2176
             '/label ~"slowness::3"'
           else

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.6.0"
+    VERSION = "2.8.0"
   end
 end

metadata

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