gitlab_quality-test_tooling 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1284d833aad5c38a45cff835cf3e701193117aa9694293b42fee9ce60345b0d
-  data.tar.gz: e209cf22987a7a19c58a4675ad529a6910ec387117a49fbcef97aadef9230c6f
+  metadata.gz: 473fb18a44195986ea17fec58d277b67fd7589fca55a08250704687e2b70aa80
+  data.tar.gz: 4c18c0a11106a2a6103c1e5ba139dd68d1879ccb94360bddd77e1cf3beeafd34
 SHA512:
-  metadata.gz: '09ded437ab350eddf3736017e844865ef0a5ca311c6d62e800b87b272e691eab904ae12c6241f202f76ae1afa1e717880b99984e640fbd9728791e684fbfbbed'
-  data.tar.gz: a9064f95ca94ef8d8d476f097f3ee9412d71dca931a715e9f446a81f8646e75e14ab141b93fe83ebd1bf898d32503b4806179ac2f9b3233fe69c95024c693491
+  metadata.gz: ba2aac53d5ce9f33bba7791ddc5dfaae10dff68f118d0de6ab33ca9569b64e1a555f29ee9bb9d3d1b04d9f182e374dac27a3d75bd561531ceaa6c728f0a63545
+  data.tar.gz: 999efaaa3f6067aeb29b7c0cb00bf3ba8877f61fb108f8ef4213b1946e739a22249b77cf0a54feed33396ca6d5677920a34070d5b861a49535070f1cbc4bf464

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (3.13.0)
+    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/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
@@ -18,13 +19,9 @@ module GitlabQuality
           end
         end
 
-        attr_reader :initial_run
         attr_accessor :run_type,
-          :clickhouse_url,
-          :clickhouse_database,
-          :clickhouse_table_name,
-          :clickhouse_username,
-          :clickhouse_password
+          :observer_url,
+          :observer_token
         attr_writer :extra_rspec_metadata_keys,
           :skip_record_proc,
           :test_retried_proc,
@@ -32,44 +29,13 @@ module GitlabQuality
           :spec_file_path_prefix,
           :logger
 
-        # rubocop:disable Style/TrivialAccessors -- allows adding documentation for extra_metadata_columns
-
-        # 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
-
-        # Whether ClickHouse export is configured
+        # Whether observer export is configured
         #
         # Export is considered enabled when all required attributes are set
         #
         # @return [Boolean]
-        def clickhouse_configured?
-          [clickhouse_url, clickhouse_database, clickhouse_table_name, clickhouse_username, clickhouse_password].none?(&:blank?)
-        end
-
-        # 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 ||= []
+        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

@@ -1,35 +1,37 @@
 # 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_CLICKHOUSE_ENV_VARS = %w[
-          GLCI_DA_CLICKHOUSE_URL
-          GLCI_CLICKHOUSE_METRICS_USERNAME
-          GLCI_CLICKHOUSE_METRICS_PASSWORD
-          GLCI_CLICKHOUSE_METRICS_DB
-          GLCI_CLICKHOUSE_METRICS_TABLE
-          GLCI_CLICKHOUSE_SHARED_DB
+        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["GLCI_EXPORT_TEST_METRICS"] == "true" && 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_clickhouse_variables unless clickhouse_env_vars_present?
+                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
@@ -42,59 +44,30 @@ module GitlabQuality
             @logger ||= Logger.new($stdout)
           end
 
-          def clickhouse_env_vars_present?
-            REQUIRED_CLICKHOUSE_ENV_VARS.all? { |var| ENV.fetch(var, nil) && !ENV[var].empty? }
-          end
-
-          def owner_records
-            @owner_records ||= GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CategoryOwnersTable.new(
-              database: ENV.fetch("GLCI_CLICKHOUSE_SHARED_DB", nil),
-              url: clickhouse_url,
-              username: clickhouse_username,
-              password: clickhouse_password
-            ).owner_records
-          rescue StandardError => e
-            logger.error("Failed to retrieve owner data: #{e}")
-            @owner_records = {}
+          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_clickhouse!(config)
+            configure_observer!(config)
           end
 
