buildkite-test_collector 1.1.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96fb0d0c08ff10d420388b2438ae199c7fbf72878d1fa5631c68b27e70f11cac
-  data.tar.gz: 78846d669900e535d1e03bd7494611dd124f2c1bae59471ad41b5b0d9f1efb1b
+  metadata.gz: 457b9dff2d6567d8be85f8a3e120500b04ef33aa93b9a1fa971c781cc8ff9471
+  data.tar.gz: 85a55ce20a129628d2379f73a62da0e29cef6cae0359987b986e23ce71a3ed86
 SHA512:
-  metadata.gz: c7151f06cf10d7aeb296b9d8c9294f9cdab0b07fc01112176cdc28ad55f7b65d4aa51fcc21dfd179eb58bc6c69592583f58335dece7f3b46ac1e2ba7718da369
-  data.tar.gz: cb1157c4a4cfaa719d852f2ac271bd09bbd25a461b4f6a9c002063d7461e3bb06e8107342cceb77dada1cda8090c3643aa3e2827aac7355fea90b51bbae4f7f0
+  metadata.gz: 6d3f6a44bcb2743e2389b1ae8fc15dfce3721aec0f161cbc147843c6759a00eb29ffa16f917665f571cb7f62ec81c059a08e67323629196fa03cc73e601155ed
+  data.tar.gz: 9131b6ced770ab95c5a98c399cc45d108aab5bdc74d9f8e4c7a7ea9bb63d9d07126f0b93e2f759b2fad4b0b76761679ccc7bc580298c2586fbdbf33e14c8fe0d

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## v1.2.3
+
+- Add ability to specify execution prefix/suffix #140 - @JuanitoFatas
+
+## v1.1.3
+- Use a private reference to JSON.parse to prevent it being mocked #149 - @ghcan
+
+## v1.1.2
+
+- Remove branch reference prefix in Github Actions #136 - @gchan
+- Make ruby collector work better for non-web app #128 - @JuanitoFatas
+- Avoid linters complaining about double quotes #137 - @SocalNick
+- Revert "Allow specifying run name prefix and suffix" #139 - @JuanitoFatas
+- Update Code of Conduct contact email address #143 - @JuanitoFatas
+- Suppress errors when connecting to Buildkite #145 - @swebb
+- Add some design documentation to understand how the gem works #146 - @swebb
+- Fix logging level from debug to error #147 - @gchan
+
 ## v1.1.1
 
 - Strip CR/LF from token input #127 - @gchan

data/CODE_OF_CONDUCT.md

@@ -61,7 +61,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-`support+analytics@buildkite.com`.
+[coc@buildkite.com](mailto:coc@buildkite.com).
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

data/DESIGN.md

@@ -0,0 +1,19 @@
+# Design
+
+## Threads
+
+The Buildkite ruby collector uses websockets and ActionCable to send and
+receive data with Buildkite. Execution information starts transmitting as soon
+as possible, without waiting for the test suite to finish running.
+
+This gem uses 3 ruby threads:
+
+* main thread: acts as the producer. It collects span data from the
+  test suite and enqueues it into the send queue.
+* write thread: acts as the consumer. Removes data from the send queue and
+  sends it to Buildkite.
+* read thread: receives and processes messages from Buildkite.
+
+## Data
+
+Trace data is stored in spans. See [Buildkite::TestCollector::Tracer](lib/buildkite/test_collector/tracer.rb) for more information.

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (1.1.1)
+    buildkite-test_collector (1.2.3)
       activesupport (>= 5.2, < 8)
       websocket (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.1)
+    minitest (5.16.3)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -32,7 +32,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     websocket (1.2.9)
 

data/README.md

@@ -22,7 +22,7 @@ Or add this to your Gemfile’s test group:
 
 ```ruby
 group :test do
-  gem "buildkite-test_collector"
+  gem 'buildkite-test_collector'
 end
 ```
 
@@ -34,7 +34,7 @@ Add the following code to your RSpec setup file:
 
 ```ruby
 # spec/spec_helper.rb
-require "buildkite/test_collector"
+require 'buildkite/test_collector'
 Buildkite::TestCollector.configure(hook: :rspec)
 ```
 
