buildkite-test_collector 2.6.1 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb798155684d3e4703de75ea06ccaf67b4f6d1b26c98459e621b34dea157e54
-  data.tar.gz: 6eb653f87c490762cadef81b202cb5f77d900b9a628ca245fd9718307e506dd5
+  metadata.gz: bcfc8923f58efed71367663fffeff688fbfbf9eeb330b7876cc89b71fb3e72d7
+  data.tar.gz: 59df6ce58d186a12ef039a26aa372d96af142bc0f6ecd390767ec182737960d0
 SHA512:
-  metadata.gz: d2e371578afd8e21a3736b86c5158ebc72e57f61dd771a3365ae932e16d2b0b5add98e139ffc2cfd1ac0b54b6ea08a664f1ebc4a3082e1e07ef10b5ea318fad9
-  data.tar.gz: 817afafdd348cb3f2e4b8dd0b720a1afc6e988094bb872b1306a958eea1c9432abba0edcbbba94b920df6d415115bb60e5e55d9ccd70772d9ac71e88b0e13646
+  metadata.gz: 6fdc80dfdc84af033309dee9071334d5d5978d01d2515bdc3324dce5726146edb7d145867cec458232ccd9bc83c6da53638c9895f43daca3483eb19366a18c94
+  data.tar.gz: ae959e70dec2e553f72be5168b5df7fb69aa1e94c040fa6563f277cfcf98e979604b3e5e4fc23b413b61dac018d0628babbf8be0465e869f2ad678b9cb50bd4e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## v2.7.1
+
+- Removes test links from job logs
+- Rename Test Analytics to Test Engine
+
+## v2.7.0
+
+Features:
+
+- Add configurable span filters #220 - @catkins
+
+Fixes:
+
+- Correctly report HTTP error during upload #223 - @zhming0
+
 ## v2.6.1
 
 - Fix missing failed examples if rspec hooks fail #221 - @zhming0

data/CODEOWNERS

@@ -1 +1 @@
-* @buildkite/test-analytics
+* @buildkite/test-engine

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,7 @@
 **DEPRECATION NOTICE**
 Versions prior to 2.1.x are unsupported and will not work after mid-2023. Please upgrade to the latest version.
 
