bugsnag-maze-runner 6.27.0

data/lib/maze/bitbar_utils.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+require 'open3'
+require 'fileutils'
+require 'json'
+
+module Maze
+  # Utils supporting the BitBar device farm integration
+  class BitBarUtils
+    BB_READY_FILE = 'bb.ready'
+    BB_KILL_FILE = 'bb.kill'
+    BB_USER_PREFIX = 'BB_USER_'
+    BB_KEY_PREFIX = 'BB_KEY_'
+
+    class << self
+
+      # Uploads an app to BitBar for later consumption
+      # @param api_key [String] The BitBar API key
+      # @param app [String] A path to the application file
+      def upload_app(api_key, app)
+        uuid_regex = /\A[0-9]+\z/
+
+        if uuid_regex.match? app
+          $logger.info "Using pre-uploaded app with ID #{app}"
+          app_uuid = app
+        else
+          expanded_app = Maze::Helper.expand_path(app)
+          $logger.info "Uploading app: #{expanded_app}"
+
+          # Upload the app to BitBar
+          uri = URI('https://cloud.bitbar.com/api/me/files')
+          request = Net::HTTP::Post.new(uri)
+          request.basic_auth(api_key, '')
+          request.set_form({ 'file' => File.new(expanded_app, 'rb') }, 'multipart/form-data')
+
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(request)
+          end
+
+          # Pull the UUID from the response
+          begin
+            response = JSON.parse res.body
+            if response.key?('id')
+              app_uuid = response['id']
+              $logger.info "Uploaded app ID: #{app_uuid}"
+              $logger.info 'You can use this ID to avoid uploading the same app more than once.'
+            else
+              $logger.error "Unexpected response body: #{response}"
+              raise 'App upload failed'
+            end
+          rescue JSON::ParserError
+            $logger.error "Expected JSON response, received: #{res}"
+            raise
+          end
+        end
+        app_uuid
+      end
+
+      # Requests an unused account id from the test-management-service
+      # @param tms_uri [String] The URI of the test-management-service
+      #
+      # @returns
+      def account_credentials(tms_uri)
+        Maze::Wait.new(interval: 10, timeout: 1800).until do
+          output = request_account_index(tms_uri)
+          case output.code
+          when '200'
+            body = JSON.parse(output.body, {symbolize_names: true})
+            @account_id = account_id = body[:id]
+            $logger.info "Using account #{account_id}, expiring at #{body[:expiry]}"
+            {
+              username: ENV["#{BB_USER_PREFIX}#{account_id}"],
+              access_key: ENV["#{BB_KEY_PREFIX}#{account_id}"]
+            }
+          when '409'
+            # All accounts are in use, wait for one to become available
+            $logger.info 'All accounts are currently in use, retrying in 30s'
+            false
+          else
+            # Something has gone wrong, throw an error
+            $logger.error "Unexpected status code received from test-management server"
+            raise
+          end
+        end
+      end
+
+      # Makes the HTTP call to acquire an account id
+      # @param tms_uri [String] The URI of the test-management-service
+      #
+      # @returns
+      def request_account_index(tms_uri)
+        uri = URI("#{tms_uri}/account/request")
+        request = Net::HTTP::Get.new(uri)
+        request['Authorization'] = Maze.config.tms_token
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(request)
+        end
+        res
+      end
+
+      # Informs the test-management-service that in-use account id is no longer in use
+      # @param tms_uri [String] The URI of the test-management-service
+      def release_account(tms_uri)
+        uri = URI("#{tms_uri}/account/release?account_id=#{@account_id}")
+        request = Net::HTTP::Get.new(uri)
+        request['Authorization'] = Maze.config.tms_token
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(request)
+        end
+      end
+    end
+  end
+end

