bugsnag-maze-runner 7.22.1

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

@@ -0,0 +1,102 @@
+module Maze
+  module Client
+    module Appium
+      class BitBarClient < BaseClient
+        def prepare_session
+          config = Maze.config
+          config.app = Maze::Client::BitBarClientUtils.upload_app config.access_key,
+                                                                  config.app
+          if Maze.config.start_tunnel
+            Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
+                                                               config.username,
+                                                               config.access_key
+          end
+        end
+
+        def start_scenario
+          unless Maze.config.legacy_driver?
+            # Write Maze's address to file and push to the device
+            maze_address = Maze.public_address || "local:#{Maze.config.port}"
+            Maze::Api::Appium::FileManager.new.write_app_file(JSON.generate({ maze_address: maze_address }),
+                                                              FIXTURE_CONFIG)
+          end
+
+          super
+        end
+
+        def device_capabilities
+          config = Maze.config
+          capabilities = {
+            'noReset' => true,
+            '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,
+              'newCommandTimeout' => 0
+            }
+          }
+          capabilities['appiumVersion'] = config.appium_version unless config.appium_version.nil?
+          capabilities.deep_merge! dashboard_capabilities
+          capabilities.deep_merge! BitBarDevices.get_available_device(config.device)
+          capabilities.deep_merge! JSON.parse(config.capabilities_option)
+          capabilities
+        end
+
+        def log_run_intro
+          # Nothing to log at the start
+        end
+
+        def log_run_outro
+          api_client = BitBarApiClient.new(Maze.config.access_key)
+
+          $logger.info 'Appium session(s) created:'
+          @session_ids.each do |id|
+            link = api_client.get_device_session_ui_link(id)
+            $logger.info Maze::LogUtil.linkify(link, "BitBar session: #{id}") if link
+          end
+        end
+
+        def stop_session
+          super
+          if Maze.config.start_tunnel
+            Maze::Client::BitBarClientUtils.stop_local_tunnel
+          end
+        end
+
+        # Determines capabilities used to organise sessions in the BitBar dashboard.
+        #
+        # @return [Hash] A hash containing the capabilities.
+        def dashboard_capabilities
+          # Attempt to use the current git repo as the project name
+          output, status = Maze::Runner.run_command('git rev-parse --show-toplevel')
+          if status == 0
+            project = File.basename(output[0].strip)
+          else
+            if ENV['BUILDKITE']
+              project = ENV['BUILDKITE_PIPELINE_SLUG']
+            else
+              $logger.warn 'Unable to determine project name, consider running Maze Runner from within a Git repository'
+              project = 'Unknown'
+            end
+          end
+
+          if ENV['BUILDKITE']
+            test_run = "#{ENV['BUILDKITE_BUILD_NUMBER']} - #{ENV['BUILDKITE_LABEL']}"
+          else
+            test_run = Maze.run_uuid
+          end
+
+          {
+            'bitbar:options' => {
+              bitbar_project: project,
+              bitbar_testrun: test_run
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+require 'json'
+
+module Maze
+  module Client
+    module Appium
+      # Provides a source of capabilities used to run tests against specific BitBar devices
+      # noinspection RubyStringKeysInHashInspection
+      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
+          # @return Capabilities hash for the available device
+          def get_available_device(device_or_group_name)
+            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 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)
+              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}'"
+              end
+            else
+              # See if there is a device with the given name
+              device = api_client.find_device device_or_group_name
+            end
+
+            device_name = device['displayName']
+            platform = device['platform'].downcase
+            platform_version = device['softwareVersion']['releaseVersion']
+
+            $logger.info "Selected device: #{device_name} (#{platform} #{platform_version})"
+
+            # 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.
+            Maze.config.os = platform
+            Maze.config.os_version = platform_version.to_f.floor
+
+            case platform
+            when 'android'
+              automation_name = if platform_version.start_with?('5')
+                                  'UiAutomator1'
+                                else
+                                  'UiAutomator2'
+                                end
+              make_android_hash(device_name, automation_name)
+            when 'ios'
+              make_ios_hash(device_name)
+            else
+              throw "Invalid device platform specified #{platform}"
+            end
+          end
+
+          def list_device_groups(access_key)
+            api_client = BitBarApiClient.new(access_key)
+            device_groups = api_client.get_device_group_list
+            unless device_groups['data'] && !device_groups['data'].empty?
+              puts 'There are no device groups available for the given user access key'
+              exit 1
+            end
+            puts "BitBar device groups available:"
+            device_groups['data'].sort_by{|g| g['displayName']}.each do |group|
+              puts '------------------------------'
+              puts "Group name   : #{group['displayName']}"
+              puts "OS           : #{group['osType']}"
+              puts "Device count : #{group['deviceCount']}"
+            end
+          end
+
+          def list_devices_for_group(device_group, access_key)
+            api_client = BitBarApiClient.new(access_key)
+            group_id = api_client.get_device_group_id(device_group)
+            unless group_id
+              puts "No device groups were found with the given name #{device_group}"
+              return
+            end
+            devices = api_client.get_device_list_for_group(group_id)
+            if devices['data'].empty?
+              puts "There are no devices available for the #{device_group} device group"
+              return
+            end
+            puts "BitBar devices available for device group #{device_group}:"
+            devices['data'].sort_by{|d| d['displayName']}.each do |device|
+              puts '------------------------------'
+              puts "Device name : #{device['displayName']}"
+              puts "OS          : #{device['platform']} #{device['softwareVersion']['releaseVersion']}"
+
+              if device['platform'].eql? 'ANDROID'
+                puts "API level   : #{device['softwareVersion']['apiLevel']}"
+              end
+            end
+          end
+
+          def make_android_hash(device, automation_name)
+            hash = {
+              'automationName' => automation_name,
+              'platformName' => 'Android',
+              'deviceName' => 'Android Phone',
+              'bitbar:options' => {
+                'autoGrantPermissions' => true,
+                'device' => device,
+              }
+            }
+            hash.freeze
+          end
+
+          def make_ios_hash(device)
+            {
+              'automationName' => 'XCUITest',
+              'deviceName' => 'iPhone device',
+              'platformName' => 'iOS',
+              'bitbar:options' => {
+                'noReset' => 'true',
+                'shouldTerminateApp' => 'true',
+                'device' => device
+              }
+            }.freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+module Maze
+  module Client
+    module Appium
+      class BrowserStackClient < BaseClient
+        def prepare_session
+          # Upload the app and start the secure tunnel
+          config = Maze.config
+          config.app = Maze::Client::BrowserStackClientUtils.upload_app config.username,
+                                                                        config.access_key,
+                                                                        config.app
+          if Maze.config.start_tunnel
+            Maze::Client::BrowserStackClientUtils.start_local_tunnel config.bs_local,
+                                                                     Maze.run_uuid,
+                                                                     config.access_key
+          end
+        end
+
+        def start_scenario
+          unless Maze.config.legacy_driver?
+            # Write Maze's address to file and push to the device
+            maze_address = "bs-local.com:#{Maze.config.port}"
+            Maze::Api::Appium::FileManager.new.write_app_file(JSON.generate({ maze_address: maze_address }),
+                                                              FIXTURE_CONFIG)
+          end
+
+          super
+        end
+
+        def device_capabilities
+          config = Maze.config
+          capabilities = {
+            'app' => config.app,
+            'deviceOrientation' => 'portrait',
+            'noReset' => 'true',
+            'bstack:options' => {}
+          }
+          device_caps = Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH[config.device]
+          capabilities.deep_merge! device_caps
+          capabilities.deep_merge! JSON.parse(config.capabilities_option)
+          capabilities.merge! project_name_capabilities
+          capabilities['bstack:options']['appiumVersion'] = config.appium_version unless config.appium_version.nil?
+          unless device_caps['platformName'] == 'android' && device_caps['platformVersion'].to_i <= 6
+            capabilities['bstack:options']['disableAnimations'] = 'true'
+          end
+          if Maze.config.start_tunnel
+            capabilities['bstack:options']['local'] = 'true'
+            capabilities['bstack:options']['localIdentifier'] = Maze.run_uuid
+          end
+
+          capabilities
+        end
+
+        def log_run_intro
+          # Log a link to the BrowserStack session search dashboard
+          url = "https://app-automate.browserstack.com/dashboard/v2/search?query=#{Maze.run_uuid}&type=builds"
+          $logger.info Maze::LogUtil.linkify(url, 'BrowserStack session(s)')
+        end
+
+        def log_run_outro
+          $logger.info 'Appium session(s) created:'
+          @session_ids.each { |id| $logger.info "  #{id}" }
+          log_run_intro
+        end
+
+        def stop_session
+          super
+          Maze::Client::BrowserStackClientUtils.stop_local_tunnel if Maze.config.start_tunnel
+        end
+
+        private
+
+        # Determines and returns sensible project, build, and name capabilities
+        #
+        # @return [Hash] A hash containing the 'project' and 'build' capabilities
+        def project_name_capabilities
+          # Default to values for running locally
+          project = 'local'
+
+          if ENV['BUILDKITE']
+            # Project
+            project = ENV['BUILDKITE_PIPELINE_NAME']
+          end
+          {
+            project: project,
+            build: Maze.run_uuid
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Maze
+  module Client
+    module Appium
+      # Provides a source of capabilities used to run tests against specific BrowserStack devices
+      # noinspection RubyStringKeysInHashInspection
+      class BrowserStackDevices
+        class << self
+
+          def list_devices(os)
+            puts "BrowserStack #{os} devices available:"
+            devices = DEVICE_HASH.dup
+            devices.select { |key, device|
+              device['platformName'].eql?(os)
+            }.map { |key, device|
+              new_device = device.dup
+              new_device['key'] = key
+              new_device
+            }.sort { |dev_1, dev_2|
+              dev_1['platformVersion'].to_f <=> dev_2['platformVersion'].to_f
+            }.each{ |device|
+              puts '------------------------------'
+              puts "Device key: #{device['key']}"
+              puts "Device:     #{device['deviceName']}"
+              puts "OS:         #{device['platformName']}"
+              puts "OS version: #{device['platformVersion']}"
+            }
+          end
+
+          def make_android_hash(device, version)
+            hash = {
+              'platformName' => 'android',
+              'platformVersion' => version,
+              'deviceName' => device,
+              'autoGrantPermissions' => 'true',
+            }
+            hash.freeze
+          end
+
+          def add_android(device, version, hash)
+            # Key format is "ANDROID_<version>_<device>", with:
+            # - dots in versions and all spaces replaced with underscores
+            # - device made upper case
+            name = device.upcase.gsub ' ', '_'
+            new_version = version.gsub '.', '_'
+            key = "ANDROID_#{new_version}_#{name}"
+            hash[key] = make_android_hash device, version
+          end
+
+          def make_ios_hash(device, version)
+            {
+              'platformName' => 'ios',
+              'platformVersion' => version,
+              'deviceName' => device
+            }.freeze
+          end
+
+          def add_ios(device, version, hash)
+            # Key format is "IOS_<version>_<device>", with:
+            # - dots in versions and all spaces replaced with underscores
+            # - device made upper case
+            name = device.upcase.gsub ' ', '_'
+            name = name.gsub '.', '_'
+            new_version = version.gsub '.', '_'
+            key = "IOS_#{new_version}_#{name}"
+            hash[key] = make_ios_hash device, version
+          end
+
+          def create_hash
+            hash = {
+              # Classic, non-specific devices for each Android version
+              'ANDROID_13_0' => make_android_hash('Google Pixel 6 Pro', '13.0'),
+              'ANDROID_13_0_BETA' => make_android_hash('Google Pixel 6 Pro', '13 Beta'),
+              'ANDROID_12_0' => make_android_hash('Google Pixel 5', '12.0'),
+              'ANDROID_11_0' => make_android_hash('Google Pixel 4', '11.0'),
+              'ANDROID_10_0' => make_android_hash('Google Pixel 4', '10.0'),
+              'ANDROID_9_0' => make_android_hash('Google Pixel 3', '9.0'),
+              'ANDROID_8_1' => make_android_hash('Samsung Galaxy Note 9', '8.1'),
+              'ANDROID_8_0' => make_android_hash('Google Pixel 2', '8.0'),
+              'ANDROID_7_1' => make_android_hash('Google Pixel', '7.1'),
+
+              # iOS devices
+              'IOS_16' => make_ios_hash('iPhone 14', '16'),
+              'IOS_15' => make_ios_hash('iPhone 11 Pro', '15'),
+              'IOS_14' => make_ios_hash('iPhone 11', '14'),
+              'IOS_13' => make_ios_hash('iPhone 8', '13'),
+              'IOS_12' => make_ios_hash('iPhone 8', '12'),
+              'IOS_11' => make_ios_hash('iPhone 8', '11'),
+              'IOS_10' => make_ios_hash('iPhone 7', '10')
+            }
+
+            # Specific Android devices
+            add_android 'Google Pixel 4', '11.0', hash                        # ANDROID_11_0_GOOGLE_PIXEL_4
+
+            add_android 'Xiaomi Redmi Note 9', '10.0', hash                   # ANDROID_10_0_XIAOMI_REDMI_NOTE_9
+            add_android 'Samsung Galaxy Note 20', '10.0', hash                # ANDROID_10_0_SAMSUNG_GALAXY_NOTE_20
+            add_android 'Motorola Moto G9 Play', '10.0', hash                 # ANDROID_10_0_MOTOROLA_MOTO_G9_PLAY
+            add_android 'OnePlus 8', '10.0', hash                             # ANDROID_10_0_ONEPLUS_8
+
+            add_android 'Google Pixel 2', '9.0', hash                         # ANDROID_9_0_GOOGLE_PIXEL_2
+            add_android 'Samsung Galaxy Note 9', '8.1', hash                  # ANDROID_8_1_SAMSUNG_GALAXY_NOTE_9
+            add_android 'Samsung Galaxy J7 Prime', '8.1', hash                # ANDROID_8_1_SAMSUNG_GALAXY_J7_PRIME
+            add_android 'Samsung Galaxy Tab S4', '8.1', hash                  # ANDROID_8_1_SAMSUNG_GALAXY_TAB_S4
+            add_android 'Samsung Galaxy Tab S3', '8.0', hash                  # ANDROID_8_0_SAMSUNG_GALAXY_TAB_S3
+            add_android 'Google Pixel 2', '8.0', hash                         # ANDROID_8_0_GOOGLE_PIXEL_2
+            add_android 'Samsung Galaxy S9', '8.0', hash                      # ANDROID_8_0_SAMSUNG_GALAXY_S9
+            add_android 'Samsung Galaxy S9 Plus', '8.0', hash                 # ANDROID_8_0_SAMSUNG_GALAXY_S9_PLUS
+
+            add_android 'Samsung Galaxy A8', '7.1', hash                      # ANDROID_7_1_SAMSUNG_GALAXY_A8
+            add_android 'Samsung Galaxy Note 8', '7.1', hash                  # ANDROID_7_1_SAMSUNG_GALAXY_NOTE_8
+            add_android 'Samsung Galaxy S8', '7.0', hash                      # ANDROID_7_0_SAMSUNG_GALAXY_S8
+            add_android 'Samsung Galaxy S8 Plus', '7.0', hash                 # ANDROID_7_0_SAMSUNG_GALAXY_S8_PLUS
+
+            # Specific iOS devices
+            add_ios 'iPhone 14 Plus', '16.0', hash                            # IOS_16_0_IPHONE_14_PLUS
+            add_ios 'iPhone 14 Pro', '16.0', hash                             # IOS_16_0_IPHONE_14_PRO
+            add_ios 'iPhone 14 Pro Max', '16.0', hash                         # IOS_16_0_IPHONE_14_PRO_MAX
+
+            add_ios 'iPhone 8 Plus', '11.0', hash                             # IOS_11_0_IPHONE_8_PLUS
+            add_ios 'iPhone X', '11.0', hash                                  # IOS_11_0_IPHONE_X
+            add_ios 'iPhone SE', '11.0', hash                                 # IOS_11_0_IPHONE_SE
+            add_ios 'iPhone 6', '11.0', hash                                  # IOS_11_0_IPHONE_6
+            add_ios 'iPhone 6S', '11.0', hash                                 # IOS_11_0_IPHONE_6S
+            add_ios 'iPhone 6S Plus', '11.0', hash                            # IOS_11_0_IPHONE_6S_PLUS
+            add_ios 'iPad 5th', '11.0', hash                                  # IOS_11_0_IPAD_5TH
+            add_ios 'iPad Mini 4', '11.0', hash                               # IOS_11_0_IPAD_MINI_4
+            add_ios 'iPad Pro 9.7 2016', '11.0', hash                         # IOS_11_0_IPAD_PRO_9_7_2016
+            add_ios 'iPad 6th', '11.0', hash                                  # IOS_11_0_IPAD_6TH
+            add_ios 'iPad Pro 12.9', '11.0', hash                             # IOS_11_0_IPAD_PRO_12_9
+
+            hash
+          end
+        end
+
+        # The hash of device capabilities, accessible by simple names
+        DEVICE_HASH = create_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Maze
+  module Client
+    module Appium
+      class BrowserStackLegacyClient < BrowserStackClient
+        def device_capabilities
+          config = Maze.config
+          capabilities = {
+            'app' => config.app,
+            'browserstack.console' => 'errors',
+            'deviceOrientation' => 'portrait',
+            'noReset' => 'true'
+          }
+          device_caps = Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH[config.device]
+          capabilities.deep_merge! device_caps
+          capabilities.deep_merge! JSON.parse(config.capabilities_option)
+          capabilities.merge! project_name_capabilities
+          capabilities['browserstack.appium_version'] = config.appium_version unless config.appium_version.nil?
+          unless device_caps['platformName'] == 'android' && device_caps['platformVersion'].to_i <= 6
+            capabilities['disableAnimations'] = 'true'
+          end
+          if Maze.config.start_tunnel
+            capabilities['browserstack.localIdentifier'] = Maze.run_uuid
+            capabilities['browserstack.local'] = 'true'
+          end
+
+          capabilities
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module Maze
+  module Client
+    module Appium
+      class LocalClient < BaseClient
+        def prepare_session
+          # Attempt to start the local appium server
+          appium_uri = URI(Maze.config.appium_server_url)
+          Maze::AppiumServer.start(address: appium_uri.host, port: appium_uri.port.to_s) if Maze.config.start_appium
+        end
+
+        def device_capabilities
+          config = Maze.config
+          platform = Maze::Helper.get_current_platform
+          capabilities = case platform
+                         when 'android'
+                           {
+                             'platformName' => 'Android',
+                             'automationName' => 'UiAutomator2',
+                             'autoGrantPermissions' => 'true',
+                             'noReset' => 'true'
+                           }
+                         when 'ios'
+                           {
+                             'platformName' => 'iOS',
+                             'automationName' => 'XCUITest',
+                             'deviceName' => config.device_id,
+                             'xcodeOrgId' => config.apple_team_id,
+                             'xcodeSigningId' => 'iPhone Developer',
+                             'udid' => config.device_id,
+                             'noReset' => 'true',
+                             'waitForQuiescence' => false,
+                             'newCommandTimeout' => 0
+                           }
+                         when 'macos'
+                           {
+                             'platformName' => 'Mac'
+                           }
+                         else
+                           raise "Unsupported platform: #{config.os}"
+                         end
+          common = {
+            'app' => config.app,
+            'os' => platform,
+            'autoAcceptAlerts': 'true'
+          }
+          capabilities.merge! common
+          capabilities.merge! JSON.parse(config.capabilities_option)
+          capabilities
+        end
+
+        def log_run_intro
+          # Nothing to do
+        end
+
+        def log_run_outro
+          # Nothing to do
+        end
+
+        def stop_session
+          super
+          # Acquire and output the logs for the current session
+          Maze::Runner.run_command("log show --predicate '(process == \"#{Maze.config.app}\")' --style syslog --start '#{Maze.start_time}' > #{Maze.config.app}.log")
+        end
+      end
+    end
+  end
+end

data/lib/maze/client/appium.rb

@@ -0,0 +1,23 @@
+module Maze
+  module Client
+    module Appium
+      def self.start
+        client_class =
+          case Maze.config.farm
+          when :bb then BitBarClient
+          when :bs
+            if Maze.config.legacy_driver?
+              $logger.info 'Using the Legacy (JWP) Appium client'
+              BrowserStackLegacyClient
+            else
+              $logger.info 'Using the W3C Appium client'
+              BrowserStackClient
+            end
+          when :local then LocalClient
+          end
+
+        client_class.new.tap(&:start_session)
+      end
+    end
+  end
+end