bugsnag-maze-runner 7.26.1 → 7.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f329df5934008d114f663a224e93592bc7d785024e20d0b015771abc1ca027
-  data.tar.gz: c566d0a2aaccaf1bfe36107290ffd8519d777a7c9e5dbe77769a1674dd751e6e
+  metadata.gz: 4a074f231fdb2489046d9e6ad85f601239d3375edbbffe7de28ad862bc66a881
+  data.tar.gz: afe8771d431a5988986ad0ae5982f24c866436eb10edc95afb81af5fb5d2b0a7
 SHA512:
-  metadata.gz: e8fadbe837d32d0f8804c168eadf175aa6b0e1a3448d3072243ff25f8b0c64933a1b00edacf24c22de9bf4aa607e328cfa0351d94010c1a688ca612d347c9411
-  data.tar.gz: e7eb8c09b447af8b4b473a28b80b023a70dcf31100ea1d9fb0677f9c52a4322156f289eb102751be282cbdac47b451a7ba63490595fd98fe30bad3c8fa6e5170
+  metadata.gz: 1091d4188d165f6d1122a5a2a0275eda1ed818a550bf953c9a826f84950691ca86674bda0e11a007260a45742665c3d52630c614f1705daf88dc6ff86dec0b82
+  data.tar.gz: 59ec8f4f08c75411e9766c4379b841f39d1a7f3dc9f02988231fc99c229fb7affe226145f86499860a3b005cf2be9261fc0f6a8eea6151ead2515ef7c27b3e96

data/bin/maze-runner

@@ -58,6 +58,7 @@ require_relative '../lib/maze/assertions/request_set_assertions'
 
 require_relative '../lib/maze/schemas/trace_schema'
 require_relative '../lib/maze/schemas/trace_validator'
+require_relative '../lib/maze/schemas/validator'
 
 require_relative '../lib/maze/store'
 require_relative '../lib/maze/timers'

data/lib/features/steps/request_assertion_steps.rb

@@ -31,60 +31,6 @@ def assert_received_requests(request_count, list, list_name, precise = true)
   else
     Maze.check.operator(request_count, :<=, list.size_remaining, "#{list.size_remaining} #{list_name} received")
   end
-
-  verify_schema_matches(list, list_name)
-  validate_payload_elements(list, list_name)
-end
-
-def verify_schema_matches(list, list_name)
-  request_schema_results = list.all.map { |request| request[:schema_errors] }
-  passed = true
-  request_schema_results.each.with_index(1) do |schema_errors, index|
-    next if schema_errors.nil?
-    if schema_errors.size > 0
-      passed = false
-      $stdout.puts "\n"
-      $stdout.puts "\e[31m--- #{list_name} #{index} failed validation with errors at the following locations:\e[0m"
-      schema_errors.each do |error|
-        $stdout.puts "\e[31m#{error["data_pointer"]} failed to match #{error["schema_pointer"]}\e[0m"
-      end
-      $stdout.puts "\n"
-    end
-  end
-
-  unless passed
-    raise Test::Unit::AssertionFailedError.new 'The received payloads did not match the endpoint schema.  A full list of the errors can be found above'
-  end
-end
-
-def validate_payload_elements(list, list_name)
-  validator_class = case list_name
-  when 'trace', 'traces'
-    Maze::Schemas::TraceValidator
-  else
-    nil
-  end
-
-  if validator_class
-    validators = list.all.map do |request|
-      validator = validator_class.new(request[:body])
-      validator.validate
-      validator
-    end
-
-    return if validators.all? { |validator| validator.success }
-    validators.each.with_index(1) do |validator, index|
-      unless validator.success
-        $stdout.puts "\n"
-        $stdout.puts "\e[31m--- #{list_name} #{index} failed validation with the following errors:\e[0m"
-        validator.errors.each do |error|
-          $stdout.puts "\e[31m#{error}\e[0m"
-        end
-        $stdout.puts "\n"
-      end
-    end
-    raise Test::Unit::AssertionFailedError.new("One or more #{list_name} payloads failed validation.  A full list of the errors can be found above")
-  end
 end
 
 #

