buildkite-test_collector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e6c042c033ec5dce4350b7bc365b7367d2b02d188b661ceffeab42ac3b44a93
+  data.tar.gz: b4a9669cbc466980b6a9f7cf4c971f049c799ea2846013165eb53bf7c153b75b
+SHA512:
+  metadata.gz: e81965dc948812b4ea7a9045bba5db5cdc6a3a634e5b92b201eaf3636c09ce473159d4a664d13575730620d1fa4994814b0515e503cb2a4d4f9c4b41a0559428
+  data.tar.gz: 4518c2d5dfa75d3e22177341b43a1ff85e15e329257844b9c6866dc787d1226558bedaa675e3659a31f44c7a4cb9213bd9b77ec622a71586b95d07f3052580a9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## v1.0.0
+
+- Option to disable detailed tracing #108 - @blanknite
+- minitest support (beta) #103 - @mariovisic, @blaknite
+- Handle re-raised disconnect exceptions #102 - @JuantoFatas
+- Make trace lookup faster using a Hash #98 - @blaknite, @mariovisic
+- Introduce more configurable logging #97 - @JuanitoFatas
+
+## v0.8.1
+
+- Improve the EOT confirmation #93 — @blaknite
+
+## v0.8.0
+
+- Support multiple CI platforms and generic env #80 — @blaknite
+- Replace invalid UTF-8 characters in test names #85 — @mariovisic
+- Relax Active Support constraint #87 — @ags

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+`support+analytics@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
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-buildkite-analytics.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    buildkite-test_collector (1.0.0)
+      activesupport (>= 5.2, < 8)
+      websocket (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      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)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket (1.2.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  buildkite-test_collector!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-core (~> 3.10)
+  rspec-expectations (~> 3.10)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Buildkite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Buildkite Collectors for Ruby
+
+Official [Buildkite Test Analytics](https://buildkite.com/test-analytics) 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).
+
+📦 **Supported CI systems:** Buildkite, GitHub Actions, CircleCI, and others via the `BUILDKITE_ANALYTICS_*` environment variables.
+
+## 👉 Installing
+
+### Step 1
+
+[Create a test suite](https://buildkite.com/docs/test-analytics), and copy the API token that it gives you.
+
+Add the [`buildkite-test_collector`](https://rubygems.org/gems/buildkite-test_collector) gem:
+
+```shell
+gem install buildkite-test_collector
+```
+
+Or add this to your Gemfile’s test group:
+
+```ruby
+group :test do
+  gem "buildkite-test_collector"
+end
+```
+
+### Step 2
+
+#### RSpec
+
+Add the following code to your RSpec setup file:
+
+```ruby
+# spec/spec_helper.rb
+require "buildkite/test_collector"
+Buildkite::TestCollector.configure(hook: :rspec)
+```
+
+Run your tests locally:
+
+```shell
+BUILDKITE_ANALYTICS_TOKEN=xyz rspec
+```
+
+#### Minitest
+
+Add the following code to your Minitest setup file:
+
+```ruby
+# test/test_helper.rb
+require "buildkite/test_collector"
+Buildkite::TestCollector.configure(hook: :minitest)
+```
+
+Run your tests locally:
+
+```shell
+BUILDKITE_ANALYTICS_TOKEN=xyz rake
+```
+
+### Step 3
+
+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
+```
+
+## 🔍 Debugging
+
+To enable debugging output, set the `BUILDKITE_ANALYTICS_DEBUG_ENABLED` environment variable to `true`.
+
+## 🔜 Roadmap
+
+See the [GitHub 'enhancement' issues](https://github.com/buildkite/test-collector-ruby/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) for planned features. Pull requests are always welcome, and we’ll give you feedback and guidance if you choose to contribute 💚
+
+## ⚒ Developing
+
+After cloning the repository, install the dependencies:
+
+```
+bundle
+```
+
+And run the tests:
+
+```
+bundle exec rspec
+```
+
+Useful resources for developing collectors include the [Buildkite Test Analytics docs](https://buildkite.com/docs/test-analytics).
+
+## 👩‍💻 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/test-collector-ruby
+
+## 📜 MIT License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec/buildkite/analytics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/buildkite-test_collector.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/buildkite/test_collector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "buildkite-test_collector"
+  spec.version       = Buildkite::TestCollector::VERSION
+  spec.authors       = ["Buildkite"]
+  spec.email         = ["support+analytics@buildkite.com"]
+
+  spec.summary       = "Track test executions and report to Buildkite Test Analytics"
+  spec.homepage      = "https://github.com/buildkite/test-collector-ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/buildkite/test-collector-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_dependency "activesupport", ">= 5.2", "< 8"
+  spec.add_dependency "websocket", '~> 1.2'
+
+  spec.add_development_dependency "rspec-core", '~> 3.10'
+  spec.add_development_dependency "rspec-expectations", '~> 3.10'
+end

data/buildkite.yaml

@@ -0,0 +1,8 @@
+steps:
+  - label: ":rspec: Tests"
+    command:
+      - "bundle"
+      - "bundle exec rake"
+    plugins:
+      - docker#v3.7.0:
+          image: ruby:latest

data/lib/buildkite/test_collector/ci.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+class Buildkite::TestCollector::CI
+  def self.env
+    new.env
+  end
+
+  # The analytics env are more specific than the automatic ci platform env.
+  # If they've been specified we'll assume the user wants to use that value instead.
+  def env
+    ci_env.merge(analytics_env)
+  end
+
+  private
+
+  def ci_env
+    return buildkite if ENV["BUILDKITE_BUILD_ID"]
+    return github_actions if ENV["GITHUB_RUN_NUMBER"]
+    return circleci if ENV["CIRCLE_BUILD_NUM"]
+    return generic if ENV["CI"]
+
+    {
+      "CI" => nil,
+      "key" => SecureRandom.uuid,
+    }
+  end
+
+  def analytics_env
+    {
+      "key" => ENV["BUILDKITE_ANALYTICS_KEY"],
+      "url" => ENV["BUILDKITE_ANALYTICS_URL"],
+      "branch" => ENV["BUILDKITE_ANALYTICS_BRANCH"],
+      "commit_sha" => ENV["BUILDKITE_ANALYTICS_SHA"],
+      "number" => ENV["BUILDKITE_ANALYTICS_NUMBER"],
+      "job_id" => ENV["BUILDKITE_ANALYTICS_JOB_ID"],
+      "message" => ENV["BUILDKITE_ANALYTICS_MESSAGE"],
+      "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+      "version" => Buildkite::TestCollector::VERSION,
+      "collector" => Buildkite::TestCollector::NAME,
+  }.compact
+  end
+
+  def generic
+    {
+      "CI" => "generic",
+      "key" => SecureRandom.uuid,
+    }
+  end
+
+  def buildkite
+    {
+      "CI" => "buildkite",
+      "key" => ENV["BUILDKITE_BUILD_ID"],
+      "url" => ENV["BUILDKITE_BUILD_URL"],
+      "branch" => ENV["BUILDKITE_BRANCH"],
+      "commit_sha" => ENV["BUILDKITE_COMMIT"],
+      "number" => ENV["BUILDKITE_BUILD_NUMBER"],
+      "job_id" => ENV["BUILDKITE_JOB_ID"],
+      "message" => ENV["BUILDKITE_MESSAGE"],
+    }
+  end
+
+  def github_actions
+    {
+      "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"],
+      "commit_sha" => ENV["GITHUB_SHA"],
+      "number" => ENV["GITHUB_RUN_NUMBER"],
+    }
+  end
+
+  def circleci
+    {
+      "CI" => "circleci",
+      "key" => "#{ENV["CIRCLE_WORKFLOW_ID"]}-#{ENV["CIRCLE_BUILD_NUM"]}",
+      "url" => ENV["CIRCLE_BUILD_URL"],
+      "branch" => ENV["CIRCLE_BRANCH"],
+      "commit_sha" => ENV["CIRCLE_SHA1"],
+      "number" => ENV["CIRCLE_BUILD_NUM"],
+    }
+  end
+end

data/lib/buildkite/test_collector/http_client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module Buildkite::TestCollector
+  class HTTPClient
+    attr :authorization_header
+    def initialize(url)
+      @url = url
+      @authorization_header = "Token token=\"#{Buildkite::TestCollector.api_token}\""
+    end
+
+    def post
+      contact_uri = URI.parse(url)
+
+      http = Net::HTTP.new(contact_uri.host, contact_uri.port)
+      http.use_ssl = contact_uri.scheme == "https"
+
+      contact = Net::HTTP::Post.new(contact_uri.path, {
+        "Authorization" => authorization_header,
+        "Content-Type" => "application/json",
+      })
+      contact.body = {
+        run_env: Buildkite::TestCollector::CI.env,
+        format: "websocket"
+      }.to_json
+
+      http.request(contact)
+    end
+
+    private
+
+    attr :url
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "minitest"
+
+require_relative "../uploader"
+require_relative "../minitest_plugin"
+
+Buildkite::TestCollector.uploader = Buildkite::TestCollector::Uploader
+
+class MiniTest::Test
+  include Buildkite::TestCollector::MinitestPlugin
+end
+
+Buildkite::TestCollector.enable_tracing!
+
+Buildkite::TestCollector::Uploader.configure

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require "rspec/expectations"
+
+require_relative "../uploader"
+require_relative "../rspec_plugin/reporter"
+require_relative "../rspec_plugin/trace"
+
+Buildkite::TestCollector.uploader = Buildkite::TestCollector::Uploader
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    config.add_formatter Buildkite::TestCollector::RSpecPlugin::Reporter
+
+    Buildkite::TestCollector::Uploader.configure
+  end
+
+  config.around(:each) do |example|
+    tracer = Buildkite::TestCollector::Tracer.new
+
+    # The _buildkite prefix here is added as a safeguard against name collisions
+    # as we are in the main thread
+    Thread.current[:_buildkite_tracer] = tracer
+    example.run
+    Thread.current[:_buildkite_tracer] = nil
+
+    tracer.finalize
+
+    trace = Buildkite::TestCollector::RSpecPlugin::Trace.new(example, history: tracer.history)
+    Buildkite::TestCollector.uploader.traces[example.id] = trace
+  end
+end
+
+Buildkite::TestCollector.enable_tracing!

data/lib/buildkite/test_collector/logger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "logger"
+require "time"
+
+module Buildkite::TestCollector
+  class Logger < ::Logger
+    class Formatter < ::Logger::Formatter
+      def call(severity, time, _program, message)
+        "#{time.utc.iso8601(9)} pid=#{::Process.pid} tid=#{::Thread.current.object_id} #{severity}: #{message}\n"
+      end
+    end
+
+    def initialize(*args, **kwargs)
+      super
+      self.formatter = Buildkite::TestCollector.log_formatter
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Buildkite::TestCollector::MinitestPlugin
+  class Reporter < Minitest::StatisticsReporter
+    def initialize(io, options)
+      super
+      @io = io
+      @options = options
+    end
+
+    def record(result)
+      super
+
+      if trace = Buildkite::TestCollector.uploader.traces[result.source_location]
+        Buildkite::TestCollector.session&.write_result(trace)
+      end
+    end
+
+    def report
+      super
+
+      if Buildkite::TestCollector.session.present?
+        examples_count = {
+          examples: count,
+          failed: failures,
+          pending: skips,
+          errors_outside_examples: 0, # Minitest does not report this
+        }
+
+        Buildkite::TestCollector.session.close(examples_count)
+      end
+    end
+  end
+end