Module: Calabash::Cucumber::WaitHelpers
- Includes:
- Core, TestsHelpers
- Included in:
- Operations
- Defined in:
- lib/calabash-cucumber/wait_helpers.rb
Defined Under Namespace
Classes: WaitError
Constant Summary collapse
- CALABASH_CONDITIONS =
{:none_animating => "NONE_ANIMATING", :no_network_indicator => "NO_NETWORK_INDICATOR"}
Constants included from PlaybackHelpers
Instance Method Summary collapse
- #handle_error_with_options(ex, timeout_message, screenshot_on_error) ⇒ Object
- #screenshot_and_retry(msg, &block) ⇒ Object
- #touch_transition(touch_q, done_queries, check_options = {}, animation_options = {}) ⇒ Object
- #wait_error(msg) ⇒ Object
- #wait_for(options_or_timeout = {:timeout => 30, :retry_frequency => 0.3, :post_timeout => 0, :timeout_message => 'Timed out waiting...', :screenshot_on_error => true}, &block) ⇒ Object
- #wait_for_condition(options = {}) ⇒ Object
-
#wait_for_elements_do_not_exist(elements_arr, options = {}) ⇒ Object
options for wait_for apply.
-
#wait_for_elements_exist(elements_arr, options = {}) ⇒ Object
options for wait_for apply.
- #wait_for_no_network_indicator(options = {}) ⇒ Object
- #wait_for_none_animating(options = {}) ⇒ Object
-
#wait_for_transition(done_queries, check_options = {}, animation_options = {}) ⇒ Object
may be called with a string (query) or an array of strings.
- #wait_poll(opts, &block) ⇒ Object
Methods included from TestsHelpers
#check_element_does_not_exist, #check_element_exists, #check_view_with_mark_exists, #classes, #each_cell, #each_cell_and_back, #element_does_not_exist, #element_exists, #navigation_path, #query_map, #view_with_mark_exists
Methods included from FailureHelpers
#fail, #screenshot, #screenshot_and_raise, #screenshot_embed
Methods included from Core
#backdoor, #calabash_exit, #cell_swipe, #client_version, #console_attach, #double_tap, #extract_query_and_options, #flash, #flick, #launcher, #location_for_place, #locations_for_place, #macro, #move_wheel, #pan, #picker, #pinch, #prepare_query_options, #query, #query_action_with_options, #query_all, #scroll, #scroll_to_cell, #scroll_to_row, #scroll_to_row_with_mark, #send_app_to_background, #server_version, #set_location, #shutdown_test_server, #start_test_server_in_background, #stop_test_server, #swipe, #touch, #touch_hold, #two_finger_tap
Methods included from PlaybackHelpers
#find_compatible_recording, #interpolate, #load_playback_data, #load_recording, #playback, #playback_file_directories, #record_begin, #record_end, #recording_name_for
Methods included from RotationHelpers
#rotate, #rotate_home_button_to, #rotation_candidates
Methods included from StatusBarHelpers
#device_orientation, #landscape?, #portrait?, #status_bar_orientation
Methods included from UIA
#escape_uia_string, #send_uia_command, #uia, #uia_call, #uia_call_method, #uia_double_tap, #uia_double_tap_mark, #uia_double_tap_offset, #uia_element_does_not_exist?, #uia_element_exists?, #uia_enter, #uia_flick_offset, #uia_handle_command, #uia_names, #uia_pan, #uia_pan_offset, #uia_pinch, #uia_pinch_offset, #uia_query, #uia_query_el, #uia_query_windows, #uia_screenshot, #uia_scroll_to, #uia_send_app_to_background, #uia_serialize_argument, #uia_serialize_arguments, #uia_serialize_command, #uia_set_location, #uia_swipe, #uia_swipe_offset, #uia_tap, #uia_tap_mark, #uia_tap_offset, #uia_touch_hold, #uia_touch_hold_offset, #uia_two_finger_tap, #uia_two_finger_tap_offset, #uia_type_string
Methods included from Map
Methods included from QueryHelpers
Methods included from ConnectionHelpers
Methods included from EnvironmentHelpers
#_deprecated, #debug_logging?, #default_device, #device_family_iphone?, #full_console_logging?, #ios5?, #ios6?, #ios7?, #ipad?, #iphone?, #iphone_4in?, #iphone_5?, #iphone_app_emulated_on_ipad?, #ipod?, #no_deprecation_warnings?, #simulator?, #uia_available?, #uia_not_available?, #xamarin_test_cloud?
Instance Method Details
#handle_error_with_options(ex, timeout_message, screenshot_on_error) ⇒ Object
179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 179 def (ex, , screenshot_on_error) msg = ( || ex) if ex msg = "#{msg} (#{ex.class})" end if screenshot_on_error screenshot_and_raise msg else raise msg end end |
#screenshot_and_retry(msg, &block) ⇒ Object
60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 60 def screenshot_and_retry(msg, &block) path = screenshot res = yield # Validate after taking screenshot if res FileUtils.rm_f(path) return res else (path, 'image/png', msg) raise wait_error(msg) end end |
#touch_transition(touch_q, done_queries, check_options = {}, animation_options = {}) ⇒ Object
174 175 176 177 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 174 def touch_transition(touch_q, done_queries,={},={}) touch(touch_q) wait_for_transition(done_queries,,) end |
#wait_error(msg) ⇒ Object
191 192 193 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 191 def wait_error(msg) (msg.is_a?(String) ? WaitError.new(msg) : msg) end |
#wait_for(options_or_timeout = {:timeout => 30, :retry_frequency => 0.3, :post_timeout => 0, :timeout_message => 'Timed out waiting...', :screenshot_on_error => true}, &block) ⇒ Object
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 18 def wait_for(= {:timeout => 30, :retry_frequency => 0.3, :post_timeout => 0, :timeout_message => 'Timed out waiting...', :screenshot_on_error => true}, &block) #note Hash is preferred, number acceptable for backwards compat default_timeout = 30 timeout = || default_timeout post_timeout=0 retry_frequency=0.3 = nil screenshot_on_error = true if .is_a?(Hash) timeout = [:timeout] || default_timeout retry_frequency = [:retry_frequency] || retry_frequency post_timeout = [:post_timeout] || post_timeout = [:timeout_message] if .key?(:screenshot_on_error) screenshot_on_error = [:screenshot_on_error] end end begin Timeout::timeout(timeout, WaitError) do sleep(retry_frequency) until yield end sleep(post_timeout) if post_timeout > 0 rescue WaitError => e msg = || e if screenshot_on_error sleep(retry_frequency) return screenshot_and_retry(msg, &block) else raise wait_error(msg) end rescue Exception => e (e, nil, screenshot_on_error) end end |
#wait_for_condition(options = {}) ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 108 def wait_for_condition( = {}) [:timeout] = [:timeout] || 30 [:query] = [:query] || "view" if .has_key?(:condition) opt_condition = [:condition] if opt_condition.is_a?(Symbol) target_condition = CALABASH_CONDITIONS[opt_condition] elsif opt_condition.is_a?(String) target_condition = [:condition] end [:condition] = target_condition end [:condition] = [:condition] || CALABASH_CONDITIONS[:none_animating] [:post_timeout] = [:post_timeout] || 0 [:frequency] = [:frequency] || 0.3 retry_frequency = [:retry_frequency] = [:retry_frequency] || 0.3 [:count] = [:count] || 2 = [:timeout_message] = [:timeout_message] || "Timeout waiting for condition (#{[:condition]})" screenshot_on_error = [:screenshot_on_error] = [:screenshot_on_error] || true begin Timeout::timeout([:timeout],WaitError) do loop do res = http({:method => :post, :path => 'condition'}, ) res = JSON.parse(res) break if res['outcome'] == 'SUCCESS' sleep([:retry_frequency]) if [:retry_frequency] > 0 end sleep([:post_timeout]) if [:post_timeout] > 0 end rescue WaitError => e msg = || e if screenshot_on_error sleep(retry_frequency) return screenshot_and_retry(msg) do res = http({:method => :post, :path => 'condition'}, ) res = JSON.parse(res) res['outcome'] == 'SUCCESS' end else raise wait_error(msg) end rescue Exception => e (e,nil, [:screenshot_on_error]) end end |
#wait_for_elements_do_not_exist(elements_arr, options = {}) ⇒ Object
options for wait_for apply
101 102 103 104 105 106 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 101 def wait_for_elements_do_not_exist(elements_arr, ={}) [:timeout_message] = [:timeout_message] || "Timeout waiting for no elements matching: #{elements_arr.join(",")}" wait_for() do elements_arr.none? { |q| element_exists(q) } end end |
#wait_for_elements_exist(elements_arr, options = {}) ⇒ Object
options for wait_for apply
91 92 93 94 95 96 97 98 99 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 91 def wait_for_elements_exist(elements_arr, ={}) if elements_arr.is_a?(String) elements_arr = [elements_arr] end [:timeout_message] = [:timeout_message] || "Timeout waiting for elements: #{elements_arr.join(",")}" wait_for() do elements_arr.all? { |q| element_exists(q) } end end |
#wait_for_no_network_indicator(options = {}) ⇒ Object
162 163 164 165 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 162 def wait_for_no_network_indicator( = {}) [:condition] = CALABASH_CONDITIONS[:no_network_indicator] wait_for_condition() end |
#wait_for_none_animating(options = {}) ⇒ Object
157 158 159 160 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 157 def wait_for_none_animating( = {}) [:condition] = CALABASH_CONDITIONS[:none_animating] wait_for_condition() end |
#wait_for_transition(done_queries, check_options = {}, animation_options = {}) ⇒ Object
may be called with a string (query) or an array of strings
168 169 170 171 172 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 168 def wait_for_transition(done_queries, ={},={}) done_queries = [*done_queries] wait_for_elements_exist(done_queries,) wait_for_none_animating() end |
#wait_poll(opts, &block) ⇒ Object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/calabash-cucumber/wait_helpers.rb', line 73 def wait_poll(opts, &block) test = opts[:until] if test.nil? cond = opts[:until_exists] raise 'Must provide :until or :until_exists' unless cond test = lambda { element_exists(cond) } end wait_for(opts) do if test.call() true else yield false end end end |