gitlab_quality-test_tooling 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009e41374e42e637a571410da7cd95aa23ab4d5a6f1599f080a0ccea8432b820'
-  data.tar.gz: b81d4043e16bc5da888a102d3765250691acb705bb3edac3762c6baad0fe490f
+  metadata.gz: 6895c7a00b6414c417fdadfe15fc030d316c1a6ecac135d5a3b281748d321926
+  data.tar.gz: d9c8dcf80524df5f22c3cc32439f2abaf5f148d061c46a1b8f74a6c40aaa2a21
 SHA512:
-  metadata.gz: f1d34b6b4862000282c042e25b5f0cd02e23e72dee4307d0eb9d2309a0e5d352dfeeeadab2f5da7d01b91fe798a192bf8f2ed075608e9f73854842d107bef55a
-  data.tar.gz: eb3746a140cb622b9ede27514cb26ea7681b1bafffc5320dd9ce6dce83951db2e752f5458fa7af09906488fd6ef871c589c232794a4bf3d8a6962613cc35e484
+  metadata.gz: c6305ab3fcdf665926a8a1180ffd1308611e39ef53442d584e1797e8caf0115527bac36376b668ee89473d94f86ee160eeeeeaf2a72dca8348a96b44c375f233
+  data.tar.gz: bf77f8ce83ebebb939925479593cb7c21b9f2f4a8ac564da009605d509ec4e56c4eb68b73fbc156b05567c9c0d5603b7ac2552f77c615b1b19fa2e5e19ad568a

data/.ruby-version

@@ -1 +1 @@
-3.0.5
+3.2.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.24.0)
+    gitlab_quality-test_tooling (1.26.0)
       activesupport (>= 6.1, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -331,4 +331,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.5.6
+   2.5.4

data/exe/update-screenshot-paths

@@ -11,7 +11,7 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+  opts.on('-i', '--input-files INPUT_FILES', String, 'Glob pattern for RSpec report files (JSON or JUnit XML)') do |input_files|
     params[:input_files] = input_files
   end
 

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

@@ -33,10 +33,11 @@ module GitlabQuality
           input_files:,
           base_issue_labels: nil,
           dry_run: false,
+          related_issues_file: nil,
           project: nil,
           max_diff_ratio: DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION,
           **_kwargs)
-          super(token: token, input_files: input_files, project: project, dry_run: dry_run)
+          super(token: token, input_files: input_files, related_issues_file: related_issues_file, project: project, dry_run: dry_run)
 
           @base_issue_labels = Set.new(base_issue_labels)
           @max_diff_ratio = max_diff_ratio.to_f

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

@@ -133,17 +133,17 @@ module GitlabQuality
         # See https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/blob/main/scripts/unhealthy_test_issues_statistics.rb
         # to gather these statistics.
         #
-        # P75       => flakiness::4
-        # P90       => flakiness::3
-        # P95       => flakiness::2
-        # Above P95 => flakiness::1
+        # x <= P90       => flakiness::4
+        # P90 < x <= P95 => flakiness::3
+        # P95 < x <= P99 => flakiness::2
+        # > P99          => flakiness::1
         def flakiness_status_labels_quick_action(reports_count)
           case reports_count
-          when 42..Float::INFINITY
+          when 399..Float::INFINITY
             '/label ~"flakiness::1"'
-          when 22..41
+          when 37..398
             '/label ~"flakiness::2"'
-          when 4..21
+          when 13..36
             '/label ~"flakiness::3"'
           else
             '/label ~"flakiness::4"'

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

@@ -16,8 +16,8 @@ module GitlabQuality
 
         def invoke!
           Dir.glob(input_files).each do |input_file|
