buildkite-test_collector 2.7.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031c438a0a80bcd10c351184efb4749618f5bf65d94518454cfe4d105c3d0f05
-  data.tar.gz: aeb85765c74bd2e59c4daa11270fcd807aa4964f9eea985ae0587075bdb437d8
+  metadata.gz: 468ad8ce641432cc7a1112d1f80396a4f54e9d63a566aa7f240d485969855686
+  data.tar.gz: 8348dc3fac0a7e57b0543da3870fbc89cdef8b0e1662c439eaea8c7d2a685210
 SHA512:
-  metadata.gz: 38352feb0b55450da89472f06f883bd565b4ee6ac4c7f14ff8dfb7456621626c404868d25c7348676db2b288948f65bad26b6d40308097800583960150f0f4b8
-  data.tar.gz: a7500ee72f134530e3b7254dfe3391604edea02937d2e762349e8ea242be0d55c46c48d3563fdfe909aeee9475575fc4815a7e36bd3105188e8fd36cb1aa8b9b
+  metadata.gz: 70baa9565cb411b56888f1e72048d554e87dc6d8ee76c7dd1cc3d67e943801f9133e27d883a5d7da74677b61d73c2c8258385a02aa4c997f98471d3d1157af06
+  data.tar.gz: c8a34a8fd8c6554c59a66812d41cc747cc5ffae27b4f651c4ca58c6cb44c81ec9f747eeb82ac061897e11c555053404be500414055c0881adafb33272ba1c511

data/.buildkite/pipeline.release.yml

@@ -0,0 +1,18 @@
+agents:
+  queue: hosted
+
+steps:
+  - block: "OK to release?"
+
+  - command: ".buildkite/steps/release-gem"
+    label: ":rubygems:"
+    if: build.tag != null
+    plugins:
+      - rubygems-oidc#v0.2.0:
+          role: "rg_oidc_akr_fy1x4px4yjwd1rdhkkda"
+      - docker#v5.12.0:
+          image: "ruby:3.4"
+          environment:
+            - GEM_HOST_API_KEY
+            - BUILDKITE_TAG
+

