buildkite-test_collector 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b48c795c760f5a77634bc30024c344925036c3b4f935848caf6dcaf861b1692
-  data.tar.gz: 263e4faa13017fa5f8e1465dc76f245e05b3f26f703e933c87cb547b17e5dfbd
+  metadata.gz: d1d5188350d19431be80e4d9680a9a561d4ae25f64549d5be488607d1882a5c1
+  data.tar.gz: aece9ddaddba6792fcf2fa91f8642e5be3712bf118f154f6e152f0cbad5aa9eb
 SHA512:
-  metadata.gz: feaa2ec084069d17991bf5fda126b6b6d01fee4a807e4295bd644a02ccf30a02e9f1c0e912e2441347aee48f36bdae7eaa46ea4fe86075ac60e0b88424199aee
-  data.tar.gz: 7c31eafe74aa8cba48e74537940968c0b322b8939b33fa1cee2fdfb05600aa5ef9fc6192fb3b3c972bf4286edc3180cd375240eac2b6be8be08a4466bbed5567
+  metadata.gz: 6eb7578e7cad14c2088b6bb522eb3548cccd6de33dd09952fc4d4fd8638a707f9abaa8b68060fefd3eab212ab7a23d114cba0f4155e9394b13277b1b67719652
+  data.tar.gz: 6d1f20581f34336eb39e22a753661d5cd9b9feaf05a7773ca6d3171ec50ef335a61ec6697f9baeab4526810e0ed400981fae1738a78637179fbadae452a1995d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.3.2)
+    buildkite-test_collector (2.4.0)
       activesupport (>= 4.2)
 
 GEM

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/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.2"
+    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.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-04 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