gitlab-rspec-metrics-exporter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1951be0502a4f67569cb0fb9963973a93de7886c4c8bab253baef2fc365b6c61
-  data.tar.gz: 03505aadc3e234357cb58e453beda21a128483e3e677adb9422dedd2ae106969
+  metadata.gz: ae316f64101cc9f5b26f75d48b0ace55d2ad77ce5be00255d8710b45c491a93c
+  data.tar.gz: c59d9c429b33c598886b500d4623a674b381041e876c34c97421182b28f1be6f
 SHA512:
-  metadata.gz: 410cc4f2c8e8c35e4f2edaa78b5af5417cd1d26e356a9993188903118fbb8713682cd290a8c34e7873b777bad413ae89b55e7155cb027fe9c02b1391d652192f
-  data.tar.gz: ea95665fe643e7111662240f2be720cd45d031b9171bff1adc301510054afc61163f01de943bff557c2a753b194824068a591c8fcfb37ed3af2bec49f1a2602c
+  metadata.gz: db8e097dba5d2d37150167abfd98f37fa25c73e6f557993f3dfaa281ba355ed643d513ba3bfc8a8e1ce5fa434ba110d839869a76d896e544cc8e114b54d57aaa
+  data.tar.gz: b896db0dde1695eeaae0e48d44576790c22d35139bbe9b3f522e4fe42c90d3da33f432241b3f99971918c9de243e330ce50833cdf703cb6347c92bbedb10d28f

data/lib/gitlab/rspec_metrics_exporter/config_helper.rb

@@ -3,6 +3,7 @@
 require "logger"
 
 require_relative "config"
+require_relative "env"
 require_relative "formatter"
 
 module Gitlab
@@ -14,9 +15,9 @@ module Gitlab
     #   require "gitlab/rspec_metrics_exporter/config_helper"
     #   Gitlab::RSpecMetricsExporter::ConfigHelper.configure!("backend_unit")
     class ConfigHelper
-      STABLE_EE_BRANCH_REGEX = /^[\d-]+-stable-ee$/
-
       class << self
+        include Env
+
         def configure!(run_type = nil)
           return unless ENV.fetch("CI", nil) && ENV.fetch("GLCI_EXPORT_TEST_METRICS", "true") == "true"
 
@@ -45,17 +46,13 @@ module Gitlab
           @logger ||= Logger.new($stdout)
         end
 
-        def present?(value)
-          !value.nil? && !value.to_s.empty?
-        end
-
         def observer_not_fully_configured?(config)
-          if [config.observer_url, ENV.fetch("GLCI_OBSERVER_URL", nil)].none? { |opt| present?(opt) }
+          if [config.observer_url, ENV.fetch("GLCI_OBSERVER_URL", nil)].none? { |opt| env_present?(opt) }
             logger.warn("Observer url is not configured!. Set GLCI_OBSERVER_URL environment variable or set observer_url in the exporter config.") # rubocop:disable Layout/LineLength
             return true
           end
 
-          if [config.observer_token, ENV.fetch("GLCI_OBSERVER_AUTH_TOKEN", nil)].none? { |opt| present?(opt) }
+          if [config.observer_token, ENV.fetch("GLCI_OBSERVER_AUTH_TOKEN", nil)].none? { |opt| env_present?(opt) }
             logger.warn("Observer auth token is not configured!. Set GLCI_OBSERVER_AUTH_TOKEN environment variable or set observer_token in the exporter config.") # rubocop:disable Layout/LineLength
             return true
           end
@@ -64,47 +61,21 @@ module Gitlab
         end
 
         def configure_exporter!(config, run_type)
-          config.run_type = run_type || default_run_type unless present?(config.run_type)
-          config.custom_metrics_proc = custom_metrics_proc
+          config.run_type = run_type || default_run_type unless env_present?(config.run_type)
 
           configure_observer!(config)
         end
 
         def configure_observer!(config)
-          config.observer_url = observer_url unless present?(config.observer_url)
-          config.observer_token = observer_token unless present?(config.observer_token)
+          config.observer_url = observer_url unless env_present?(config.observer_url)
+          config.observer_token = observer_token unless env_present?(config.observer_token)
         end
 
         def warn_missing_observer_variables
-          missing = REQUIRED_OBSERVER_ENV_VARS.reject { |var| present?(ENV.fetch(var, nil)) }
+          missing = REQUIRED_OBSERVER_ENV_VARS.reject { |var| env_present?(ENV.fetch(var, nil)) }
           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 ||= detect_pipeline_type
-        end
-
-        def detect_pipeline_type
-          return "default_branch_scheduled_pipeline" if default_branch? && present?(ENV.fetch("SCHEDULE_TYPE", nil))
-          return "default_branch_pipeline"           if default_branch?
-          return "stable_branch_pipeline"            if ENV["CI_COMMIT_REF_NAME"]&.match?(STABLE_EE_BRANCH_REGEX)
-          return "backport_merge_request_pipeline"   if ENV["CI_MERGE_REQUEST_TARGET_BRANCH_NAME"]&.match?(STABLE_EE_BRANCH_REGEX)
-          return "merge_request_pipeline"            if present?(ENV["CI_MERGE_REQUEST_IID"])
-          return "downstream_pipeline"               if ENV["CI_PIPELINE_SOURCE"] == "pipeline"
-
-          "unknown"
-        end
-
         def default_run_type
           @default_run_type ||= ENV.fetch("GLCI_TEST_METRICS_RUN_TYPE") { ENV.fetch("CI_JOB_NAME", nil) }
         end
@@ -116,10 +87,6 @@ module Gitlab
         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

data/lib/gitlab/rspec_metrics_exporter/env.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module RSpecMetricsExporter
+    module Env
+      # Fetch an env var, returning nil if it is unset or empty.
+      #
+      # @param name [String]
+      # @return [String, nil]
+      def env_fetch(name)
+        value = ENV.fetch(name, nil)
+        env_present?(value) ? value : nil
+      end
+
+      # @param value [Object]
+      # @return [Boolean]
+      def env_present?(value)
+        !value.nil? && !value.to_s.empty?
+      end
+
+      # Parse a string into an Integer, returning nil for nil, empty, or
+      # non-numeric input. Strict: trailing non-digits are rejected.
+      #
+      # @param value [String, nil]
+      # @return [Integer, nil]
+      def env_parse_int_or_nil(value)
+        return nil unless env_present?(value)
+
+        Integer(value, 10)
+      rescue ArgumentError, TypeError
+        nil
+      end
+    end
+  end
+end

data/lib/gitlab/rspec_metrics_exporter/pipeline.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "env"
+
+module Gitlab
+  module RSpecMetricsExporter
+    # Pipeline classification and CI pipeline id resolution.
+    #
+    # Mixed into the metric builder to expose `pipeline_type` and
+    # `ci_pipeline_id` derived from CI environment variables. Methods are
+    # instance methods on the including class.
+    module Pipeline
+      include Env
+
+      STABLE_EE_BRANCH_REGEX = /^[\d-]+-stable-ee$/
+
+      # @return [String] GitLab pipeline classification, or "unknown".
+      def pipeline_type
+        return "default_branch_scheduled_pipeline" if default_branch? && env_fetch("SCHEDULE_TYPE")
+        return "default_branch_pipeline"           if default_branch?
+        return "stable_branch_pipeline"            if stable_ee_branch?("CI_COMMIT_REF_NAME")
+        return "backport_merge_request_pipeline"   if stable_ee_branch?("CI_MERGE_REQUEST_TARGET_BRANCH_NAME")
+        return "merge_request_pipeline"            if env_fetch("CI_MERGE_REQUEST_IID")
+        return "downstream_pipeline"               if env_fetch("CI_PIPELINE_SOURCE") == "pipeline"
+
+        "unknown"
+      end
+
+      # @return [Integer, nil] PARENT_PIPELINE_ID when set, otherwise CI_PIPELINE_ID.
+      def ci_pipeline_id
+        env_parse_int_or_nil(env_fetch("PARENT_PIPELINE_ID") || env_fetch("CI_PIPELINE_ID"))
+      end
+
+      private
+
+      def default_branch?
+        ref = env_fetch("CI_COMMIT_REF_NAME")
+        !ref.nil? && ref == env_fetch("CI_DEFAULT_BRANCH")
+      end
+
+      def stable_ee_branch?(env_var)
+        env_fetch(env_var)&.match?(STABLE_EE_BRANCH_REGEX) || false
+      end
+    end
+  end
+end

