bugsnag-maze-runner 9.3.1 → 9.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27ea68dc346c2a0f579cc5469176bb972b410df5c45cb033d133b872c6ececb
-  data.tar.gz: d9b56d5caa14ddf01e612e578fcc778cc522ef64dc7e92f2fcf1d343edd0ef00
+  metadata.gz: ae769213765ead600bb5d24630e7ee9e64cb9cd4a0af662d907254aad577b325
+  data.tar.gz: '08c6383f74a282fc41e04e5d12828ca27506da7205bbc979992794edc468c242'
 SHA512:
-  metadata.gz: 4ed30e0eaa84c7a257b39738b59c9d07199bd6f0d11216964f543f5df2624cb085d70ce653df94e6140577d68cfac03bac9c11526e876c1f70a83b8626cc9fb1
-  data.tar.gz: 7c435daa612fb2b91802757845ac706a70ca78fcd84d3d991a71d10ea4e2725e3985956ba5d65f77cd6edcf73a7ea3ad57475ce1fd49771d95474e9a7029d98b
+  metadata.gz: 995669002344c3dd20206512b9a3cd1efa17db026d2355b5db6f0e1e5b4f4911113b13f2366919468acf5ff5c9d49361e143bfa918596f08a406c78a4ea4cc40
+  data.tar.gz: 7bf1354e0233fc6f760bb2b6fa35827cb597cb005f3d80ee3f2f9182c3379186817fb5dca4bf248d6c65eaa83b4bd43282164e858e9b437ed1629deb4bf39b64

data/lib/features/steps/request_assertion_steps.rb

@@ -149,3 +149,17 @@ Then('the received errors match:') do |table|
   end
   Maze.check.equal(requests.size, match_count, 'Unexpected number of requests matched the received payloads')
 end
+
+# Verifies that a request was sent via a given method.
+# Currently only supported with the reflective servlet.
+#
+# @step_input request_type [String] The type of request (error, session, build, etc)
+# @step_input method [String] The request method expected (GET, POST, etc)
+Then('the {request_type} request method equals {string}') do |request_type, method|
+  list = Maze::Server.list_for(request_type)
+  payload = list.current
+  if payload[:method].nil?
+    raise Test::Unit::AssertionFailedError.new("#{request_type} request had no receipt method listed")
+  end
+  Maze.check.equal(method, payload[:method], "Expected #{request_type} request method to be #{method}")
+end

data/lib/features/support/cucumber_types.rb

@@ -1,6 +1,6 @@
 ParameterType(
   name:        'request_type',
-  regexp:      /errors?|sessions?|builds?|logs?|metrics?|sampling requests?|traces?|uploads?|sourcemaps?|invalid requests?/,
+  regexp:      /errors?|sessions?|builds?|logs?|metrics?|sampling requests?|traces?|uploads?|sourcemaps?|reflects?|reflections?|invalid requests?/,
   type:        String,
   transformer: ->(s) { s }
 )

data/lib/features/support/internal_hooks.rb

@@ -95,8 +95,8 @@ InstallPlugin do |config|
   # Add step logging
   config.filters << Maze::Plugins::LoggingScenariosPlugin.new(config)
 
-  # TODO: Reporting of test failures as errors deactivated pending PLAT-10963
-  #config.filters << Maze::Plugins::BugsnagReportingPlugin.new(config)
+  # Add bugsnag failed scenario reporting only if ENV['MAZE_SCENARIO_BUGSNAG_API_KEY'] is present
+  config.filters << Maze::Plugins::BugsnagReportingPlugin.new(config) unless ENV['MAZE_SCENARIO_BUGSNAG_API_KEY'].nil?
 end
 
 # Before each scenario

data/lib/maze/api/exit_code.rb

@@ -12,6 +12,8 @@ module Maze
       TUNNEL_FAILURE = 101
       SESSION_CREATION_FAILURE = 102
       APPIUM_SESSION_FAILURE = 103
+      # A catch-all for certain errors related to Appium failures when the app is running app hang or ANR tests
+      APPIUM_APP_HANG_FAILURE = 104
     end
   end
 end

data/lib/maze/bugsnag_config.rb

@@ -11,7 +11,6 @@ module Maze
         Bugsnag.configure do |config|
           config.api_key = ENV['MAZE_BUGSNAG_API_KEY']
           config.app_version = Maze::VERSION