@@ -50,7 +50,7 @@ Add the following code to your Minitest setup file:
 
 ```ruby
 # test/test_helper.rb
-require "buildkite/test_collector"
+require 'buildkite/test_collector'
 Buildkite::TestCollector.configure(hook: :minitest)
 ```
 
@@ -94,6 +94,8 @@ bundle exec rspec
 
 Useful resources for developing collectors include the [Buildkite Test Analytics docs](https://buildkite.com/docs/test-analytics).
 
+See [DESIGN.md](DESIGN.md) for an overview of the design of this gem.
+
 ## 👩‍💻 Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/test-collector-ruby

data/lib/buildkite/test_collector/ci.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "securerandom"
-
 class Buildkite::TestCollector::CI
   def self.env
     new.env
@@ -37,10 +35,10 @@ class Buildkite::TestCollector::CI
       "job_id" => ENV["BUILDKITE_ANALYTICS_JOB_ID"],
       "message" => ENV["BUILDKITE_ANALYTICS_MESSAGE"],
       "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+      "execution_name_prefix" => ENV["BUILDKITE_ANALYTICS_EXECUTION_NAME_PREFIX"],
+      "execution_name_suffix" => ENV["BUILDKITE_ANALYTICS_EXECUTION_NAME_SUFFIX"],
       "version" => Buildkite::TestCollector::VERSION,
       "collector" => Buildkite::TestCollector::NAME,
-      "run_name_prefix" => ENV["BUILDKITE_ANALYTICS_RUN_NAME_PREFIX"],
-      "run_name_suffix" => ENV["BUILDKITE_ANALYTICS_RUN_NAME_SUFFIX"],
     }.compact
   end
 
@@ -69,7 +67,7 @@ class Buildkite::TestCollector::CI
       "CI" => "github_actions",
       "key" => "#{ENV["GITHUB_ACTION"]}-#{ENV["GITHUB_RUN_NUMBER"]}-#{ENV["GITHUB_RUN_ATTEMPT"]}",
       "url" => File.join("https://github.com", ENV["GITHUB_REPOSITORY"], "actions/runs", ENV["GITHUB_RUN_ID"]),
-      "branch" => ENV["GITHUB_REF"],
+      "branch" => ENV["GITHUB_REF_NAME"],
       "commit_sha" => ENV["GITHUB_SHA"],
       "number" => ENV["GITHUB_RUN_NUMBER"],
     }

data/lib/buildkite/test_collector/error.rb

@@ -0,0 +1,4 @@
+module Buildkite::TestCollector
+  class Error < StandardError; end
+  class TimeoutError < ::Timeout::Error; end
+end

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

@@ -2,7 +2,6 @@
 
 require "minitest"
 
-require_relative "../uploader"
 require_relative "../minitest_plugin"
 
 Buildkite::TestCollector.uploader = Buildkite::TestCollector::Uploader
@@ -13,4 +12,4 @@ end
 
 Buildkite::TestCollector.enable_tracing!
 
-Buildkite::TestCollector::Uploader.configure
+Buildkite::TestCollector.safe { Buildkite::TestCollector::Uploader.configure }

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

@@ -3,7 +3,6 @@
 require "rspec/core"
 require "rspec/expectations"
 
-require_relative "../uploader"
 require_relative "../rspec_plugin/reporter"
 require_relative "../rspec_plugin/trace"
 
@@ -13,7 +12,7 @@ RSpec.configure do |config|
   config.before(:suite) do
     config.add_formatter Buildkite::TestCollector::RSpecPlugin::Reporter
 
-    Buildkite::TestCollector::Uploader.configure
+    Buildkite::TestCollector.safe { Buildkite::TestCollector::Uploader.configure }
   end
 
   config.around(:each) do |example|

data/lib/buildkite/test_collector/logger.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "logger"
-require "time"
-
 module Buildkite::TestCollector
   class Logger < ::Logger
     class Formatter < ::Logger::Formatter

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/hash/indifferent_access"
-
 module Buildkite::TestCollector::MinitestPlugin
   class Trace
     attr_accessor :example

