RubyGems - gitlab_quality-test_tooling - Versions diffs - 3.0.0 → 3.5.0 - Mend

gitlab_quality-test_tooling 3.0.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

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

@@ -8,11 +8,13 @@ module GitlabQuality
           "Net::ReadTimeout",
           "403 Forbidden - Your account has been blocked",
           "API failed (502) with `GitLab is not responding",
+          "Error Code: 502",
           "unexpected token at 'GitLab is not responding'",
           "GitLab: Internal API error (502).",
           "could not be found (502)",
           "Error reference number: 502",
           "(502): `GitLab is not responding`",
+          "(502): `502 Bad Gateway`",
           "<head><title>502 Bad Gateway</title></head>",
           "14:connections to all backends failing",
           "gitlab_canary=true cookie was set in browser but 'Next' badge was not shown on UI"
@@ -127,14 +129,26 @@ module GitlabQuality
         end
         def full_stacktrace
+          page_error_failure = ""
+          first_non_ignored_failure = ""
           failures.each do |failure|
             message = failure['message'] || ""
             message_lines = failure['message_lines'] || []
             next if IGNORED_FAILURES.any? { |e| message.include?(e) }
-            return message_lines.empty? ? message : message_lines.join("\n")
+            formatted_failure = message_lines.empty? ? message : message_lines.join("\n")
+            if message.include?("PageErrorChecker")
+              page_error_failure = formatted_failure
+            elsif first_non_ignored_failure.empty?
+              first_non_ignored_failure = formatted_failure
+            end
           end
+          # Return PageErrorChecker failure if found, otherwise first non-ignored failure
+          page_error_failure.empty? ? first_non_ignored_failure : page_error_failure
         end
         def calls_shared_examples?

data/lib/gitlab_quality/test_tooling/version.rb CHANGED Viewed

@@ -2,6 +2,6 @@
 module GitlabQuality
   module TestTooling
-    VERSION = "3.0.0"
+    VERSION = "3.5.0"
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.5.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
+date: 2026-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -227,9 +227,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -237,9 +234,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.3'
 - !ruby/object:Gem::Dependency
   name: amatch
   requirement: !ruby/object:Gem::Requirement
@@ -308,20 +302,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: influxdb-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -436,12 +416,10 @@ email:
 executables:
 - detect-infrastructure-failures
 - epic-readiness-notification
-- existing-test-health-issue
 - failed-test-issues
 - feature-readiness-checklist
 - feature-readiness-evaluation
 - flaky-test-issues
-- generate-test-session
 - knapsack-report-issues
 - post-to-slack
 - prepare-stage-reports
@@ -471,12 +449,10 @@ files:
 - Rakefile
 - exe/detect-infrastructure-failures
 - exe/epic-readiness-notification
-- exe/existing-test-health-issue
 - exe/failed-test-issues
 - exe/feature-readiness-checklist
 - exe/feature-readiness-evaluation
 - exe/flaky-test-issues
-- exe/generate-test-session
 - exe/knapsack-report-issues
 - exe/post-to-slack
 - exe/prepare-stage-reports
@@ -490,15 +466,20 @@ files:
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
 - lib/gitlab_quality/test_tooling/click_house/client.rb
+- lib/gitlab_quality/test_tooling/code_coverage/README.md
 - lib/gitlab_quality/test_tooling/code_coverage/artifacts.rb
 - lib/gitlab_quality/test_tooling/code_coverage/category_owners.rb
 - lib/gitlab_quality/test_tooling/code_coverage/click_house/category_owners_table.rb
 - lib/gitlab_quality/test_tooling/code_coverage/click_house/coverage_metrics_table.rb
 - lib/gitlab_quality/test_tooling/code_coverage/click_house/table.rb
+- lib/gitlab_quality/test_tooling/code_coverage/click_house/test_file_mappings_table.rb
 - lib/gitlab_quality/test_tooling/code_coverage/coverage_data.rb
 - lib/gitlab_quality/test_tooling/code_coverage/lcov_file.rb
+- lib/gitlab_quality/test_tooling/code_coverage/responsibility_classifier.rb
+- lib/gitlab_quality/test_tooling/code_coverage/responsibility_patterns_config.rb
 - lib/gitlab_quality/test_tooling/code_coverage/rspec_report.rb
 - lib/gitlab_quality/test_tooling/code_coverage/source_file_classifier.rb
