bugsnag-maze-runner 6.27.0 → 7.22.1

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

data/lib/maze/docker.rb

@@ -54,6 +54,45 @@ module Maze
         @services_started = true
       end
 
+      # Execute a command in an already running docker container. Use {start_service}
+      # to build and run the service before calling this method
+      #
+      # This is equivalent to the Docker Compose 'exec' command:
+      # https://docs.docker.com/engine/reference/commandline/compose_exec/
+      #
+      # @param service [String] The name of the service. This must already be running
+      # @param command [String] The command to run
+      # @param detach [Boolean] Optional. Whether to run detached
+      def exec(service, command, detach: false)
+        flags = detach ? " --detach" : ""
+
+        run_docker_compose_command("exec #{flags} #{service} /bin/sh -c '#{command}'")
+      end
+
+      # Copy a file or directory from a container to the local filesystem
+      #
+      # This is equivalent to the Docker Compose 'cp' command:
+      # https://docs.docker.com/engine/reference/commandline/compose_cp/
+      #
+      # @param service [String] The name of the service to copy from. This must already be running
+      # @param from [String] The path to the file/directory that should be copied
+      # @param to [String] The path to copy the file/directory to
+      def copy_from_container(service, from:, to:)
+        run_docker_compose_command("cp #{service}:#{from} #{to}", success_codes: [0])
+      end
+
+      # Copy a file or directory from the local filesystem to a container
+      #
+      # This is equivalent to the Docker Compose 'cp' command:
+      # https://docs.docker.com/engine/reference/commandline/compose_cp/
+      #
+      # @param service [String] The name of the service to copy to. This must already be running
+      # @param from [String] The path to the file/directory that should be copied
+      # @param to [String] The path to copy the file/directory to
+      def copy_to_container(service, from:, to:)
+        run_docker_compose_command("cp #{from} #{service}:#{to}", success_codes: [0])
+      end
+
       # Kills a running service
       #
       # @param service [String] The name of the service to kill
@@ -91,7 +130,7 @@ module Maze
       def get_docker_compose_command(command)
         project_name = compose_project_name.nil? ? '' : "-p #{compose_project_name}"
 
-        "docker-compose #{project_name} -f #{COMPOSE_FILENAME} #{command}"
+        "docker compose #{project_name} -f #{COMPOSE_FILENAME} #{command}"
       end
 
       def run_docker_compose_command(command, success_codes: nil)

data/lib/maze/driver/appium.rb

@@ -10,6 +10,10 @@ module Maze
     # Provide a thin layer of abstraction above @see Appium::Driver
     class Appium < Appium::Driver
 
+      # @!attribute [rw] app_id
+      #   @return [String] The app_id derived from session_capabilities (appPackage on Android, bundleID on iOS)
+      attr_accessor :app_id
+
       # @!attribute [r] device_type
       #   @return [String] The device, from the list of device capabilities, used for this test
       attr_reader :device_type
@@ -25,11 +29,10 @@ module Maze
       # @param locator [Symbol] the primary locator strategy Appium should use to find elements
       def initialize(server_url, capabilities, locator = :id)
         # Sets up identifiers for ease of connecting jobs
-        name_capabilities = project_name_capabilities
+        capabilities ||= {}
 
         @element_locator = locator
         @capabilities = capabilities
-        @capabilities.merge! name_capabilities
 
         # Timers
         @find_element_timer = Maze.timers.add 'Appium - find element'
@@ -43,10 +46,6 @@ module Maze
             server_url: server_url
           }
         }, true)
-
-        $logger.info 'Appium driver initialized for:'
-        $logger.info "    project : #{name_capabilities[:project]}"
-        $logger.info "    build   : #{name_capabilities[:build]}"
       end
 
       # Starts the Appium driver
@@ -187,24 +186,6 @@ module Maze
         reset
       end
 
-      # 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'
-        build = SecureRandom.uuid
-
-        if ENV['BUILDKITE']
-          # Project
-          project = ENV['BUILDKITE_PIPELINE_NAME']
-        end
-        {
-          project: project,
-          build: build
-        }
-      end
-
       def device_info
         driver.execute_script('mobile:deviceInfo')
       end

data/lib/maze/driver/browser.rb

@@ -11,12 +11,10 @@ module Maze
       attr_reader :capabilities
 
       def initialize(driver_for, selenium_url=nil, capabilities=nil)
-        capabilities.merge! project_name_capabilities
+        capabilities ||= {}
         @capabilities = capabilities
         @driver_for = driver_for
         @selenium_url = selenium_url
-
-        start_driver
       end
 
       def find_element(*args)
@@ -62,24 +60,6 @@ module Maze
         JAVASCRIPT
       end
 
-      # 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'
-        build = SecureRandom.uuid
-
-        if ENV['BUILDKITE']
-          # Project
-          project = ENV['BUILDKITE_PIPELINE_NAME']
-        end
-        {
-          project: project,
-          build: build
-        }
-      end
-
       # Restarts the underlying-driver in the case an unrecoverable error occurs
       #
       # @param attempts [Integer] The number of times we should retry a failed attempt (defaults to 6)
@@ -91,8 +71,6 @@ module Maze
         start_driver(attempts)
       end
 
-      private
-
       # Attempts to create a new selenium driver a given number of times
       #
       # @param attempts [Integer] The number of times we should retry a failed attempt (defaults to 6)
@@ -114,15 +92,23 @@ module Maze
         end
       end
 
+      private
+
       # Creates and starts the selenium driver
       def create_driver(driver_for, selenium_url=nil)
         begin
           $logger.info "Starting Selenium driver"
           time = Time.now
           if driver_for == :remote
-            driver = ::Selenium::WebDriver.for :remote,
-                                                url: selenium_url,
-                                                desired_capabilities: @capabilities
+            if Maze.config.legacy_driver?
+              driver = ::Selenium::WebDriver.for :remote,
+                                                 url: selenium_url,
+                                                 desired_capabilities: @capabilities
+            else
+              driver = ::Selenium::WebDriver.for :remote,
+                                                 url: selenium_url,
+                                                 capabilities: @capabilities
+            end
           else
             driver = ::Selenium::WebDriver.for driver_for
           end

data/lib/maze/errors.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'appium_lib'
+
 module Maze
   module Error
     # An error raised when an appium element cannot be found
@@ -16,5 +20,33 @@ module Maze
         super(message)
       end
     end
+
+    ERROR_CODES = {
+      ::Selenium::WebDriver::Error::UnknownError => {
+        retry: true,
+        error_code: 10
+      },
+      ::Selenium::WebDriver::Error::WebDriverError => {
+        retry: true,
+        error_code: 10
+      },
+      Maze::Error::AppiumElementNotFoundError => {
+        retry: true,
+        error_code: 11
+      },
+      ::Selenium::WebDriver::Error::NoSuchElementError => {
+        retry: true,
+        error_code: 12
+      },
+      ::Selenium::WebDriver::Error::TimeoutError => {
+        retry: true,
+        error_code: 13
+      },
+      ::Selenium::WebDriver::Error::StaleElementReferenceError => {
+        retry: true,
+        error_code: 14
+      },
+    }.freeze
+
   end
 end