rspec-buildkite-analytics 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541f8d1bf4465e411f3fa17757b1c13bc073ea361db1e66973060cb673779d39
-  data.tar.gz: 87bb5b43638e2db1951ab0fc0a60a67f5edc7f41c0b4d4735bf75d4202745d21
+  metadata.gz: a29588419eb727d74849c54b0d38f5b90974c3f58f083e48958a17288a1dc1fe
+  data.tar.gz: 1fd5fd323f7737c247b61bcd87ea9778e3f020601514eb52777c0ba5871c24aa
 SHA512:
-  metadata.gz: e98d13112dddf07fbad1cef13042de7fadd856b3c92202859ebf7e9c935b72eb8d960525181c726fd2ac1d15f72e9252273c9c1e8553f466a0aa415e0307b7df
-  data.tar.gz: 9380dce5392e09ef0758780e8a58586f11aabc57ca11ea345d2ae3d7a0f9fa2bac1c982e514b0b556faddf10b0b5ba02f9495320a628bf7add4700898fb29d0e
+  metadata.gz: 45624d6a321c8ff16008e259b4a3eb3f118449d36947f1cb0efb86c7e988ee3e904a2665be517b4be2cd8075d4c1352d8356df88ac43c615664ec28383ced50f
+  data.tar.gz: fdb57102cd80974a01e939e8ab8bc8ae3ce22f39ff5a6862cc7cdc9d5250672a93ff966dfa391e47e80cdfaf70354082f0afd9ca1f6d4e1104edb53dbc11d977

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## 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/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rspec-buildkite-analytics (0.6.1)
-      activesupport (>= 5.2, <= 7.0)
+    rspec-buildkite-analytics (0.8.0)
+      activesupport (>= 5.2, < 8)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
       websocket (~> 1.2)
@@ -10,17 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     rake (13.0.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -38,7 +37,6 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     websocket (1.2.9)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby

data/lib/rspec/buildkite/analytics/ci.rb

@@ -2,26 +2,85 @@
 
 require "securerandom"
 
-module RSpec::Buildkite::Analytics::CI
+class RSpec::Buildkite::Analytics::CI
   def self.env
-    if ENV["BUILDKITE_BUILD_ID"]
-      {
-        "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"],
-        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"]
-      }
-    else
-      {
-        "CI" => nil,
-        "key" => SecureRandom.uuid,
-        "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"]
-      }
-    end
+    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_ANANLYTICS_MESSAGE"],
+      "debug" => ENV["BUILDKITE_ANALYTICS_DEBUG_ENABLED"],
+      "version" => RSpec::Buildkite::Analytics::VERSION,
+      "collector" => RSpec::Buildkite::Analytics::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/rspec/buildkite/analytics/session.rb

@@ -52,9 +52,22 @@ module RSpec::Buildkite::Analytics
 
       @logger = Logger.new
 
-      connect
-    rescue TimeoutError, InitialConnectionFailure => e
-      $stderr.puts "rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e.message}. You may be missing some data for this test suite, please contact support."
+      reconnection_count = 0
+
+      begin
+        reconnection_count += 1
+        connect
+      rescue TimeoutError, InitialConnectionFailure => e
+        @logger.write("rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e}. Attempting retry #{reconnection_count} of #{MAX_RECONNECTION_ATTEMPTS}...")
+        if reconnection_count > MAX_RECONNECTION_ATTEMPTS
+          $stderr.puts "rspec-buildkite-analytics could not establish an initial connection with Buildkite due to #{e.message} after #{MAX_RECONNECTION_ATTEMPTS} attempts. You may be missing some data for this test suite, please contact support if this issue persists."
+        else
+          sleep(WAIT_BETWEEN_RECONNECTIONS)
+          @logger.write("retrying reconnection")
+          retry
+        end
+      end
+      init_write_thread
     end
 
     def disconnected(connection)
@@ -76,7 +89,8 @@ module RSpec::Buildkite::Analytics
         begin
           reconnection_count += 1
           connect
-        rescue SocketConnection::HandshakeError, RejectedSubscription, TimeoutError, SocketConnection::SocketError => e
+          init_write_thread
+        rescue SocketConnection::HandshakeError, RejectedSubscription, TimeoutError, InitialConnectionFailure, SocketConnection::SocketError => e
           @logger.write("failed reconnection attempt #{reconnection_count} due to #{e}")
           if reconnection_count > MAX_RECONNECTION_ATTEMPTS
             $stderr.puts "rspec-buildkite-analytics experienced a disconnection and could not reconnect to Buildkite due to #{e.message}. Please contact support."
@@ -170,8 +184,10 @@ module RSpec::Buildkite::Analytics
       wait_for_confirm
 
       @logger.write("connected")
+    end
 
-      # As this connect method can be called multiple times in the
+    def init_write_thread
+      # As this method can be called multiple times in the
       # reconnection process, kill prev write threads (if any) before
       # setting up the new one
       @write_thread&.kill

data/lib/rspec/buildkite/analytics/uploader.rb

@@ -42,7 +42,7 @@ module RSpec::Buildkite::Analytics
       end
 
       def as_hash
-        {
+        strip_invalid_utf8_chars(
           id: @id,
           scope: example.example_group.metadata[:full_description],
           name: example.description,
@@ -53,14 +53,14 @@ module RSpec::Buildkite::Analytics
           failure_reason: failure_reason,
           failure_expanded: failure_expanded,
           history: history,
-        }.with_indifferent_access.compact
+        ).with_indifferent_access.compact
       end
 
       private
 
       def generate_file_name(example)
         file_path_regex = /^(.*?\.(rb|feature))/
-        identifier_file_name = example.id[file_path_regex]
+        identifier_file_name = strip_invalid_utf8_chars(example.id)[file_path_regex]
         location_file_name = example.location[file_path_regex]
 
         if identifier_file_name != location_file_name
@@ -78,6 +78,18 @@ module RSpec::Buildkite::Analytics
           identifier_file_name
         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
 
     def self.traces
@@ -125,6 +137,8 @@ module RSpec::Buildkite::Analytics
               puts "Buildkite Test Analytics: Error communicating with the server: #{e.message}"
             end
 
+            return unless response
+
             case response.code
             when "401"
               puts "Buildkite Test Analytics: Invalid Suite API key. Please double check your Suite API key."

data/lib/rspec/buildkite/analytics/version.rb

@@ -3,7 +3,8 @@
 module RSpec
   module Buildkite
     module Analytics
-      VERSION = "0.6.1"
+      VERSION = "0.8.0"
+      NAME = "rspec-buildkite"
     end
   end
 end

data/lib/rspec/buildkite/analytics.rb

@@ -30,4 +30,10 @@ module RSpec::Buildkite::Analytics
 
     self::Uploader.configure
   end
+
+  def self.annotate(content)
+    tracer = RSpec::Buildkite::Analytics::Uploader.tracer
+    tracer&.enter("annotation", **{ content: content })
+    tracer&.leave
+  end
 end

data/rspec-buildkite-analytics.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.add_dependency "activesupport", ">= 5.2", "<= 7.0"
+  spec.add_dependency "activesupport", ">= 5.2", "< 8"
   spec.add_dependency "rspec-core", '~> 3.10'
   spec.add_dependency "rspec-expectations", '~> 3.10'
   spec.add_dependency "websocket", '~> 1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite-analytics
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Buildkite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-09 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Track execution of specs and report to Buildkite Analytics