+- lib/gitlab_quality/test_tooling/code_coverage/test_file_mapping_data.rb
 - lib/gitlab_quality/test_tooling/code_coverage/test_map.rb
 - lib/gitlab_quality/test_tooling/code_coverage/test_report.rb
 - lib/gitlab_quality/test_tooling/code_coverage/utils.rb
@@ -541,7 +522,6 @@ files:
 - lib/gitlab_quality/test_tooling/report/failed_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/feature_readiness/report_on_epic.rb
 - lib/gitlab_quality/test_tooling/report/flaky_test_issue.rb
-- lib/gitlab_quality/test_tooling/report/generate_test_session.rb
 - lib/gitlab_quality/test_tooling/report/group_issues/error_message_normalizer.rb
 - lib/gitlab_quality/test_tooling/report/group_issues/error_pattern_matcher.rb
 - lib/gitlab_quality/test_tooling/report/group_issues/failure_processor.rb
@@ -564,7 +544,6 @@ files:
 - lib/gitlab_quality/test_tooling/report/results_in_issues.rb
 - lib/gitlab_quality/test_tooling/report/results_in_test_cases.rb
 - lib/gitlab_quality/test_tooling/report/slow_test_issue.rb
-- lib/gitlab_quality/test_tooling/report/test_health_issue_finder.rb
 - lib/gitlab_quality/test_tooling/report/update_screenshot_path.rb
 - lib/gitlab_quality/test_tooling/runtime/env.rb
 - lib/gitlab_quality/test_tooling/runtime/logger.rb
@@ -595,6 +574,8 @@ files:
 - lib/gitlab_quality/test_tooling/test_metrics_exporter/formatter.rb
 - lib/gitlab_quality/test_tooling/test_metrics_exporter/test_metrics.rb
 - lib/gitlab_quality/test_tooling/test_metrics_exporter/utils.rb
+- lib/gitlab_quality/test_tooling/test_quarantine/quarantine_formatter.rb
+- lib/gitlab_quality/test_tooling/test_quarantine/quarantine_helper.rb
 - lib/gitlab_quality/test_tooling/test_result/base_test_result.rb
 - lib/gitlab_quality/test_tooling/test_result/j_unit_test_result.rb
 - lib/gitlab_quality/test_tooling/test_result/json_test_result.rb

data/exe/existing-test-health-issue DELETED Viewed

@@ -1,59 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-require "bundler/setup"
-require "optparse"
-require_relative "../lib/gitlab_quality/test_tooling"
-params = {}
-HEALTH_PROBLEM_TYPES = GitlabQuality::TestTooling::Report::TestHealthIssueFinder::HEALTH_PROBLEM_TYPE_TO_LABEL.keys
-options = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
-  opts.on('-i', '--input-files INPUT_FILES', String, 'JSON rspec-retry report files') do |input_files|
-    params[:input_files] = input_files
-  end
-  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
-    params[:project] = project
-  end
-  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT') do |token|
-    params[:token] = token
-  end
-  opts.on("--health-problem-type PROBLEM_TYPE", String, "Look for the given health problem type (#{HEALTH_PROBLEM_TYPES.join(', ')})") do |value|
-    raise ArgumentError, "Invalid health problem type: #{value}. Valid options are: #{HEALTH_PROBLEM_TYPES.join(', ')}" unless HEALTH_PROBLEM_TYPES.include?(value)
-    params[:health_problem_type] = value
-  end
-  opts.on_tail('-v', '--version', 'Show the version') do
-    require_relative "../lib/gitlab_quality/test_tooling/version"
-    puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
-    exit
-  end
-  opts.on_tail('-h', '--help', 'Show the usage') do
-    puts "Purpose: Checks whether tests coming from the rspec JSON report files has an existing test health issue opened."
-    puts opts
-    exit
-  end
-  opts.parse(ARGV)
-end
-if params.any?
-  raise ArgumentError, "No health problem type given. Valid options are: #{HEALTH_PROBLEM_TYPES.join(', ')}" unless params.key?(:health_problem_type)
-  if GitlabQuality::TestTooling::Report::TestHealthIssueFinder.new(**params).found_existing_unhealthy_test_issue?
-    exit 0
-  else
-    exit 1
-  end
-else
-  puts options
-  exit 1
-end

data/exe/generate-test-session DELETED Viewed

@@ -1,70 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-require "bundler/setup"
-require "optparse"
-require_relative "../lib/gitlab_quality/test_tooling"
-params = {}
-options = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
-  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
-    params[:input_files] = input_files
-  end
-  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
-    params[:project] = project
-  end
-  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Reporter permission in PROJECT') do |token|
-    params[:token] = token
-  end
-  opts.on('-c', '--ci-project-token CI_PROJECT_TOKEN', String, 'A valid access token with `read_api` scope permission in current ENV["CI_PROJECT_ID"]') do |ci_project_token|
-    params[:ci_project_token] = ci_project_token
-  end
-  opts.on('-f', '--issue-url-file ISSUE_URL_FILE', 'Output the created test session issue URL') do |issue_url_file|
-    params[:issue_url_file] = issue_url_file
-  end
-  opts.on('--pipeline-stages STAGES', String, 'Comma-separated list of pipeline stages to include in test session issue') do |pipeline_stages|
-    params[:pipeline_stages] = pipeline_stages.split(',')
-  end
-  opts.on('--confidential', "Makes test session issue confidential") do
-    params[:confidential] = true
-  end
-  opts.on('--dry-run', "Perform a dry-run (don't create or update issues or test cases)") do
-    params[:dry_run] = true
-  end
-  opts.on_tail('-v', '--version', 'Show the version') do
-    require_relative "../lib/gitlab_quality/test_tooling/version"
-    puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
-    exit
-  end
-  opts.on_tail('-h', '--help', 'Show the usage') do
-    puts "Purpose: Generate test session report based on RSpec report files (JSON or JUnit XML)"
-    puts opts
-    exit
-  end
-  opts.parse(ARGV)
-end
-issue_url_file = params.delete(:issue_url_file)
-if params.any?
-  issue_url = GitlabQuality::TestTooling::Report::GenerateTestSession.new(**params).invoke!
-  File.write(issue_url_file, issue_url) if issue_url_file && issue_url
-else
-  puts options
-  exit 1
-end

data/lib/gitlab_quality/test_tooling/report/generate_test_session.rb DELETED Viewed