-          config.discard_classes << 'Test::Unit::AssertionFailedError'
           config.add_metadata(:'test driver', {
             'driver type': Maze.driver.class,
             'device farm': Maze.config.farm,
@@ -32,6 +31,7 @@ module Maze
               metadata['job url'] = ENV['BUILDKITE_BUILD_URL'] + "#" + ENV['BUILDKITE_JOB_ID']
             end
           end
+          config.middleware.use(AssertErrorMiddleware)
           config.add_metadata(:'buildkite', metadata)
           config.project_root = Dir.pwd
         end
@@ -45,5 +45,27 @@ module Maze
         end
       end
     end
+
+    class AssertErrorMiddleware
+      IGNORE_CLASS_NAME = 'Test::Unit::AssertionFailedError'
+
+      # @param middleware [#call] The next middleware to call
+      def initialize(middleware)
+        @middleware = middleware
+      end
+
+      def call(report)
+        # Only ignore automated notifies with assertion errors
+        automated = report.unhandled
+
+        class_match = report.raw_exceptions.any? do |ex|
+          ex.class.name.eql?(IGNORE_CLASS_NAME)
+        end
+
+        report.ignore! if automated && class_match
+
+        @middleware.call(report)
+      end
+    end
   end
 end

data/lib/maze/maze_output.rb

@@ -13,7 +13,7 @@ module Maze
       path = output_folder
       FileUtils.makedirs(path)
 
-      request_types = %w[errors sessions builds uploads logs sourcemaps traces invalid]
+      request_types = %w[errors sessions builds uploads logs sourcemaps traces invalid reflections]
       request_types << 'sampling requests'
 
       request_types.each do |request_type|
@@ -51,6 +51,11 @@ module Maze
             end
             file.puts
 
+            if request.include?(:query)
+              file.puts "Query:"
+              file.puts JSON.pretty_generate(request[:query])
+            end
+
             file.puts "Request body:"
             if !invalid_request && headers["content-type"].first == 'application/json'
               file.puts JSON.pretty_generate(body)

data/lib/maze/option/parser.rb

@@ -42,7 +42,7 @@ module Maze
                 default: true
 
             opt Option::BUGSNAG,
-                'Enables reporting to Bugsnag on scenario failure (requires MAZE_BUGSNAG_API_KEY)',
+                'Enables reporting to Bugsnag on scenario failure (requires MAZE_BUGSNAG_API_KEY for errors, MAZE_SCENARIO_BUGSNAG_API_KEY for test failures)',
                 type: :boolean,
                 short: :none,
                 default: true

data/lib/maze/plugins/bugsnag_reporting_plugin.rb

@@ -25,6 +25,9 @@ module Maze
           next unless event.test_case.eql?(test_case) && event.result.failed?
 
           Bugsnag.notify(event.result.exception) do |bsg_event|
+
+            bsg_event.api_key = ENV['MAZE_SCENARIO_BUGSNAG_API_KEY']
+
             unless @last_test_step.nil?
 
               repo = ENV['BUILDKITE_PIPELINE_SLUG']

data/lib/maze/server.rb

@@ -93,6 +93,8 @@ module Maze
           uploads
         when 'sourcemap', 'sourcemaps'
           sourcemaps
+        when 'reflect', 'reflects', 'reflection', 'reflections'
+          reflections
         when 'invalid', 'invalid requests'
           invalid_requests
         else
@@ -163,6 +165,13 @@ module Maze
         @metrics ||= RequestList.new
       end
 
+      # A list of reflection requests received
+      #
+      # @return [RequestList] Received reflection requests
+      def reflections
+        @reflections ||= RequestList.new
+      end
+
       # A list of commands for a test fixture to perform.  Strictly speaking these are responses to HTTP
       # requests, but the list behavior is all we need.
       #
@@ -272,6 +281,7 @@ module Maze
         traces.clear
         logs.clear
         invalid_requests.clear
+        reflections.clear
       end
     end
   end

data/lib/maze/servlets/reflective_servlet.rb

@@ -11,6 +11,8 @@ module Maze
     # for POST requests they are expected to be given as JSON fields.
     class ReflectiveServlet < BaseServlet
 
+      REFLECTION_REQUEST_TYPE = 'reflection'
+
       # Accepts a GET request to provide a reflective response to.
       #
       # @param request [HTTPRequest] The incoming GET request
@@ -18,6 +20,16 @@ module Maze
       def do_GET(request, response)
         delay_ms = request.query['delay_ms']
         status = request.query['status']
+
+        logged_request = {
+          body: {},
+          query: Rack::Utils.parse_nested_query(request.query_string),
+          request: request,
+          response: response,
+          method: 'GET'
+        }
+        Server.list_for(REFLECTION_REQUEST_TYPE).add(logged_request)
+
         reflect response, delay_ms, status
       end
 
@@ -36,10 +48,20 @@ module Maze
           status = body['status']
         else
           query = Rack::Utils.parse_nested_query(request.query_string)
+          body = {}
           delay_ms = query['delay_ms']
           status = query['status']
         end
 
+        logged_request = {
+          body: body,
+          request: request,
+          response: response,
+          method: 'POST'
+        }
+        logged_request[:query] = query if query
+        Server.list_for(REFLECTION_REQUEST_TYPE).add(logged_request)
+
         reflect response, delay_ms, status
       rescue JSON::ParserError => e
         Bugsnag.notify e

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 = '9.3.1'
+  VERSION = '9.5.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: 9.3.1
+  version: 9.5.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber