buildkite-test_collector 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06be6db9195629f49724e87ac755466db10f8e8ae5289ca7f3a1803a335ff66
-  data.tar.gz: 8b0110c802047ac6f169156f8f07e0808a2d23e8cc3f47156a5208a92167e0a4
+  metadata.gz: 468ad8ce641432cc7a1112d1f80396a4f54e9d63a566aa7f240d485969855686
+  data.tar.gz: 8348dc3fac0a7e57b0543da3870fbc89cdef8b0e1662c439eaea8c7d2a685210
 SHA512:
-  metadata.gz: caad67348cde90de584225d0c64e1c1cc3ab50aa222879679ab1399063ea2e9ff97ce3c19f3c85725560d288a034d0ee25e1d0e5e6eb79bcf89d9ee0e51e9f38
-  data.tar.gz: 550c9d2ba8120b5fc2464f47094223f28c5103a836123179fb43f8b6399ce45490a20c67454921a7f192cda575e6b19c3296654af28a9a3b7fc2a90cbcf03fe0
+  metadata.gz: 70baa9565cb411b56888f1e72048d554e87dc6d8ee76c7dd1cc3d67e943801f9133e27d883a5d7da74677b61d73c2c8258385a02aa4c997f98471d3d1157af06
+  data.tar.gz: c8a34a8fd8c6554c59a66812d41cc747cc5ffae27b4f651c4ca58c6cb44c81ec9f747eeb82ac061897e11c555053404be500414055c0881adafb33272ba1c511

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.9.0
+
+* `Buildkite::TestCollector.tag_execution(key, value)` by @pda in https://github.com/buildkite/test-collector-ruby/pull/240
+
+**Full Changelog**: https://github.com/buildkite/test-collector-ruby/compare/v2.8.0...v2.9.0
+
 ## v2.8.0
 
 * Buildkite::TestCollector.tags: specify tags for all executions by @pda in https://github.com/buildkite/test-collector-ruby/pull/235

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.8.0)
+    buildkite-test_collector (2.9.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/buildkite/test_collector/library_hooks/rspec.rb

@@ -18,21 +18,27 @@ RSpec.configure do |config|
       min_duration: Buildkite::TestCollector.trace_min_duration,
     )
 
-    # The _buildkite prefix here is added as a safeguard against name collisions
-    # as we are in the main thread
+    tags = {}
+
+    # _buildkite prefix reduces chance of collisions in this almost-global (per-fiber) namespace.
     Thread.current[:_buildkite_tracer] = tracer
-    # It's important to use begin/ensure here, because otherwise if other hooks fail,
-    # the cleanup code won't run, meaning we will miss some data.
-    #
-    # Having said that, this behavior isn't documented by RSpec.
+    Thread.current[:_buildkite_tags] = tags
+
+    # example.run can raise errors (including from other middleware/hooks) so clean up in `ensure`.
     begin
       example.run
     ensure
       Thread.current[:_buildkite_tracer] = nil
+      Thread.current[:_buildkite_tags] = nil
 
       tracer.finalize
 
-      trace = Buildkite::TestCollector::RSpecPlugin::Trace.new(example, history: tracer.history)
+      trace = Buildkite::TestCollector::RSpecPlugin::Trace.new(
+        example,
+        history: tracer.history,
+        tags: tags,
+      )
+
       Buildkite::TestCollector.uploader.traces[example.id] = trace
     end
   end

data/lib/buildkite/test_collector/minitest_plugin/trace.rb

@@ -5,6 +5,7 @@ module Buildkite::TestCollector::MinitestPlugin
     attr_accessor :example
     attr_writer :failure_reason, :failure_expanded
     attr_reader :history
+    attr_reader :tags
 
     RESULT_CODES = {
       '.' => 'passed',
@@ -15,9 +16,10 @@ module Buildkite::TestCollector::MinitestPlugin
 
     FILE_PATH_REGEX = /^(.*?\.(rb|feature))/
 
-    def initialize(example, history:)
+    def initialize(example, history:, tags: nil)
       @example = example
       @history = history
+      @tags = tags
     end
 
     def result
@@ -38,6 +40,7 @@ module Buildkite::TestCollector::MinitestPlugin
         failure_reason: failure_reason,
         failure_expanded: failure_expanded,
         history: history,
+        tags: tags,
       ).select { |_, value| !value.nil? }
     end
 

data/lib/buildkite/test_collector/minitest_plugin.rb

@@ -14,18 +14,29 @@ module Buildkite::TestCollector::MinitestPlugin
       min_duration: Buildkite::TestCollector.trace_min_duration,
     )
 
-    # The _buildkite prefix here is added as a safeguard against name collisions
-    # as we are in the main thread
+    tags = {}
+
+    # _buildkite prefix reduces chance of collisions in this almost-global (per-fiber) namespace.
     Thread.current[:_buildkite_tracer] = tracer
+    Thread.current[:_buildkite_tags] = tags
   end
 
   def after_teardown
     tracer = Thread.current[:_buildkite_tracer]
+    tags = Thread.current[:_buildkite_tags]
+
+    Thread.current[:_buildkite_tracer] = nil
+    Thread.current[:_buildkite_tags] = nil
+
     if !tracer.nil?
-      Thread.current[:_buildkite_tracer] = nil
       tracer.finalize
 
-      trace = Buildkite::TestCollector::MinitestPlugin::Trace.new(self, history: tracer.history)
+      trace = Buildkite::TestCollector::MinitestPlugin::Trace.new(
+        self,
+        history: tracer.history,
+        tags: tags,
+      )
+
       Buildkite::TestCollector.uploader.traces[trace.source_location] = trace
     end
 

data/lib/buildkite/test_collector/rspec_plugin/trace.rb

@@ -4,14 +4,16 @@ module Buildkite::TestCollector::RSpecPlugin
   class Trace
     attr_accessor :example, :failure_reason, :failure_expanded
     attr_reader :history
+    attr_reader :tags
 
     FILE_PATH_REGEX = /^(.*?\.(rb|feature))/
 
-    def initialize(example, history:, failure_reason: nil, failure_expanded: [])
+    def initialize(example, history:, failure_reason: nil, failure_expanded: [], tags: nil)
       @example = example
       @history = history
       @failure_reason = failure_reason
       @failure_expanded = failure_expanded
+      @tags = tags
     end
 
     def result
@@ -32,6 +34,7 @@ module Buildkite::TestCollector::RSpecPlugin
         failure_reason: failure_reason,
         failure_expanded: failure_expanded,
         history: history,
+        tags: tags,
       ).select { |_, value| !value.nil? }
     end
 

data/lib/buildkite/test_collector/version.rb

@@ -2,7 +2,7 @@
 
 module Buildkite
   module TestCollector
-    VERSION = "2.8.0"
+    VERSION = "2.9.0"
     NAME = "buildkite-test_collector"
   end
 end

data/lib/buildkite/test_collector.rb

@@ -77,6 +77,18 @@ module Buildkite
       tracer&.leave
     end
 
+    # Set a key=value tag on the current test execution.
+    def self.tag_execution(key, value)
+      tags = Thread.current[:_buildkite_tags]
+      raise "_buildkite_tags not available" unless tags
+
+      unless key.is_a?(String) && value.is_a?(String)
+        raise ArgumentError, "tag key and value expected string"
+      end
+
+      tags[key] = value
+    end
+
     def self.enable_tracing!
       return unless self.tracing_enabled
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Buildkite
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport