bugsnag-maze-runner 9.6.0 → 9.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c5244250d40c6b3b44f775401c136e2f61e87779135858b5533e40875658190
-  data.tar.gz: 9cab0c07bc4db58a9ec93e4b25157a7749f5bb53a03812e1420270da48f38729
+  metadata.gz: b6101c495b7debb939e4bb83f21dbc015c13f7bc58ce797d69fb90e618c6be6d
+  data.tar.gz: 69f5fdd5eec4c1f5bc8e9ed2aaa188531a6f54e80ec26471873ef93e7ecb1ecd
 SHA512:
-  metadata.gz: b80d77bb8d388956f6acbefce51c3482b7450feb01dda66d655e9e682c89dc4b118f20d14bd63b0289092a27bce4dfb923332bf364a051e382b46e86ad8cf852
-  data.tar.gz: 3ddc5d20186dee38db31c3db556e5454b9bd825caf6cef96ef18b92b3f503c2771f2f78afa8bf22d262fbdef0165d66e280daae764ab0b15d4db441811eac63e
+  metadata.gz: '0438524dc2173c1f31b323cca182e651ea1fc095727ee4658c5bb14baa986b5a17230fcd64460dd9eb9e805469c84eae2d3eadb85ae47668501a70dd1211e090'
+  data.tar.gz: bcf7dfcf91d8093099733839d06b38b1cea25548617eebad4f88a01910d8f64d6e0db26de0de5ebe38977e1cfa2b64d3fed80f8bc693d5ec6071c8dc633f5bb0

data/lib/features/support/internal_hooks.rb

@@ -238,17 +238,21 @@ AfterAll do
   # Ensure the logger output is in the correct location
   Maze::Hooks::LoggerHooks.after_all
 
-  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)
+  if Maze.config.file_log
+    # create a zip file from the maze_output directory
+    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
-  end
 
-  # Move the zip file to the maze_output folder
-  FileUtils.mv(maze_output_zip, maze_output)
+    # Move the zip file to the maze_output folder
+    FileUtils.mv(maze_output_zip, maze_output)
+  end
 
   metrics = Maze::MetricsProcessor.new(Maze::Server.metrics)
   metrics.process

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

@@ -34,6 +34,10 @@ module Maze
             interval = 10
           elsif error.message.include? 'Could not proxy command to the remote server'
             interval = 10
+          elsif error.message.include? 'Could not find a connected Android device'
+            interval = 10
+          elsif error.message.include? '\'platformVersion\' must be a valid version number.'
+            interval = 10
           else
             # Do not retry in any other case
           end
@@ -54,26 +58,24 @@ module Maze
         end
 
         def device_capabilities
-          # Doubling up on capabilities in both the `appium:options` and `appium` sub dictionaries.
-          # See PLAT-11087
           config = Maze.config
           common_caps = {
             'noReset' => true,
             'newCommandTimeout' => 600
           }
           capabilities = {
-            'appium:options' => common_caps,
-            'appium' => common_caps,
             'bitbar:options' => {
-              # Some capabilities probably belong in the top level
-              # of the hash, but BitBar picks them up from here.
               'apiKey' => config.access_key,
               'app' => config.app,
               'findDevice' => false,
               'testTimeout' => 7200
             }
           }
-          capabilities.deep_merge! common_caps
+          if Maze.config.appium_version && Maze.config.appium_version.to_f < 2.0
+            capabilities.merge!(common_caps)
+          else
+            capabilities['appium:options'] = common_caps
+          end
           capabilities.deep_merge! BitBarClientUtils.dashboard_capabilities
           capabilities.deep_merge! BitBarDevices.get_available_device(config.device)
           capabilities['bitbar:options']['appiumVersion'] = config.appium_version unless config.appium_version.nil?

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

@@ -18,22 +18,44 @@ module Maze
             if device_group_ids
               # Device group found - find a free device in it
               $logger.trace "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?
