bugsnag-maze-runner 6.27.0 → 7.22.1

data/lib/maze/servlets/base_servlet.rb

@@ -11,11 +11,16 @@ module Maze
       # @param response [HTTPResponse] The response to return
       def do_OPTIONS(request, response)
         response.header['Access-Control-Allow-Origin'] = '*'
-        response.header['Access-Control-Allow-Headers'] = %w[Accept
-                                                             Bugsnag-Api-Key Bugsnag-Integrity
-                                                             Bugsnag-Payload-Version
-                                                             Bugsnag-Sent-At Content-Type
-                                                             Origin].join(',')
+        response.header['Access-Control-Allow-Headers'] = %w[
+          Accept
+          Bugsnag-Api-Key
+          Bugsnag-Integrity
+          Bugsnag-Payload-Version
+          Bugsnag-Sent-At
+          Bugsnag-Span-Sampling
+          Content-Type
+          Origin
+        ].join(',')
       end
     end
   end

data/lib/maze/servlets/command_servlet.rb

@@ -16,14 +16,15 @@ module Maze
         response.header['Access-Control-Allow-Origin'] = '*'
 
         commands = Maze::Server.commands
-        # Note that empty? is not the same as size == 0 (design bug to be corrected in v7)
-        if commands.size == 0
-          response.body = 'No commands to provide'
-          response.status = 400
+
+        if commands.size_remaining == 0
+          response.body = '{"action": "noop", "message": "No commands queued"}'
+          response.status = 200
         else
           command = commands.current
-          command[:uuid] = Maze::Server.command_uuid
-          response.body = JSON.pretty_generate(command)
+          command_json = JSON.pretty_generate(command)
+          command[:uuid] = Maze.run_uuid
+          response.body = command_json
           response.status = 200
           commands.next
         end
@@ -37,8 +38,10 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
     end
   end
 end
+
+

data/lib/maze/servlets/log_servlet.rb

@@ -27,7 +27,7 @@ module Maze
         @requests.add(hash)
 
         response.header['Access-Control-Allow-Origin'] = '*'
-        response.status = Server.status_code
+        response.status = Server.status_code('POST')
       rescue JSON::ParserError => e
         msg = "Unable to parse request as JSON: #{e.message}"
         $logger.error msg
@@ -57,7 +57,7 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
     end
   end

data/lib/maze/servlets/reflective_servlet.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'rack'
 
 module Maze
   module Servlets
@@ -7,7 +8,7 @@ module Maze
     # - status - HTTP response code
     # For GET requests these are expected to passed as GET parameters,
     # for POST requests they are expected to be given as JSON fields.
-    class ReflectiveServlet < WEBrick::HTTPServlet::AbstractServlet
+    class ReflectiveServlet < BaseServlet
 
       # Accepts a GET request to provide a reflective response to.
       #
@@ -26,17 +27,17 @@ module Maze
       def do_POST(request, response)
 
         content_type = request['Content-Type']
-        unless content_type == 'application/json'
-          msg = "Content-Type '#{content_type}' not supported - only application/json is supported at present"
-          $logger.error msg
-          response.status = 415
-          response.body = msg
-          return
-        end
 
-        body = JSON.parse(request.body)
-        delay_ms = body['delay_ms']
-        status = body['status']
+        # For JSON, pull the instructions from the body.  Otherwise, take them from the query string.
+        if content_type == 'application/json'
+          body = JSON.parse(request.body)
+          delay_ms = body['delay_ms']
+          status = body['status']
+        else
+          query = Rack::Utils.parse_nested_query(request.query_string)
+          delay_ms = query['delay_ms']
+          status = query['status']
+        end
 
         reflect response, delay_ms, status
       rescue JSON::ParserError => e

data/lib/maze/servlets/servlet.rb

@@ -1,18 +1,45 @@
 # frozen_string_literal: true
 
+require 'zlib'
+require 'stringio'
+require 'json_schemer'
+require 'delegate'
+
 module Maze
+  class HttpRequest < SimpleDelegator
+    def body
+      @body ||= decode_body
+    end
+
+    private
+
+    def decode_body
+      delegate = __getobj__
+      if %r{^gzip$}.match(delegate['Content-Encoding'])
+        gz_element = Zlib::GzipReader.new(StringIO.new(delegate.body))
+        gz_element.read
+      else
+        delegate.body
+      end
+    end
+  end
+
   module Servlets
 
     # Receives and parses the requests and payloads sent from the test fixture
     class Servlet < BaseServlet
+      prepend RequestRepeater
+
       # Constructor
       #
       # @param server [HTTPServer] WEBrick HTTPServer
       # @param request_type [Symbol] Request type that the servlet will receive
-      def initialize(server, request_type)
+      # @param schema [Dictionary] A `json-schema` describing the payload for POST requests
+      def initialize(server, request_type, schema=nil)
         super server
         @request_type = request_type
         @requests = Server.list_for request_type
+        @schema = JSONSchemer.schema(schema) unless schema.nil?
       end
 
       # Logs an incoming GET WEBrick request.
@@ -30,9 +57,11 @@ module Maze
       # @param request [HTTPRequest] The incoming GET request
       # @param response [HTTPResponse] The response to return
       def do_POST(request, response)
-        log_request(request)
-        case request['Content-Type']
-        when %r{^multipart/form-data; boundary=([^;]+)}
+        # Turn the WEBrick HttpRequest into our internal HttpRequest delegate
+        request = HttpRequest.new(request)
+
+        content_type = request['Content-Type']
+        if %r{^multipart/form-data; boundary=([^;]+)}.match(content_type)
           boundary = WEBrick::HTTPUtils::dequote($1)
           body = WEBrick::HTTPUtils.parse_form_data(request.body, boundary)
           hash = {
@@ -50,6 +79,10 @@ module Maze
             digests: digests
           }
         end
+        if @schema
+          schema_errors = @schema.validate(hash[:body])
+          hash[:schema_errors] = schema_errors.to_a
+        end
         @requests.add(hash)
 
         # For the response, delaying if configured to do so
@@ -58,8 +91,8 @@ module Maze
           $logger.info "Waiting #{response_delay_ms} milliseconds before responding"
           sleep response_delay_ms / 1000.0
         end
-        response.header['Access-Control-Allow-Origin'] = '*'
-        response.status = Server.status_code
+        set_response_header response.header
+        response.status = Server.status_code('POST')
       rescue JSON::ParserError => e
         msg = "Unable to parse request as JSON: #{e.message}"
         if Maze.config.captured_invalid_requests.include? @request_type
@@ -89,6 +122,10 @@ module Maze
         end
       end
 
+      def set_response_header(header)
+        header['Access-Control-Allow-Origin'] = '*'
+      end
+
       # Logs and returns a set of valid headers for this servlet.
       #
       # @param request [HTTPRequest] The incoming GET request
