buildkite-test_collector 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09f0da65683acfa44ac43a124494f3c9d5d8e3067abf0b28a3aa979a6413489d'
-  data.tar.gz: e7791580735083001493204451c79eae2e58ad5d51250f9c6535ca26bd8b169f
+  metadata.gz: d1d5188350d19431be80e4d9680a9a561d4ae25f64549d5be488607d1882a5c1
+  data.tar.gz: aece9ddaddba6792fcf2fa91f8642e5be3712bf118f154f6e152f0cbad5aa9eb
 SHA512:
-  metadata.gz: 3937ba2cfed151fb5c62af03b0a4925d6a4f36be0a95432c39a6f6e5974198e6e9c44fa5f7138086415ffac7b4907f082f067ee33b9bac7cb32a2ccfad50647d
-  data.tar.gz: bd956bc8de0375dcc657a7ed5f9a4256f0ba7b81de62dbc61ecb80ec2392eb6e9c57b298122f649659d16010189809a19dc4eb1f62e3c04626eb24917d53090c
+  metadata.gz: 6eb7578e7cad14c2088b6bb522eb3548cccd6de33dd09952fc4d4fd8638a707f9abaa8b68060fefd3eab212ab7a23d114cba0f4155e9394b13277b1b67719652
+  data.tar.gz: 6d1f20581f34336eb39e22a753661d5cd9b9feaf05a7773ca6d3171ec50ef335a61ec6697f9baeab4526810e0ed400981fae1738a78637179fbadae452a1995d

data/CHANGELOG.md

@@ -1,20 +1,35 @@
 # CHANGELOG
 
+## v2.4.0
+
+- Feature release: Output links to Test Analytic tests within the rspec log @meghan-kradolfer
+
+## v2.3.2
+
+- Add support for Codeship #198 - @swebb
+- Restore compatibility with older Ruby versions #201 - @gchan
+- Report Ruby version to Test Analytics #203 - @gchan
+
 ## v2.3.1
+
 - Log standard error raised during upload #195 - @nprizal
 
 ## v2.3.0
+
 - Stop sending execution id and safeguard SecureRandom.uuid #192 - @niceking
 - Rescue from StandardError when sending upload request #191 - @niceking
 - Fix nil pointer #188 - @ChrisBr
 
 ## v2.2.0
+
 - Gzip payload of request to Upload API #183 - @niceking
 
 ## v2.1.0
+
 - Major change: deprecates websocket connection in favour of sending HTTP requests to the Upload API. In future, websocket support will be completely removed from Buildkite and only version 2.1+ of this gem will continue to work.
 
 ## v2.1.0.pre
+
 - Minitest plugin to use HTTP Upload API instead of websocket connection to send test data #178 #179 - @niceking
 
 ## v2.0.0.pre
@@ -32,6 +47,7 @@
 - Update collector argument in the Analytics::API payload #170 - @KatieWright26
 
 ## v1.4.1
+
 - Add in support to create file with trace data #167
 
 ## v1.3.1

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.3.1)
+    buildkite-test_collector (2.4.0)
       activesupport (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     concurrent-ruby (1.2.2)
     diff-lcs (1.4.4)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.18.0)
+    minitest (5.19.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)

data/README.md

