bugsnag-maze-runner 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/compare.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Maze
+  # Routines for conducting comparisons
+  module Compare
+    # Provides a way to delivering results of element comparisons to test steps
+    class Result
+      # @!attribute [r] reasons
+      #   @return [Array] An array of reasons for a comparison result
+      attr_reader :reasons
+
+      # @!attribute [w] equal
+      #   @param [Boolean] Indicates if the comparison indicated the elements were equal
+      attr_writer :equal
+
+      # @!attribute [r] keys
+      #   @return [Array] An array of keys checked
+      attr_reader :keys
+
+      # Creates the Result object
+      def initialize
+        @equal = true
+        @keys = []
+        @reasons = []
+      end
+
+      # Indicates if the values compared to produced this result were equal
+      #
+      # @return [Boolean] Whether the elements were equal
+      def equal?
+        @equal
+      end
+
+      # Returns the keys traversed in order to compare the end values
+      #
+      # @return [String] The keypath used in the test
+      def keypath
+        keys.length > 0 ? keys.reverse.join('.') : '<root>'
+      end
+
+      # Provides a standard assertion of equality, with standardised output
+      def assert_equal
+        Maze.check.true(@equal, "The compared fields do not match:\n #{result.reasons.join('\n')}")
+      end
+    end
+
+    class << self
+      # Compares two objects for value equality, traversing to compare each
+      # nested object.
+      #
+      # @param obj1 [Any] The first object to compare
+      # @param obj2 [Any] The second object to compare
+      # @param result [Result|nil] Optional. Used for comparing recursively
+      #
+      # @return [Result] The result of comparing the objects
+      def value(obj1, obj2, result = nil)
+        result ||= Result.new
+        return result if obj1 == 'IGNORE'
+
+        if obj1 == 'NUMBER'
+          if obj2.is_a?(Numeric)
+            return result
+          else
+            result.equal = false
+            result.reasons << "A Number was expected, '#{obj2.class} received"
+            return result
+          end
+        end
+
+        unless obj1.class == obj2.class
+          result.equal = false
+          result.reasons << "Object types differ - expected '#{obj1.class}', received '#{obj2.class}'"
+          return result
+        end
+
+        case obj1
+        when Array
+          array(obj1, obj2, result)
+        when Hash
+          hash(obj1, obj2, result)
+        when String
+          string(obj1, obj2, result)
+        else
+          result.reasons << "#{obj1} is not equal to #{obj2}" unless (result.equal = (obj1 == obj2))
+        end
+        result
+      end
+
+      # Compares two arrays for value equality, traversing and comparing each element.
+      # Results are written to the given Result object.
+      #
+      # @param array1 [Array] The first array to compare
+      # @param array2 [Array] The second array to compare
+      # @param result [Result] The Result to store the results
+      def array(array1, array2, result)
+        unless array1.length == array2.length
+          result.equal = false
+          result.reasons << "Expected #{array1.length} items in array, received #{array2.length}"
+          return
+        end
+
+        array1.each_with_index do |obj1, index|
+          value(obj1, array2[index], result)
+          unless result.equal?
+            result.keys << index.to_s
+            break
+          end
+        end
+      end
+
+      # Compares two hashes for value equality, traversing and comparing each key-value pair.
+      # Results are written to the given Result object.
+      #
+      # @param hash1 [Hash] The first hash to compare
+      # @param hash2 [Hash] The second hash to compare
+      # @param result [Result] The Result to store the results
+      def hash(hash1, hash2, result)
+        unless hash1.keys.length == hash2.keys.length
+          result.equal = false
+          missing = hash1.keys - hash2.keys
+          unexpected = hash2.keys - hash1.keys
+          result.reasons << "Missing keys from hash: #{missing.join(',')}" unless missing.empty?
+          result.reasons << "Unexpected keys in hash: #{unexpected.join(',')}" unless unexpected.empty?
+          return
+        end
+
+        hash1.each do |key, value|
+          value(value, hash2[key], result)
+          unless result.equal?
+            result.keys << key
+            break
+          end
+        end
+      end
+
+      # Compares two strings, writing the results to the given Result object.
+      #
+      # @param template [String] The expected string
+      # @param str2 [String] The string to compare
+      # @param result [Result] The Result to store the results
+      def string(template, str2, result)
+        return if template == str2 || regex_match(template, str2)
+
+        result.equal = false
+        result.reasons << "'#{str2}' does not match '#{template}'"
+      end
+
+      # Matches a string against a regex
+      #
+      # @param template [String] The regex to test with
+      # @param value [String] The value to test
+      #
+      # @return [Boolean] Whether the regex produced a match
+      def regex_match(template, value)
+        regex = template
+        regex = "^#{regex}$" unless regex.start_with?('^') || regex.end_with?('$')
+        value =~ /#{regex}/
+      end
+    end
+  end
+end