data/lib/maze/browser_stack_devices.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Maze
+  # Provides a source of capabilities used to run tests against specific BrowserStack devices
+  # noinspection RubyStringKeysInHashInspection
+  class BrowserStackDevices
+    APPIUM_1_7_0 = '1.7.0'
+    APPIUM_1_9_1 = '1.9.1'
+    APPIUM_1_15_0 = '1.15.0'
+    APPIUM_1_20_2 = '1.20.2'
+    APPIUM_1_21_0 = '1.21.0'
+
+    class << self
+
+      def list_devices(os)
+        puts "BrowserStack #{os} devices available"
+        devices = DEVICE_HASH.dup
+        devices.select { |key, device|
+          device['os'].eql?(os)
+        }.map { |key, device|
+          new_device = device.dup
+          new_device['key'] = key
+          new_device
+        }.sort { |dev_1, dev_2|
+          dev_1['os_version'].to_f <=> dev_2['os_version'].to_f
+        }.each{ |device|
+          puts '------------------------------'
+          puts "Device key: #{device['key']}"
+          puts "Device: #{device['device']}"
+          puts "OS: #{device['os']}"
+          puts "OS version: #{device['os_version']}"
+        }
+      end
+
+      def make_android_hash(device, version, appium_version = APPIUM_1_20_2)
+        hash = {
+          'device' => device,
+          'os_version' => version,
+          'autoGrantPermissions' => 'true',
+          'platformName' => 'Android',
+          'os' => 'android',
+          'browserstack.appium_version' => appium_version
+        }
+        # disableAnimations only allowed > Android 6
+        if version.to_i > 6
+          hash['disableAnimations'] = 'true'
+        end
+        hash.freeze
+      end
+
+      def add_android(device, version, hash, appium_version = APPIUM_1_20_2)
+        # 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, appium_version
+      end
+
+      def make_ios_hash(device, version, appium_version = APPIUM_1_21_0)
+        {
+          'device' => device,
+          'os_version' => version,
+          'platformName' => 'iOS',
+          'os' => 'ios',
+          'disableAnimations' => 'true',
+          'browserstack.appium_version' => appium_version
+        }.freeze
+      end
+
+      def add_ios(device, version, hash, appium_version = APPIUM_1_21_0)
+        # 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, appium_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'),
+          'ANDROID_6_0' => make_android_hash('Google Nexus 6', '6.0'),
+          'ANDROID_5_0' => make_android_hash('Google Nexus 6', '5.0'),
+          'ANDROID_4_4' => make_android_hash('Google Nexus 5', '4.4', APPIUM_1_9_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', APPIUM_1_7_0),
+          'IOS_10' => make_ios_hash('iPhone 7', '10', APPIUM_1_7_0)
+        }
+
+        # 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', '8.0', hash                           # ANDROID_8_0_GOOGLE_PIXEL
+        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
+
+        add_android 'Motorola Moto X 2nd Gen', '6.0', hash                # ANDROID_6_0_MOTOROLA_MOTO_X_2ND_GEN
+        add_android 'Google Nexus 6', '6.0', hash                         # ANDROID_6_0_GOOGLE_NEXUS_6
+        add_android 'Samsung Galaxy S7', '6.0', hash                      # ANDROID_6_0_SAMSUNG_GALAXY_S7
+        add_android 'Google Nexus 6', '5.0', hash                         # ANDROID_5_0_GOOGLE_NEXUS_6
+        add_android 'Samsung Galaxy S6', '5.0', hash                      # ANDROID_5_0_SAMSUNG_GALAXY_S6
+        add_android 'Samsung Galaxy Note 4', '4.4', hash, APPIUM_1_9_1    # ANDROID_4_4_SAMSUNG_GALAXY_NOTE_4
+        add_android 'Samsung Galaxy Tab 4', '4.4', hash, APPIUM_1_9_1     # ANDROID_4_4_SAMSUNG_GALAXY_TAB_4
+
+        # Specific iOS devices
+        add_ios 'iPhone 8 Plus', '11.0', hash, APPIUM_1_7_0               # IOS_11_0_IPHONE_8_PLUS
+        add_ios 'iPhone X', '11.0', hash, APPIUM_1_7_0                    # IOS_11_0_IPHONE_X
+        add_ios 'iPhone SE', '11.0', hash, APPIUM_1_7_0                   # IOS_11_0_IPHONE_SE
+        add_ios 'iPhone 6', '11.0', hash, APPIUM_1_7_0                    # IOS_11_0_IPHONE_6
+        add_ios 'iPhone 6S', '11.0', hash, APPIUM_1_7_0                   # IOS_11_0_IPHONE_6S
+        add_ios 'iPhone 6S Plus', '11.0', hash, APPIUM_1_7_0              # IOS_11_0_IPHONE_6S_PLUS
+        add_ios 'iPad 5th', '11.0', hash, APPIUM_1_7_0                    # IOS_11_0_IPAD_5TH
+        add_ios 'iPad Mini 4', '11.0', hash, APPIUM_1_7_0                 # IOS_11_0_IPAD_MINI_4
+        add_ios 'iPad Pro 9.7 2016', '11.0', hash, APPIUM_1_7_0           # IOS_11_0_IPAD_PRO_9_7_2016
+        add_ios 'iPad 6th', '11.0', hash, APPIUM_1_7_0                    # IOS_11_0_IPAD_6TH
+        add_ios 'iPad Pro 12.9', '11.0', hash, APPIUM_1_7_0               # 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