-          def configure_clickhouse!(config)
-            config.clickhouse_database = ENV.fetch("GLCI_CLICKHOUSE_METRICS_DB", nil)
-            config.clickhouse_table_name = ENV.fetch("GLCI_CLICKHOUSE_METRICS_TABLE", nil)
-            config.clickhouse_url = clickhouse_url
-            config.clickhouse_username = clickhouse_username
-            config.clickhouse_password = clickhouse_password
+          def configure_observer!(config)
+            config.observer_url = observer_url
+            config.observer_token = observer_token
           end
 
-          def warn_missing_clickhouse_variables
-            missing = REQUIRED_CLICKHOUSE_ENV_VARS.reject { |var| ENV.fetch(var, nil) && !ENV[var].empty? }
+          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|
-              feature_category = example.metadata[:feature_category]
-
-              owners = if feature_category.blank?
-                         logger.warn("Example '#{example.description}' is missing feature category metadata!")
-                         {}
-                       elsif unowned?(feature_category)
-                         # currently will default to shared or tooling
-                         { group: feature_category, stage: feature_category, section: feature_category }
-                       else
-                         owner_records.fetch(feature_category.to_s, {}).tap do |o|
-                           logger.warn("Feature category '#{feature_category}' has no owner data") if o.empty?
-                         end
-                       end
-
-              { pipeline_type: pipeline_type, ci_pipeline_id: ci_pipeline_id, **owners }
+            proc do |_example|
+              { pipeline_type: pipeline_type, ci_pipeline_id: ci_pipeline_id }
             end
           end
 
@@ -120,26 +93,16 @@ module GitlabQuality
                                end
           end
 
-          def unowned?(feature_category)
-            GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CategoryOwnersTable::KNOWN_UNOWNED.include?(
-              feature_category.to_s
-            )
-          end
-
           def test_run_type
             @run_type ||= ENV.fetch("GLCI_TEST_METRICS_RUN_TYPE", nil)
           end
 
-          def clickhouse_url
-            ENV.fetch("GLCI_DA_CLICKHOUSE_URL", nil)
-          end
-
-          def clickhouse_username
-            ENV.fetch("GLCI_CLICKHOUSE_METRICS_USERNAME", nil)
+          def observer_url
+            ENV.fetch("GLCI_OBSERVER_URL", nil)
           end
 
-          def clickhouse_password
-            ENV.fetch("GLCI_CLICKHOUSE_METRICS_PASSWORD", nil)
+          def observer_token
+            ENV.fetch("GLCI_OBSERVER_AUTH_TOKEN", nil)
           end
 
           def ci_pipeline_id

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 config.clickhouse_configured?
-
-          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,32 +22,44 @@ module GitlabQuality
           end
           return logger.warn("#{LOG_PREFIX} No test execution records found, metrics will not be exported!") if data.empty?
 
-          push_to_clickhouse(data)
+          push_to_observer(data)
         end
 
         private
 
+        def config
+          Config.configuration
+        end
+
+        def logger
+          config.logger
+        end
+
         # Single common timestamp for all exported example metrics to keep data points consistently grouped
         #
         # @return [String]
         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 clickhouse
+        # Push data to observer service
         #
         # @param data [Array<Hash>]
         # @return [void]
-        def push_to_clickhouse(data)
-          return logger.debug("ClickHouse configuration missing, skipping ClickHouse export!") unless config.clickhouse_configured?
+        def push_to_observer(data)
+          return logger.debug("#{LOG_PREFIX} Observer configuration missing, skipping export!") unless config.observer_configured?
 
-          clickhouse_client.insert_json_data(config.clickhouse_table_name, data)
-          logger.info("#{LOG_PREFIX} Successfully pushed #{data.size} entries to ClickHouse!")
+          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 ClickHouse: #{e.message}")
+          logger.error("#{LOG_PREFIX} Error occurred while pushing metrics to Observer: #{e.message}")
+        end
+
+        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.13.0"
+    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.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-24 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -588,11 +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,87 +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_url,
-            database: config.clickhouse_database,
-            username: config.clickhouse_username,
-            password: config.clickhouse_password,
-            logger: logger
-          )
-        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_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