@@ -1,288 +0,0 @@
-# frozen_string_literal: true
-require 'erb'
-require 'date'
-module GitlabQuality
-  module TestTooling
-    module Report
-      class GenerateTestSession < ReportAsIssue
-        def initialize(ci_project_token:, pipeline_stages: nil, **kwargs)
-          super
-          @ci_project_token = ci_project_token
-          @pipeline_stages = Set.new(pipeline_stages)
-          @issue_type = 'issue'
-        end
-        private
-        attr_reader :ci_project_token, :pipeline_stages
-        # rubocop:disable Metrics/AbcSize
-        def run!
-          puts "Generating test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
-          tests = Dir.glob(files).flat_map do |path|
-            puts "Loading tests in #{path}"
-            TestResults::JsonTestResults.new(path: path).to_a
-          end
-          tests = tests.select { |test| pipeline_stages.include? test.report["stage"] } unless pipeline_stages.empty?
-          issue = gitlab.create_issue(
-            title: "#{Time.now.to_date.iso8601} Test session report | #{Runtime::Env.qa_run_type}",
-            description: generate_description(tests),
-            labels: ['automation:bot-authored', 'E2E', 'triage report', pipeline_name_label, 'suppress-contributor-links'],
-            confidential: confidential
-          )
-          # Workaround for https://gitlab.com/gitlab-org/gitlab/-/issues/295493
-          unless Runtime::Env.qa_issue_url.to_s.empty?
-            gitlab.create_issue_note(
-              iid: issue.iid,
-              note: "/relate #{Runtime::Env.qa_issue_url}")
-          end
-          issue&.web_url # Issue isn't created in dry-run mode
-        end
-        # rubocop:enable Metrics/AbcSize
-        def generate_description(tests)
-          <<~MARKDOWN.rstrip
-          ## Session summary
-          * Deploy version: #{Runtime::Env.deploy_version}
-          * Deploy environment: #{Runtime::Env.deploy_environment}
-          * Pipeline: #{Runtime::Env.pipeline_from_project_name} [#{Runtime::Env.ci_pipeline_id}](#{Runtime::Env.ci_pipeline_url})
-          #{generate_summary(tests: tests)}
-          #{generate_failed_jobs_listing}
-          #{generate_stages_listing(tests)}
-          #{generate_qa_issue_relation}
-          #{generate_link_to_dashboard}
-          MARKDOWN
-        end
-        def generate_summary(tests:, tests_by_status: nil)
-          tests_by_status ||= tests.group_by(&:status)
-          total = tests.size
-          passed = tests_by_status['passed']&.size || 0
-          failed = tests_by_status['failed']&.size || 0
-          others = total - passed - failed
-          <<~MARKDOWN.chomp
-          * Total #{total} tests
-          * Passed #{passed} tests
-          * Failed #{failed} tests
-          * #{others} other tests (usually skipped)
-          MARKDOWN
-        end
-        def generate_failed_jobs_listing
-          failed_jobs = fetch_pipeline_failed_jobs
-          listings = failed_jobs.filter_map do |job|
-            next if pipeline_stages.any? && !pipeline_stages.include?(job.stage)
-            allowed_to_fail = ' (allowed to fail)' if job.allow_failure
-            "* [#{job.name}](#{job.web_url})#{allowed_to_fail}"
-          end.join("\n")
-          <<~MARKDOWN.chomp if failed_jobs.any?
-          ## Failed jobs
-          #{listings}
-          MARKDOWN
-        end
-        def generate_stages_listing(tests)
-          generate_tests_by_stage(tests).map do |stage, tests_for_stage|
-            tests_by_status = tests_for_stage.group_by(&:status)
-            <<~MARKDOWN.chomp
-            ### #{stage&.capitalize || 'Unknown'}
-            #{generate_summary(
-              tests: tests_for_stage, tests_by_status: tests_by_status)}
-            #{generate_testcase_listing_by_status(
-              tests: tests_for_stage, tests_by_status: tests_by_status)}
-            MARKDOWN
-          end.join("\n\n")
-        end
-        def generate_tests_by_stage(tests)
-          # https://about.gitlab.com/handbook/product/product-categories/#devops-stages
-          ordering = %w[
-            manage
-            plan
-            create
-            verify
-            package
-            release
-            configure
-            monitor
-            secure
-            defend
-            growth
-            fulfillment
-            enablement
-            self-managed
-            saas
-          ]
-          tests.sort_by do |test|
-            ordering.index(test.stage) || ordering.size
-          end.group_by(&:stage)
-        end
-        def generate_testcase_listing_by_status(tests:, tests_by_status:)
-          failed_tests = tests_by_status['failed']
-          passed_tests = tests_by_status['passed']
-          other_tests = tests.reject do |test|
-            test.status == 'failed' || test.status == 'passed'
-          end
-          [
-            (failed_listings(failed_tests) if failed_tests),
-            (passed_listings(passed_tests) if passed_tests),
-            (other_listings(other_tests) if other_tests.any?)
-          ].compact.join("\n\n")
-        end
-        def failed_listings(failed_tests)
-          generate_testcase_listing(failed_tests)
-        end
-        def passed_listings(passed_tests)
-          <<~MARKDOWN.chomp
-            <details><summary>Passed tests:</summary>
-            #{generate_testcase_listing(passed_tests, passed: true)}
-            </details>
-          MARKDOWN
-        end
-        def other_listings(other_tests)
-          <<~MARKDOWN.chomp
-            <details><summary>Other tests:</summary>
-            #{generate_testcase_listing(other_tests)}
-            </details>
-          MARKDOWN
-        end
-        def generate_testcase_listing(tests, passed: false)
-          body = tests.group_by(&:testcase).map do |testcase, tests_with_same_testcase|
-            tests_with_same_testcase.sort_by!(&:name)
-            [
-              generate_test_text(testcase, tests_with_same_testcase, passed),
-              generate_test_job(tests_with_same_testcase),
-              generate_test_status(tests_with_same_testcase),
-              generate_test_actions(tests_with_same_testcase)
-            ].join(' | ')
-          end.join("\n")
-          <<~MARKDOWN.chomp
-          | Test | Job | Status | Action |
-          | - | - | - | - |
-          #{body}
-          MARKDOWN
-        end
-        def generate_test_text(testcase, tests_with_same_testcase, passed)
-          text = tests_with_same_testcase.map(&:name).uniq.join(', ')
-          if testcase && !passed
-            "[#{text}](#{testcase})"
-          else
-            text
-          end
-        end
-        def generate_test_job(tests_with_same_testcase)
-          tests_with_same_testcase.map do |test|
-            ci_job_id = test.ci_job_url[/\d+\z/]
-            "[#{ci_job_id}](#{test.ci_job_url})#{' ~"quarantine"' if test.quarantine?}"
-          end.uniq.join(', ')
-        end
-        def generate_test_status(tests_with_same_testcase)
-          tests_with_same_testcase.map(&:status).uniq.map do |status|
-            %(~"#{status}")
-          end.join(', ')
-        end
-        def generate_test_actions(tests_with_same_testcase)
-          # All failed tests would be grouped together, meaning that
-          # if one failed, all the tests here would be failed too.
-          # So this check is safe. Same applies to 'passed'.
-          # But all other status might be mixing together,
-          # we cannot assume other statuses.
-          if tests_with_same_testcase.first.status == 'failed'
-            tests_having_failure_issue =
-              tests_with_same_testcase.select(&:failure_issue)
-            if tests_having_failure_issue.any?
-              items = tests_having_failure_issue.uniq(&:failure_issue).map do |test|
-                "<li>[ ] [failure issue](#{test.failure_issue})</li>"
-              end.join(' ')
-              "<ul>#{items}</ul>"
-            else
-              '<ul><li>[ ] failure issue exists or was created</li></ul>'
-            end
-          else
-            '-'
-          end
-        end
-        def generate_qa_issue_relation
-          return unless Runtime::Env.qa_issue_url
-          <<~MARKDOWN.chomp
-          ## Release QA issue
-          * #{Runtime::Env.qa_issue_url}
-          /relate #{Runtime::Env.qa_issue_url}
-          MARKDOWN
-        end
-        def generate_link_to_dashboard
-          return unless Runtime::Env.qa_run_type
-          <<~MARKDOWN.chomp
-          ## Link to Grafana dashboard for run-type of #{Runtime::Env.qa_run_type}
-          * https://dashboards.quality.gitlab.net/d/tR_SmBDVk/main-runs?orgId=1&refresh=1m&var-run_type=#{Runtime::Env.qa_run_type}
-          MARKDOWN
-        end
-        def fetch_pipeline_failed_jobs
-          failed_jobs = []
-          ci_project_client = Gitlab.client(
-            endpoint: Runtime::Env.ci_api_v4_url,
-            private_token: ci_project_token)
-          gitlab.handle_gitlab_client_exceptions do
-            failed_jobs = ci_project_client.pipeline_jobs(
-              Runtime::Env.ci_project_id,
-              Runtime::Env.ci_pipeline_id,
-              scope: 'failed')
-          end
-          failed_jobs
-        end
-      end
-    end
-  end
-end