data/lib/buildkite/test_collector/minitest_plugin.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Minitest finds this file before setup code
+require_relative "tracer"
+
 require_relative "minitest_plugin/reporter"
 require_relative "minitest_plugin/trace"
 

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "time"
-
 module Buildkite::TestCollector::RSpecPlugin
   class Reporter
     RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending, :dump_summary

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/hash/indifferent_access"
-
 module Buildkite::TestCollector::RSpecPlugin
   class Trace
     attr_accessor :example, :failure_reason, :failure_expanded

data/lib/buildkite/test_collector/session.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "socket_connection"
-
 module Buildkite::TestCollector
   class Session
     # Picked 75 as the magic timeout number as it's longer than the TCP timeout of 60s 🤷‍♀️
@@ -9,15 +7,19 @@ module Buildkite::TestCollector
     MAX_RECONNECTION_ATTEMPTS = ENV.fetch("BUILDKITE_ANALYTICS_RECONNECTION_ATTEMPTS") { 3 }.to_i
     WAIT_BETWEEN_RECONNECTIONS = ENV.fetch("BUILDKITE_ANALYTICS_RECONNECTION_WAIT") { 5 }.to_i
 
+    # We keep a private reference so that mocking libraries won't break JSON
+    JSON_PARSE = JSON.method(:parse)
+    private_constant :JSON_PARSE
+
     class RejectedSubscription < StandardError; end
     class InitialConnectionFailure < StandardError; end
 
     DISCONNECTED_EXCEPTIONS = [
-      SocketConnection::HandshakeError,
+      Buildkite::TestCollector::SocketConnection::HandshakeError,
+      Buildkite::TestCollector::TimeoutError,
+      Buildkite::TestCollector::SocketConnection::SocketError,
       RejectedSubscription,
-      TimeoutError,
       InitialConnectionFailure,
-      SocketConnection::SocketError
     ]
 
     def initialize(url, authorization_header, channel)
@@ -41,7 +43,7 @@ module Buildkite::TestCollector
       begin
         reconnection_count += 1
         connect
-      rescue TimeoutError, InitialConnectionFailure => e
+      rescue Buildkite::TestCollector::TimeoutError, InitialConnectionFailure => e
         Buildkite::TestCollector.logger.warn("buildkite-test_collector could not establish an initial connection with Buildkite due to #{e}. Attempting retry #{reconnection_count} of #{MAX_RECONNECTION_ATTEMPTS}...")
         if reconnection_count > MAX_RECONNECTION_ATTEMPTS
           Buildkite::TestCollector.logger.error "buildkite-test_collector could not establish an initial connection with Buildkite due to #{e.message} after #{MAX_RECONNECTION_ATTEMPTS} attempts. You may be missing some data for this test suite, please contact support if this issue persists."
@@ -122,7 +124,7 @@ module Buildkite::TestCollector
     end
 
     def handle(_connection, data)
-      data = JSON.parse(data)
+      data = JSON_PARSE.call(data)
       case data["type"]
       when "ping"
         # In absence of other message, the server sends us a ping every 3 seconds

data/lib/buildkite/test_collector/socket_connection.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "socket"
-require "openssl"
-require "json"
-
 module Buildkite::TestCollector
   class SocketConnection
     class HandshakeError < StandardError; end
@@ -65,7 +61,7 @@ module Buildkite::TestCollector
 
       # Setting up a new thread that listens on the socket, and processes incoming
       # comms from the server
-      @thread = Thread.new do
+      @read_thread = Thread.new do
         Buildkite::TestCollector.logger.debug("listening in on socket")
         frame = WebSocket::Frame::Incoming::Client.new
 
@@ -82,7 +78,7 @@ module Buildkite::TestCollector
       rescue EOFError => e
         Buildkite::TestCollector.logger.warn("#{e}")
         if @socket
-          Buildkite::TestCollector.logger.warn("attempting disconnected flow")
+          Buildkite::TestCollector.logger.error("attempting disconnected flow")
           @session.disconnected(self)
           disconnect
         end