data/lib/maze/browser_stack_utils.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Maze
+  # Utils supporting the BrowserStack device farm integration
+  class BrowserStackUtils
+    class << self
+
+      # Uploads an app to BrowserStack for later consumption
+      # @param username [String] the BrowserStack username
+      # @param access_key [String] the BrowserStack access key
+      # @param app_id_file [String] the file to write the uploaded app url to BrowserStack
+      def upload_app(username, access_key, app, app_id_file=nil)
+        if app.start_with? 'bs://'
+          app_url = app
+          $logger.info "Using pre-uploaded app from #{app}"
+        else
+          expanded_app = Maze::Helper.expand_path(app)
+
+          uri = URI('https://api-cloud.browserstack.com/app-automate/upload')
+          request = Net::HTTP::Post.new(uri)
+          request.basic_auth(username, access_key)
+          request.set_form({ 'file' => File.new(expanded_app, 'rb') }, 'multipart/form-data')
+
+          upload_tries = 0
+          allowed_tries = 10
+
+          while upload_tries < allowed_tries
+            $logger.info "Uploading app: #{expanded_app}"
+            res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+              http.request(request)
+            end
+
+            begin
+              body = res.body
+              response = JSON.parse body
+              if response.include?('error')
+                $logger.error "Upload failed due to error: #{response['error']}"
+              elsif !response.include?('app_url')
+                $logger.error "Upload failed, response did not include an app_url: #{res}"
+              else
+                # Successful upload
+                break
+              end
+            rescue JSON::ParserError
+              $logger.error "Error: expected JSON response, received: #{body}"
+            end
+
+            upload_tries += 1
+            if upload_tries < allowed_tries
+              $logger.info 'Retrying upload in 60s'
+              Kernel::sleep 60
+            end
+          end
+
+          if response.nil? || response.include?('error') || !response.include?('app_url')
+            raise "Failed to upload app after #{upload_tries} attempts"
+          end
+          
+          app_url = response['app_url']
+          $logger.info "app uploaded to: #{app_url}"
+          $logger.info 'You can use this url to avoid uploading the same app more than once.'
+        end
+
+        unless app_id_file.nil?
+          $logger.info "Writing uploaded app url to #{app_id_file}"
+          File.write(Maze::Helper.expand_path(app_id_file), app_url)
+        end
+
+        app_url
+      end
+
+      # Starts the BrowserStack local tunnel
+      # @param bs_local [String] path to the BrowserStackLocal binary
+      # @param local_id [String] unique key for the tunnel instance
+      # @param access_key [String] BrowserStack access key
+      def start_local_tunnel(bs_local, local_id, access_key)
+        $logger.info 'Starting BrowserStack local tunnel'
+        command = "#{bs_local} -d start --key #{access_key} --local-identifier #{local_id} " \
+                    '--force-local --only-automate --force'
+
+        # Extract the pid from the output so it gets killed at the end of the run
+        output = Runner.run_command(command)[0][0]
+        begin
+          @pid = JSON.parse(output)['pid']
+          $logger.info "BrowserStackLocal daemon running under pid #{@pid}"
+        rescue JSON::ParserError
+          $logger.warn 'Unable to parse pid from output, BrowserStackLocal will be left to die its own death'
+        end
+      end
+
+      # Stops the local tunnel
+      def stop_local_tunnel
+        if @pid
+          $logger.info "Stopping BrowserStack local tunnel"
+          Process.kill('TERM', @pid)
+          @pid = nil
+        end
+      rescue Errno::ESRCH
+        # ignored
+      end
+
+      # Gets the build/session info from BrowserStack
+      # @param username [String] the BrowserStack username
+      # @param access_key [String] the BrowserStack access key
+      # @param build_name [String] the name of the BrowserStack build
+      def build_info(username, access_key, build_name)
+        # Get the ID of a build
+        uri = URI("https://api.browserstack.com/app-automate/builds.json?name=#{build_name}")
+        request = Net::HTTP::Get.new(uri)
+        request.basic_auth(username, access_key)
+
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        build_info = JSON.parse(res.body)
+
+        if !build_info.empty?
+          build_id = build_info[0]['automation_build']['hashed_id']
+
+          # Get the build info
+          uri = URI("https://api.browserstack.com/app-automate/builds/#{build_id}/sessions")
+          request = Net::HTTP::Get.new(uri)
+          request.basic_auth(username, access_key)
+
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(request)
+          end
+
+          build_json = JSON.parse(res.body)
+        else
+          raise "No build found for given ID: #{build_name}"
+        end
+        build_json
+      end
+
+      # @param username [String] the BrowserStack username
+      # @param access_key [String] the BrowserStack access key
+      # @param name [String] name of the build the log is being downloaded from
+      # @param log_url [String] url to the log
+      # @param log_type [Symbol] The type of log we are downloading
+      def download_log(username, access_key, name, log_url, log_type)
+        begin
+          path = File.join(Dir.pwd, 'maze_output', log_type.to_s)
+          FileUtils.makedirs(path)
+
+          uri = URI(log_url)
+          request = Net::HTTP::Get.new(uri)
+          request.basic_auth(username, access_key)
+
+          res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(request)
+          end
+
+          $logger.info "Saving #{log_type.to_s} log to #{path}/#{name}.log"
+          File.open("#{path}/#{name}.log", 'w+') { |file| file.write(res.body) }
+        rescue StandardError => e
+          $logger.warn "Unable to save log from #{log_url}"
+          $logger.warn e
+        end
+      end
+    end
+  end
+end