data/lib/features/steps/trace_steps.rb

@@ -255,6 +255,9 @@ def assert_received_spans(span_count, list)
   end
 
   Maze.check.operator(span_count, :<=, received_count, "#{received_count} spans received")
+
+  Maze::Schemas::Validator.verify_against_schema(list, 'trace')
+  Maze::Schemas::Validator.validate_payload_elements(list, 'trace')
 end
 
 def get_attribute_value(field, attribute, attr_type)

data/lib/features/support/internal_hooks.rb

@@ -44,12 +44,6 @@ BeforeAll do
   Maze.run_uuid = SecureRandom.uuid
   $logger.info "UUID for this run: #{Maze.run_uuid}"
 
-  # Determine public IP if enabled
-  if Maze.config.aws_public_ip
-    Maze.public_address = Maze::AwsPublicIp.new.address
-    $logger.info "Public address: #{Maze.public_address}"
-  end
-
   # Start mock server
   Maze::Server.start
   Maze::Server.set_response_delay_generator(Maze::Generator.new [Maze::Server::DEFAULT_RESPONSE_DELAY].cycle)
@@ -66,6 +60,18 @@ BeforeAll do
   # This must happen after any client hooks have run, so that they can set the server root
   Maze::DocumentServer.start unless Maze.config.document_server_root.nil?
 
+  # Determine public IP if enabled
+  if Maze.config.aws_public_ip
+    public_ip = Maze::AwsPublicIp.new
+    Maze.public_address = public_ip.address
+    $logger.info "Public address: #{Maze.public_address}"
+
+    unless Maze.config.document_server_root.nil?
+      Maze.public_document_server_address = public_ip.document_server_address
+      $logger.info "Public document server address: #{Maze.public_document_server_address}"
+    end
+  end
+
   # An initial setup for total success status
   $success = true
 end
@@ -186,6 +192,15 @@ After do |scenario|
   end
 end
 
+# Test all requests against schemas or extra validation rules.  These will only run if the schema/validation is
+# specified for the specific endpoint
+After do |scenario|
+  ['error', 'session', 'build', 'trace'].each do |endpoint|
+    Maze::Schemas::Validator.verify_against_schema(Maze::Server.list_for(endpoint), endpoint)
+    Maze::Schemas::Validator.validate_payload_elements(Maze::Server.list_for(endpoint), endpoint)
+  end
+end
+
 # After all tests
 AfterAll do
 

data/lib/maze/aws_public_ip.rb

@@ -1,16 +1,31 @@
 module Maze
   # Determines the public IP address and port when running on Buildkite with the Elastic CI Stack for AWS
   class AwsPublicIp
-    attr_reader :address
+    attr_reader :host
+    attr_reader :port
+    attr_reader :document_server_port
+
+    def address
+      "#{@ip}:#{@port}"
+    end
+
+    def document_server_address
+      return nil if @document_server_port.nil?
+
+      "#{@ip}:#{@document_server_port}"
+    end
 
     def initialize
       # This class is only relevant on Buildkite
       return unless ENV['BUILDKITE']
 
-      ip = determine_public_ip
-      port = determine_public_port
+      @ip = determine_public_ip
+      @port = determine_public_port Maze.config.port
+
+      unless Maze.config.document_server_root.nil?
+        @document_server_port = determine_public_port Maze.config.document_server_port
+      end
 
-      @address = "#{ip}:#{port}"
     end
 
     # Determines the public IP address of the running AWS instance
@@ -20,8 +35,9 @@ module Maze
       `curl --silent -XGET http://169.254.169.254/latest/meta-data/public-ipv4`
     end
 
-    # Determines the external port of the running Docker container that's associated with the port of the mock server
-    def determine_public_port
+    # Determines the external port of the running Docker container that's associated with the port given
+    # @param local_port Local port to find the external port for
+    def determine_public_port(local_port)
       port = 0
       count = 0
       max_attempts = 30
