gitlab_quality-test_tooling 2.26.0 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125bc8b9a38435053e2e82849dd2a41c241d05d47784626234f01702c5619671
-  data.tar.gz: 56255580e30a0fd8896a456e4f079bea4a8de9c2a363d73263dc641f613df786
+  metadata.gz: 9627a5294f93832f5513406c664eb60589037f0317bca00ad7dd7d9a6668ee85
+  data.tar.gz: 540672e53766c7c64743575b77600ffeda9916e7aa8337d269405eadb80bec12
 SHA512:
-  metadata.gz: 041e97993894d0edc5d61c0e5e4c5bba688f81fdd92d6bec8d06e19787b3219daad4400d2aedc6c9da2a35e44f526bc8cc4960dce8016ad269f769be482c6ee5
-  data.tar.gz: eb2eef2912be06edf872af18ef1ff8ae1722462b694aa07f57f7a42e138ae8a0327aaa35914a778472e9104b9d08d407075026d2a48ac7ca9b0a5a9ad64944ad
+  metadata.gz: a5c0623b34d029ac924e8cb52ba3b8e22999c246c17b947c29995ccdb61d1b7738fa57428afea6a8bf77138b235e780dc6d2e53e270b5691762e083025249782
+  data.tar.gz: 1e9f61e86067efcd19c3f6e945d75e8bbc797383c3c7e0f0b5f9aa656edf020fa42a4236f49a02b63a6651af2a3f81a9b1433cde5853d4d2f0b16d9875304f5a

data/Gemfile.lock

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

data/exe/test-coverage

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "optparse"
+require "uri"
 
 require_relative "../lib/gitlab_quality/test_tooling"
 
@@ -12,15 +13,24 @@ require_relative '../lib/gitlab_quality/test_tooling/code_coverage/coverage_data
 require_relative '../lib/gitlab_quality/test_tooling/code_coverage/lcov_file'
 require_relative '../lib/gitlab_quality/test_tooling/code_coverage/artifacts'
 require_relative '../lib/gitlab_quality/test_tooling/code_coverage/rspec_report'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/test_report'
 require_relative '../lib/gitlab_quality/test_tooling/code_coverage/test_map'
 
 params = {}
-required_params = [:rspec_reports, :coverage_report, :test_map]
+required_params = [:coverage_report, :test_map, :clickhouse_url, :clickhouse_database, :clickhouse_username]
 
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('--rspec-reports GLOB', 'Glob pattern for RSpec JSON reports (e.g., "rspec/rspec-*.json")') do |pattern|
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('--test-reports GLOB',
+    'Glob pattern for test JSON reports (RSpec or Jest) (e.g., "reports/**/*.json"). Takes precedence over --rspec-reports if both are provided.') do |pattern|
+    params[:test_reports] = pattern
+  end
+
+  opts.on('--rspec-reports GLOB', '[DEPRECATED] Use --test-reports instead. Glob pattern for RSpec JSON reports. Ignored if --test-reports is also provided.') do |pattern|
     params[:rspec_reports] = pattern
   end
 
@@ -32,6 +42,23 @@ options = OptionParser.new do |opts|
     params[:test_map] = path
   end
 
+  opts.on('--clickhouse-url URL', 'ClickHouse server URL') do |url|
+    params[:clickhouse_url] = url
+  end
+
+  opts.on('--clickhouse-database DATABASE', 'ClickHouse database name') do |database|
+    params[:clickhouse_database] = database
+  end
+
+  opts.on('--clickhouse-username USERNAME', 'ClickHouse username') do |username|
+    params[:clickhouse_username] = username
+  end
+
+  opts.separator ""
+  opts.separator "Environment variables:"
+  opts.separator "  GLCI_CLICKHOUSE_METRICS_PASSWORD   ClickHouse password (required, not passed via CLI for security)"
+  opts.separator ""
+
   opts.on('-h', '--help', 'Show the usage') do
     puts opts
     puts "\nExamples:"
@@ -49,24 +76,64 @@ options = OptionParser.new do |opts|
 end
 
 if params.any? && (required_params - params.keys).none?
+  clickhouse_password = ENV.fetch('GLCI_CLICKHOUSE_METRICS_PASSWORD', nil)
+  if clickhouse_password.to_s.strip.empty?
+    puts "Error: GLCI_CLICKHOUSE_METRICS_PASSWORD environment variable must be set and not empty"
+    exit 1
+  end
+
+  [:clickhouse_url, :clickhouse_database, :clickhouse_username].each do |param|
+    if params[param].to_s.strip.empty?
+      puts "Error: --#{param.to_s.tr('_', '-')} cannot be empty"
+      exit 1
+    end
+  end
+
+  begin
+    uri = URI.parse(params[:clickhouse_url])
+    unless uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+      puts "Error: --clickhouse-url must be a valid HTTP or HTTPS URL"
+      exit 1
+    end
+  rescue URI::InvalidURIError
+    puts "Error: --clickhouse-url is not a valid URL format"
+    exit 1
+  end
+
+  # Validate that at least one of test_reports or rspec_reports is provided
+  if params[:test_reports].nil? && params[:rspec_reports].nil?
+    puts "Error: At least one of --test-reports or --rspec-reports must be provided"
+    exit 1
+  end
+
   artifacts = GitlabQuality::TestTooling::CodeCoverage::Artifacts.new(
-    rspec_reports: params[:rspec_reports],
     coverage_report: params[:coverage_report],
-    test_map: params[:test_map]
+    test_map: params[:test_map],
+    test_reports: params[:test_reports],
+    rspec_reports: params[:rspec_reports]
   )
 
   coverage_report = artifacts.coverage_report