data/.buildkite/steps/release-gem

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+set -euo pipefail
+
+if [ -z "${GEM_HOST_API_KEY}" ]; then
+  echo "GEM_HOST_API_KEY environment variable not found"
+  exit 1
+fi
+
+if [ -z "${BUILDKITE_TAG}" ]; then
+  echo "BUILDKITE_TAG environment variable not found"
+  exit 1
+fi
+
+cd $(dirname $0)/../..
+
+echo "--- Inspecting tag and version"
+
+echo "BUILDKITE_TAG: ${BUILDKITE_TAG}"
+
+if [[ ! "${BUILDKITE_TAG}" == v* ]]; then
+  echo "We will only try to publish to rubygems when the tag starts with 'v'"
+  exit 1
+fi
+
+VERSION=$(echo "${BUILDKITE_TAG}" | sed "s/^v//")
+GEM_FILENAME="buildkite-test_collector-${VERSION}.gem"
+
+echo "Version to release: ${VERSION}"
+
+echo "--- Building gem"
+
+gem build buildkite-test_collector.gemspec
+
+if [ ! -f "${GEM_FILENAME}" ]; then
+  echo
+  echo "ERROR: Expected compiled gem to be '${GEM_FILENAME}' but file not found"
+  echo "Does the gemspec specify version '${BUILDKITE_TAG}'?"
+  echo
+  echo "Gem files found:"
+  echo
+  ls *.gem
+  echo
+  exit 1
+fi
+
+echo "--- Check if version already exists on rubygems.org"
+
+if [ $(curl -s -o /dev/null -w "%{http_code}" https://rubygems.org/api/v2/rubygems/buildkite-test_collector/versions/${VERSION}.json) == "200" ]; then
+  echo "Gem version ${VERSION} already found on rubygems, skipping release"
+  exit 1
+fi
+
+echo "--- publish gem"
+
+gem push "${GEM_FILENAME}"

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # 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
+* Add Ruby 3.4 to Buildkite build matrix by @gchan in https://github.com/buildkite/test-collector-ruby/pull/236
+
+**Full Changelog**: https://github.com/buildkite/test-collector-ruby/compare/v2.7.2...v2.8.0
+
 ## v2.7.2
 
 - Fixes RSpec library hook bug introduced in v2.7.1 #230 - @malclocke

data/Gemfile.lock

@@ -1,37 +1,53 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.7.2)
+    buildkite-test_collector (2.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.7.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.4.4)
-    i18n (1.14.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.19.0)
-    rake (13.0.6)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    logger (1.6.5)
+    minitest (5.25.4)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -131,14 +131,15 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/buildk
 
 1. Bump the version in `version.rb` and run `bundle` to update the `Gemfile.lock`.
 1. Update the CHANGELOG.md with your new version and a description of your changes.
-1. Git tag your changes and push
-```
-git tag v.x.x.x
-git push --tags
-```
+
 Once your PR is merged to `main`:
 
-1. Run `rake release` from `main`.
+1. Git tag the merge commit and push
+```
+git tag vX.X.X
+git push origin vX.X.X
+```
+1. Visit the [release pipeline](https://buildkite.com/buildkite/test-collector-ruby-release) to unblock it and confirm the new version is pushed to rubygems.org
 1. Create a [new release in github](https://github.com/buildkite/test-collector-ruby/releases).
 
 ## 📜 MIT License

data/buildkite.yaml

@@ -4,6 +4,7 @@ agents:
 steps:
   - label: ":rspec: Tests :ruby: {{matrix}}"
     command:
+      - "gem install bundler:2.3.25"
       - "bundle"
       - "bundle exec rake"
     plugins:
@@ -11,6 +12,7 @@ steps:
           image: "public.ecr.aws/docker/library/ruby:{{matrix}}"
     matrix:
       - "latest"
+      - "3.4"
       - "3.3"
       - "3.2"
       - "3.1"

data/lib/buildkite/test_collector/http_client.rb

@@ -4,19 +4,18 @@ require "net/http"
 
 module Buildkite::TestCollector
   class HTTPClient
-    attr :authorization_header
-    def initialize(url)
+    def initialize(url:, api_token:)
       @url = url
-      @authorization_header = "Token token=\"#{Buildkite::TestCollector.api_token}\""
+      @api_token = api_token
     end
 
-    def post_json(data)
-      contact_uri = URI.parse(url)
+    def post_upload(data:, run_env:, tags:)
+      endpoint_uri = URI.parse(url)
 
-      http = Net::HTTP.new(contact_uri.host, contact_uri.port)
-      http.use_ssl = contact_uri.scheme == "https"
+      http = Net::HTTP.new(endpoint_uri.host, endpoint_uri.port)
+      http.use_ssl = endpoint_uri.scheme == "https"
 
-      contact = Net::HTTP::Post.new(contact_uri.path, {
+      request = Net::HTTP::Post.new(endpoint_uri.path, {
         "Authorization" => authorization_header,
         "Content-Type" => "application/json",
         "Content-Encoding" => "gzip",
@@ -25,7 +24,8 @@ module Buildkite::TestCollector
       data_set = data.map(&:as_hash)
 
       body = {
-        run_env: Buildkite::TestCollector::CI.env,
+        run_env: run_env,
+        tags: tags,
         format: "json",
         data: data_set
       }.to_json
@@ -36,9 +36,9 @@ module Buildkite::TestCollector
       writer.write(body)
       writer.close
 
-      contact.body = compressed_body.string
+      request.body = compressed_body.string
 
-      response = http.request(contact)
+      response = http.request(request)
 
       if response.is_a?(Net::HTTPSuccess)
         response
@@ -48,21 +48,25 @@ module Buildkite::TestCollector
     end
 
     def metadata
-      contact_uri = URI.parse("#{url}/metadata")
+      endpoint_uri = URI.parse("#{url}/metadata")
 
-      http = Net::HTTP.new(contact_uri.host, contact_uri.port)
-      http.use_ssl = contact_uri.scheme == "https"
+      http = Net::HTTP.new(endpoint_uri.host, endpoint_uri.port)
+      http.use_ssl = endpoint_uri.scheme == "https"
 
-      contact = Net::HTTP::Get.new(contact_uri.path, {
+      request = Net::HTTP::Get.new(endpoint_uri.path, {
         "Authorization" => authorization_header,
         "Content-Type" => "application/json"
       })
 
-      http.request(contact)
+      http.request(request)
     end
 
     private
 
-    attr :url
+    attr_reader :url
+
+    def authorization_header
+      "Token token=\"#{@api_token}\""
+    end
   end
 end

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

@@ -36,16 +36,23 @@ module Buildkite::TestCollector
     def self.upload(data)
       return false unless Buildkite::TestCollector.api_token
 
-      http = Buildkite::TestCollector::HTTPClient.new(Buildkite::TestCollector.url)
+      http = Buildkite::TestCollector::HTTPClient.new(
+        url: Buildkite::TestCollector.url,
+        api_token: Buildkite::TestCollector.api_token,
+      )
 
       Thread.new do
         begin
           upload_attempts ||= 0
-          http.post_json(data)
+          http.post_upload(
+            data: data,
+            run_env: Buildkite::TestCollector::CI.env,
+            tags: Buildkite::TestCollector.tags,
+          )
+
         rescue *Buildkite::TestCollector::Uploader::RETRYABLE_UPLOAD_ERRORS => e
-          if (upload_attempts += 1) < MAX_UPLOAD_ATTEMPTS
-            retry
-          end
+          retry if (upload_attempts += 1) < MAX_UPLOAD_ATTEMPTS
+
         rescue StandardError => e
           $stderr.puts e
           $stderr.puts "#{Buildkite::TestCollector::NAME} #{Buildkite::TestCollector::VERSION} experienced an error when sending your data, you may be missing some executions for this run."

data/lib/buildkite/test_collector/version.rb

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

data/lib/buildkite/test_collector.rb

@@ -36,17 +36,19 @@ module Buildkite
       attr_accessor :tracing_enabled
       attr_accessor :artifact_path
       attr_accessor :env
+      attr_accessor :tags
       attr_accessor :batch_size
       attr_accessor :trace_min_duration
       attr_accessor :span_filters
     end
 
-    def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, env: {})
+    def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, env: {}, tags: {})
       self.api_token = (token || ENV["BUILDKITE_ANALYTICS_TOKEN"])&.strip
       self.url = url || DEFAULT_URL
       self.tracing_enabled = tracing_enabled
       self.artifact_path = artifact_path
       self.env = env
+      self.tags = tags
       self.batch_size = ENV.fetch("BUILDKITE_ANALYTICS_UPLOAD_BATCH_SIZE") { DEFAULT_UPLOAD_BATCH_SIZE }.to_i
 
       trace_min_ms_string = ENV["BUILDKITE_ANALYTICS_TRACE_MIN_MS"]
@@ -75,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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Buildkite
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,13 +51,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
-description:
 email:
 - support+analytics@buildkite.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".buildkite/pipeline.release.yml"
+- ".buildkite/steps/release-gem"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -99,7 +99,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/buildkite/test-collector-ruby
   source_code_uri: https://github.com/buildkite/test-collector-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Track test executions and report to Buildkite Test Engine
 test_files: []