@@ -7,7 +7,7 @@ Official [Buildkite Test Analytics](https://buildkite.com/test-analytics) collec
 
 ⚒ **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.
+📦 **Supported CI systems:** Buildkite, GitHub Actions, CircleCI, Codeship, and others via the `BUILDKITE_ANALYTICS_*` environment variables.
 
 ## 👉 Installing
 

data/buildkite.yaml

@@ -1,8 +1,41 @@
 steps:
-  - label: ":rspec: Tests"
+  - label: ":rspec: Tests :ruby: 3.3-rc"
     command:
       - "bundle"
       - "bundle exec rake"
     plugins:
       - docker#v3.7.0:
-          image: 445615400570.dkr.ecr.us-east-1.amazonaws.com/ecr-public/docker/library/ruby:3.1.4
+          image: "445615400570.dkr.ecr.us-east-1.amazonaws.com/ecr-public/docker/library/ruby:3.3-rc"
+    soft_fail: true
+
+  - label: ":rspec: Tests :ruby: {{matrix}}"
+    command:
+      - "bundle"
+      - "bundle exec rake"
+    plugins:
+      - docker#v3.7.0:
+          image: "445615400570.dkr.ecr.us-east-1.amazonaws.com/ecr-public/docker/library/ruby:{{matrix}}"
+    matrix:
+      - "latest"
+      - "3.2"
+      - "3.1"
+      - "3.0"
+      - "2.7"
+
+  - group: ":rspec: Legacy Ruby :ruby:"
+    steps:
+      - label: ":rspec: Tests :ruby: {{matrix}}"
+        command:
+          - "gem install bundler:2.3.25"
+          - "bundle"
+          - "bundle exec rake"
+        plugins:
+          - docker#v3.7.0:
+              # Images for older Ruby versions aren't available on AWS ECR
+              # so fall back to Docker Hub
+              image: "ruby:{{matrix}}"
+        matrix:
+          - "2.6"
+          - "2.5"
+          - "2.4"
+          - "2.3"

data/lib/buildkite/test_collector/ci.rb

@@ -17,6 +17,7 @@ class Buildkite::TestCollector::CI
     return buildkite if ENV["BUILDKITE_BUILD_ID"]
     return github_actions if ENV["GITHUB_RUN_NUMBER"]
     return circleci if ENV["CIRCLE_BUILD_NUM"]
+    return codeship if ENV["CI_NAME"] == "codeship"
     return generic if ENV["CI"]
 
     {
@@ -36,9 +37,10 @@ class Buildkite::TestCollector::CI
       "message" => ENV["BUILDKITE_ANALYTICS_MESSAGE"],
       "execution_name_prefix" => ENV["BUILDKITE_ANALYTICS_EXECUTION_NAME_PREFIX"],
       "execution_name_suffix" => ENV["BUILDKITE_ANALYTICS_EXECUTION_NAME_SUFFIX"],
+      "language_version" => RUBY_VERSION,
       "version" => Buildkite::TestCollector::VERSION,
       "collector" => "ruby-#{Buildkite::TestCollector::NAME}",
-    }.compact
+    }.select { |_, value| !value.nil? }
   end
 
   def generic
@@ -82,4 +84,16 @@ class Buildkite::TestCollector::CI
       "number" => ENV["CIRCLE_BUILD_NUM"],
     }
   end
+
+  def codeship
+    {
+      "CI" => "codeship",
+      "key" => "#{ENV["CI_BUILD_ID"]}",
+      "url" => ENV["CI_PULL_REQUEST"],
+      "branch" => ENV["CI_BRANCH"],
+      "commit_sha" => ENV["CI_COMMIT_ID"],
+      "number" => nil,
+      "message" => ENV["CI_COMMIT_MESSAGE"],
+    }
+  end
 end

data/lib/buildkite/test_collector/http_client.rb

@@ -41,6 +41,20 @@ module Buildkite::TestCollector
       http.request(contact)
     end
 
+    def metadata
+      contact_uri = URI.parse("#{url}/metadata")
+
+      http = Net::HTTP.new(contact_uri.host, contact_uri.port)
+      http.use_ssl = contact_uri.scheme == "https"
+
+      contact = Net::HTTP::Get.new(contact_uri.path, {
+        "Authorization" => authorization_header,
+        "Content-Type" => "application/json"
+      })
+
+      http.request(contact)
+    end
+
     private
 
     attr :url

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

@@ -5,12 +5,14 @@ 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
 
 RSpec.configure do |config|
   config.before(:suite) do
     config.add_formatter Buildkite::TestCollector::RSpecPlugin::Reporter
+    config.add_formatter Buildkite::TestCollector::TestLinksPlugin::Formatter
   end
 
   config.around(:each) do |example|

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

@@ -38,7 +38,7 @@ module Buildkite::TestCollector::MinitestPlugin
         failure_reason: failure_reason,
         failure_expanded: failure_expanded,
         history: history,
-      ).with_indifferent_access.compact
+      ).with_indifferent_access.select { |_, value| !value.nil? }
     end
 
     private
@@ -50,7 +50,7 @@ module Buildkite::TestCollector::MinitestPlugin
     end
 
     def file_name
-      @file_name ||= File.join('./', source_location[0].delete_prefix(project_dir))
+      @file_name ||= File.join('./', source_location[0].sub(/\A#{project_dir}/, ""))
     end
 
     def line_number
@@ -74,7 +74,7 @@ module Buildkite::TestCollector::MinitestPlugin
         # remove the first line of message from the first failure
         # to avoid duplicate line in Test Analytics UI
         messages = strip_invalid_utf8_chars(failure.message).split("\n")
-        messages = messages[1..] if index.zero?
+        messages = messages[1..-1] if index.zero?
 
         {
           expanded: messages,

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

@@ -32,7 +32,7 @@ module Buildkite::TestCollector::RSpecPlugin
         failure_reason: failure_reason,
         failure_expanded: failure_expanded,
         history: history,
-      ).with_indifferent_access.compact
+      ).with_indifferent_access.select { |_, value| !value.nil? }
     end
 
     private

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

@@ -0,0 +1,62 @@
+# 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 unless notification.failed_examples.present?
+
+      # 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

data/lib/buildkite/test_collector/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,7 @@ 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
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Track test executions and report to Buildkite Test Analytics