@@ -97,7 +134,7 @@ module Maze
         super
 
         response.header['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
-        response.status = Server.status_code
+        response.status = Server.status_code('OPTIONS')
       end
 
       private
@@ -116,8 +153,10 @@ module Maze
           body = WEBrick::HTTPUtils.parse_form_data(request.body, boundary)
           $logger.debug 'BODY:'
           LogUtil.log_hash(Logger::Severity::DEBUG, body)
-        else
+        when %r{^application/json$}
           $logger.debug "BODY: #{JSON.pretty_generate(JSON.parse(request.body))}"
+        else
+          $logger.debug "BODY: #{request.body}"
         end
       end
 

data/lib/maze/servlets/trace_servlet.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Maze
+  module Servlets
+    class TraceServlet < Servlet
+      def set_response_header(header)
+        super
+        value = Maze::Server.sampling_probability
+        header['Bugsnag-Sampling-Probability'] =  value unless value == 'null'
+      end
+    end
+  end
+end

data/lib/maze.rb

@@ -7,10 +7,10 @@ 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 = '6.27.0'
+  VERSION = '7.22.1'
 
   class << self
-    attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry
+    attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address, :run_uuid
 
     def config
       @config ||= Maze::Configuration.new

data/lib/utils/deep_merge.rb

@@ -0,0 +1,17 @@
+class Hash
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+end

data/lib/utils/selenium_money_patch.rb

@@ -0,0 +1,17 @@
+# Log the full response so we see more than just the error code
+module Selenium
+  module WebDriver
+    module Error
+      class ServerError < StandardError
+        def initialize(response)
+          if response.is_a? String
+            super(response)
+          else
+            $logger.error "Server response: #{response.inspect}"
+            super("status code #{response.code}")
+          end
+        end
+      end # ServerError
+    end # Error
+  end # WebDriver
+end # Selenium

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 6.27.0
+  version: 7.22.1
 platform: ruby
 authors:
 - Steve Kirkland
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: 12.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: appium_lib_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bugsnag
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +193,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 0.2.24
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: 0.2.24
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +290,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 description: Automation steps and mock server to validaterequest payloads response.
 email:
 - steve@bugsnag.com
@@ -288,39 +344,56 @@ files:
 - lib/features/steps/request_assertion_steps.rb
 - lib/features/steps/runner_steps.rb
 - lib/features/steps/session_tracking_steps.rb
+- lib/features/steps/trace_steps.rb
 - lib/features/steps/value_steps.rb
 - lib/features/support/env.rb
 - lib/features/support/internal_hooks.rb
 - lib/maze.rb
+- lib/maze/api/appium/file_manager.rb
 - lib/maze/appium_server.rb
 - lib/maze/assertions/request_set_assertions.rb
 - lib/maze/aws/sam.rb
-- lib/maze/bitbar_devices.rb
-- lib/maze/bitbar_utils.rb
-- lib/maze/browser_stack_devices.rb
-- lib/maze/browser_stack_utils.rb
-- lib/maze/browsers_bs.yml
-- lib/maze/browsers_cbt.yml
+- lib/maze/aws_public_ip.rb
 - lib/maze/bugsnag_config.rb
-- lib/maze/capabilities.rb
 - lib/maze/checks/assert_check.rb
 - lib/maze/checks/noop_check.rb
+- lib/maze/client/appium.rb
+- lib/maze/client/appium/base_client.rb
+- lib/maze/client/appium/bb_client.rb
+- lib/maze/client/appium/bb_devices.rb
+- lib/maze/client/appium/bs_client.rb
+- lib/maze/client/appium/bs_devices.rb
+- lib/maze/client/appium/bs_legacy_client.rb
+- lib/maze/client/appium/local_client.rb
+- lib/maze/client/bb_api_client.rb
+- lib/maze/client/bb_client_utils.rb
+- lib/maze/client/bs_client_utils.rb
+- lib/maze/client/selenium.rb
+- lib/maze/client/selenium/base_client.rb
+- lib/maze/client/selenium/bb_browsers.yml
+- lib/maze/client/selenium/bb_client.rb
+- lib/maze/client/selenium/bs_browsers.yml
+- lib/maze/client/selenium/bs_client.rb
+- lib/maze/client/selenium/local_client.rb
 - lib/maze/compare.rb
 - lib/maze/configuration.rb
 - lib/maze/docker.rb
 - lib/maze/document_server.rb
 - lib/maze/driver/appium.rb
 - lib/maze/driver/browser.rb
-- lib/maze/driver/resilient_appium.rb
 - lib/maze/errors.rb
+- lib/maze/generator.rb
 - lib/maze/helper.rb
 - lib/maze/hooks/appium_hooks.rb
 - lib/maze/hooks/browser_hooks.rb
 - lib/maze/hooks/command_hooks.rb
+- lib/maze/hooks/error_code_hook.rb
 - lib/maze/hooks/hooks.rb
+- lib/maze/http_request.rb
 - lib/maze/interactive_cli.rb
 - lib/maze/logger.rb
 - lib/maze/macos_utils.rb
+- lib/maze/maze_output.rb
 - lib/maze/network.rb
 - lib/maze/option.rb
 - lib/maze/option/parser.rb
@@ -328,28 +401,35 @@ files:
 - lib/maze/option/validator.rb
 - lib/maze/plugins/bugsnag_reporting_plugin.rb
 - lib/maze/plugins/cucumber_report_plugin.rb
+- lib/maze/plugins/error_code_plugin.rb
 - lib/maze/plugins/global_retry_plugin.rb
 - lib/maze/proxy.rb
 - lib/maze/request_list.rb
+- lib/maze/request_repeater.rb
 - lib/maze/retry_handler.rb
 - lib/maze/runner.rb
-- lib/maze/sauce_labs_utils.rb
+- lib/maze/schemas/OtelTraceSchema.json
+- lib/maze/schemas/trace_schema.rb
+- lib/maze/schemas/trace_validator.rb
 - lib/maze/server.rb
 - lib/maze/servlets/base_servlet.rb
 - lib/maze/servlets/command_servlet.rb
 - lib/maze/servlets/log_servlet.rb
 - lib/maze/servlets/reflective_servlet.rb
 - lib/maze/servlets/servlet.rb
-- lib/maze/smart_bear_utils.rb
+- lib/maze/servlets/temp.rb
+- lib/maze/servlets/trace_servlet.rb
 - lib/maze/store.rb
 - lib/maze/terminating_server.rb
 - lib/maze/timers.rb
 - lib/maze/wait.rb
-homepage: 
+- lib/utils/deep_merge.rb
+- lib/utils/selenium_money_patch.rb
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -365,7 +445,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: []

data/lib/maze/bitbar_devices.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-require 'json'
-
-module Maze
-  # Provides a source of capabilities used to run tests against specific BitBar devices
-  # noinspection RubyStringKeysInHashInspection
-  class BitBarDevices
-    APPIUM_1_9_1 = '1.9.1'
-    APPIUM_1_15_0 = '1.15.0'
-    APPIUM_1_20_2 = '1.20.2'
-
-    BASE_URI = 'https://cloud.bitbar.com/api/v2/me'
-    FILTER_PATH = 'devices/filters'
-
-    DEVICE_GROUP_IDS = {
-      # Classic, non-specific devices for each Android version
-      'ANDROID_10_0' => '46024',
-
-      # iOS devices
-      'IOS_14' => '46025'
-    }
-
-    class << self
-      def call_bitbar_api(path, query, api_key)
-        encoded_query = URI.encode_www_form(query)
-        uri = URI("#{BASE_URI}/#{path}?#{encoded_query}")
-        request = Net::HTTP::Get.new(uri)
-        request.basic_auth(api_key, '')
-
-        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-          http.request(request)
-        end
-
-        JSON.parse(res.body)
-      end
-
-      def get_filtered_device_name(device_group_id, api_key)
-        path = "device-groups/#{device_group_id}/devices"
-        query = {
-          'filter': "online_eq_true"
-        }
-        all_devices = call_bitbar_api(path, query, api_key)
-        filtered_devices = all_devices['data'].reject { |device| device['locked'] }
-        filtered_devices.first['displayName']
-      end
-
-      def get_device(device_group, platform, platform_version, api_key)
-        device_group_id = DEVICE_GROUP_IDS[device_group]
-        device_name = get_filtered_device_name(device_group_id, api_key)
-        case platform.downcase
-        when 'android'
-          automation_name = 'UiAutomator1' if platform_version.start_with?('5')
-          make_android_hash(device_name, nil, automation_name)
-        when 'ios'
-          make_ios_hash(device_name)
-        else
-          throw "Invalid device platform specified #{platform}"
-        end
-      end
-
-      def make_android_hash(device, appium_version = nil, automation_name = nil)
-        hash = {
-          'platformName' => 'Android',
-          'bitbar_device' => device,
-          'bitbar_target' => 'android',
-          'deviceName' => 'Android Phone'
-        }
-        hash['bitbar_appiumVersion'] = appium_version if appium_version
-        hash['automationName'] = automation_name if automation_name
-        hash.freeze
-      end
-
-      def make_ios_hash(device)
-        {
-          'platformName' => 'iOS',
-          'bitbar_device' => device,
-          'bitbar_target' => 'ios',
-          'deviceName' => 'iPhone device',
-          'automationName' => 'XCUITest'
-        }.freeze
-      end
-    end
-  end
-end