gitlab_quality-test_tooling 3.12.1 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 544d1dca9801992bdb2b7cbe9c34eb3dae7f7c47f84c3d51b5eb55dbfcaae6c6
-  data.tar.gz: 8442c5eaa7f809c59cbad5e96ef46606ab7f1a881bc9040267929b66cf36f9d5
+  metadata.gz: 473fb18a44195986ea17fec58d277b67fd7589fca55a08250704687e2b70aa80
+  data.tar.gz: 4c18c0a11106a2a6103c1e5ba139dd68d1879ccb94360bddd77e1cf3beeafd34
 SHA512:
-  metadata.gz: d1115577ba91a7bf0c1a8632a53502b58fad6b5c2cd62862230d70e26a31c7ef5eed202bed97f90cd2d8d98897bdc5a71f5006a4059a6b1bdac571144c5722c8
-  data.tar.gz: 108b5be41cde544adee4439d56e61caeccab5a4fa5ebefcb785cea9b8dc70a4751cdce0659e7f4bf176165392a3e184dd944e8832bdc8c399661e87f36830c58
+  metadata.gz: ba2aac53d5ce9f33bba7791ddc5dfaae10dff68f118d0de6ab33ca9569b64e1a555f29ee9bb9d3d1b04d9f182e374dac27a3d75bd561531ceaa6c728f0a63545
+  data.tar.gz: 999efaaa3f6067aeb29b7c0cb00bf3ba8877f61fb108f8ef4213b1946e739a22249b77cf0a54feed33396ca6d5677920a34070d5b861a49535070f1cbc4bf464

data/Gemfile.lock

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

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

@@ -7,6 +7,8 @@ module GitlabQuality
         SLOW_TEST_MESSAGE = '<!-- slow-test -->'
         SLOW_TEST_LABEL = '/label ~"rspec:slow test detected"'
         SLOW_TEST_NOTE_SOURCE_CODE = 'Generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/blob/main/lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb).'
+        SLOW_TEST_UNHEALTHY_PATTERNS = 'https://docs.gitlab.com/development/testing_guide/unhealthy_tests/#common-patterns-that-cause-slow-tests'
+        SLOW_TEST_BEST_PRACTICES = 'https://docs.gitlab.com/development/testing_guide/best_practices/#test-slowness'
 
         def initialize(token:, input_files:, merge_request_iid:, project: nil, dry_run: false, **_kwargs)
           @token = token
@@ -70,23 +72,36 @@ module GitlabQuality
             SLOW_TEST_LABEL,
             ":tools: #{SLOW_TEST_NOTE_SOURCE_CODE}\n",
             "---\n",
-            ":snail: Slow tests detected in this merge request. These slow tests might be related to this merge request's changes.",
-            "<details><summary>Click to expand</summary>\n",
-            '| Job | File | Name | Duration | Expected duration |',
-            '| --- | --- | --- | --- | --- |'
+            ":snail: Slow tests detected in this merge request. These slow tests might be related to this merge request's changes."
           ]
         end
 
+        def handbook_guidance
+          ":books: For guidance on improving test performance, see " \
+            "[Common Patterns That Cause Slow Tests](#{SLOW_TEST_UNHEALTHY_PATTERNS}) " \
+            "and [Best Practices – Test Slowness](#{SLOW_TEST_BEST_PRACTICES})."
+        end
+
+        def feature_spec?(slow_test)
+          slow_test.file.include?('spec/features/')
+        end
+
         def slow_test_rows(slow_test)
           slow_test.map do |test|
             slow_test_table_row(test)
           end
         end
 
-        def build_note(slow_test)
-          rows = note_header + slow_test_rows(slow_test) + ["\n</details>"]
+        def build_note(slow_tests)
+          rows = note_header
+          rows << "\n#{handbook_guidance}" if slow_tests.any? { |t| feature_spec?(t) }
+          rows += [
+            "<details><summary>Click to expand</summary>\n",
+            '| Job | File | Name | Duration | Expected duration |',
+            '| --- | --- | --- | --- | --- |'
+          ]
 
