buildkite-test_collector 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497ced90aac96227b8e4d2fc9ad1685eb4f554742b597568efa7e0f8bb1a0879
-  data.tar.gz: 709f96eaa2af7732b73c2838862bb98f350e9f8cda5aa7e209b00e96e00ab127
+  metadata.gz: 423b9692a49e1cea2d180d684f9f54c82a6fd84289087efe256cf4a2d1dd5f4b
+  data.tar.gz: 7ec78a72fb4506ee301b44f2830adfc22c83eb0508cab3ef7d455ec4a1f3049a
 SHA512:
-  metadata.gz: d559f0b297b7402a3f57203ea6226ee861b81b72682896c8a49d13ecaa036ca6ba6b3cf6b22e5693d0de8133500b4dd0b84a10db171d17c93237a0d2873e2704
-  data.tar.gz: e6d23fe2be97f26f4c1f753585340220d46ea926ed490878a4b02627b3488da57a859a1e3948796e84055dce99d01380e60ca77e96c33970c03ba38683259b7c
+  metadata.gz: dcf9a81dd2c1b74f8241c22ea94aff3dc75a9c1190afda0b12d4c2ac06bd79b89694fcee5d43a07a051864d404e140cf665064778dbb5d73b389abbba28af1ec
+  data.tar.gz: eb43eb66820451723296546c70b3b2fc7b63572aa393ae4ea2380bb8e195e7faa0c6e8b7eff56c04a70223585c55162872a82d647a7a4d74e8cfe7ffa7cad3c6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.11.0
+
+* Add `location_prefix` option. Allows a file name prefix to be set which will be prepended to `file_name` and `location` in the test results.
+
+**Full Changelog**: https://github.com/buildkite/test-collector-ruby/compare/v2.10.0...v2.11.0
+
 ## v2.10.0
 
 * Add support for Cucumber

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.10.0)
+    buildkite-test_collector (2.11.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -113,17 +113,15 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/buildk
 ## 🚀 Releasing
 
 1. Bump the version in `version.rb` and run `bundle` to update the `Gemfile.lock`.
-1. Update the CHANGELOG.md with your new version and a description of your changes.
+2. Update the CHANGELOG.md with your new version and a description of your changes.
+3. Once your PR is merged to `main` git tag the merge commit and push:
 
-Once your PR is merged to `main`:
-
-1. Git tag the merge commit and push
 ```
 git tag vX.X.X
 git push origin vX.X.X
 ```
-1. Visit the [release pipeline](https://buildkite.com/buildkite/test-collector-ruby-release) to unblock it and confirm the new version is pushed to rubygems.org
-1. Create a [new release in github](https://github.com/buildkite/test-collector-ruby/releases).
+4. Visit the [release pipeline](https://buildkite.com/buildkite/test-collector-ruby-release) to unblock it and confirm the new version is pushed to rubygems.org
+5. Create a [new release in github](https://github.com/buildkite/test-collector-ruby/releases).
 
 ## 📜 MIT License
 

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

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 module Buildkite::TestCollector::CucumberPlugin
-  class Trace
+  class Trace < Buildkite::TestCollector::Trace
     attr_accessor :scenario, :failure_reason, :failure_expanded
-    attr_reader :history, :tags
+    attr_reader :history, :tags, :location_prefix
 
     FILE_PATH_REGEX = /^(.*?\.(rb|feature))/
 
-    def initialize(scenario, history:, failure_reason: nil, failure_expanded: [], tags: nil)
+    def initialize(scenario, history:, failure_reason: nil, failure_expanded: [], tags: nil, location_prefix: nil)
       @scenario         = scenario
       @history          = history
       @failure_reason   = failure_reason
       @failure_expanded = failure_expanded
       @tags             = tags
+      @location_prefix  = location_prefix
     end
 
     def result
@@ -25,41 +26,30 @@ module Buildkite::TestCollector::CucumberPlugin
       end
     end
 
-    def as_hash
-      parser = Gherkin::Parser.new
-      document = parser.parse(File.read(file_name))
-      feature_name = document.feature.name
+    private
 
-      strip_invalid_utf8_chars(
-        scope:          feature_name,
-        name:           scenario.name,
-        location:       scenario.location&.to_s,
-        file_name:      file_name,
-        result:         result,
-        failure_reason: failure_reason,
-        failure_expanded: failure_expanded,
-        history:        history,
-        tags:           tags,
-      ).select { |_, v| !v.nil? }
+    def gherkin_parser
+      @gherkin_parser ||= Gherkin::Parser.new
     end
 
-    private
+    def document
+      @document ||= gherkin_parser.parse(File.read(file_name))
+    end
 
-    def file_name
-      @file_name ||= scenario.location&.to_s[FILE_PATH_REGEX]
+    def scope
+      document.feature.name
     end
 
-    def strip_invalid_utf8_chars(object)
-      case object
-      when Hash
-        object.transform_values { |v| strip_invalid_utf8_chars(v) }
-      when Array
-        object.map { |v| strip_invalid_utf8_chars(v) }
-      when String
-        object.encode('UTF-8', invalid: :replace, undef: :replace)
-      else
-        object
-      end
+    def name
+      scenario.name
+    end
+
+    def location
+      scenario.location&.to_s
+    end
+
+    def file_name
+      @file_name ||= location&.to_s[FILE_PATH_REGEX]
     end
   end
 end

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

@@ -52,6 +52,7 @@ After do |scenario|
       failure_reason:   failure_reason,
       failure_expanded: failure_expanded,
       tags:             tags,
+      location_prefix:  Buildkite::TestCollector.location_prefix,
     )
 
     Buildkite::TestCollector.uploader.traces[scenario.location.to_s] = trace

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

@@ -37,6 +37,7 @@ RSpec.configure do |config|
         example,
         history: tracer.history,
         tags: tags,
+        location_prefix: Buildkite::TestCollector.location_prefix
       )
 
       Buildkite::TestCollector.uploader.traces[example.id] = trace

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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module Buildkite::TestCollector::MinitestPlugin
-  class Trace
+  class Trace < Buildkite::TestCollector::Trace
     attr_accessor :example
     attr_writer :failure_reason, :failure_expanded
     attr_reader :history
+    attr_reader :location_prefix
     attr_reader :tags
 
     RESULT_CODES = {
@@ -16,10 +17,11 @@ module Buildkite::TestCollector::MinitestPlugin
 
     FILE_PATH_REGEX = /^(.*?\.(rb|feature))/
 
-    def initialize(example, history:, tags: nil)
+    def initialize(example, history:, tags: nil, trace: nil, location_prefix: nil)
       @example = example
       @history = history
       @tags = tags
+      @location_prefix = location_prefix
     end
 
     def result
@@ -30,21 +32,15 @@ module Buildkite::TestCollector::MinitestPlugin
       @source_location ||= example.method(example.name).source_location
     end
 
-    def as_hash
-      strip_invalid_utf8_chars(
-        scope: example.class.name,
-        name: example.name,
-        location: location,
-        file_name: file_name,
-        result: result,
-        failure_reason: failure_reason,
-        failure_expanded: failure_expanded,
-        history: history,
-        tags: tags,
-      ).select { |_, value| !value.nil? }
+    private
+
+    def scope
+      example.class.name
     end
 
-    private
+    def name
+      example.name
+    end
 
     def location
       if file_name
@@ -85,17 +81,5 @@ module Buildkite::TestCollector::MinitestPlugin
         }
       end
     end
-
-    def strip_invalid_utf8_chars(object)
-      if object.is_a?(Hash)
-        Hash[object.map { |key, value| [key, strip_invalid_utf8_chars(value)] }]
-      elsif object.is_a?(Array)
-        object.map { |value| strip_invalid_utf8_chars(value) }
-      elsif object.is_a?(String)
-        object.encode('UTF-8', :invalid => :replace, :undef => :replace)
-      else
-        object
-      end
-    end
   end
 end

data/lib/buildkite/test_collector/minitest_plugin.rb

@@ -35,6 +35,7 @@ module Buildkite::TestCollector::MinitestPlugin
         self,
         history: tracer.history,
         tags: tags,
+        location_prefix: Buildkite::TestCollector.location_prefix
       )
 
       Buildkite::TestCollector.uploader.traces[trace.source_location] = trace

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

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 module Buildkite::TestCollector::RSpecPlugin
-  class Trace
+  class Trace < Buildkite::TestCollector::Trace
     attr_accessor :example, :failure_reason, :failure_expanded
     attr_reader :history
     attr_reader :tags
+    attr_reader :location_prefix
 
     FILE_PATH_REGEX = /^(.*?\.(rb|feature))/
 
-    def initialize(example, history:, failure_reason: nil, failure_expanded: [], tags: nil)
+    def initialize(example, history:, failure_reason: nil, failure_expanded: [], tags: nil, location_prefix: nil)
       @example = example
       @history = history
       @failure_reason = failure_reason
       @failure_expanded = failure_expanded
       @tags = tags
+      @location_prefix = location_prefix
     end
 
     def result
@@ -24,21 +26,19 @@ module Buildkite::TestCollector::RSpecPlugin
       end
     end
 
-    def as_hash
-      strip_invalid_utf8_chars(
-        scope: example.example_group.metadata[:full_description],
-        name: example.description,
-        location: example.location,
-        file_name: file_name,
-        result: result,
-        failure_reason: failure_reason,
-        failure_expanded: failure_expanded,
-        history: history,
-        tags: tags,
-      ).select { |_, value| !value.nil? }
+    private
+
+    def scope
+      example.example_group.metadata[:full_description]
     end
 
-    private
+    def name
+      example.description
+    end
+
+    def location
+      example.location
+    end
 
     def file_name
       @file_name ||= begin
@@ -69,17 +69,5 @@ module Buildkite::TestCollector::RSpecPlugin
     def shared_example_call_location
       example.metadata[:shared_group_inclusion_backtrace].last.inclusion_location
     end
-
-    def strip_invalid_utf8_chars(object)
-      if object.is_a?(Hash)
-        Hash[object.map { |key, value| [key, strip_invalid_utf8_chars(value)] }]
-      elsif object.is_a?(Array)
-        object.map { |value| strip_invalid_utf8_chars(value) }
-      elsif object.is_a?(String)
-        object.encode('UTF-8', :invalid => :replace, :undef => :replace)
-      else
-        object
-      end
-    end
   end
 end

data/lib/buildkite/test_collector/trace.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module TestCollector
+    class Trace
+      def as_hash
+        strip_invalid_utf8_chars(
+          scope: scope,
+          name: name,
+          location: prepend_location_prefix(location),
+          file_name: prepend_location_prefix(file_name),
+          result: result,
+          failure_reason: failure_reason,
+          failure_expanded: failure_expanded,
+          history: history,
+          tags: tags,
+        ).select { |_, value| !value.nil? }
+      end
+
+      private
+
+      def strip_invalid_utf8_chars(object)
+        if object.is_a?(Hash)
+          Hash[object.map { |key, value| [key, strip_invalid_utf8_chars(value)] }]
+        elsif object.is_a?(Array)
+          object.map { |value| strip_invalid_utf8_chars(value) }
+        elsif object.is_a?(String)
+          object.encode('UTF-8', :invalid => :replace, :undef => :replace)
+        else
+          object
+        end
+      end
+
+      def prepend_location_prefix(file_name)
+        return file_name unless file_name && location_prefix
+
+        Pathname.new(location_prefix).join(
+          Pathname.new(file_name)
+        ).to_s
+      end
+    end
+  end
+end

data/lib/buildkite/test_collector/version.rb

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

data/lib/buildkite/test_collector.rb

@@ -20,6 +20,7 @@ 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/trace"
 require_relative "test_collector/tracer"
 require_relative "test_collector/session"
 require_relative "test_collector/uuid"
@@ -35,6 +36,7 @@ module Buildkite
       attr_accessor :session
       attr_accessor :tracing_enabled
       attr_accessor :artifact_path
+      attr_accessor :location_prefix
       attr_accessor :env
       attr_accessor :tags
       attr_accessor :batch_size
@@ -42,15 +44,16 @@ module Buildkite
       attr_accessor :span_filters
     end
 
-    def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, env: {}, tags: {})
+    def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, location_prefix: nil, env: {}, tags: {})
       if hook.to_sym == :cucumber && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
         raise UnsupportedFrameworkError.new("Cucumber is only supported in versions of Ruby >= 2.7")
       end
 
       self.api_token = (token || ENV["BUILDKITE_ANALYTICS_TOKEN"])&.strip
-      self.url = url || DEFAULT_URL
+      self.url = url || ENV["BUILDKITE_ANALYTICS_ENDPOINT"] || DEFAULT_URL
       self.tracing_enabled = tracing_enabled
       self.artifact_path = artifact_path
+      self.location_prefix = location_prefix || ENV["BUILDKITE_ANALYTICS_LOCATION_PREFIX"]
       self.env = env
       self.tags = tags
       self.batch_size = ENV.fetch("BUILDKITE_ANALYTICS_UPLOAD_BATCH_SIZE") { DEFAULT_UPLOAD_BATCH_SIZE }.to_i

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Buildkite
@@ -105,6 +105,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/trace.rb
 - lib/buildkite/test_collector/tracer.rb
 - lib/buildkite/test_collector/uploader.rb
 - lib/buildkite/test_collector/uuid.rb
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Track test executions and report to Buildkite Test Engine
 test_files: []