-            rewrite_screenshot_paths_in_junit_file(input_file)
-            rewrite_screenshot_paths_in_json_file(input_file.gsub('.xml', '.json'))
+            rewrite_screenshot_paths_in_junit_file(input_file) if input_file.end_with?('.xml')
+            rewrite_screenshot_paths_in_json_file(input_file) if input_file.end_with?('.json')
           end
         end
 

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module GitlabQuality
+  module TestTooling
+    module TestMetricsExporter
+      class << self
+        def configuration
+          Config.instance
+        end
+
+        def configure
+          yield(configuration)
+        end
+      end
+
+      class Config
+        include Singleton
+
+        attr_accessor :influxdb_url,
+          :influxdb_token,
+          :influxdb_bucket,
+          :run_type
+
+        attr_writer :custom_keys_tags,
+          :custom_keys_fields,
+          :test_metric_file_name
+
+        def custom_keys_tags
+          @custom_keys_tags || []
+        end
+
+        def custom_keys_fields
+          @custom_keys_fields || []
+        end
+
+        def test_metric_file_name
+          @test_metric_file_name || "test_metrics.json"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMetricsExporter
+      class Formatter < RSpec::Core::Formatters::BaseFormatter
+        RSpec::Core::Formatters.register(self, :stop)
+
+        def stop(_notification)
+          setup_test_metrics_exporter
+
+          log_test_metrics.push_test_metrics(
+            custom_keys_tags: config.custom_keys_tags,
+            custom_keys_fields: config.custom_keys_fields
+          )
+
+          log_test_metrics.save_test_metrics(
+            file_name: config.test_metric_file_name,
+            custom_keys_tags: config.custom_keys_tags,
+            custom_keys_fields: config.custom_keys_fields
+          )
+        end
+
+        private
+
+        attr_reader :log_test_metrics
+
+        def config
+          Config.configuration
+        end
+
+        def setup_test_metrics_exporter
+          @log_test_metrics = LogTestMetrics.new(
+            examples: notification.examples,
+            influxdb_url: config.influxdb_url,
+            influxdb_token: config.influxdb_token,
+            influxdb_bucket: config.influxdb_bucket,
+            run_type: config.run_type
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/{concerns → test_metrics_exporter}/influxdb_tools.rb

@@ -2,7 +2,7 @@
 
 module GitlabQuality
   module TestTooling
-    module Concerns
+    module TestMetricsExporter
       module InfluxdbTools
         # InfluxDb client
         #

data/lib/gitlab_quality/test_tooling/{test_metric → test_metrics_exporter}/log_test_metrics.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module GitlabQuality
   module TestTooling
-    module TestMetric
+    module TestMetricsExporter
       class LogTestMetrics
-        include Concerns::TestMetrics
-        include Concerns::InfluxdbTools
+        include TestMetrics
+        include InfluxdbTools
 
         CUSTOM_METRICS_KEY = :custom_test_metrics
 
@@ -39,7 +37,9 @@ module GitlabQuality
         # @param [Array<String>] custom_keys_tags
         # @param [Array<String>] custom_keys_fields
         # @return [nil]
-        def save_test_metrics(file_name, custom_keys_tags: nil, custom_keys_fields: nil)
+        def save_test_metrics(file_name:, custom_keys_tags: nil, custom_keys_fields: nil)
+          return Runtime::Logger.warn("No file_name provided, not saving test metrics") if file_name.nil?
+
           @test_metrics ||= examples.filter_map { |example| parse_test_results(example, custom_keys_tags, custom_keys_fields) }
           file = "tmp/#{file_name}"
 

data/lib/gitlab_quality/test_tooling/{concerns → test_metrics_exporter}/test_metrics.rb

@@ -2,7 +2,7 @@
 
 module GitlabQuality
   module TestTooling
-    module Concerns
+    module TestMetricsExporter
       module TestMetrics
         # Single common timestamp for all exported example metrics to keep data points consistently grouped
         #
@@ -30,7 +30,7 @@ module GitlabQuality
             job_name: job_name,
             merge_request: merge_request,
             run_type: run_type,
-            stage: example.metadata[:product_stage] || example.metadata[:product_category],
+            feature_category: example.metadata[:feature_category],
             product_group: example.metadata[:product_group],
             exception_class: example.execution_result.exception&.class&.to_s,
             **custom_metrics(example.metadata, custom_keys)

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.24.0"
+    VERSION = "1.26.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.26.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -438,8 +438,6 @@ files:
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
 - lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb
-- lib/gitlab_quality/test_tooling/concerns/influxdb_tools.rb
-- lib/gitlab_quality/test_tooling/concerns/test_metrics.rb
 - lib/gitlab_quality/test_tooling/failed_jobs_table.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/branches_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/branches_dry_client.rb
@@ -497,8 +495,12 @@ files:
 - lib/gitlab_quality/test_tooling/test_meta/processor/meta_processor.rb
 - 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_metric/log_test_metrics.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/formatter.rb
+- lib/gitlab_quality/test_tooling/test_metrics_exporter/influxdb_tools.rb
+- lib/gitlab_quality/test_tooling/test_metrics_exporter/log_test_metrics.rb
+- lib/gitlab_quality/test_tooling/test_metrics_exporter/test_metrics.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