-Official [Buildkite Test Analytics](https://buildkite.com/test-analytics) collectors for Ruby test frameworks ✨
+Official [Buildkite Test Engine](https://buildkite.com/platform/test-engine) collectors for Ruby test frameworks ✨
 
 ⚒ **Supported test frameworks:** RSpec, Minitest, and [more coming soon](https://github.com/buildkite/test-collector-ruby/issues?q=is%3Aissue+is%3Aopen+label%3A%22test+frameworks%22).
 
@@ -68,13 +68,13 @@ BUILDKITE_ANALYTICS_TOKEN=xyz rake
 Add the `BUILDKITE_ANALYTICS_TOKEN` secret to your CI, push your changes to a branch, and open a pull request 🎉
 
 ```bash
-git checkout -b add-buildkite-test-analytics
-git commit -am "Add Buildkite Test Analytics"
-git push origin add-buildkite-test-analytics
+git checkout -b add-buildkite-test-engine
+git commit -am "Add Buildkite Test Engine"
+git push origin add-buildkite-test-engine
 ```
 
 ### VCR
-If your test suites use [VCR](https://github.com/vcr/vcr) to stub network requests, you'll need to modify the config to allow actual network requests to Test Analytics.
+If your test suites use [VCR](https://github.com/vcr/vcr) to stub network requests, you'll need to modify the config to allow actual network requests to Test Engine.
 
 ```
 VCR.configure do |c|
@@ -119,7 +119,7 @@ And run the tests:
 bundle exec rspec
 ```
 
-Useful resources for developing collectors include the [Buildkite Test Analytics docs](https://buildkite.com/docs/test-analytics).
+Useful resources for developing collectors include the [Buildkite Test Engine docs](https://buildkite.com/docs/test-engine).
 
 See [DESIGN.md](DESIGN.md) for an overview of the design of this gem.
 

data/buildkite-test_collector.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Buildkite"]
   spec.email         = ["support+analytics@buildkite.com"]
 
-  spec.summary       = "Track test executions and report to Buildkite Test Analytics"
+  spec.summary       = "Track test executions and report to Buildkite Test Engine"
   spec.homepage      = "https://github.com/buildkite/test-collector-ruby"
   spec.license       = "MIT"
 

data/lib/buildkite/test_collector/http_client.rb

@@ -38,7 +38,13 @@ module Buildkite::TestCollector
 
       contact.body = compressed_body.string
 
-      http.request(contact)
+      response = http.request(contact)
+
+      if response.is_a?(Net::HTTPSuccess)
+        response
+      else
+        raise "HTTP Request Failed: #{response.code} #{response.message}"
+      end
     end
 
     def metadata

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

@@ -5,7 +5,6 @@ require "rspec/expectations"
 
 require_relative "../rspec_plugin/reporter"
 require_relative "../rspec_plugin/trace"
-require_relative "../test_links_plugin/formatter"
 
 Buildkite::TestCollector.uploader = Buildkite::TestCollector::Uploader
 

data/lib/buildkite/test_collector/tracer.rb

@@ -58,7 +58,6 @@ module Buildkite::TestCollector
     def initialize(min_duration: nil)
       @top = Span.new(:top, MonotonicTime.call, nil, {})
       @stack = [@top]
-      @min_duration = min_duration
     end
 
     def enter(section, **detail)
@@ -69,17 +68,17 @@ module Buildkite::TestCollector
 
     def leave
       current_span.end_at = MonotonicTime.call
-      duration = current_span.duration
       @stack.pop
-      current_span.children.pop if @min_duration && duration < @min_duration
+
+      current_span.children.pop unless retain_span?(current_span.children.last)
+
       nil # avoid ambiguous return type/value
     end
 
     def backfill(section, duration, **detail)
-      return if @min_duration && duration < @min_duration
       now = MonotonicTime.call
       new_entry = Span.new(section, now - duration, now, detail)
-      current_span.children << new_entry
+      current_span.children << new_entry if retain_span?(new_entry)
     end
 
     def current_span
@@ -95,5 +94,15 @@ module Buildkite::TestCollector
     def history
       @top.as_hash
     end
+
+    private
+
+    def retain_span?(span)
+      return true unless Buildkite::TestCollector.span_filters
+
+      Buildkite::TestCollector.span_filters.all? do |filter|
+        filter.call(span)
+      end
+    end
   end
 end

data/lib/buildkite/test_collector/uploader.rb

@@ -25,7 +25,8 @@ module Buildkite::TestCollector
       OpenSSL::SSL::SSLError,
       OpenSSL::SSL::SSLErrorWaitReadable,
       EOFError,
-      Errno::ETIMEDOUT
+      Errno::ETIMEDOUT,
+      # TODO: some retries for server-side error would be great.
     ]
 
     def self.tracer
@@ -38,7 +39,7 @@ module Buildkite::TestCollector
       http = Buildkite::TestCollector::HTTPClient.new(Buildkite::TestCollector.url)
 
       Thread.new do
-        response = begin
+        begin
           upload_attempts ||= 0
           http.post_json(data)
         rescue *Buildkite::TestCollector::Uploader::RETRYABLE_UPLOAD_ERRORS => e

data/lib/buildkite/test_collector/version.rb

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

data/lib/buildkite/test_collector.rb

@@ -28,7 +28,6 @@ module Buildkite
   module TestCollector
     DEFAULT_URL = "https://analytics-api.buildkite.com/v1/uploads"
     DEFAULT_UPLOAD_BATCH_SIZE = 500
-
     class << self
       attr_accessor :api_token
       attr_accessor :url
@@ -39,6 +38,7 @@ module Buildkite
       attr_accessor :env
       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: {})
@@ -54,6 +54,11 @@ module Buildkite
         Float(trace_min_ms_string) / 1000
       end
 
+      self.span_filters = []
+      unless self.trace_min_duration.nil?
+        self.span_filters << MinDurationSpanFilter.new(self.trace_min_duration)
+      end
+
       self.hook_into(hook)
     end
 
@@ -84,5 +89,15 @@ module Buildkite
         Buildkite::TestCollector::Uploader.tracer&.backfill(:sql, finish - start, **{ query: payload[:sql] })
       end
     end
+
+    class MinDurationSpanFilter
+      def initialize(min_duration)
+        @min_duration = min_duration
+      end
+
+      def call(span)
+        span.duration > @min_duration
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.1
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,7 +88,6 @@ files:
 - lib/buildkite/test_collector/rspec_plugin/reporter.rb
 - lib/buildkite/test_collector/rspec_plugin/trace.rb
 - lib/buildkite/test_collector/session.rb
-- lib/buildkite/test_collector/test_links_plugin/formatter.rb
 - lib/buildkite/test_collector/tracer.rb
 - lib/buildkite/test_collector/uploader.rb
 - lib/buildkite/test_collector/uuid.rb
@@ -118,5 +117,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Track test executions and report to Buildkite Test Analytics
+summary: Track test executions and report to Buildkite Test Engine
 test_files: []

data/lib/buildkite/test_collector/test_links_plugin/formatter.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite::TestCollector::TestLinksPlugin
-  class Formatter
-    RSpec::Core::Formatters.register self, :dump_failures
-
-    def initialize(output)
-      @output = output
-    end
-
-    def dump_failures(notification)
-      # Do not display summary if no failed examples
-      return if notification.failed_examples.empty?
-
-      # Check if a Test Analytics token is set
-      return unless Buildkite::TestCollector.api_token
-
-      metadata = fetch_metadata
-
-      # return if metadata was not fetched successfully
-      return if metadata.nil?
-
-      # return if suite url is nil
-      return if metadata['suite_url'].nil?
-
-      @output << "\n\n🔥 \x1b[31mTest Analytics failures 🔥\n"
-      @output << '_____________________________'
-      @output << "\n\n"
-
-      @output << notification.failed_examples.map do |example|
-        failed_example_output(example, metadata['suite_url'])
-      end.join("\n")
-
-      @output << "\n\n"
-    end
-
-    private
-
-    def generate_scope_name_digest(scope, name)
-      Digest::SHA256.hexdigest(scope + name)
-    end
-
-    def failed_example_output(example, url)
-      scope = example.example_group.metadata[:full_description]
-      name = example.description
-      scope_name_digest = generate_scope_name_digest(scope, name)
-      test_url = "#{url}/tests/#{scope_name_digest}"
-      "🔗 \x1b[4m\x1b[37m#{%(\x1b]1339;url=#{test_url};content="#{scope} #{name}"\x07)}\x1b[m"
-    end
-
-    def fetch_metadata
-      return unless Buildkite::TestCollector.api_token
-
-      http = Buildkite::TestCollector::HTTPClient.new(Buildkite::TestCollector.url)
-      response = http.metadata
-
-      JSON.parse(response.body) if response.code == '200'
-    rescue StandardError => e
-      # We don't need to output anything here
-    end
-  end
-end