gitlab_quality-test_tooling 2.20.3 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fcdafab955309e5bc8339d69af869089359e4323f4b51ba80565092443928df
-  data.tar.gz: fe09638d129c26153885ea49ebed73834fbd87e7bc65f4cd79ff3807027d47c3
+  metadata.gz: a5d7cbba0261ebfecefff8f84b388d3d238c4126ee183897ab63349f4995888a
+  data.tar.gz: 3210de6e92566a315e3bf1b07a7cd8c37e883c073a021f51cdcc5582f357e0d6
 SHA512:
-  metadata.gz: aa9dab59ef59c0c3fedce10911290974a8e0fe65746da8e38c0ac33697808e936b8386b7252fa6a55ccc11df2fadadfa46467b390749bf41db9a273f03e698a8
-  data.tar.gz: f03234f295299537ae028678e8039754f8e15fe988599ef688ef2bd3feb9e8b52fad07f6dde9a892057d4ea9da096e029612feb549bc929259bea573f322c33d
+  metadata.gz: f4b180f20e75823e25737977cc545fd04adb46f91dd5029723d29d663b51876ac0be5f4d867bdbef20870d020d5d6ef36e7375d6c67fbfab10807c1ded2b9f42
+  data.tar.gz: c9f09041698d0a08032eb20b5ad26133e381d52315108f86c838b7b32bfb62d3db08a276037d7224addfb44f1779146f1ce1192fe51083075d1ca56f1104e6b5

data/Gemfile.lock

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

data/lib/gitlab_quality/test_tooling/click_house/client.rb

@@ -3,13 +3,12 @@
 require "httparty"
 require "json"
 require "logger"
+require "active_support/core_ext/object/blank"
 
 module GitlabQuality
   module TestTooling
     module ClickHouse
       class Client
-        include HTTParty
-
         DEFAULT_BATCH_SIZE = 100_000
         LOG_PREFIX = "[ClickHouse]"
 
@@ -19,14 +18,29 @@ module GitlabQuality
           @username = username
           @password = password
           @logger = logger
+        end
 
-          # Set base URI
-          self.class.base_uri @url
-
-          # Set basic auth if credentials provided
-          return unless @username && @password
+        # Perform sql query
+        #
+        # @param sql [String]
+        # @param format [String]
+        # @return [Array, Hash, String]
+        def query(sql, format: "JSONEachRow")
+          logger.debug("Running #{sql}")
+          response = post(
+            body: sql,
+            content_type: "text/plain",
+            query_opts: { default_format: format }
+          )
+          raise "ClickHouse query failed: code: #{response.code}, error: #{response.body}" if response.code != 200
 
-          self.class.basic_auth @username, @password
+          if format == "JSONEachRow"
+            response.body.split("\n").map { |row| JSON.parse(row) }
+          elsif %w[JSON JSONCompact].include?(format)
+            JSON.parse(response.body.presence || "{}")
+          else
+            response.body
+          end
         end
 
         # Push data to ClickHouse
@@ -50,14 +64,14 @@ module GitlabQuality
 
           err = results
             .reject { |res| res[:success] }
-            .map { |res| "size: #{res[:count]}, err: #{res[:error]}" }
+            .map { |res| "batch_size: #{res[:count]}, err: #{res[:error]}" }
             .join("\n")
           raise "Failures detected when pushing data to ClickHouse, errors:\n#{err}"
         end
 
         private
 
-        attr_reader :logger
+        attr_reader :url, :database, :username, :password, :logger
 
         # Push batch of data
         #
@@ -65,20 +79,32 @@ module GitlabQuality
         # @param batch [Array<Hash>] data batch
         # @return [Hash]
         def send_batch(table_name, batch)
-          response = self.class.post('/', {
+          response = post(
             body: batch.map(&:to_json).join("\n"),
-            headers: { 'Content-Type' => 'application/json' },
-            query: {
-              database: @database,
-              query: "INSERT INTO #{table_name} FORMAT JSONEachRow"
-            }
-          })
+            content_type: 'application/json',
+            query_opts: { query: "INSERT INTO #{table_name} FORMAT JSONEachRow" }
+          )
           return { success: true, count: batch.size, response: response.body } if response.code == 200
 
           { success: false, count: batch.size, error: response.body }
         rescue StandardError => e
           { success: false, count: batch.size, error: e.message }
         end
