bugsnag-maze-runner 6.27.0 → 7.23.0

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

@@ -0,0 +1,188 @@
+chrome_latest:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'chrome'
+  version: 'latest'
+  resolution: '1920x1080'
+
+chrome_108:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'chrome'
+  version: '108'
+  resolution: '1920x1080'
+
+chrome_107:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'chrome'
+  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'
+  browserName: 'chrome'
+  version: '72'
+  resolution: '1920x1080'
+
+chrome_43:
+  platform': 'Windows'
+  osVersion: '10'
+  browserName: 'chrome'
+  version: '43'
+  resolution: '1920x1080'
+
+firefox_latest:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: 'latest'
+  resolution: '1920x1080'
+
+firefox_107:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '107'
+  resolution: '1920x1080'
+
+firefox_106:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '106'
+  resolution: '1920x1080'
+
+firefox_105:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '105'
+  resolution: '1920x1080'
+
+firefox_104:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '104'
+  resolution: '1920x1080'
+
+firefox_103:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '103'
+  resolution: '1920x1080'
+
+firefox_102:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'firefox'
+  version: '102'
+  resolution: '1920x1080'
+
+firefox_78:
+  platform: 'Windows'
+  osVersion: '10'
+  browserName: 'firefox'
+  version: '78'
+  resolution: '1920x1080'
+
+ie_11:
+  platform: 'Windows'
+  osVersion: '10'
+  browserName: 'internet explorer'
+  version: '11'
+  resolution: '1920x1080'
+
+edge_latest:
+  platform: 'Windows'
+  osVersion: '11'
+  browserName: 'MicrosoftEdge'
+  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'
+  browserName: 'safari'
+  version: '16'
+  resolution: '2560x1920'
+
+safari_15:
+  platform: 'macOS'
+  osVersion: '12'
+  browserName: 'safari'
+  version: '15'
+  resolution: '2560x1920'

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

@@ -0,0 +1,38 @@
+module Maze
+  module Client
+    module Selenium
+      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"))
+          capabilities.merge! browsers[config.browser]
+          capabilities.merge! JSON.parse(config.capabilities_option)
+          config.capabilities = capabilities
+
+          Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
+                                                             config.username,
+                                                             config.access_key
+
+          # 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'
+          Maze.driver = Maze::Driver::Browser.new :remote, selenium_url, config.capabilities
+          Maze.driver.start_driver
+        end
+
+        def stop_session
+          super
+          Maze::Client::BitBarClientUtils.stop_local_tunnel
+          Maze::Client::BitBarClientUtils.release_account(Maze.config.tms_uri) if ENV['BUILDKITE']
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,89 @@
+require 'selenium-webdriver'
+
+module Maze
+  module Client
+    module Selenium
+      class BrowserStackClient < BaseClient
+        def start_session
+          # Set up the capabilities
+          browsers = YAML.safe_load(File.read("#{__dir__}/bs_browsers.yml"))
+
+          config = Maze.config
+          browser = browsers[config.browser]
+
+          if config.legacy_driver?
+            capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
+            capabilities['browserstack.local'] = 'true'
+            capabilities['browserstack.localIdentifier'] = Maze.run_uuid
+            capabilities['browserstack.console'] = 'errors'
+
+            # Convert W3S capabilities to JSON-WP
+            capabilities['browser'] = browser['browserName']
+            capabilities['browser_version'] = browser['browserVersion']
+            capabilities['device'] = browser['device']
+            capabilities['os'] = browser['os']
+            capabilities['os_version'] = browser['osVersion']
+
+            capabilities.merge! JSON.parse(config.capabilities_option)
+            capabilities.merge! project_name_capabilities
+            config.capabilities = capabilities
+          else
+            capabilities = {
+              'bstack:options' => {
+                'local' => 'true',
+                'localIdentifier' => Maze.run_uuid
+              }
+            }
+            capabilities.deep_merge! browser
+            capabilities.deep_merge! JSON.parse(config.capabilities_option)
+            capabilities.merge! project_name_capabilities
+            config.capabilities = ::Selenium::WebDriver::Remote::Capabilities.new capabilities
+          end
+
+          # Start the tunnel
+          Maze::Client::BrowserStackClientUtils.start_local_tunnel config.bs_local,
+                                                                   Maze.run_uuid,
+                                                                   config.access_key
+
+          # Start the driver
+          selenium_url = "https://#{config.username}:#{config.access_key}@hub.browserstack.com/wd/hub"
+          Maze.driver = Maze::Driver::Browser.new :remote, selenium_url, config.capabilities
+          Maze.driver.start_driver
+
+          # Log details for the session
+          log_session_info
+        end
+
+        def stop_session
+          super
+          Maze::Client::BrowserStackClientUtils.stop_local_tunnel
+        end
+
+        private
+
+        # Determines and returns sensible project and build 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
+
+        def log_session_info
+          # Log a link to the BrowserStack session search dashboard
+          url = "https://automate.browserstack.com/dashboard/v2/search?query=#{Maze.run_uuid}&type=builds"
+          $logger.info Maze::LogUtil.linkify url, 'BrowserStack session(s)'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Maze
+  module Client
+    module Selenium
+      class LocalClient < BaseClient
+        def start_session
+          Maze.driver = Maze::Driver::Browser.new Maze.config.browser.to_sym
+          Maze.driver.start_driver
+        end
+
+        def stop_session
+          # No need to quit the local driver
+        end
+      end
+    end
+  end
+end