@@ -35,7 +51,7 @@ module Maze
           begin
             json_string = result[0][0].strip
             json_result = JSON.parse(json_string)
-            port = json_result['NetworkSettings']['Ports']["#{Maze.config.port}/tcp"][0]['HostPort']
+            port = json_result['NetworkSettings']['Ports']["#{local_port}/tcp"][0]['HostPort']
           rescue StandardError
             $logger.error "Unable to parse public port from: #{json_string}"
             return 0

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

@@ -6,7 +6,7 @@ module Maze
           config = Maze.config
           config.app = Maze::Client::BitBarClientUtils.upload_app config.access_key,
                                                                   config.app
-          if Maze.config.start_tunnel
+          if Maze::Client::BitBarClientUtils.use_local_tunnel?
             Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
                                                                config.username,
                                                                config.access_key
@@ -61,7 +61,7 @@ module Maze
 
         def stop_session
           super
-          if Maze.config.start_tunnel
+          if Maze::Client::BitBarClientUtils.use_local_tunnel?
             Maze::Client::BitBarClientUtils.stop_local_tunnel
           end
         end

data/lib/maze/client/bb_client_utils.rb

@@ -123,6 +123,10 @@ module Maze
           end
         end
 
+        def use_local_tunnel?
+          Maze.config.start_tunnel && !Maze.config.aws_public_ip
+        end
+
         # Starts the BitBar local tunnel
         #
         # @param sb_local [String] path to the SBSecureTunnel binary

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

@@ -19,34 +19,6 @@ chrome_107:
   version: '107'
   resolution: '1920x1080'
 
-chrome_106:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'chrome'
-  version: '106'
-  resolution: '1920x1080'
-
-chrome_105:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'chrome'
-  version: '105'
-  resolution: '1920x1080'
-
-chrome_104:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'chrome'
-  version: '104'
-  resolution: '1920x1080'
-
-chrome_103:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'chrome'
-  version: '103'
-  resolution: '1920x1080'
-
 chrome_72:
   platform: 'Windows'
   osVersion: '10'
@@ -131,48 +103,6 @@ edge_latest:
   version: 'latest'
   resolution: '1920x1080'
 
-edge_106:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '106'
-  resolution: '1920x1080'
-
-edge_105:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '105'
-  resolution: '1920x1080'
-
-edge_104:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '104'
-  resolution: '1920x1080'
-
-edge_103:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '103'
-  resolution: '1920x1080'
-
-edge_102:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '102'
-  resolution: '1920x1080'
-
-edge_101:
-  platform: 'Windows'
-  osVersion: '11'
-  browserName: 'MicrosoftEdge'
-  version: '101'
-  resolution: '1920x1080'
-
 safari_16:
   platform: 'macOS'
   osVersion: '13'

data/lib/maze/client/selenium/bb_client.rb

@@ -4,11 +4,6 @@ module Maze
       class BitBarClient < BaseClient
         def start_session
           config = Maze.config
-          if ENV['BUILDKITE']
-            credentials = Maze::Client::BitBarClientUtils.account_credentials config.tms_uri
-            config.username = credentials[:username]
-            config.access_key = credentials[:access_key]
-          end
           capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
           capabilities['bitbar_apiKey'] = config.access_key
           browsers = YAML.safe_load(File.read("#{__dir__}/bb_browsers.yml"))
@@ -16,13 +11,17 @@ module Maze
           capabilities.merge! JSON.parse(config.capabilities_option)
           config.capabilities = capabilities
 
-          Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
-                                                             config.username,
-                                                             config.access_key
+          if Maze::Client::BitBarClientUtils.use_local_tunnel?
+            credentials = Maze::Client::BitBarClientUtils.account_credentials config.tms_uri
+            config.username = credentials[:username]
+            config.access_key = credentials[:access_key]
+
+            Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
+                                                               config.username,
+                                                               config.access_key
+          end
 