+
+        # Execute post request
+        #
+        # @param body [String]
+        # @param content_type [String]
+        # @param query_opts [Hash] additional query options
+        # @return [HTTParty::Response]
+        def post(body:, content_type:, query_opts: {})
+          HTTParty.post(url, {
+            body: body,
+            headers: { "Content-Type" => content_type },
+            query: { database: database, **query_opts }.compact,
+            basic_auth: !!(username && password) ? { username: username, password: password } : nil
+          }.compact)
+        end
       end
     end
   end

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

@@ -36,13 +36,15 @@ module GitlabQuality
         # there before being released to the public repository
         DIFF_PROJECT_MAPPINGS = {
           'gitlab-org/quality/e2e-test-issues' => 'gitlab-org/security/gitlab',
+          'gitlab-org/quality/test-failure-issues' => 'gitlab-org/security/gitlab',
           'gitlab-org/gitlab' => 'gitlab-org/security/gitlab',
           'gitlab-org/customers-gitlab-com' => 'gitlab-org/customers-gitlab-com'
         }.freeze
 
         # Don't use the E2E test issues project for commit parent
         COMMIT_PROJECT_MAPPINGS = {
-          'gitlab-org/quality/e2e-test-issues' => 'gitlab-org/gitlab'
+          'gitlab-org/quality/e2e-test-issues' => 'gitlab-org/gitlab',
+          'gitlab-org/quality/test-failure-issues' => 'gitlab-org/gitlab'
         }.freeze
 
         # The project contains record of the deployments we use to determine the commit diff

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/config.rb

@@ -46,7 +46,7 @@ module GitlabQuality
           end
         end
 
-        attr_reader :gcs_config, :clickhouse_config
+        attr_reader :gcs_config, :clickhouse_config, :initial_run
         attr_accessor :run_type
         attr_writer :extra_rspec_metadata_keys,
           :skip_record_proc,
@@ -72,8 +72,35 @@ module GitlabQuality
           @clickhouse_config = config
         end
 
+        # Additional columns to be created in the table if initial_run setup is used
+        # Columns should be defined in the format used for ALTER TABLE query, example;
+        #   [
+        #     "feature_category LowCardinality(String) DEFAULT ''",
+        #     "level LowCardinality(String) DEFAULT ''"
+        #   ]
+        #
+        # @param columns [Array]
+        # @return [Array]
+        def extra_metadata_columns=(columns)
+          @extra_metadata_columns = columns
+        end
+
         # rubocop:enable Style/TrivialAccessors
 
+        # Marks execution as initial run and performs setup tasks before running tests, like creating database in ClickHouse
+        #
+        # @return [Boolean]
+        def initial_run!
+          @initial_run = true
+        end
+
+        # Additional metadata columns used during initial table creation
+        #
+        # @return [Array]
+        def extra_metadata_columns
+          @extra_metadata_columns ||= []
+        end
+
         # Extra rspec metadata keys to include in exported metrics
         #
         # @return [Array<Symbol>]

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/formatter.rb

@@ -2,16 +2,25 @@
 
 require "rspec/core/formatters/base_formatter"
 
-# rubocop:disable Metrics/AbcSize
 module GitlabQuality
   module TestTooling
     module TestMetricsExporter
       class Formatter < RSpec::Core::Formatters::BaseFormatter
-        RSpec::Core::Formatters.register(self, :stop)
+        include Utils
+
+        RSpec::Core::Formatters.register(self, *[:stop, Utils.config.initial_run ? :start : nil].compact)
 
         LOG_PREFIX = "[MetricsExporter]"
 
+        def start(_notification)
+          logger.debug("#{LOG_PREFIX} Running initial setup for metrics export")
+          return logger.warn("#{LOG_PREFIX} Initial setup is enabled, but clickhouse configuration is missing!") unless clickhouse_config
+
+          create_clickhouse_metrics_table
+        end
+
         def stop(notification)
+          logger.debug("#{LOG_PREFIX} Starting test metrics export")
           data = notification.examples.filter_map do |example|
             next if config.skip_record_proc.call(example)
 
@@ -25,19 +34,7 @@ module GitlabQuality
 
         private
 
-        # Configuration instance
-        #
-        # @return [Config]
-        def config
-          Config.configuration
-        end
-
-        # Logger instance
-        #
-        # @return [Logger]
-        def logger
-          config.logger
-        end
+        delegate :gcs_config, :clickhouse_config, to: :config
 
         # Single common timestamp for all exported example metrics to keep data points consistently grouped
         #
@@ -54,14 +51,9 @@ module GitlabQuality
         # @param data [Array]
         # @return [void]
         def push_to_gcs(data)
-          return logger.debug("#{LOG_PREFIX} GCS configuration missing, skipping gcs export!") unless config.gcs_config
-
-          gcs_config = config.gcs_config
-          GcsTools.gcs_client(
-            project_id: gcs_config.project_id,
-            credentials: gcs_config.credentials,
-            dry_run: gcs_config.dry_run
-          ).put_object(gcs_config.bucket_name, gcs_config.metrics_file_name, data.to_json)
+          return logger.debug("#{LOG_PREFIX} GCS configuration missing, skipping gcs export!") unless gcs_config
+
+          gcs_client.put_object(gcs_config.bucket_name, gcs_config.metrics_file_name, data.to_json)
           logger.info("#{LOG_PREFIX} Successfully pushed #{data.size} entries to GCS bucket!")
         rescue StandardError => e
           logger.error("#{LOG_PREFIX} Error occurred while pushing metrics to GCS: #{e.message}")
@@ -72,16 +64,9 @@ module GitlabQuality
         # @param data [Array<Hash>]
         # @return [void]
         def push_to_clickhouse(data)
-          return logger.debug("ClickHouse configuration missing, skipping ClickHouse export!") unless config.clickhouse_config
-
-          clickhouse_config = config.clickhouse_config
-          ClickHouse::Client.new(
-            url: clickhouse_config.url,
-            database: clickhouse_config.database,
-            username: clickhouse_config.username,
-            password: clickhouse_config.password,
-            logger: logger
-          ).insert_json_data(clickhouse_config.table_name, data)
+          return logger.debug("ClickHouse configuration missing, skipping ClickHouse export!") unless clickhouse_config
+
+          clickhouse_client.insert_json_data(clickhouse_config.table_name, data)
           logger.info("#{LOG_PREFIX} Successfully pushed #{data.size} entries to ClickHouse!")
         rescue StandardError => e
           logger.error("#{LOG_PREFIX} Error occurred while pushing metrics to ClickHouse: #{e.message}")
@@ -90,4 +75,3 @@ module GitlabQuality
     end
   end
 end
-# rubocop:enable Metrics/AbcSize

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/test_metrics.rb

@@ -39,15 +39,17 @@ module GitlabQuality
         # @return [Hash]
         def rspec_metrics # rubocop:disable Metrics/AbcSize
           {
-            id: example.id,
+            id: without_relative_path(example.id),
             name: example.full_description,
-            file_path: example.metadata[:file_path].sub(/\A./, ''),
+            hash: OpenSSL::Digest.hexdigest("SHA256", "#{file_path}#{example.full_description}")[..40],
+            file_path: file_path,
             status: example.execution_result.status,
             run_time: (example.execution_result.run_time * 1000).round,
             location: example_location,
             exception_class: exception_class,
             failure_exception: failure_exception,
             quarantined: quarantined?,
+            feature_category: example.metadata[:feature_category] || "",
             test_retried: config.test_retried_proc.call(example)
           }
         end
@@ -102,6 +104,8 @@ module GitlabQuality
         #
         # @return [String]
         def example_location
+          return @example_location if @example_location
+
           # ensures that location will be correct even in case of shared examples
           file = example
                  .metadata
@@ -109,9 +113,16 @@ module GitlabQuality
                  .last
                  &.formatted_inclusion_location
 
-          return example.location unless file
+          return without_relative_path(example.location) unless file
+
+          @example_location = without_relative_path(file)
+        end
 
-          file
+        # File path based on actual test location, not shared example location
+        #
+        # @return [String]
+        def file_path
+          @file_path ||= example_location.gsub(/:\d+$/, "")
         end
 
         # Failure exception class
@@ -166,6 +177,14 @@ module GitlabQuality
         def bool?(val)
           [true, false].include?(val)
         end
