bugsnag-maze-runner 8.2.0 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac01df378fac543e5aa19a4999e4a2e403de8e7df9860b6463e27899f2f2f0d
-  data.tar.gz: c59e92d444b2da617bb0ec06c5fdc4355687129b7cc01cd56e5900a48c2fbe2c
+  metadata.gz: 02b1bd719cc437d684670a164059b1db11b6b86e10de81348e1027b74b1a138d
+  data.tar.gz: f5341e638425082222c5ca8462e4e98cce7a00a084351a91e746ebb07fc0d23e
 SHA512:
-  metadata.gz: a7d5e5079dc431e2c33d57f63ce3242cc0eaf12f81de1b043b843598ba15beb6d0610f21fbc2955502c6f35125781c1889b5a92963560e5dfc14d01f230bda90
-  data.tar.gz: 8551f7d971779b47ec6e65ba0a6402bcbf9110e4b9232b4851c2b37aab1793a89879c1e3946e86c87abea478465ec43a28306f6f1daf42ff5c043415e4b297e9
+  metadata.gz: 683441571c5eb37acffc60787acaa1f697b9e20fe5af95ebb45abe52682ac0507b2ee1f4b55bc28ea0de7eb7587c5f829ee12bcde75482a818cee3be34cbafe5
+  data.tar.gz: 8832b0b1684e380449cc3aac2fecf6b2ae47195761a07ac6d1fdc469e6bd176ab89a068726e259dd63f3137af80d57b2542120c8e41b779afe211e75ac4c1470

data/lib/features/steps/deprecated_steps.rb

@@ -0,0 +1,8 @@
+# @!group Deprecated steps
+
+# Waits for a given number of spans to be received, which may be spread across one or more trace requests.
+#
+# @step_input span_count [Integer] The number of spans to wait for
+When('I wait for {int} span(s)') do |span_count|
+  assert_received_spans Maze::Server.list_for('traces'), span_count
+end

data/lib/features/steps/request_assertion_steps.rb

@@ -8,7 +8,7 @@ require_relative '../../maze/wait'
 
 # @!group Request assertion steps
 
-def assert_received_requests(request_count, list, list_name, precise = true)
+def assert_received_requests(request_count, list, list_name, precise = true, maximum = nil)
   timeout = Maze.config.receive_requests_wait
   # Interval set to 0.5s to make it more likely to detect erroneous extra requests,
   # without impacting overall speed too much
@@ -45,6 +45,7 @@ def assert_received_requests(request_count, list, list_name, precise = true)
     Maze.check.equal(request_count, list.size_remaining, "#{list.size_remaining} #{list_name} received")
   else
     Maze.check.operator(request_count, :<=, list.size_remaining, "#{list.size_remaining} #{list_name} received")
+    Maze.check.operator(maximum, :>=, list.size_remaining, "#{list.size_remaining} #{list_name} received") unless maximum.nil?
   end
 end
 
@@ -102,6 +103,16 @@ Then('I have received at least {int} {request_type}') do |min_received, request_
   Maze.check.operator(list.size_remaining, :>=, min_received, "Actually received #{list.size_remaining} #{request_type} requests")
 end
 
+# Verify that an amount of requests within a range have been received
+#
+# @step_input min_received [Integer] The minimum amount of requests required to pass
+# @step_input max_received [Integer] The maximum amount of requests before failure
+# @step_input request_type [String] The type of request (error, session, build, etc)
+Then('I wait to receive between {int} and {int} {request_type}') do |min_received, max_received, request_type|
+  list = Maze::Server.list_for(request_type)
+  assert_received_requests min_received, list, request_type, false, max_received
+end
+
 # Assert that the test Server hasn't received any requests - of a specific, or any, type.
 #
 # @step_input request_type [String] The type of request ('error', 'session', 'trace', sampling request', etc)

data/lib/features/steps/trace_steps.rb

@@ -3,8 +3,25 @@
 # Waits for a given number of spans to be received, which may be spread across one or more trace requests.
 #
 # @step_input span_count [Integer] The number of spans to wait for
-When('I wait for {int} span(s)') do |span_count|
-  assert_received_spans span_count, Maze::Server.list_for('traces')
+Then('I wait to receive {int} span(s)') do |span_count|
+  assert_received_span_count Maze::Server.list_for('traces'), span_count
+end
+
+# Waits for a minimum number of spans to be received, which may be spread across one or more trace requests.
+# If more spans than requested are received, this step will still pass.
+#
+# @step_input span_min [Integer] The minimum number of spans to wait for
+Then('I wait to receive at least {int} span(s)') do |span_min|
+  assert_received_minimum_span_count Maze::Server.list_for('traces'), span_min
+end
+
+# Waits for a minimum number of spans to be received, which may be spread across one or more trace requests.
+# If more spans than the maximum requested number of spans are received, this step will fail.
+#
+# @step_input span_min [Integer] The minimum number of spans to wait for
+# @step_input span_max [Integer] The maximum number of spans to receive before failure
+Then('I wait to receive between {int} and {int} span(s)') do |span_min, span_max|
+  assert_received_ranged_span_count Maze::Server.list_for('traces'), span_min, span_max
 end
 
 Then('I should have received no spans') do
