bugsnag-maze-runner 7.29.0 → 7.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a557d4bf1f5d2518fef4116fe4bceecc5b28f78d585ab0926296105e5284ff49
-  data.tar.gz: 6e2c3eed0f98e66d586c64186a77917bb93aa4dbb7f2e0704ab42fa4abb05eb6
+  metadata.gz: 50ddc2b8a7d69a3c11f06e1f9984de46bc4fd607178f240fb76c0d47b03e7725
+  data.tar.gz: 682fee5deb9bc66d86380ee5017a8ccd0b4f1b0f9809d6a9e36efa9e73510b83
 SHA512:
-  metadata.gz: 194edc4175cb7e7d9c2816d749e2b97a56b97885511762345d2ecdce4c07be4bf2a9de82415f26c127f20b8a1fc5fa0256e84ffcedff74eaf5ad4d017c006f19
-  data.tar.gz: c2a7a1998c8c2fa628165f1961483e0986942be71ad599e72aad19351984a27c6284007037f7779834fd16e43f3905f8b316d2a1742546c90234f999bd734f1e
+  metadata.gz: 9a2b800801966259fa5453d00340645e7afeee1626808ffe4b670c2d64e28614f0d5a69093a38dcb70e123e02150034ce768c4368557e11a57d17f119e3ed306
+  data.tar.gz: fd5c15d2cede7d05040b0347d5816543eacaf3c1ca5430a33ccd26d2bb7c71e5bdedcb184b9cdc5113133e7a3ca1f23542aabb4325267f0dc4201b0d11463871

data/bin/maze-runner

@@ -42,7 +42,9 @@ require_relative '../lib/maze/metrics_processor'
 require_relative '../lib/maze/network'
 require_relative '../lib/maze/proxy'
 require_relative '../lib/maze/retry_handler'
-require_relative '../lib/maze/request_repeater'
+require_relative '../lib/maze/repeaters/request_repeater'
+require_relative '../lib/maze/repeaters/aspecto_repeater'
+require_relative '../lib/maze/repeaters/bugsnag_repeater'
 require_relative '../lib/maze/runner'
 require_relative '../lib/maze/terminating_server'
 

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

@@ -9,24 +9,25 @@ module Maze
       class BitBarDevices
         class << self
           # Uses the BitBar API to find an available device from the group name given, or a device of that name
-          # @param device_or_group_name [String] Name of the device, or device group for which to find an available device
+          # @param device_or_group_names [String] Name of the device, or device group(s) for which to find an available
+          # device.  Multiple device group names can be separated by a pipe.
           # @return Capabilities hash for the available device
-          def get_available_device(device_or_group_name)
+          def get_available_device(device_or_group_names)
             api_client = BitBarApiClient.new(Maze.config.access_key)
-            device_group_id = api_client.get_device_group_id(device_or_group_name)
-            if device_group_id
+            device_group_ids = api_client.get_device_group_ids(device_or_group_names)
+            if device_group_ids
               # Device group found - find a free device in it
-              $logger.debug "Got group id #{device_group_id} for #{device_or_group_name}"
-              group_count, device = api_client.find_device_in_group(device_group_id)
+              $logger.debug "Got group ids #{device_group_ids} for #{device_or_group_names}"
+              group_count, device = api_client.find_device_in_groups(device_group_ids)
               if device.nil?
                 # TODO: Retry rather than fail, see PLAT-7377
                 Maze::Helper.error_exit 'There are no devices available'
               else
-                $logger.info "#{group_count} device(s) currently available in group '#{device_or_group_name}'"
+                $logger.info "#{group_count} device(s) currently available in group(s) '#{device_or_group_names}'"
               end
             else
               # See if there is a device with the given name
-              device = api_client.find_device device_or_group_name
+              device = api_client.find_device device_or_group_names
             end
 
             device_name = device['displayName']

data/lib/maze/client/bb_api_client.rb

@@ -20,30 +20,38 @@ module Maze
         query_api(path)
       end
 
-      # Get the id of a device group given its name
-      def get_device_group_id(device_group_name)
+      # Get the id(s) of a one or more device groups given their names.  Multiple device group names should be separated
+      # by a pipe (which is directly supported by the BitBar API)
+      def get_device_group_ids(device_group_names)
         query = {
-          'filter': "displayName_eq_#{device_group_name}"
+          'filter': "displayName_in_#{device_group_names}"
         }
         device_groups = query_api('device-groups', query)
         if device_groups['data'].nil? || device_groups['data'].size == 0
           nil
         else
-          device_groups['data'][0]['id']
+          device_groups['data'].map { |group| group['id'] }
         end
       end
 
-      def find_device_in_group(device_group_id)
-        path = "device-groups/#{device_group_id}/devices"
-        query = {
-          'filter': "online_eq_true"
-        }
-        all_devices = query_api(path, query)
+      def find_device_in_groups(device_group_ids)
+        all_devices = []
+        device_group_ids.each do |group_id|
+          path = "device-groups/#{group_id}/devices"
+          query = {
+            'filter': "online_eq_true"
+          }
+          all_devices += query_api(path, query)['data']
+        end
+
+        $logger.debug "All available devices in group(s) #{device_group_ids}: #{JSON.pretty_generate(all_devices)}"
+        filtered_devices = all_devices.reject { |device| device['locked'] }
 
-        $logger.debug "All available devices in group #{device_group_id}: #{JSON.pretty_generate(all_devices)}"
-        Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.available', all_devices['data'].size, [Maze.config.device])
-        filtered_devices = all_devices['data'].reject { |device| device['locked'] }
-        Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.unlocked', filtered_devices.size, [Maze.config.device])
+        # Only send gauges to DataDog for single device groups
+        if device_group_ids.size == 1
+          Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.available', all_devices.size, [Maze.config.device])
+          Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.unlocked', filtered_devices.size, [Maze.config.device])
+        end
         return filtered_devices.size, filtered_devices.sample
       end
 

data/lib/maze/configuration.rb

@@ -61,8 +61,11 @@ module Maze
     # The server endpoints for which invalid requests should be captured and cause tests to fail
     attr_accessor :captured_invalid_requests
 
-    # API key to use when repeating requests
-    attr_accessor :repeater_api_key
+    # API key to use when repeating requests to Bugsnag
+    attr_accessor :aspecto_repeater_api_key
+
+    # API key to use when repeating requests to Bugsnag
+    attr_accessor :bugsnag_repeater_api_key
 
     # Enables awareness of a public IP address on Buildkite with the Elastic CI Stack for AWS.
     attr_accessor :aws_public_ip

data/lib/maze/option/parser.rb

@@ -41,7 +41,11 @@ module Maze
                 type: :boolean,
                 default: true
 
-            opt Option::REPEATER_API_KEY,
+            opt Option::ASPECTO_REPEATER_API_KEY,
+                'Enables forwarding of all received POST requests to Aspecto, using the API key provided.  MAZE_ASPECTO_REPEATER_API_KEY may also be set.',
+                type: :string
+
+            opt Option::BUGSNAG_REPEATER_API_KEY,
                 'Enables forwarding of all received POST requests to Bugsnag, using the API key provided.  MAZE_REPEATER_API_KEY may also be set.',
                 type: :string
 
@@ -232,7 +236,8 @@ module Maze
             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']
+          options[Option::ASPECTO_REPEATER_API_KEY] ||= ENV['MAZE_ASPECTO_REPEATER_API_KEY']
+          options[Option::BUGSNAG_REPEATER_API_KEY] ||= ENV['MAZE_REPEATER_API_KEY']
           options[Option::SB_LOCAL] ||= ENV['MAZE_SB_LOCAL'] || '/SBSecureTunnel'
           options[Option::TMS_URI] ||= ENV['MAZE_TMS_URI']
           options[Option::TMS_TOKEN] ||= ENV['MAZE_TMS_TOKEN']

data/lib/maze/option/processor.rb

@@ -23,7 +23,8 @@ module Maze
           config.enable_bugsnag = options[Maze::Option::ENABLE_BUGSNAG]
           config.tms_uri = options[Maze::Option::TMS_URI]
           config.tms_token = options[Maze::Option::TMS_TOKEN]
-          config.repeater_api_key = options[Maze::Option::REPEATER_API_KEY]
+          config.aspecto_repeater_api_key = options[Maze::Option::ASPECTO_REPEATER_API_KEY]
+          config.bugsnag_repeater_api_key = options[Maze::Option::BUGSNAG_REPEATER_API_KEY]
 
           # Document server options
           config.document_server_root = options[Maze::Option::DS_ROOT]

data/lib/maze/option/validator.rb

@@ -30,10 +30,10 @@ module Maze
         end
 
         # --repeater-api-key