-          rows.join("\n")
+          (rows + slow_test_rows(slow_tests) + ["\n</details>"]).join("\n")
         end
 
         def note_comment_includes_slow_test?(gitlab_note, slow_test)

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+
+module GitlabQuality
+  module TestTooling
+    module TestMetricsExporter
+      class Client
+        ResponseError = Class.new(StandardError)
+
+        TESTS_PATH = "/api/v1/tests"
+        # Observer enforces a per-request cap; batch above this size to avoid silent failures.
+        MAX_BATCH_SIZE = 10_000
+
+        def initialize(url:, token:)
+          @url = url
+          @token = token
+        end
+
+        # POST array of test metric records to the observer service.
+        # Wraps each batch as { "tests" => [...] } and splits oversized payloads
+        # into chunks of at most MAX_BATCH_SIZE records.
+        #
+        # @param tests [Array<Hash>]
+        # @return [Boolean] true when every batch succeeds (or input is empty)
+        # @raise [ResponseError] on the first non-2xx batch response
+        def post_tests(tests)
+          tests.each_slice(MAX_BATCH_SIZE) do |batch|
+            response = HTTParty.post(
+              "#{url.to_s.chomp('/')}#{TESTS_PATH}",
+              body: { tests: batch }.to_json,
+              headers: {
+                "X-Gitlab-Token" => token,
+                "Content-Type" => "application/json"
+              }
+            )
+            raise ResponseError, "Observer request failed with status #{response.code}: #{response.body}" unless response.success?
+          end
+
+          true
+        end
+
+        private
+
+        attr_reader :url, :token
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "logger"
 require "singleton"
 
 module GitlabQuality
@@ -8,34 +9,6 @@ module GitlabQuality
       class Config
         include Singleton
 
-        # GCS client configuration object used to push metrics as json file to gcs bucket
-        #
-        class GCS
-          def initialize(project_id:, credentials:, bucket_name:, metrics_file_name:, dry_run: false)
-            @project_id = project_id
-            @credentials = credentials
-            @bucket_name = bucket_name
-            @metrics_file_name = metrics_file_name
-            @dry_run = dry_run
-          end
-
-          attr_reader :project_id, :credentials, :bucket_name, :metrics_file_name, :dry_run
-        end
-
-        # ClickHouse client configuration object
-        #
-        class ClickHouse
-          def initialize(url:, database:, table_name:, username:, password:)
-            @url = url
-            @database = database
-            @table_name = table_name
-            @username = username
-            @password = password
-          end
-
-          attr_reader :url, :database, :table_name, :username, :password
-        end
-
         class << self
           def configuration
             Config.instance
@@ -46,8 +19,9 @@ module GitlabQuality
           end
         end
 
-        attr_reader :gcs_config, :clickhouse_config, :initial_run
-        attr_accessor :run_type
+        attr_accessor :run_type,
+          :observer_url,
+          :observer_token
         attr_writer :extra_rspec_metadata_keys,
           :skip_record_proc,
           :test_retried_proc,
@@ -55,51 +29,13 @@ module GitlabQuality
           :spec_file_path_prefix,
           :logger
 
-        # rubocop:disable Style/TrivialAccessors -- allows documenting that setting config enables the export as well as document input class type
-
-        # Enable metrics export to gcs bucket by setting configuration object
+        # Whether observer export is configured
         #
-        # @param config [Config::GCS]
-        # @return [GCS]
-        def gcs_config=(config)
-          @gcs_config = config
-        end
-
-        # Enable metrics export to clickhouse by setting configuration object
-        #
-        # @param config [Config::ClickHouse]
-        # @return [ClickHouse]
-        def clickhouse_config=(config)
-          @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
+        # Export is considered enabled when all required attributes are set
         #
         # @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 ||= []
+        def observer_configured?
+          [observer_url, observer_token].none? { |value| value.nil? || value.to_s.empty? }
         end
 
         # Extra rspec metadata keys to include in exported metrics

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'active_support/core_ext/object/blank'
+
+require_relative 'config'
+require_relative 'formatter'
+
+module GitlabQuality
+  module TestTooling
+    module TestMetricsExporter
+      class ConfigHelper
+        REQUIRED_OBSERVER_ENV_VARS = %w[
+          GLCI_OBSERVER_URL
+          GLCI_OBSERVER_AUTH_TOKEN
+        ].freeze
+
+        class << self
+          def configure!(run_type = test_run_type)
+            return unless ENV.fetch("CI", nil) && ENV.fetch("GLCI_EXPORT_TEST_METRICS", "true") == "true" && run_type
+
+            RSpec.configure do |rspec_config|
+              next if rspec_config.dry_run?
+
+              Config.configure do |exporter_config|
+                self.logger = exporter_config.logger
+                next warn_missing_observer_variables unless observer_env_vars_present?
+
+                yield(exporter_config) if block_given?
+                configure_exporter!(exporter_config, run_type)
+
+                rspec_config.add_formatter Formatter
+
+                logger.info("Test metrics export is enabled for run type: #{run_type}")
+              end
+            end
+          end
+
+          private
+
+          attr_writer :logger
+
+          def logger
+            @logger ||= Logger.new($stdout)
+          end
+
+          def observer_env_vars_present?
+            REQUIRED_OBSERVER_ENV_VARS.all? { |var| ENV.fetch(var, nil) && !ENV[var].empty? }
+          end
+
+          def configure_exporter!(config, run_type)
+            config.run_type = run_type
+            config.custom_metrics_proc = custom_metrics_proc
+
+            configure_observer!(config)
+          end
+
+          def configure_observer!(config)
+            config.observer_url = observer_url
+            config.observer_token = observer_token
+          end
+
+          def warn_missing_observer_variables
+            missing = REQUIRED_OBSERVER_ENV_VARS.reject { |var| ENV.fetch(var, nil) && !ENV[var].empty? }
+            logger.warn("Test metrics export is enabled but missing environment variables: #{missing.join(', ')}")
+          end
+
+          def custom_metrics_proc
+            proc do |_example|
+              { pipeline_type: pipeline_type, ci_pipeline_id: ci_pipeline_id }
+            end
+          end
+
+          def default_branch?
+            ENV["CI_COMMIT_REF_NAME"] == ENV["CI_DEFAULT_BRANCH"]
+          end
+
+          def pipeline_type
+            @pipeline_type ||= if default_branch? && ENV["SCHEDULE_TYPE"].present?
+                                 "default_branch_scheduled_pipeline"
+                               elsif default_branch?
+                                 "default_branch_pipeline"
+                               elsif ENV["CI_COMMIT_REF_NAME"]&.match?(/^[\d-]+-stable-ee$/)
+                                 "stable_branch_pipeline"
+                               elsif ENV["CI_MERGE_REQUEST_TARGET_BRANCH_NAME"]&.match?(/^[\d-]+-stable-ee$/)
+                                 "backport_merge_request_pipeline"
+                               elsif ENV["CI_MERGE_REQUEST_IID"].present?
+                                 "merge_request_pipeline"
+                               elsif ENV["CI_PIPELINE_SOURCE"] == "pipeline"
+                                 "downstream_pipeline"
+                               else
+                                 "unknown"
+                               end
+          end
+
+          def test_run_type
+            @run_type ||= ENV.fetch("GLCI_TEST_METRICS_RUN_TYPE", nil)
+          end
+
+          def observer_url
+            ENV.fetch("GLCI_OBSERVER_URL", nil)
+          end
+
+          def observer_token
+            ENV.fetch("GLCI_OBSERVER_AUTH_TOKEN", nil)
+          end
+
+          def ci_pipeline_id
+            (ENV["PARENT_PIPELINE_ID"] || ENV.fetch("CI_PIPELINE_ID", nil)).to_i
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,27 +2,17 @@
 
 require "rspec/core/formatters/base_formatter"
 
+require_relative "test_metrics"
+require_relative "client"
+
 module GitlabQuality
   module TestTooling
     module TestMetricsExporter
       class Formatter < RSpec::Core::Formatters::BaseFormatter
-        include Utils
-
-        RSpec::Core::Formatters.register(self, :start, :stop)
+        RSpec::Core::Formatters.register(self, :stop)
 
         LOG_PREFIX = "[MetricsExporter]"
 