-  rspec_reports = artifacts.rspec_reports
   test_map = artifacts.test_map
 
   code_coverage_by_source_file = GitlabQuality::TestTooling::CodeCoverage::LcovFile.new(coverage_report).parsed_content
 
   source_file_to_tests = GitlabQuality::TestTooling::CodeCoverage::TestMap.new(test_map).source_to_tests
 
-  tests_to_categories = rspec_reports.reduce({}) do |combined_hash, rspec_report_file|
-    file_categories = GitlabQuality::TestTooling::CodeCoverage::RspecReport.new(rspec_report_file).tests_to_categories
-    combined_hash.merge(file_categories) { |_, old_val, new_val| (old_val + new_val).uniq }
-  end
+  # Process test reports using the new unified approach or fall back to legacy rspec_reports
+  tests_to_categories = if params[:test_reports]
+                          # Use new TestReport class for unified test reports
+                          artifacts.test_reports.reduce({}) do |combined_hash, test_report_file|
+                            file_categories = GitlabQuality::TestTooling::CodeCoverage::TestReport.new(test_report_file).tests_to_categories
+                            combined_hash.merge(file_categories) { |_, old_val, new_val| (old_val + new_val).uniq }
+                          end
+                        else
+                          # Fall back to legacy RspecReport for backward compatibility
+                          artifacts.rspec_reports.reduce({}) do |combined_hash, rspec_report_file|
+                            file_categories = GitlabQuality::TestTooling::CodeCoverage::RspecReport.new(rspec_report_file).tests_to_categories
+                            combined_hash.merge(file_categories) { |_, old_val, new_val| (old_val + new_val).uniq }
+                          end
+                        end
 
   category_owners = GitlabQuality::TestTooling::CodeCoverage::CategoryOwners.new
 
@@ -77,35 +144,25 @@ if params.any? && (required_params - params.keys).none?
     category_owners.categories_to_teams
   )
 
-  if ENV.fetch('CLICKHOUSE_URL', nil) &&
-      ENV.fetch('CLICKHOUSE_DATABASE', nil) &&
-      ENV.fetch('CLICKHOUSE_USERNAME', nil) &&
-      ENV.fetch('CLICKHOUSE_PASSWORD', nil)
-
-    clickhouse_data = {
-      url: ENV.fetch('CLICKHOUSE_URL', nil),
-      database: ENV.fetch('CLICKHOUSE_DATABASE', nil),
-      username: ENV.fetch('CLICKHOUSE_USERNAME', nil),
-      password: ENV.fetch('CLICKHOUSE_PASSWORD', nil)
-    }
+  clickhouse_data = {
+    url: params[:clickhouse_url],
+    database: params[:clickhouse_database],
+    username: params[:clickhouse_username],
+    password: clickhouse_password
+  }
 
-    category_owners_table  = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CategoryOwnersTable.new(**clickhouse_data)
-    coverage_metrics_table = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CoverageMetricsTable.new(**clickhouse_data)
+  category_owners_table  = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CategoryOwnersTable.new(**clickhouse_data)
+  coverage_metrics_table = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CoverageMetricsTable.new(**clickhouse_data)
 
-    category_owners_table.create  if ENV['CLICKHOUSE_CREATE_CATEGORY_OWNERS_TABLE']  == 'true'
-    coverage_metrics_table.create if ENV['CLICKHOUSE_CREATE_COVERAGE_METRICS_TABLE'] == 'true'
+  category_owners_table.create  if ENV['CLICKHOUSE_CREATE_CATEGORY_OWNERS_TABLE']  == 'true'
+  coverage_metrics_table.create if ENV['CLICKHOUSE_CREATE_COVERAGE_METRICS_TABLE'] == 'true'
 
-    if ENV['CLICKHOUSE_PUSH_CATEGORY_DATA'] == 'true'
-      category_owners_table.truncate
-      category_owners_table.push(category_owners.as_db_table)
-    end
-
-    coverage_metrics_table.push(coverage_data.as_db_table)
-  else
-    puts "ClickHouse configuration not found.\n" \
-      'Set CLICKHOUSE_URL, CLICKHOUSE_DATABASE, CLICKHOUSE_USERNAME, ' \
-      'CLICKHOUSE_PASSWORD environment variables to enable ClickHouse export.'
+  if ENV['CLICKHOUSE_PUSH_CATEGORY_DATA'] == 'true'
+    category_owners_table.truncate
+    category_owners_table.push(category_owners.as_db_table)
   end