-                raise 'There are no devices available'
+              if device_group_ids.size > 1
+                group_id = false
+                group_count, device = api_client.find_device_in_groups(device_group_ids)
+                if device.nil?
+                  raise 'There are no devices available'
+                else
+                  $logger.info "#{group_count} device(s) currently available in group(s) '#{device_or_group_names}'"
+                end
               else
-                $logger.info "#{group_count} device(s) currently available in group(s) '#{device_or_group_names}'"
+                # Since there is only one group, we can use it verbatim
+                $logger.info "Using device group #{device_or_group_names}"
+                group_id = true
+                device_name = device_group_ids.first
               end
             else
               # See if there is a device with the given name
               device = api_client.find_device device_or_group_names
             end
 
-            device_name = device['displayName']
-            platform = device['platform'].downcase
-            platform_version = device['softwareVersion']['releaseVersion']
+            # If a single device has been identified use that to determine other characteristics
+            if device
+              device_name = device['displayName']
+              platform = device['platform'].downcase
+              platform_version = device['softwareVersion']['releaseVersion']
 
-            $logger.info "Selected device: #{device_name} (#{platform} #{platform_version})"
+              $logger.info "Selected device: #{device_name} (#{platform} #{platform_version})"
+            else
+              # If a device group has been identified, extrapolate characteristics from the group name
+              if android_match = Regexp.new('(ANDROID|android)_(\d{1,2})').match(device_or_group_names)
+                platform = 'android'
+                platform_version = android_match[2]
+              elsif ios_match = Regexp.new('(IOS|ios)_(\d{1,2})').match(device_or_group_names)
+                platform = 'ios'
+                platform_version = ios_match[2]
+              end
+
+              $logger.info "Selected device group: #{device_or_group_names} (#{platform} #{platform_version})"
+            end
 
             # TODO: Setting the config here is rather a side effect and factoring it out would be better.
             #   For now, though, it means not having to provide the --os and --os-version options on the command line.
@@ -42,9 +64,9 @@ module Maze
 
             case platform
             when 'android'
-              make_android_hash(device_name)
+              make_android_hash(device_name, group_id)
             when 'ios'
-              make_ios_hash(device_name)
+              make_ios_hash(device_name, group_id)
             else
               throw "Invalid device platform specified #{platform}"
             end
@@ -90,9 +112,7 @@ module Maze
             end
           end
 