data/lib/gitlab/rspec_metrics_exporter/test_metrics.rb

@@ -4,10 +4,14 @@ require "openssl"
 require "time"
 
 require_relative "config"
+require_relative "env"
+require_relative "pipeline"
 
 module Gitlab
   module RSpecMetricsExporter
     class TestMetrics
+      include Pipeline
+
       def initialize(example, timestamp)
         @example = example
         @timestamp = timestamp
@@ -55,7 +59,8 @@ module Gitlab
           feature_category: example.metadata[:feature_category] || "",
           test_retried: config.test_retried_proc.call(example),
           run_type: run_type,
-          spec_file_path_prefix: config.spec_file_path_prefix
+          spec_file_path_prefix: config.spec_file_path_prefix,
+          pipeline_type: pipeline_type
         }
       end
 
@@ -64,15 +69,17 @@ module Gitlab
       # @return [Hash]
       def ci_metrics
         {
-          ci_project_id: env("CI_PROJECT_ID")&.to_i,
-          ci_project_path: env("CI_PROJECT_PATH"),
+          ci_project_id: env_parse_int_or_nil(env_fetch("CI_PROJECT_ID")),
+          ci_project_path: env_fetch("CI_PROJECT_PATH"),
           ci_job_name: ci_job_name,
-          ci_job_id: env("CI_JOB_ID")&.to_i,
-          ci_pipeline_id: env("CI_PIPELINE_ID")&.to_i,
-          ci_merge_request_iid: (env("CI_MERGE_REQUEST_IID") || env("TOP_UPSTREAM_MERGE_REQUEST_IID"))&.to_i,
-          ci_branch: env("CI_COMMIT_REF_NAME"),
-          ci_target_branch: env("CI_MERGE_REQUEST_TARGET_BRANCH_NAME"),
-          ci_server_url: env("CI_SERVER_URL")
+          ci_job_id: env_parse_int_or_nil(env_fetch("CI_JOB_ID")),
+          ci_pipeline_id: ci_pipeline_id,
+          ci_merge_request_iid: env_parse_int_or_nil(
+            env_fetch("CI_MERGE_REQUEST_IID") || env_fetch("TOP_UPSTREAM_MERGE_REQUEST_IID")
+          ),
+          ci_branch: env_fetch("CI_COMMIT_REF_NAME"),
+          ci_target_branch: env_fetch("CI_MERGE_REQUEST_TARGET_BRANCH_NAME"),
+          ci_server_url: env_fetch("CI_SERVER_URL")
         }
       end
 
@@ -122,7 +129,7 @@ module Gitlab
       #
       # @return [String]
       def ci_job_name
-        env("CI_JOB_NAME")&.gsub(%r{ \d{1,2}/\d{1,2}}, "")
+        env_fetch("CI_JOB_NAME")&.gsub(%r{ \d{1,2}/\d{1,2}}, "")
       end
 
       # Example location
@@ -187,16 +194,6 @@ module Gitlab
         config.run_type || ci_job_name || "unknown"
       end
 
-      # Return non empty environment variable value
-      #
-      # @param [String] name
-      # @return [String, nil]
-      def env(name)
-        return unless ENV[name] && !ENV[name].empty?
-
-        ENV.fetch(name)
-      end
-
       # Metrics value cast to a valid type
       #
       # @param value [Object]

data/lib/gitlab/rspec_metrics_exporter/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module RSpecMetricsExporter
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-rspec-metrics-exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Developer Experience
@@ -159,7 +159,9 @@ files:
 - lib/gitlab/rspec_metrics_exporter/client.rb
 - lib/gitlab/rspec_metrics_exporter/config.rb
 - lib/gitlab/rspec_metrics_exporter/config_helper.rb
+- lib/gitlab/rspec_metrics_exporter/env.rb
 - lib/gitlab/rspec_metrics_exporter/formatter.rb
+- lib/gitlab/rspec_metrics_exporter/pipeline.rb
 - lib/gitlab/rspec_metrics_exporter/test_metrics.rb
 - lib/gitlab/rspec_metrics_exporter/version.rb
 homepage: https://gitlab.com/gitlab-org/quality/analytics/test-metrics-exporters
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: RSpec formatter that exports test execution metrics to GitLab Observer.
 test_files: []