@@ -227,16 +244,28 @@ def attribute_value_matches?(attribute_value, expected_type, expected_value)
   end
 end
 
-def assert_received_spans(span_count, list)
+def assert_received_span_count(list, count)
+  assert_received_spans(list, count, count)
+end
+
+def assert_received_minimum_span_count(list, minimum)
+  assert_received_spans(list, minimum)
+end
+
+def assert_received_ranged_span_count(list, minimum, maximum)
+  assert_received_spans(list, minimum, maximum)
+end
+
+def assert_received_spans(list, min_received, max_received = nil)
   timeout = Maze.config.receive_requests_wait
   wait = Maze::Wait.new(timeout: timeout)
 
-  received = wait.until { spans_from_request_list(list).size >= span_count }
+  received = wait.until { spans_from_request_list(list).size >= min_received }
   received_count = spans_from_request_list(list).size
 
   unless received
     raise Test::Unit::AssertionFailedError.new <<-MESSAGE
-    Expected #{span_count} spans but received #{received_count} within the #{timeout}s timeout.
+    Expected #{min_received} spans but received #{received_count} within the #{timeout}s timeout.
     This could indicate that:
     - Bugsnag crashed with a fatal error.
     - Bugsnag did not make the requests that it should have done.
@@ -246,7 +275,7 @@ def assert_received_spans(span_count, list)
     MESSAGE
   end
 
-  Maze.check.operator(span_count, :<=, received_count, "#{received_count} spans received")
+  Maze.check.operator(max_received, :>=, received_count, "#{received_count} spans received") if max_received
 
   Maze::Schemas::Validator.verify_against_schema(list, 'trace')
   Maze::Schemas::Validator.validate_payload_elements(list, 'trace')

data/lib/features/support/internal_hooks.rb

@@ -30,12 +30,14 @@ BeforeAll do
   end
   $logger.info "Running in #{Maze.mode.to_s} mode"
 
-  # Clear out maze_output folder
+  # Clear out maze_output folder and zip
   maze_output = Dir.glob(File.join(Dir.pwd, 'maze_output', '*'))
   if Maze.config.file_log && !maze_output.empty?
     maze_output.each { |path| $logger.info "Clearing contents of #{path}" }
     FileUtils.rm_rf(maze_output)
   end
+  maze_output_zip = Dir.glob(File.join(Dir.pwd, 'maze_output.zip'))
+  FileUtils.rm_rf(maze_output_zip)
 
   # Record the local server starting time
   Maze.start_time = Time.now.strftime('%Y-%m-%d %H:%M:%S')
@@ -222,6 +224,14 @@ end
 
 # After all tests
 AfterAll do
+  maze_output = File.join(Dir.pwd, 'maze_output')
+  maze_output_zip = File.join(Dir.pwd, 'maze_output.zip')
+  # zip a folder with files and subfolders
+  Zip::File.open(maze_output_zip, Zip::File::CREATE) do |zipfile|
+    Dir["#{maze_output}/**/**"].each do |file|
+      zipfile.add(file.sub(Dir.pwd + '/', ''), file)
+    end
+  end
 
   metrics = Maze::MetricsProcessor.new(Maze::Server.metrics)
   metrics.process

data/lib/maze/client/appium/bs_devices.rb

@@ -108,7 +108,6 @@ module Maze
             add_android 'Samsung Galaxy A8', '7.1', hash                      # ANDROID_7_1_SAMSUNG_GALAXY_A8
             add_android 'Samsung Galaxy Note 8', '7.1', hash                  # ANDROID_7_1_SAMSUNG_GALAXY_NOTE_8
             add_android 'Samsung Galaxy S8', '7.0', hash                      # ANDROID_7_0_SAMSUNG_GALAXY_S8
-            add_android 'Samsung Galaxy S8 Plus', '7.0', hash                 # ANDROID_7_0_SAMSUNG_GALAXY_S8_PLUS
 
             # Specific iOS devices
             add_ios 'iPhone 14 Plus', '16.0', hash                            # IOS_16_0_IPHONE_14_PLUS

data/lib/maze/client/selenium/bs_browsers.yml

@@ -161,7 +161,7 @@ android_6:
 
 android_7:
   browserName: "Android Browser"