-        def start(_notification)
-          return unless config.initial_run
-
-          logger.info("#{LOG_PREFIX} Running initial setup for metrics export")
-          raise "Initial setup is enabled, but clickhouse configuration is missing!" unless clickhouse_config
-
-          create_clickhouse_metrics_table
-        rescue StandardError => e
-          logger.error("#{LOG_PREFIX} Error occurred during initial setup: #{e.message}")
-        end
-
         def stop(notification)
           logger.debug("#{LOG_PREFIX} Starting test metrics export")
           data = notification.examples.filter_map do |example|
@@ -32,13 +22,18 @@ module GitlabQuality
           end
           return logger.warn("#{LOG_PREFIX} No test execution records found, metrics will not be exported!") if data.empty?
 
-          push_to_gcs(data)
-          push_to_clickhouse(data)
+          push_to_observer(data)
         end
 
         private
 
-        delegate :gcs_config, :clickhouse_config, to: :config
+        def config
+          Config.configuration
+        end
+
+        def logger
+          config.logger
+        end
 
         # Single common timestamp for all exported example metrics to keep data points consistently grouped
         #
@@ -46,34 +41,25 @@ module GitlabQuality
         def time
           return @time if @time
 
-          ci_created_at = Runtime::Env.ci_pipeline_created_at
+          ci_created_at = ENV.fetch("CI_PIPELINE_CREATED_AT", nil)
           @time = (ci_created_at ? Time.strptime(ci_created_at, '%Y-%m-%dT%H:%M:%S%z') : Time.now.utc).strftime('%Y-%m-%dT%H:%M:%S.%6N')
         end
 
-        # Push data to gcs
+        # Push data to observer service
         #
-        # @param data [Array]
+        # @param data [Array<Hash>]
         # @return [void]
-        def push_to_gcs(data)
-          return logger.debug("#{LOG_PREFIX} GCS configuration missing, skipping gcs export!") unless gcs_config
+        def push_to_observer(data)
+          return logger.debug("#{LOG_PREFIX} Observer configuration missing, skipping export!") unless config.observer_configured?
 
-          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!")
+          observer_client.post_tests(data)
+          logger.info("#{LOG_PREFIX} Successfully pushed #{data.size} entries to Observer!")
         rescue StandardError => e
-          logger.error("#{LOG_PREFIX} Error occurred while pushing metrics to GCS: #{e.message}")
+          logger.error("#{LOG_PREFIX} Error occurred while pushing metrics to Observer: #{e.message}")
         end
 
-        # Push data to clickhouse
-        #
-        # @param data [Array<Hash>]
-        # @return [void]
-        def push_to_clickhouse(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}")
+        def observer_client
+          Client.new(url: config.observer_url, token: config.observer_token)
         end
       end
     end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "3.12.1"
+    VERSION = "3.14.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.14.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -588,10 +588,11 @@ files:
 - lib/gitlab_quality/test_tooling/test_meta/test_meta_updater.rb
 - lib/gitlab_quality/test_tooling/test_metric/json_test_metric.rb
 - lib/gitlab_quality/test_tooling/test_metrics/json_test_metric_collection.rb
+- lib/gitlab_quality/test_tooling/test_metrics_exporter/client.rb
 - lib/gitlab_quality/test_tooling/test_metrics_exporter/config.rb
+- lib/gitlab_quality/test_tooling/test_metrics_exporter/config_helper.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_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

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

@@ -1,98 +0,0 @@
-# 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 'unknown',
-                run_type LowCardinality(String) DEFAULT 'unknown',
-                spec_file_path_prefix 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),
-                ci_server_url LowCardinality(String) DEFAULT 'https://gitlab.com',
-                exception_class String DEFAULT '',
-                exception_classes Array(String) DEFAULT [],
-                failure_exception String DEFAULT ''
-            )
-            ENGINE = MergeTree()
-            PARTITION BY toYYYYMM(timestamp)
-            ORDER BY (ci_project_path, status, run_type, feature_category, file_path, timestamp, 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