+
+        # Path without leading ./
+        #
+        # @param path [String]
+        # @return [String]
+        def without_relative_path(path)
+          path.gsub(%r{^\./}, "")
+        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/utils.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMetricsExporter
+      module Utils
+        # Instance of metrics exporter configuration
+        #
+        # @return [Config]
+        def config
+          Config.configuration
+        end
+
+        # Configured logger instance
+        #
+        # @return [Logger]
+        def logger
+          config.logger
+        end
+
+        # Configured clickhouse client
+        #
+        # @return [ClickHouse::Client]
+        def clickhouse_client
+          ClickHouse::Client.new(
+            url: config.clickhouse_config.url,
+            database: config.clickhouse_config.database,
+            username: config.clickhouse_config.username,
+            password: config.clickhouse_config.password,
+            logger: logger
+          )
+        end
+
+        # GCS client instance
+        #
+        # @return [Fog::Storage::Google, GcsTools::GCSMockClient]
+        def gcs_client
+          GcsTools.gcs_client(
+            project_id: config.gcs_config.project_id,
+            credentials: config.gcs_config.credentials,
+            dry_run: config.gcs_config.dry_run
+          )
+        end
+
+        # Create table for metrics export using current ClickHouse configuration
+        #
+        # This method is mostly for schema documentation but it can be used together with initial_run! method in
+        #
+        # @return [void]
+        def create_clickhouse_metrics_table
+          table_name = config.clickhouse_config.table_name
+
+          clickhouse_client.query(<<~SQL)
+            CREATE TABLE IF NOT EXISTS #{table_name}
+            (
+                timestamp DateTime64(6, 'UTC'),
+                id String,
+                name String,
+                hash String,
+                file_path String,
+                status LowCardinality(String),
+                run_time UInt32,
+                location String,
+                quarantined Bool,
+                test_retried Bool,
+                feature_category LowCardinality(String) DEFAULT '',
+                ci_project_id UInt32,
+                ci_job_name LowCardinality(String),
+                ci_job_id UInt64,
+                ci_pipeline_id UInt64,
+                ci_merge_request_iid UInt32 DEFAULT 0,
+                ci_project_path LowCardinality(String),
+                ci_branch String,
+                ci_target_branch LowCardinality(String),
+                exception_class String DEFAULT '',
+                failure_exception String DEFAULT ''
+            )
+            ENGINE = MergeTree()
+            PARTITION BY toYYYYMM(timestamp)
+            ORDER BY (ci_project_path, timestamp, status, feature_category, file_path, ci_pipeline_id)
+            SETTINGS index_granularity = 8192;
+          SQL
+          return if config.extra_metadata_columns.empty?
+
+          clickhouse_client.query(
+            "ALTER TABLE #{table_name} #{config.extra_metadata_columns.map { |column| "ADD COLUMN IF NOT EXISTS #{column}" }.join(', ')};"
+          )
+        end
+
+        module_function :config, :logger, :clickhouse_client
+      end
+    end
+  end
+end

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

@@ -119,7 +119,7 @@ module GitlabQuality
         end
 
         def file_base_url
-          @file_base_url ||= "https://gitlab.com/#{project == 'gitlab-org/quality/e2e-test-issues' ? 'gitlab-org/gitlab' : project}/-/blob/#{ref}/"
+          @file_base_url ||= "https://gitlab.com/#{mapped_project}/-/blob/#{ref}/"
         end
 
         def test_file_link
@@ -158,7 +158,7 @@ module GitlabQuality
         attr_reader :token, :project, :ref
 
         def mapped_project
-          if project == 'gitlab-org/quality/e2e-test-issues'
+          if ['gitlab-org/quality/e2e-test-issues', 'gitlab-org/quality/test-failure-issues'].include?(project)
             'gitlab-org/gitlab'
           else
             project

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.20.3"
+    VERSION = "2.21.0"
   end
 end

data/lib/gitlab_quality/test_tooling.rb

@@ -2,6 +2,7 @@
 
 require 'rainbow/refinement'
 require 'zeitwerk'
+require 'active_support/core_ext/module/delegation'
 
 module GitlabQuality
   module TestTooling

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 2.20.3
+  version: 2.21.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-08 00:00:00.000000000 Z
+date: 2025-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -580,6 +580,7 @@ files:
 - lib/gitlab_quality/test_tooling/test_metrics_exporter/config.rb
 - 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_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