data/lib/maze/browsers_bs.yml

@@ -0,0 +1,220 @@
+# Selenium capabilities for browsers available on BrowserStack
+---
+ie_8:
+  browser: "ie"
+  browser_version: "8"
+  os: "windows"
+  os_version: "7"
+
+ie_9:
+  browser: "ie"
+  browser_version: "9"
+  os: "windows"
+  os_version: "7"
+
+ie_10:
+  browser: "ie"
+  browser_version: "10"
+  os: "windows"
+  os_version: "8"
+
+ie_11:
+  browser: "ie"
+  browser_version: "11"
+  os: "windows"
+  os_version: "10"
+
+edge_14:
+  browser: "edge"
+  browser_version: "14"
+  os: "windows"
+  os_version: "10"
+
+edge_15:
+  browser: "edge"
+  browser_version: "15"
+  os: "windows"
+  os_version: "10"
+
+edge_17:
+  browser: "edge"
+  browser_version: "17"
+  os: "windows"
+  os_version: "10"
+
+safari_6:
+  browser: "safari"
+  browser_version: "6"
+  os: "OS X"
+  os_version: "lion"
+
+safari_10:
+  browser: "safari"
+  browser_version: "10.0"
+  os: "OS X"
+  os_version: "sierra"
+
+safari_13:
+  browser: "Safari"
+  browser_version: "13.0"
+  os: "OS X"
+  os_version: "Catalina"
+
+safari_14:
+  browser: "Safari"
+  browser_version: "14.0"
+  os: "OS X"
+  os_version: "Big Sur"
+
+safari_15:
+  browser: "Safari"
+  browser_version: "15.0"
+  os: "OS X"
+  os_version: "Monterey"
+
+iphone_6s:
+  browser: "iphone"
+  device: "iPhone 6S"
+  os: "ios"
+  os_version: "9.0"
+  real_mobile: true
+
+iphone_7:
+  browser: "iphone"
+  device: "iPhone 7"
+  os: "ios"
+  os_version: "10.3"
+  real_mobile: true
+
+iphone_13:
+  browser: "iphone"
+  device: "iPhone 13"
+  os: "ios"
+  os_version: "15.4"
+  real_mobile: true
+
+android_nexus5:
+  browser: "Android Browser"
+  device: "Google Nexus 5"
+  os: "android"
+  os_version: "4.4"
+  real_mobile: true
+
+android_s6:
+  browser: "Android Browser"
+  device: "Samsung Galaxy S6"
+  os: "android"
+  os_version: "5.0"
+  real_mobile: true
+
+android_s7:
+  browser: "Android Browser"
+  device: "Samsung Galaxy S7"
+  os: "android"
+  os_version: "6.0"
+  real_mobile: true
+
+android_s8:
+  browser: "Android Browser"
+  device: "Samsung Galaxy S8 Plus"
+  os: "android"
+  os_version: "7.0"
+  real_mobile: true
+
+firefox_30:
+  browser: "firefox"
+  browser_version: "30"
+  os: "windows"
+  os_version: "7"
+
+firefox_56:
+  browser: "firefox"
+  browser_version: "56"
+  os: "windows"
+  os_version: "10"
+
+firefox_78:
+  browser: "firefox"
+  browser_version: "78"
+  os: "windows"
+  os_version: "10"
+
+firefox_latest:
+  browser: "firefox"
+  browser_version: "latest"
+  os: "windows"
+  os_version: "10"
+  selenium_version: "3.10.0"
+
+chrome_30:
+  browser: "chrome"
+  browser_version: "30.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_32:
+  browser: "chrome"
+  browser_version: "32.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_34:
+  browser: "chrome"
+  browser_version: "34.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_36:
+  browser: "chrome"
+  browser_version: "36.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_38:
+  browser: "chrome"
+  browser_version: "38.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_40:
+  browser: "chrome"
+  browser_version: "40.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_42:
+  browser: "chrome"
+  browser_version: "42.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_43:
+  browser: "chrome"
+  browser_version: "43.0"
+  os: "windows"
+  os_version: "7"
+
+chrome_53:
+  browser: "chrome"
+  browser_version: "53.0"
+  os: "windows"
+  os_version: "10"
+
+chrome_61:
+  browser: "chrome"
+  browser_version: "61.0"
+  os: "windows"
+  os_version: "10"
+
+chrome_72:
+  browser: "chrome"
+  browser_version: "72.0"
+  os: "windows"
+  os_version: "10"
+
+chrome_latest:
+  browser: "chrome"
+  browser_version: "latest"
+  os: "windows"
+  os_version: "10"
+  selenium_version: "3.14.0"