+
+  coverage_metrics_table.push(coverage_data.as_db_table)
 else
   puts "Missing argument(s). Required arguments are: #{required_params}\nPassed arguments are: #{params}\n"
   puts options

data/lib/gitlab_quality/test_tooling/code_coverage/artifacts.rb

@@ -10,15 +10,34 @@ module GitlabQuality
       class Artifacts
         # Loads coverage artifacts from the filesystem
         #
-        # @param rspec_reports [String] Glob pattern for RSpec JSON report files (e.g., "rspec/rspec-*.json")
+        # @param test_reports [String, nil] Glob pattern for test JSON report files (RSpec or Jest) (e.g., "reports/**/*.json")
+        # @param rspec_reports [String, nil] [DEPRECATED] Use test_reports instead. Glob pattern for RSpec JSON report files
         # @param coverage_report [String] Path to the LCOV coverage report file (e.g., "coverage/lcov/gitlab.lcov")
         # @param test_map [String] Path to the test map file, gzipped or plain JSON (e.g., "crystalball/packed-mapping.json.gz")
-        def initialize(rspec_reports:, coverage_report:, test_map:)
+        def initialize(coverage_report:, test_map:, test_reports: nil, rspec_reports: nil)
+          @test_reports_glob = test_reports
           @rspec_reports_glob = rspec_reports
           @coverage_report_path = coverage_report
           @test_map_path = test_map
         end
 
+        # Loads and parses test JSON report files (RSpec or Jest)
+        #
+        # @return [Array<Hash>] Array of parsed JSON test reports
+        # @raise [RuntimeError] If no test reports are found or if JSON parsing fails
+        def test_reports
+          @test_report_files ||= test_reports_paths.map do |report_path|
+            JSON.parse(File.read(report_path))
+          rescue JSON::ParserError => e
+            raise "Invalid JSON in test report file #{report_path}: #{e.message}"
+          end
+        end
+
+        # Loads and parses RSpec JSON report files
+        #
+        # @deprecated Use {#test_reports} instead
+        # @return [Array<Hash>] Array of parsed JSON RSpec reports
+        # @raise [RuntimeError] If no RSpec reports are found or if JSON parsing fails
         def rspec_reports
           @rspec_report_files ||= rspec_reports_paths.map do |report_path|
             JSON.parse(File.read(report_path))
@@ -27,17 +46,39 @@ module GitlabQuality
           end
         end
 
+        # Loads the LCOV coverage report file
+        #
+        # @return [String] Raw content of the LCOV coverage report
+        # @raise [RuntimeError] If the coverage report file is not found
         def coverage_report
           @coverage_report ||= read_coverage_reports
         end
 
+        # Loads and parses the test map file (supports gzipped or plain JSON)
+        #
+        # @return [Hash] Parsed test map data
+        # @raise [RuntimeError] If the test map file is not found or cannot be parsed
         def test_map
           @test_map ||= fetch_test_map
         end
 
         private
 
+        def test_reports_paths
+          return [] if @test_reports_glob.nil? || @test_reports_glob.empty?
+
+          @test_reports_paths ||= begin
+            paths = Dir.glob(@test_reports_glob)
+
+            raise "No test reports found matching pattern: #{@test_reports_glob}" if paths.empty?
+
+            paths
+          end
+        end
+
         def rspec_reports_paths
+          return [] if @rspec_reports_glob.nil? || @rspec_reports_glob.empty?
+
           @rspec_reports_paths ||= begin
             paths = Dir.glob(@rspec_reports_glob)
 

data/lib/gitlab_quality/test_tooling/code_coverage/test_report.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module CodeCoverage
+      class TestReport
+        # @param [Hash<String, Object>] test_report The content of a test
+        #   report (RSpec or Jest)
+        def initialize(test_report)
+          @test_report = test_report
+        end
+
+        # @return [Array<Hash<String, String>>] Content of the "examples"
+        #   section of the test report
+        def examples
+          @examples ||= @test_report['examples']
+        end
+
+        # @return [Hash<String, Array<String>>] Test files mapped to all feature
+        #   categories they belong to
+        # @example Return value
+        #   {
+        #     "spec/path/to/file_spec.rb" => [
+        #       "feature_category1", "feature_category2"
+        #     ],
+        #     ...
+        #   }
+        def tests_to_categories
+          @tests_to_categories ||= examples.to_a.filter_map do |example|
+            next unless example.is_a?(Hash)
+
+            file_path = example['file_path']
+            next unless file_path.is_a?(String)
+
+            [file_path.gsub('./', ''), Array(example['feature_category']).compact]
+          end.to_h
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ 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)",
@@ -127,14 +128,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

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.26.0"
+    VERSION = "2.27.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 2.26.0
+  version: 2.27.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-05 00:00:00.000000000 Z
+date: 2025-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -499,6 +499,7 @@ files:
 - lib/gitlab_quality/test_tooling/code_coverage/lcov_file.rb
 - lib/gitlab_quality/test_tooling/code_coverage/rspec_report.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
 - lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb
 - lib/gitlab_quality/test_tooling/failed_jobs_table.rb