data/lib/maze/client/selenium.rb

@@ -0,0 +1,16 @@
+module Maze
+  module Client
+    module Selenium
+      def self.start
+        client_class =
+          case Maze.config.farm
+          when :bb then BitBarClient
+          when :bs then BrowserStackClient
+          when :local then LocalClient
+          end
+
+        client_class.new.tap(&:start_session)
+      end
+    end
+  end
+end

data/lib/maze/configuration.rb

@@ -10,6 +10,7 @@ module Maze
       self.receive_requests_wait = 30
       self.enforce_bugsnag_integrity = true
       self.captured_invalid_requests = Set[:errors, :sessions, :builds, :uploads, :sourcemaps]
+      @legacy_driver = false
     end
 
     #
@@ -60,13 +61,16 @@ 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
+
+    # Enables awareness of a public IP address on Buildkite with the Elastic CI Stack for AWS.
+    attr_accessor :aws_public_ip
+
     #
     # General appium configuration
     #
 
-    # Whether each scenario should have its own Appium session
-    attr_accessor :appium_session_isolation
-
     # Element locator strategy, :id or :accessibility_id
     attr_accessor :locator
 
@@ -82,16 +86,15 @@ module Maze
     # - on macOS, the name of an installed or previously executed application
     attr_accessor :app
 
-    # Whether the ResilientAppium driver should be used (only applicable when using Appium in the first place)
-    attr_accessor :resilient
-
     # Device farm to be used, one of:
-    # :cbt (CrossBrowserTesting)
     # :bs (BrowserStack)
     # :local (Using Appium Server with a local device)
     # :none (Cucumber-driven testing with no devices)
     attr_accessor :farm
 
+    # Whether the device farm secure tunnel should be started
+    attr_accessor :start_tunnel
+
     #
     # Device farm specific configuration
     #
@@ -102,9 +105,6 @@ module Maze
     # Location of the BrowserStackLocal binary (if used)
     attr_accessor :bs_local
 
-    # Location of the Sauce Connect binary (if used)
-    attr_accessor :sl_local
-
     # Bundle ID of the test application
     attr_accessor :app_bundle_id
 
@@ -132,6 +132,14 @@ module Maze
     # Access token for the test-management service
     attr_accessor :tms_token
 
+    # Whether the legacy (JSON-WP) Appium driver should be used
+    def legacy_driver?
+      @legacy_driver
+    end
+
+    def legacy_driver=(value)
+      @legacy_driver = value
+    end
 
     #
     # Local testing specific configuration