-        key = options[Option::REPEATER_API_KEY]
+        key = options[Option::BUGSNAG_REPEATER_API_KEY]
         key_regex = /^[0-9a-fA-F]{32}$/
         if key && !key_regex.match?(key)
-          errors << "--#{Option::REPEATER_API_KEY} must be set to a 32-character hex value"
+          errors << "--#{Option::BUGSNAG_REPEATER_API_KEY} must be set to a 32-character hex value"
         end
 
         # Farm specific options

data/lib/maze/option.rb

@@ -56,7 +56,8 @@ module Maze
 
     # General options
     AWS_PUBLIC_IP = 'aws-public-ip'
-    REPEATER_API_KEY = 'repeater-api-key'
+    ASPECTO_REPEATER_API_KEY = 'aspecto-repeater-api-key'
+    BUGSNAG_REPEATER_API_KEY = 'repeater-api-key'
     ENABLE_BUGSNAG = 'enable-bugsnag'
     ENABLE_RETRIES = 'enable-retries'
   end

data/lib/maze/repeaters/aspecto_repeater.rb

@@ -0,0 +1,34 @@
+module Maze
+  module Repeaters
+    # Repeats Bugsnag requests
+    class AspectoRepeater < RequestRepeater
+
+      private
+
+      def set_headers(request)
+        request['Authorization'] = Maze.config.aspecto_repeater_api_key
+      end
+
+      def enabled?
+        # enabled if the config option is on and this request type should be repeated
+        Maze.config.aspecto_repeater_api_key && url_for_request_type
+      end
+
+      def gzip_supported
+        false
+      end
+
+      def url_for_request_type
+        url = case @request_type
+              when :traces then 'https://otelcol.aspecto.io:4318/v1/traces'
+              else return nil
+              end
+        URI.parse(url)
+      end
+
+      def include_header?(key, _value)
+        true unless key.start_with? 'bugsnag'
+      end
+    end
+  end
+end

data/lib/maze/repeaters/bugsnag_repeater.rb

@@ -0,0 +1,35 @@
+module Maze
+  module Repeaters
+    # Repeats Bugsnag requests
+    class BugsnagRepeater < RequestRepeater
+
+      private
+
+      def set_headers(request)
+        # TODO Also overwrite apiKey in the payload, if present, recalculate the integrity header (handling
+        #   compressed payloads if the content-encoding header is set accordingly)
+        request['bugsnag-api-key'] = Maze.config.bugsnag_repeater_api_key
+      end
+
+      def enabled?
+        # enabled if the config option is on and this request type should be repeated
+        Maze.config.bugsnag_repeater_api_key && url_for_request_type
+      end
+
+      def url_for_request_type
+        url = case @request_type
+              when :errors then 'https://notify.bugsnag.com/'
+              when :sessions then 'https://sessions.bugsnag.com/'
+              when :traces then 'https://otlp.bugsnag.com/v1/traces'
+              else return nil
+              end
+        URI.parse(url)
+      end
+
+      def include_header?(key, value)
+        # Include all headers apart from the API key, which is set separately
+        key != 'bugsnag-api-key'
+      end
+    end
+  end
+end

data/lib/maze/repeaters/request_repeater.rb

@@ -0,0 +1,87 @@
+module Maze
+  module Repeaters
+    # Repeats POST requests
+    class RequestRepeater
+
+      def initialize(request_type)
+        @request_type = request_type
+      end
+
+      # @param request [HTTPRequest] The request to be repeated
+      def repeat(request)
+
+        return unless enabled?
+
+        # TODO Forwarding of internal errors to be considered later
+        return if request.header.keys.any? { |key| key.downcase == 'bugsnag-internal-error' }
+
+        uri = url_for_request_type
+
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |https|
+          onward_request = Net::HTTP::Post.new(uri.path)
+          onward_request.body = decompress(request)
+
+          # Set all headers that are present, unless Gzip is not supported
+          request.header.each do |key,value|
+            # Only include content-type header if gip is supported
+            next if !gzip_supported && key.downcase == 'content-encoding'
+
+            # All other headers are opt-in to avoid accidental leakage
+            next unless include_header? key.downcase, value
+
+            onward_request[key] = value
+          end
+
+          # Set headers specific to the repeater
+          set_headers onward_request
+
+          response = https.request(onward_request)
+          log_response response
+        end
+      end
+
+      private
+
+      def gzip_supported
+        true
+      end
+
+      def decompress(request)
+        if !gzip_supported && %r{^gzip$}.match(request['Content-Encoding'])
+
+          reader = Zlib::GzipReader.new(StringIO.new(request.body))
+          reader.read
+        else
+          request.body
+        end
+      end
+
+      def enabled?
+        raise 'Method not implemented by this class'
+      end
+
+      def url_for_request_type
+        raise 'Method not implemented by this class'
+      end
+
+      def include_header?(_key, _value)
+        raise 'Method not implemented by this class'
+      end
+
+      def log_response(response)
+        log "HEADERS:"
+        response.header.each_header do |key, value|
+          log "  #{key}: #{value}"
+        end
+
+        log
+        log "BODY:"
+        log response.body
+      end
+      
+      def log(message = '')
+        $logger.debug message
+      end
+    end
+  end
+end