@@ -151,7 +147,7 @@ module Buildkite::TestCollector
       socket = @socket
       @socket = nil
       socket&.close
-      @thread&.join unless @thread == Thread.current
+      @read_thread&.join unless @read_thread == Thread.current
     end
   end
 end

data/lib/buildkite/test_collector/tracer.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/hash/indifferent_access"
-
 module Buildkite::TestCollector
+  # Traces the execution of an application by creating and storing spans of information.
+  #
+  # This class contains two data structures:
+  #
+  # - A stack (called @stack) that traces the entering & leaving of each part of the application.
+  # - A tree made up of many Span nodes. Each Span is a node in the tree. Each
+  #   span is also stored in the stack. The root of the tree is called @top and
+  #   is stored at @stack[0].
+  #
+  # When the trace is complete the stack MUST contain a single node @top, which
+  # is the root of the tree (see #finalize). The tree is converted into a hash
+  # in #as_json which recursively calls #as_json on all of it's children.
   class Tracer
     # https://github.com/buildkite/test-collector-ruby/issues/131
     class MonotonicTime

data/lib/buildkite/test_collector/uploader.rb

@@ -1,20 +1,5 @@
 # frozen_string_literal: true
 
-require "openssl"
-require "websocket"
-
-require_relative "tracer"
-require_relative "network"
-require_relative "object"
-require_relative "session"
-require_relative "ci"
-require_relative "http_client"
-
-require "active_support"
-require "active_support/notifications"
-
-require "securerandom"
-
 module Buildkite::TestCollector
   class Uploader
     def self.traces

data/lib/buildkite/test_collector/version.rb

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

data/lib/buildkite/test_collector.rb

@@ -1,16 +1,39 @@
 # frozen_string_literal: true
 
+module Buildkite
+  module TestCollector
+  end
+end
+
+require "json"
+require "logger"
+require "net/http"
+require "openssl"
+require "time"
 require "timeout"
 require "tmpdir"
+require "securerandom"
+require "socket"
+require "websocket"
+
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/notifications"
 
 require_relative "test_collector/version"
+require_relative "test_collector/error"
 require_relative "test_collector/logger"
+require_relative "test_collector/ci"
+require_relative "test_collector/http_client"
+require_relative "test_collector/uploader"
+require_relative "test_collector/network"
+require_relative "test_collector/object"
+require_relative "test_collector/tracer"
+require_relative "test_collector/socket_connection"
+require_relative "test_collector/session"
 
 module Buildkite
   module TestCollector
-    class Error < StandardError; end
-    class TimeoutError < ::Timeout::Error; end
-
     DEFAULT_URL = "https://analytics-api.buildkite.com/v1/uploads"
 
     class << self
@@ -78,5 +101,12 @@ module Buildkite
         Buildkite::TestCollector::Uploader.tracer&.backfill(:sql, finish - start, **{ query: payload[:sql] })
       end
     end
+
+    def self.safe(&block)
+      block.call
+    rescue StandardError => e
+      logger.error("Buildkite::TestCollector received exception: #{e}")
+      logger.error("Backtrace:\n#{e.backtrace.join("\n")}")
+    end
   end
 end

data/lib/minitest/buildkite_collector_plugin.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+# Minitest finds this file before setup code
+require_relative "../buildkite/test_collector"
+require_relative "../buildkite/test_collector/minitest_plugin/reporter"
+
 module Minitest
   def self.plugin_buildkite_collector_init(options)
     if defined?(Buildkite::TestCollector::MinitestPlugin) && Buildkite::TestCollector.respond_to?(:uploader)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,6 +84,7 @@ files:
 - CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
+- DESIGN.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -95,6 +96,7 @@ files:
 - buildkite.yaml
 - lib/buildkite/test_collector.rb
 - lib/buildkite/test_collector/ci.rb
+- lib/buildkite/test_collector/error.rb
 - lib/buildkite/test_collector/http_client.rb
 - lib/buildkite/test_collector/library_hooks/minitest.rb
 - lib/buildkite/test_collector/library_hooks/rspec.rb