bugsnag-maze-runner 9.26.0 → 9.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe6839c118433a185e262346bb616d17f0b2b90072eeb5962b25bf25c9a5f22
-  data.tar.gz: bc1741d029fba29158f2508ce191735c983ee216a2c6aa9beced5c2c7b908062
+  metadata.gz: 9562b6754ae5e11ad6b47b979c6d36dac48df518a839b686db74342e6e8eea19
+  data.tar.gz: 94a85fd0ca95e2b66d9a6140ced8705adfb43c560ea7ad4a7d4d0d6bd42e460c
 SHA512:
-  metadata.gz: 74da6521237c5610846964b81407ab8316d1eebac30a7347cfd598e29508731e3ed0549679c8d08ccde20f2c08ae135c29224009ecfb45f8678237e044b6bd88
-  data.tar.gz: 3c852d53478a052d0950d9c35174c0ada1d223d2f7208fa98024547d6bc51e6d5bd4596d83afb332b8a85f505067c6e94e6cebfeaed623350a9cd3135a86d99e
+  metadata.gz: 9b68a919b41128a620c466953bd5a15cf9f17ee5f7e25c25e0e97e268b18ef84a282ba2efd7c44bf4dea82532c27c65d72e49ad99616aafd2f0d61c2a8e23c39
+  data.tar.gz: cfa2a623bcb0b80a622e6c0e8a6ce5b62910e59e6ac0ca6c5b46fbaa5c4f18b576260afadf82ea7fd9b373955f54ed5a1a1558bbf1e3f167a006d11cfe334179

data/bin/maze-runner

@@ -15,6 +15,7 @@ require_relative '../lib/maze/api/appium/manager'
 require_relative '../lib/maze/api/appium/app_manager'
 require_relative '../lib/maze/api/appium/device_manager'
 require_relative '../lib/maze/api/appium/file_manager'
+require_relative '../lib/maze/api/appium/ui_manager'
 require_relative '../lib/maze/api/cucumber/scenario'
 require_relative '../lib/maze/api/exit_code'
 require_relative '../lib/maze/bugsnag_config'

data/lib/features/steps/app_automator_steps.rb

@@ -5,7 +5,7 @@
 #
 # @step_input element_id [String] The locator id
 Given('the element {string} is present') do |element_id|
-  present = Maze.driver.wait_for_element(element_id)
+  present = Maze::Api::Appium::UiManager.new.wait_for_element(element_id)
   raise Maze::Error::AppiumElementNotFoundError.new("The element #{element_id} could not be found", element_id) unless present
 end
 
@@ -24,7 +24,15 @@ end
 #
 # @step_input element_id [String] The locator id
 When('I click the element {string}') do |element_id|
-  Maze.driver.click_element(element_id)
+  Maze::Api::Appium::UiManager.new.click_element(element_id)
+end
+
+# Clicks a given element if present
+# Requires a running Appium driver
+#
+# @step_input element_id [String] The locator id
+When('I click the element {string} if present') do |element_id|
+  Maze::Api::Appium::UiManager.new.click_element_if_present(element_id)
 end
 
 # Sends the app to the background indefinitely

data/lib/maze/api/appium/device_manager.rb

@@ -40,6 +40,23 @@ module Maze
           raise e
         end
 
+        # Gets logs from the device.
+        # @param log_type [String] The type pf log to get as recognised by Appium, such as 'syslog'
+        #
+        # @returns [Array, nil] Array of Selenium::WebDriver::LogEntry, or nil if the driver has failed
+        def get_log(log_type)
+          if failed_driver?
+            $logger.error 'Cannot get logs - Appium driver failed.'
+            return nil
+          end
+
+          @driver.get_log(log_type)
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver(e.message)
+          raise e
+        end
+
         # Sets the rotation of the device.
         # @param orientation [Symbol] The orientation to set the device to, :portrait or :landscape
         # @returns [Boolean] Success status

data/lib/maze/api/appium/ui_manager.rb

@@ -0,0 +1,69 @@
+require_relative '../../helper'
+require_relative './manager'
+
+module Maze
+  module Api
+    module Appium
+      # Provides operations for working with the app.
+      class UiManager < Maze::Api::Appium::Manager
+
+        # Checks for an element, waiting until it is present or the method times out
+        #
+        # @param element_id [String] the element to search for
+        # @param timeout [Integer] the maximum time to wait for an element to be present in seconds
+        # @param retry_if_stale [Boolean] enables the method to retry acquiring the element if a StaleObjectException occurs
+        #
+        # @returns [Boolean] Whether the operation was successfully performed
+        def wait_for_element(element_id, timeout = 15, retry_if_stale = true)
+          if failed_driver?
+            $logger.error 'Cannot wait for element - Appium driver failed.'
+            return false
+          end
+
+          @driver.wait_for_element(element_id, timeout, retry_if_stale)
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver(e.message)
+          raise e
+        end
+
+        # Clicks a given element.
+        #
+        # @param element_id [String] the element to click
+        #
+        # @returns [Boolean] Whether the operation was successfully performed
+        def click_element(element_id)
+          if failed_driver?
+            $logger.error 'Cannot click element - Appium driver failed.'
+            return false
+          end
+
+          @driver.click_element(element_id)
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver(e.message)
+          raise e
+        end
+
+        # Clicks a given element if present.
+        #
+        # @param element_id [String] the element to click
+        #
+        # @returns [Boolean] Whether the element was clicked
+        def click_element_if_present(element_id)
+          if failed_driver?
+            $logger.error 'Cannot click element - Appium driver failed.'
+            return false
+          end
+
+          @driver.click_element_if_present(element_id)
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/maze.rb

@@ -8,7 +8,7 @@ require_relative 'maze/timers'
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
 
-  VERSION = '9.26.0'
+  VERSION = '9.27.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 9.26.0
+  version: 9.27.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -444,6 +444,7 @@ files:
 - lib/maze/api/appium/device_manager.rb
 - lib/maze/api/appium/file_manager.rb
 - lib/maze/api/appium/manager.rb
+- lib/maze/api/appium/ui_manager.rb
 - lib/maze/api/cucumber/scenario.rb
 - lib/maze/api/exit_code.rb
 - lib/maze/appium_server.rb