gitlab_quality-test_tooling 3.11.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f293cc7660b976ec011dc0e44e8f4a636b0170f99206c699bba5e59db989f7
-  data.tar.gz: 1205e282fbdbe7faf15c421e9907840ca59662488206ccb2007dfdd96254e934
+  metadata.gz: e1284d833aad5c38a45cff835cf3e701193117aa9694293b42fee9ce60345b0d
+  data.tar.gz: e209cf22987a7a19c58a4675ad529a6910ec387117a49fbcef97aadef9230c6f
 SHA512:
-  metadata.gz: 49052d3d0eade661c58479770a971ef2e8f5377cf13af619dd4e5cc9a8d6f5759d2b5ab7d41e7ad8aea5da490c8824da39a0c4fb6a45dd9ec6d17931f039faa3
-  data.tar.gz: 2bf4dca1ba6d1a34e262058843ecc81d273897a931de180bbe544b956f8568de4ad4e9bd0677f753f667c4fb965639e23e3c6e7af0e0f26f04bd3ea101ac995b
+  metadata.gz: '09ded437ab350eddf3736017e844865ef0a5ca311c6d62e800b87b272e691eab904ae12c6241f202f76ae1afa1e717880b99984e640fbd9728791e684fbfbbed'
+  data.tar.gz: a9064f95ca94ef8d8d476f097f3ee9412d71dca931a715e9f446a81f8646e75e14ab141b93fe83ebd1bf898d32503b4806179ac2f9b3233fe69c95024c693491

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (3.11.0)
+    gitlab_quality-test_tooling (3.13.0)
       activesupport (>= 7.0)
       amatch (~> 0.4.1)
       fog-google (~> 1.24, >= 1.24.1)
       gitlab (>= 4.19, < 7.0)
       http (~> 5.0)
+      http-cookie (>= 1.0, < 1.1.1)
       nokogiri (~> 1.10)
       parallel (>= 1, < 2)
       rainbow (>= 3, < 4)

data/lib/gitlab_quality/test_tooling/labels_inference.rb

@@ -34,6 +34,29 @@ module GitlabQuality
         categories_mapping.dig(feature_category, 'group')
       end
 
+      def group_data_from_label(label)
+        return unless label
+
+        groups_mapping.each do |key, data|
+          next unless label.casecmp?(data['label'])
+
+          return data.merge('key' => key)
+        end
+
+        nil
+      end
+
+      def product_managers_from_product_group(product_group)
+        group_data = groups_mapping[product_group]
+        return [] unless group_data
+
+        normalize_mentions(Array(group_data['product_managers']).compact)
+      end
+
+      def all_group_labels
+        groups_mapping.filter_map { |_key, data| data['label'] }.uniq
+      end
+
       def engineering_managers_from_product_group(product_group, *scopes)
         group_data = groups_mapping[product_group]
         return [] unless group_data
@@ -42,11 +65,15 @@ module GitlabQuality
         scopes = [:all] if default_scope
         ems = resolve_ems(group_data, scopes, default_scope)
 
-        ems.uniq.sort.map { |name| name.start_with?('@') ? name : "@#{name}" }
+        normalize_mentions(ems)
       end
 
       private
 
+      def normalize_mentions(names)
+        names.uniq.sort.map { |name| name.start_with?('@') ? name : "@#{name}" }
+      end
+
       def resolve_ems(group_data, scopes, default_scope)
         keys = scopes.flat_map { |scope| EM_KEYS.fetch(scope) { [] } }
         ems = group_data.values_at(*keys).flatten.compact

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/config.rb

@@ -8,34 +8,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 +18,13 @@ module GitlabQuality
           end
         end
 
-        attr_reader :gcs_config, :clickhouse_config, :initial_run
-        attr_accessor :run_type
+        attr_reader :initial_run
+        attr_accessor :run_type,
+          :clickhouse_url,
+          :clickhouse_database,
+          :clickhouse_table_name,
+          :clickhouse_username,
+          :clickhouse_password
         attr_writer :extra_rspec_metadata_keys,
           :skip_record_proc,
           :test_retried_proc,
@@ -55,23 +32,7 @@ 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
-        #
-        # @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
+        # 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;
@@ -88,6 +49,15 @@ module GitlabQuality
 
         # rubocop:enable Style/TrivialAccessors
 
+        # Whether ClickHouse 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]

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+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
+        ].freeze
+
+        class << self
+          def configure!(run_type = test_run_type)
+            return unless ENV.fetch("CI", nil) && ENV["GLCI_EXPORT_TEST_METRICS"] == "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?
+
+                yield(exporter_config) if block_given?
+                configure_exporter!(exporter_config, run_type)
+
+                rspec_config.add_formatter Formatter
+              end
+            end
+          end
+
+          private
+
+          attr_writer :logger
+
+          def logger
+            @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 = {}
+          end
+
+          def configure_exporter!(config, run_type)
+            config.run_type = run_type
+            config.custom_metrics_proc = custom_metrics_proc
+
+            configure_clickhouse!(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
+          end
+
+          def warn_missing_clickhouse_variables
+            missing = REQUIRED_CLICKHOUSE_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 }
+            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 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)
+          end
+
+          def clickhouse_password
+            ENV.fetch("GLCI_CLICKHOUSE_METRICS_PASSWORD", 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

@@ -16,7 +16,7 @@ module GitlabQuality
           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
+          raise "Initial setup is enabled, but clickhouse configuration is missing!" unless config.clickhouse_configured?
 
           create_clickhouse_metrics_table
         rescue StandardError => e
@@ -32,14 +32,11 @@ 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)
         end
 
         private
 
-        delegate :gcs_config, :clickhouse_config, to: :config
-
         # Single common timestamp for all exported example metrics to keep data points consistently grouped
         #
         # @return [String]
@@ -50,27 +47,14 @@ module GitlabQuality
           @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
-        #
-        # @param data [Array]
-        # @return [void]
-        def push_to_gcs(data)
-          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}")
-        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
+          return logger.debug("ClickHouse configuration missing, skipping ClickHouse export!") unless config.clickhouse_configured?
 
-          clickhouse_client.insert_json_data(clickhouse_config.table_name, data)
+          clickhouse_client.insert_json_data(config.clickhouse_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}")

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

@@ -23,32 +23,21 @@ module GitlabQuality
         # @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,
+            url: config.clickhouse_url,
+            database: config.clickhouse_database,
+            username: config.clickhouse_username,
+            password: config.clickhouse_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
+          table_name = config.clickhouse_table_name
 
           clickhouse_client.query(<<~SQL)
             CREATE TABLE IF NOT EXISTS #{table_name}

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "3.11.0"
+    VERSION = "3.13.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.13.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -302,6 +302,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -569,6 +589,7 @@ files:
 - 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/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