-  device: "Samsung Galaxy S8 Plus"
+  device: "Samsung Galaxy S8"
   os: "android"
   osVersion: "7.0"
   realMobile: true

data/lib/maze/schemas/trace_validator.rb

@@ -5,6 +5,11 @@ require_relative '../helper'
 module Maze
   module Schemas
 
+    HEX_STRING_16 = '^[A-Fa-f0-9]{16}$'
+    HEX_STRING_32 = '^[A-Fa-f0-9]{32}$'
+    SAMPLING_HEADER_ENTRY = '((1(.0)?|0(\.[0-9]+)?):[0-9]+)'
+    SAMPLING_HEADER = "^#{SAMPLING_HEADER_ENTRY}(;#{SAMPLING_HEADER_ENTRY})*$"
+
     # Contains a set of pre-defined validations for ensuring traces are correct
     class TraceValidator
 
@@ -15,9 +20,10 @@ module Maze
 
       # Creates the validator
       #
-      #   @param body [Hash] The body of the trace to validate
-      def initialize(body)
-        @body = body
+      #   @param request [Hash] The trace request to validate
+      def initialize(request)
+        @headers = request[:request].header
+        @body = request[:body]
         @success = nil
         @errors = []
       end
@@ -26,8 +32,9 @@ module Maze
       def validate
         @success = true
 
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.spanId', '^[A-Fa-f0-9]{16}$')
-        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.traceId', '^[A-Fa-f0-9]{32}$')
+        validate_headers
+        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.spanId', HEX_STRING_16)
+        regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.traceId', HEX_STRING_32)
         element_int_in_range('resourceSpans.0.scopeSpans.0.spans.0.kind', 0..5)
         regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.startTimeUnixNano', '^[0-9]+$')
         regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.endTimeUnixNano', '^[0-9]+$')
@@ -40,6 +47,49 @@ module Maze
         )
       end
 
+      def validate_header(name)
+        value = @headers[name]
+        if value.nil? || value.size > 1
+          @errors << "Expected exactly one value for header #{name}, received #{value || 'nil'}"
+        else
+          yield value[0]
+        end
+      end
+
+      # Checks that the required headers are present and correct
+      def validate_headers
+        # API key
+        validate_header('bugsnag-api-key') do |api_key|
+          expected = Regexp.new(HEX_STRING_32)
+          unless expected.match(api_key)
+            @success = false
+            @errors << "bugsnag-api-key header was expected to match the regex '#{HEX_STRING_32}', but was '#{api_key}'"
+          end
+        end
+
+        # Bugsnag-Sent-at
+        validate_header('bugsnag-sent-at') do |date|
+          begin
+            Date.iso8601(date)
+          rescue Date::Error
+            @success = false
+            @errors << "bugsnag-sent-at header was expected to be an IOS 8601 date, but was '#{date}'"
+          end
+        end
+
+        # Bugsnag-Span-Sampling
+        # of the format x:y where x is a decimal between 0 and 1 (inclusive) and y is the number of spans in the batch (if possible at this stage - we could weaken this if necessary)
+        validate_header('bugsnag-span-sampling') do |sampling|
+          begin
+            expected = Regexp.new(SAMPLING_HEADER)
+            unless expected.match(sampling)
+              @success = false
+              @errors << "bugsnag-span-sampling header was expected to match the regex '#{SAMPLING_HEADER}', but was '#{sampling}'"
+            end
+          end
+        end
+      end
+
       def regex_comparison(path, regex)
         element_value = Maze::Helper.read_key_path(@body, path)
         expected = Regexp.new(regex)

data/lib/maze/schemas/validator.rb

@@ -49,7 +49,7 @@ module Maze
 
           if validator_class
             validators = list.all.map do |request|
-              validator = validator_class.new(request[:body])
+              validator = validator_class.new(request)
               validator.validate
               validator
             end

data/lib/maze.rb

@@ -7,7 +7,7 @@ require_relative 'maze/timers'
 # Glues the various parts of MazeRunner together that need to be accessed globally,
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
-  VERSION = '8.2.0'
+  VERSION = '8.3.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.3.0
 platform: ruby
 authors:
 - Steve Kirkland
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -347,6 +347,7 @@ files:
 - lib/features/steps/breadcrumb_steps.rb
 - lib/features/steps/browser_steps.rb
 - lib/features/steps/build_api_steps.rb
+- lib/features/steps/deprecated_steps.rb
 - lib/features/steps/document_server_steps.rb
 - lib/features/steps/error_reporting_steps.rb
 - lib/features/steps/feature_flag_steps.rb
@@ -446,11 +447,11 @@ files:
 - lib/maze/wait.rb
 - lib/utils/deep_merge.rb
 - lib/utils/selenium_money_patch.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -466,7 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Bugsnag API request validation harness
 test_files: []