data/lib/maze/servlets/servlet.rb

@@ -28,7 +28,6 @@ module Maze
 
     # Receives and parses the requests and payloads sent from the test fixture
     class Servlet < BaseServlet
-      prepend RequestRepeater
 
       # Constructor
       #
@@ -40,6 +39,8 @@ module Maze
         @request_type = request_type
         @requests = Server.list_for request_type
         @schema = JSONSchemer.schema(schema) unless schema.nil?
+        @aspecto_repeater = Maze::Repeaters::AspectoRepeater.new(@request_type)
+        @bugsnag_repeater = Maze::Repeaters::BugsnagRepeater.new(@request_type)
       end
 
       # Logs an incoming GET WEBrick request.
@@ -57,6 +58,10 @@ module Maze
       # @param request [HTTPRequest] The incoming GET request
       # @param response [HTTPResponse] The response to return
       def do_POST(request, response)
+
+        @aspecto_repeater.repeat request
+        @bugsnag_repeater.repeat request
+
         # Turn the WEBrick HttpRequest into our internal HttpRequest delegate
         request = HttpRequest.new(request)
 

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 = '7.29.0'
+  VERSION = '7.30.1'
 
   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: 7.29.0
+  version: 7.30.1
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -420,8 +420,10 @@ files:
 - lib/maze/plugins/error_code_plugin.rb
 - lib/maze/plugins/global_retry_plugin.rb
 - lib/maze/proxy.rb
+- lib/maze/repeaters/aspecto_repeater.rb
+- lib/maze/repeaters/bugsnag_repeater.rb
+- lib/maze/repeaters/request_repeater.rb
 - lib/maze/request_list.rb
-- lib/maze/request_repeater.rb
 - lib/maze/retry_handler.rb
 - lib/maze/runner.rb
 - lib/maze/schemas/OtelTraceSchema.json

data/lib/maze/request_repeater.rb

@@ -1,49 +0,0 @@
-module Maze
-  # Repeats POST requests
-  module RequestRepeater
-
-    def do_POST(request, response)
-      repeat(request) if enabled?
-
-      super(request, response)
-    end
-
-    private
-
-    def enabled?
-      # enabled if the config option is on and this request type should be repeated
-      Maze.config.repeater_api_key && url_for_request_type
-    end
-
-    # @param request [HTTPRequest] The request to be repeated
-    def repeat(request)
-
-      # TODO Forwarding of internal errors to be considered later
-      return if request.header.keys.any? { |key| key.downcase == 'bugsnag-internal-error' }
-
-      url = url_for_request_type
-      http = Net::HTTP.new(url.host)
-      bugsnag_request = Net::HTTP::Post.new(url.path)
-
-      # Set all headers that are present
-      bugsnag_request.body = request.body
-      request.header.each {|key,value| bugsnag_request[key] = value }
-      bugsnag_request['bugsnag-api-key'] = Maze.config.repeater_api_key
-
-      # TODO Also overwrite apiKey in the payload, if present, recalculate the integrity header (handling
-      #   compressed payloads if the content-encoding header is set accordingly)
-
-      http.request(bugsnag_request)
-    end
-
-    def url_for_request_type
-      url = case @request_type
-            when :errors then 'https://notify.bugsnag.com/'
-            when :sessions then 'https://sessions.bugsnag.com/'
-            when :traces then 'https://otlp.bugsnag.com/v1/traces'
-            else return nil
-            end
-      URI.parse(url)
-    end
-  end
-end