data/lib/gitlab_quality/test_tooling/report/test_health_issue_finder.rb DELETED Viewed

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-require 'http'
-require 'json'
-module GitlabQuality
-  module TestTooling
-    module Report
-      class TestHealthIssueFinder < ReportAsIssue
-        HEALTH_PROBLEM_TYPE_TO_LABEL = {
-          'pass-after-retry' => 'test-health:pass-after-retry',
-          'slow' => 'test-health:slow',
-          'failures' => 'test-health:failures'
-        }.freeze
-        def initialize(health_problem_type: [], **kwargs)
-          super(**kwargs)
-          @health_problem_type = health_problem_type
-        end
-        def found_existing_unhealthy_test_issue?
-          issue_url = invoke!
-          !issue_url.nil? && !issue_url.empty?
-        end
-        def run!
-          existing_issue_found = nil
-          applicable_tests.each do |test|
-            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: search_labels)
-            next if issues.empty?
-            existing_issue_found = issues.first.web_url
-            puts "Found an existing test health issue of type #{health_problem_type} for test #{test.file}:#{test.line_number}: #{existing_issue_found}."
-            break
-          end
-          puts "Did not find an existing test health issue of type #{health_problem_type}." unless existing_issue_found
-          existing_issue_found
-        end
-        def applicable_tests
-          applicable_tests = []
-          TestResults::Builder.new(file_glob: files, token: token, project: project).test_results_per_file do |test_results|
-            applicable_tests = test_results.select { |test| test_is_applicable?(test) }
-          end
-          applicable_tests
-        end
-        private
-        attr_reader :health_problem_type
-        # Be mindful about the number of tests this method would return,
-        # as we will make at least one API request per test.
-        def test_is_applicable?(test)
-          expected_test_status =
-            case health_problem_type
-            when 'failures'
-              'failed'
-            else
-              'passed'
-            end
-          test.status == expected_test_status
-        end
-        def search_labels
-          ['test', HEALTH_PROBLEM_TYPE_TO_LABEL[health_problem_type]]
-        end
-      end
-    end
-  end
-end