-          def make_android_hash(device)
-            # Tripling up on capabilities in the `appium:options`, `appium` sub dictionaries and base dictionary.
-            # See PLAT-11087
+          def android_base_hash
             appium_options = {
               'automationName' => 'UiAutomator2',
               'autoGrantPermissions' => true,
@@ -103,20 +123,31 @@ module Maze
             appium_options['appPackage'] = Maze.config.app_package unless Maze.config.app_package.nil?
             hash = {
               'platformName' => 'Android',
-              'deviceName' => 'Android Phone',
-              'appium:options' => appium_options,
-              'appium' => appium_options,
-              'bitbar:options' => {
-                'device' => device,
-              }
+              'deviceName' => 'Android Phone'
             }
-            hash.merge!(appium_options)
+            if Maze.config.appium_version && Maze.config.appium_version.to_f < 2.0
+              hash.merge!(appium_options)
+            else
+              hash['appium:options'] = appium_options
+            end
+            hash.dup
+          end
+
+          def make_android_hash(device, group_id = false)
+            hash = android_base_hash
+            if group_id
+              hash['bitbar:options'] = {
+                'deviceGroupId' => device
+              }
+            else
+              hash['bitbar:options'] = {
+                'device' => device
+              }
+            end
             hash.freeze
           end
 
-          def make_ios_hash(device)
-            # Tripling up on capabilities in the `appium:options`, `appium` sub dictionaries and base dictionary.
-            # See PLAT-11087
+          def ios_base_hash
             appium_options = {
               'automationName' => 'XCUITest',
               'shouldTerminateApp' => 'true',
@@ -125,13 +156,26 @@ module Maze
             hash = {
               'platformName' => 'iOS',
               'deviceName' => 'iPhone device',
-              'appium:options' => appium_options,
-              'appium' => appium_options,
-              'bitbar:options' => {
+            }
+            if Maze.config.appium_version && Maze.config.appium_version.to_f < 2.0
+              hash.merge!(appium_options)
+            else
+              hash['appium:options'] = appium_options
+            end
+            hash.dup
+          end
+
+          def make_ios_hash(device, group_id = false)
+            hash = ios_base_hash
+            if group_id
+              hash['bitbar:options'] = {
+                'deviceGroupId' => device
+              }
+            else
+              hash['bitbar:options'] = {
                 'device' => device
               }
-            }
-            hash.merge!(appium_options)
+            end
             hash.freeze
           end
         end

data/lib/maze/server.rb

@@ -15,6 +15,12 @@ module Maze
     DEFAULT_STATUS_CODE = 200
 
     class << self
+
+      # Records the previous command UUID sent to the test fixture
+      #
+      # @return [String] The UUID of the last command sent
+      attr_accessor :last_command_uuid
+
       # Sets the response delay generator.
       #
       # @param generator [Maze::Generator] The new generator
@@ -236,6 +242,7 @@ module Maze
             server.mount '/logs', Servlets::LogServlet
             server.mount '/metrics', Servlets::Servlet, :metrics
             server.mount '/reflect', Servlets::ReflectiveServlet
+            server.mount '/docs', WEBrick::HTTPServlet::FileHandler, Maze.config.document_server_root unless Maze.config.document_server_root.nil?
             server.start
           rescue StandardError => e
             Bugsnag.notify e

data/lib/maze/servlets/command_servlet.rb

@@ -19,17 +19,7 @@ module Maze
 
         if request.query.empty?
           # Non-idempotent mode - return the "current" command
-          commands = Maze::Server.commands
-
-          if commands.size_remaining == 0
-            response.body = NOOP_COMMAND
-            response.status = 200
-          else
-            command = commands.current
-            response.body = JSON.pretty_generate(command)
-            response.status = 200
-            commands.next
-          end
+          send_current_command(response)
         else
           # Idempotent mode
           after_uuid = request.query['after']
@@ -44,6 +34,21 @@ module Maze
         response.header['Access-Control-Allow-Origin'] = '*'
       end
 
+      def send_current_command(response)
+        commands = Maze::Server.commands
+
+        if commands.size_remaining == 0
+          response.body = NOOP_COMMAND
+          response.status = 200
+        else
+          command = commands.current
+          Server.last_command_uuid = command[:uuid]
+          response.body = JSON.pretty_generate(command)
+          response.status = 200
+          commands.next
+        end
+      end
+
       def command_after(uuid, response)
         commands = Maze::Server.commands
         if uuid.empty?
@@ -52,14 +57,20 @@ module Maze
           index = commands.all.find_index {|command| command[:uuid] == uuid }
         end
         if index.nil?
-          msg = "Request invalid - there is no command with a UUID of #{uuid} to follow on from"
-          $logger.error msg
-          response.body = msg
-          response.status = 400
+          # If the UUID given matches the last UUID sent by the server, we can assume the fixture has failed to reset
+          if uuid.eql?(Server.last_command_uuid)
+            send_current_command(response)
+          else
+            msg = "Request invalid - there is no command with a UUID of #{uuid} to follow on from"
+            $logger.error msg
+            response.body = msg
+            response.status = 400
+          end
         else
           if index + 1 < commands.size_all
             # Respond with the next command in the queue
             command = commands.get(index + 1)
+            Server.last_command_uuid = command[:uuid]
             command_json = JSON.pretty_generate(command)
             response.body = command_json
             response.status = 200

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.6.0'
+  VERSION = '9.8.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.6.0
+  version: 9.8.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.12.0
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.12.0
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: markdown
   requirement: !ruby/object:Gem::Requirement