-          # TODO This probably needs to be settable via an environment variable
-          # selenium_url = 'https://us-west-desktop-hub.bitbar.com/wd/hub'
-          selenium_url = 'https://eu-desktop-hub.bitbar.com/wd/hub'
+          selenium_url = Maze.config.selenium_server_url
           Maze.driver = Maze::Driver::Browser.new :remote, selenium_url, config.capabilities
           Maze.driver.start_driver
         end
@@ -38,8 +37,10 @@ module Maze
 
         def stop_session
           super
-          Maze::Client::BitBarClientUtils.stop_local_tunnel
-          Maze::Client::BitBarClientUtils.release_account(Maze.config.tms_uri) if ENV['BUILDKITE']
+          if Maze::Client::BitBarClientUtils.use_local_tunnel?
+            Maze::Client::BitBarClientUtils.stop_local_tunnel
+            Maze::Client::BitBarClientUtils.release_account(Maze.config.tms_uri) if ENV['BUILDKITE']
+          end
         end
       end
     end

data/lib/maze/configuration.rb

@@ -132,6 +132,12 @@ module Maze
     # Access token for the test-management service
     attr_accessor :tms_token
 
+    # URL of the Appium server
+    attr_accessor :appium_server_url
+
+    # URL of the Selenium server
+    attr_accessor :selenium_server_url
+
     # Whether the legacy (JSON-WP) Appium driver should be used
     def legacy_driver?
       @legacy_driver
@@ -157,9 +163,6 @@ module Maze
     # Device id for running on local iOS devices
     attr_accessor :device_id
 
-    # URL of the Appium server
-    attr_accessor :appium_server_url
-
     # Whether an appium server should be started
     attr_accessor :start_appium
 

data/lib/maze/option/parser.rb

@@ -118,6 +118,15 @@ module Maze
             opt Option::TUNNEL,
                 'Start the device farm secure tunnel',
                 default: true
+            opt Option::APPIUM_SERVER,
+                "Appium server URL.  Defaults are: \n" +
+                "  --farm=local - MAZE_APPIUM_SERVER or http://localhost:4723/wd/hub\n" +
+                "  --farm=bb - MAZE_APPIUM_SERVER or https://us-west-mobile-hub.bitbar.com/wd/hub\n" +
+                'Not used for --farm=bs',
+                type: :string
+            opt Option::SELENIUM_SERVER,
+                "Selenium server URL. Only used for --farm=bb, defaulting to MAZE_SELENIUM_SERVER or https://us-west-desktop-hub.bitbar.com/wd/hub",
+                type: :string
 
             # SmartBear-only options
             opt Option::SB_LOCAL,
@@ -147,9 +156,6 @@ module Maze
             opt Option::OS_VERSION,
                 'The intended OS version when running on a local device',
                 type: :string
-            opt Option::APPIUM_SERVER,
-                'Appium server URL, only used for --farm=local. MAZE_APPIUM_SERVER env var or "http://localhost:4723/wd/hub" by default',
-                type: :string
             opt Option::START_APPIUM,
                 'Whether a local Appium server should be start.  Only used for --farm=local.',
                 default: true
@@ -222,6 +228,8 @@ module Maze
             options[Option::USERNAME] ||= ENV['BITBAR_USERNAME']
             options[Option::ACCESS_KEY] ||= ENV['BITBAR_ACCESS_KEY']
             options[Option::TMS_URI] ||= ENV['MAZE_TMS_URI']
+            options[Option::APPIUM_SERVER] ||= ENV['MAZE_APPIUM_SERVER'] || 'https://us-west-mobile-hub.bitbar.com/wd/hub'
+            options[Option::SELENIUM_SERVER] ||= ENV['MAZE_SELENIUM_SERVER'] || 'https://us-west-desktop-hub.bitbar.com/wd/hub'
           end
 
           options[Option::REPEATER_API_KEY] ||= ENV['MAZE_REPEATER_API_KEY']

data/lib/maze/option/processor.rb

@@ -97,7 +97,8 @@ module Maze
             config.os = options[Maze::Option::OS]
             config.os_version = options[Maze::Option::OS_VERSION]
             config.sb_local = Maze::Helper.expand_path(options[Maze::Option::SB_LOCAL])
