buildkite-test_collector 1.0.0

data/lib/buildkite/test_collector.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "timeout"
+require "tmpdir"
+
+require_relative "test_collector/version"
+require_relative "test_collector/logger"
+
+module Buildkite
+  module TestCollector
+    class Error < StandardError; end
+    class TimeoutError < ::Timeout::Error; end
+
+    DEFAULT_URL = "https://analytics-api.buildkite.com/v1/uploads"
+
+    class << self
+      attr_accessor :api_token
+      attr_accessor :url
+      attr_accessor :uploader
+      attr_accessor :session
+      attr_accessor :debug_enabled
+      attr_accessor :debug_filepath
+      attr_accessor :tracing_enabled
+    end
+
+    def self.configure(hook:, token: nil, url: nil, debug_enabled: false, debug_filepath: nil, tracing_enabled: true)
+      self.api_token = token || ENV["BUILDKITE_ANALYTICS_TOKEN"]
+      self.url = url || DEFAULT_URL
+      self.debug_enabled = debug_enabled || !!(ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"])
+      self.debug_filepath = debug_filepath || ENV["BUILDKITE_ANALYTICS_DEBUG_FILEPATH"] || Dir.tmpdir
+      self.tracing_enabled = tracing_enabled
+
+      self.hook_into(hook)
+    end
+
+    def self.hook_into(hook)
+      file = "test_collector/library_hooks/#{hook}"
+      require_relative file
+    rescue LoadError
+      raise ArgumentError.new("#{hook.inspect} is not a supported Buildkite Analytics Test library hook.")
+    end
+
+    def self.annotate(content)
+      tracer = Buildkite::TestCollector::Uploader.tracer
+      tracer&.enter("annotation", **{ content: content })
+      tracer&.leave
+    end
+
+    def self.log_formatter
+      @log_formatter ||= Buildkite::TestCollector::Logger::Formatter.new
+    end
+
+    def self.log_formatter=(log_formatter)
+      @log_formatter = log_formatter
+      logger.formatter = log_formatter
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      return @logger if defined?(@logger)
+
+      debug_mode = ENV.fetch("BUILDKITE_ANALYTICS_DEBUG_ENABLED") do
+        $DEBUG
+      end
+
+      level = !!debug_mode ? ::Logger::DEBUG : ::Logger::WARN
+      @logger ||= Buildkite::TestCollector::Logger.new($stderr, level: level)
+    end
+
+    def self.enable_tracing!
+      return unless self.tracing_enabled
+
+      Buildkite::TestCollector::Network.configure
+      Buildkite::TestCollector::Object.configure
+
+      ActiveSupport::Notifications.subscribe("sql.active_record") do |name, start, finish, id, payload|
+        Buildkite::TestCollector::Uploader.tracer&.backfill(:sql, finish - start, **{ query: payload[:sql] })
+      end
+    end
+  end
+end

data/lib/minitest/buildkite_collector_plugin.rb

@@ -0,0 +1,7 @@
+module Minitest
+  def self.plugin_buildkite_collector_init(options)
+    if Buildkite::TestCollector.respond_to?(:uploader)
+      self.reporter << Buildkite::TestCollector::MinitestPlugin::Reporter.new(options[:io], options)
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: buildkite-test_collector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Buildkite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: 
+email:
+- support+analytics@buildkite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- buildkite-test_collector.gemspec
+- buildkite.yaml
+- lib/buildkite/test_collector.rb
+- lib/buildkite/test_collector/ci.rb
+- lib/buildkite/test_collector/http_client.rb
+- lib/buildkite/test_collector/library_hooks/minitest.rb
+- lib/buildkite/test_collector/library_hooks/rspec.rb
+- lib/buildkite/test_collector/logger.rb
+- lib/buildkite/test_collector/minitest_plugin.rb
+- lib/buildkite/test_collector/minitest_plugin/reporter.rb
+- lib/buildkite/test_collector/minitest_plugin/trace.rb
+- lib/buildkite/test_collector/network.rb
+- lib/buildkite/test_collector/object.rb
+- 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/socket_connection.rb
+- lib/buildkite/test_collector/tracer.rb
+- lib/buildkite/test_collector/uploader.rb
+- lib/buildkite/test_collector/version.rb
+- lib/minitest/buildkite_collector_plugin.rb
+homepage: https://github.com/buildkite/test-collector-ruby
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Track test executions and report to Buildkite Test Analytics
+test_files: []