-            config.appium_server_url = 'https://us-west-mobile-hub.bitbar.com/wd/hub'
+            config.appium_server_url = options[Maze::Option::APPIUM_SERVER]
+            config.selenium_server_url = options[Maze::Option::SELENIUM_SERVER]
             config.app_bundle_id = options[Maze::Option::APP_BUNDLE_ID]
           when :local then
             if options[Maze::Option::BROWSER]

data/lib/maze/option.rb

@@ -30,6 +30,8 @@ module Maze
     OS_VERSION = 'os-version'
     TUNNEL = 'tunnel'
     USERNAME = 'username'
+    APPIUM_SERVER = 'appium-server'
+    SELENIUM_SERVER = 'selenium-server'
 
     # BitBar options
     SB_LOCAL = 'sb-local'
@@ -43,7 +45,6 @@ module Maze
 
     # Local-only options
     APPIUM_LOGFILE = 'appium-logfile'
-    APPIUM_SERVER = 'appium-server'
     APPLE_TEAM_ID = 'apple-team-id'
     START_APPIUM = 'start-appium'
     UDID = 'udid'

data/lib/maze/schemas/validator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Maze
+  module Schemas
+
+    # A general entry point for running validation with schemas and other validation methods
+    class Validator
+
+      class << self
+
+        # Tests that payloads for a specific path have passed any schema checks implemented on receipt
+        # Throws an AssertionFailedError with a list of issues on failure
+        #
+        # @param list [Array] An array of received requests
+        # @param list_name [String] The name of the payload list for received requests
+        def verify_against_schema(list, list_name)
+          request_schema_results = list.all.map { |request| request[:schema_errors] }
+          passed = true
+          request_schema_results.each.with_index(1) do |schema_errors, index|
+            next if schema_errors.nil?
+            if schema_errors.size > 0
+              passed = false
+              $stdout.puts "\n"
+              $stdout.puts "\e[31m--- #{list_name} #{index} failed validation:\e[0m"
+              schema_errors.each do |error|
+                $stdout.puts "\e[31m#{JSONSchemer::Errors.pretty(error)}\e[0m"
+              end
+              $stdout.puts "\n"
+            end
+          end
+
+          unless passed
+            raise Test::Unit::AssertionFailedError.new 'The received payloads did not match the endpoint schema.  A full list of the errors can be found above'
+          end
+        end
+
+        # Tests that payloads for a specific path pass any additional validation checks
+        # Throws an AssertionFailedError with a list of issues on failure
+        #
+        # @param list [Array] An array of received requests
+        # @param list_name [String] The name of the payload list for received requests
+        def validate_payload_elements(list, list_name)
+          validator_class = case list_name
+          when 'trace', 'traces'
+            Maze::Schemas::TraceValidator
+          else
+            nil
+          end
+
+          if validator_class
+            validators = list.all.map do |request|
+              validator = validator_class.new(request[:body])
+              validator.validate
+              validator
+            end
+
+            return if validators.all? { |validator| validator.success }
+            validators.each.with_index(1) do |validator, index|
+              unless validator.success
+                $stdout.puts "\n"
+                $stdout.puts "\e[31m--- #{list_name} #{index} failed validation with the following errors:\e[0m"
+                validator.errors.each do |error|
+                  $stdout.puts "\e[31m#{error}\e[0m"
+                end
+                $stdout.puts "\n"
+              end
+            end
+            raise Test::Unit::AssertionFailedError.new("One or more #{list_name} payloads failed validation.  A full list of the errors can be found above")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 7.26.1
+  version: 7.28.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -427,6 +427,7 @@ files:
 - lib/maze/schemas/OtelTraceSchema.json
 - lib/maze/schemas/trace_schema.rb
 - lib/maze/schemas/trace_validator.rb
+- lib/maze/schemas/validator.rb
 - lib/maze/server.rb
 - lib/maze/servlets/base_servlet.rb
 - lib/maze/servlets/command_servlet.rb