Module: Awetestlib::Regression::Waits
- Included in:
- Runner
- Defined in:
- lib/awetestlib/regression/waits.rb
Overview
Methods for waiting until something has happened, or waiting while a condition exists, in the browser or DOM. sleep_for() is the basic technique. Its disadvantage is that it needs to be set for the longest likely wait time. The wait methods take advantage of the Watir and Watir Webdriver wait functionality to pause only as long as necessary for the element in question to be in the state needed.
Core collapse
-
#sleep_for(seconds, dbg = true, desc = '') ⇒ Object
Sleep for seconds seconds before continuing execution of the script.
-
#wait_for_element_to_reappear(browser, how, what, desc = '', timeout = 20) ⇒ Boolean
Wait while an element identified by attribute how with value what 1) exists, disappears, and exists again.
-
#wait_until(browser, desc, timeout = 45, skip_pass = false, &block) ⇒ Boolean
(also: #wait_until_true)
Wait until expression in *&block* returns true.
- #wait_until_enabled(browser, what, how, value, desc = '') ⇒ Object
-
#wait_until_exists(browser, element, how, what, desc = '') ⇒ Boolean
Wait until element of type element, identified by attribute how with value what exists on the page.
-
#wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = false) ⇒ Boolean
Wait until element, identified by attribute how and its value what, exists.
-
#wait_until_ready_quiet(browser, how, what, desc = '', timeout = 45, quiet = true) ⇒ Boolean
Wait until element, identified by attribute how and its value what, exists.
- #wait_until_text(browser, strg, desc = '', timeout = 60) ⇒ Object (also: #wait_until_by_text)
- #wait_until_visible(browser, element, how, what, desc = '') ⇒ Object
-
#wait_while(browser, desc, timeout = 45, &block) ⇒ Boolean
(also: #wait_while_true)
Wait while expression in *&block* returns true.
Altenatives collapse
-
#hold_for_text(browser, how_long, text, desc = '', threshold = 20, interval = 0.25) ⇒ Boolean
(also: #wait_for_text)
Wait for a specific text to appear in the browser.
-
#wait_for(how_long, what_for, interval = 0.25) ⇒ Object
Wait up to how_long seconds for DOM element what_for to exist in the page.
-
#wait_for_exists(how_long, what_for) ⇒ Object
Wait up to how_long seconds for DOM element what_for to exist in the page.
-
#wait_the_hard_way(browser, how, what, wait = 6, interval = 0.25) ⇒ Boolean
Wait up to how_long seconds for DOM element identified by attribute how and its value what to exist in the page.
Instance Method Details
#hold_for_text(browser, how_long, text, desc = '', threshold = 20, interval = 0.25) ⇒ Boolean Also known as: wait_for_text
This is a last resort method when other wait or wait until avenues have been exhausted.
Wait for a specific text to appear in the browser.
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/awetestlib/regression/waits.rb', line 372 def hold_for_text(browser, how_long, text, desc = '', threshold = 20, interval = 0.25) countdown = how_long Watir::Wait.until { browser.exists? } sleep_for(1) while ((not browser.contains_text(text)) and countdown > 0) sleep(interval) countdown = countdown - interval end if countdown < how_long waittime = how_long - countdown passed_to_log("#{__method__} '#{text}' found after #{waittime} second(s) #{desc}") if waittime > threshold failed_to_log("#{__method__} '#{text}' took #{waittime} second(s). (threshold: #{threshold} seconds) #{desc}") end true else failed_to_log("#{__method__} '#{text}' not found after #{how_long} second(s) #{desc}") false end rescue failed_to_log("Unable to #{__method__} '#{text}'. '#{$!}' #{desc}") end |
#sleep_for(seconds, dbg = true, desc = '') ⇒ Object
Sleep for seconds seconds before continuing execution of the script. A message is logged (but not reported) which, by default, includes a trace showing where in the script the sleep was invoked.
16 17 18 19 20 21 |
# File 'lib/awetestlib/regression/waits.rb', line 16 def sleep_for(seconds, dbg = true, desc = '') trace = "\n#{get_debug_list}" if dbg msg = ("Sleeping for #{seconds} seconds.", desc, trace) info_to_log(msg) sleep(seconds) end |
#wait_for(how_long, what_for, interval = 0.25) ⇒ Object
This is a last resort method when other wait or wait until avenues have
Wait up to how_long seconds for DOM element what_for to exist in the page. been exhausted.
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'lib/awetestlib/regression/waits.rb', line 410 def wait_for(how_long, what_for, interval = 0.25) countdown = how_long while ((not what_for.exists?) and countdown > 0) sleep(interval) puts what_for.inspect+':'+countdown.to_s countdown = countdown - interval end if countdown puts 'found '+what_for.inspect passed_tolog("wait_for (#{how_long} found "+what_for.inspect) else puts 'Did not find '+what_for.inspect failed_tolog("wait_for (#{how_long} did not find "+what_for.inspect) end countdown end |
#wait_for_element_to_reappear(browser, how, what, desc = '', timeout = 20) ⇒ Boolean
Wait while an element identified by attribute how with value what 1) exists, disappears, and exists again.
32 33 34 35 36 |
# File 'lib/awetestlib/regression/waits.rb', line 32 def wait_for_element_to_reappear(browser, how, what, desc = '', timeout = 20) msg = "Element #{how}=#{what} exists. #{desc}" wait_while(browser, "While: #{msg}", timeout) { browser.element(how, what).exists? } wait_until(browser, "Until: #{msg}", timeout) { browser.element(how, what).exists? } end |
#wait_for_exists(how_long, what_for) ⇒ Object
This is a last resort method when other wait or wait until avenues have been exhausted.
Wait up to how_long seconds for DOM element what_for to exist in the page.
401 402 403 |
# File 'lib/awetestlib/regression/waits.rb', line 401 def wait_for_exists(how_long, what_for) wait_for(how_long, what_for) end |
#wait_the_hard_way(browser, how, what, wait = 6, interval = 0.25) ⇒ Boolean
This is a last resort method when other wait or wait until avenues have been exhausted.
Wait up to how_long seconds for DOM element identified by attribute how and its value what to exist in the page.
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/awetestlib/regression/waits.rb', line 438 def wait_the_hard_way(browser, how, what, wait = 6, interval = 0.25) count = (wait / interval).to_i + 1 tally = 0 ok = (1 / interval).to_i + 1 debug_to_log("#{__method__}: wait: #{wait} secs; interval: #{interval} secs; count; #{count}; thresh: #{ok}") Watir::Wait.until { browser.exists? } sleep_for(1) (1..count).each do |x| begin if browser.element(how, what).exists? tally += 1 debug_to_log("#{x}: #{(x - 1) * interval}: #{what} exists.") else tally = 0 debug_to_log("#{x}: #{(x - 1) * interval}: #{what} does not exist.") end rescue tally = 0 debug_to_log("#{x}: #{(x - 1) * interval}: #{what} rescue: #{$!}") end if tally >= ok return true end sleep(interval) end end |
#wait_until(browser, desc, timeout = 45, skip_pass = false, &block) ⇒ Boolean Also known as: wait_until_true
Wait until expression in *&block* returns true.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/awetestlib/regression/waits.rb', line 147 def wait_until(browser, desc, timeout = 45, skip_pass = false, &block) #TODO: Would like to be able to see the block code in the log message instead of the identification msg = "Wait until #{desc}" start = Time.now.to_f Watir::Wait.until { browser.exists? } begin Watir::Wait.until(timeout) { block.call(nil) } rescue => e if e.class.to_s =~ /TimeOutException/ or e. =~ /timed out/ failed_to_log("#{msg} '#{$!}'") return false elsif not rescue_me(e, __method__, "#{block.to_s}", "#{browser.class}") raise e end end stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{start} stop:#{stop} block: #{block.to_s}") # sleep 1 passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") unless skip_pass # {#{block.to_s}}") true rescue failed_to_log("Unable to complete #{msg} '#{$!}'") end |
#wait_until_enabled(browser, what, how, value, desc = '') ⇒ Object
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/awetestlib/regression/waits.rb', line 275 def wait_until_enabled(browser, what, how, value, desc = '') # TODO: This can be simplified start = Time.now.to_f Watir::Wait.until { browser.exists? } sleep_for(1) begin case what when :link Watir::Wait.until { browser.link(how, value).enabled? } when :button Watir::Wait.until { browser.(how, value).enabled? } when :radio Watir::Wait.until { browser.radio(how, value).enabled? } when :checkbox Watir::Wait.until { browser.checkbox(how, value).enabled? } when :div Watir::Wait.until { browser.div(how, value).enabled? } when :select_list Watir::Wait.until { browser.select_list(how, value).enabled? } when :text_field Watir::Wait.until { browser.text_field(how, value).enabled? } when :table Watir::Wait.until { browser.table(how, value).enabled? } else Watir::Wait.until { browser.element(how, value).enabled? } end rescue => e if e.class.to_s =~ /TimeOutException/ failed_to_log("Wait until (#{what} :#{how}=>#{value}) enabled. #{desc}: '#{$!}' #{desc}") return false elsif not rescue_me(e, __method__, "#{block.to_s}", "#{browser.class}") raise e end end stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{start} stop:#{stop}") # sleep 1 passed_to_log("Wait until (#{what} :#{how}=>#{value}) enabled. #{desc} (#{stop - start} seconds)") true rescue failed_to_log("Unable to complete wait until (#{what} :#{how}=>#{value}) enabled. #{desc}: '#{$!}'") end |
#wait_until_exists(browser, element, how, what, desc = '') ⇒ Boolean
Wait until element of type element, identified by attribute how with value what exists on the page. Timeout is the default used by watir (60 seconds)
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/awetestlib/regression/waits.rb', line 49 def wait_until_exists(browser, element, how, what, desc = '') msg = ("Wait until (:#{element} :#{how}=>'#{what}') exists.", desc) start = Time.now.to_f # TODO: try Watir::Wait.until { browser.element(how, what).exists? } instead of this (cumbersome) case statement # TODO: above fails on frame Watir::Wait.until { browser.exists? } begin case element when :link Watir::Wait.until { browser.link(how, what).exists? } when :button Watir::Wait.until { browser.(how, what).exists? } when :radio Watir::Wait.until { browser.radio(how, what).exists? } when :checkbox Watir::Wait.until { browser.checkbox(how, what).exists? } when :div Watir::Wait.until { browser.div(how, what).exists? } when :select_list Watir::Wait.until { browser.select_list(how, what).exists? } when :text_field Watir::Wait.until { browser.text_field(how, what).exists? } when :frame Watir::Wait.until { browser.frame(how, what).exists? } when :form Watir::Wait.until { browser.form(how, what).exists? } when :cell Watir::Wait.until { browser.cell(how, what).exists? } when :image Watir::Wait.until { browser.image(how, what).exists? } else Watir::Wait.until { browser.element(how, what).exists? } end rescue => e if e.class.to_s =~ /TimeOutException/ failed_to_log("#{msg}: '#{$!}'") return false elsif not rescue_me(e, __method__, rescue_me_command(element, how, what, :exists?), "#{browser.class}") raise e end end stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{start} stop:#{stop}") # sleep 1 passed_to_log("#{msg} (#{stop - start} seconds)") true rescue failed_to_log("Unable to complete #{msg}: '#{$!}'") end |
#wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = false) ⇒ Boolean
Wait until element, identified by attribute how and its value what, exists. If it exists within timeout seconds then wait until it is enabled. all steps return pass/fail messages in the report.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/awetestlib/regression/waits.rb', line 185 def wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = false) msg = "#{__method__.to_s.titleize}: element: #{how}='#{what}'" msg << " #{desc}" if desc.length > 0 proc_exists = Proc.new { browser.element(how, what).exists? } proc_enabled = Proc.new { browser.element(how, what).enabled? } case how when :href proc_exists = Proc.new { browser.link(how, what).exists? } proc_enabled = Proc.new { browser.link(how, what).enabled? } end if verbose if wait_until(browser, "#{msg} Element exists.", timeout) { proc_exists.call(nil) } if wait_until(browser, "#{msg} Element enabled.", timeout) { proc_enabled.call(nil) } passed_to_log(msg) true else failed_to_log(msg) end else failed_to_log(msg) end else start = Time.now.to_f Watir::Wait.until { browser.exists? } if Watir::Wait.until(timeout) { proc_exists.call(nil) } if Watir::Wait.until(timeout) { proc_enabled.call(nil) } stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{"%.5f" % start} stop:#{"%.5f" % stop}") passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") true else failed_to_log(msg) end else failed_to_log(msg) end end rescue failed_to_log("Unable to #{msg}. '#{$!}'") end |
#wait_until_ready_quiet(browser, how, what, desc = '', timeout = 45, quiet = true) ⇒ Boolean
Wait until element, identified by attribute how and its value what, exists. If it exists within timeout seconds then wait until it is enabled. Report only failures.
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/awetestlib/regression/waits.rb', line 237 def wait_until_ready_quiet(browser, how, what, desc = '', timeout = 45, quiet = true) msg = "#{__method__.to_s.titleize}: element: #{how}='#{what}'" msg << " #{desc}" if desc.length > 0 proc_exists = Proc.new { browser.element(how, what).exists? } proc_enabled = Proc.new { browser.element(how, what).enabled? } case how when :href proc_exists = Proc.new { browser.link(how, what).exists? } proc_enabled = Proc.new { browser.link(how, what).enabled? } end start = Time.now.to_f Watir::Wait.until { browser.exists? } sleep_for(1) if Watir::Wait.until(timeout) { proc_exists.call(nil) } if Watir::Wait.until(timeout) { proc_enabled.call(nil) } stop = Time.now.to_f #debug_to_log("#{msg}: start:#{"%.5f" % start} stop:#{"%.5f" % stop}") passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") unless quiet true else failed_to_log(msg) end else failed_to_log(msg) end rescue failed_to_log("Unable to #{msg}. '#{$!}'") end |
#wait_until_text(browser, strg, desc = '', timeout = 60) ⇒ Object Also known as: wait_until_by_text
266 267 268 269 270 271 |
# File 'lib/awetestlib/regression/waits.rb', line 266 def wait_until_text(browser, strg, desc = '', timeout = 60) if not strg.class.to_s.match('String') raise "#{__method__} requires String for search target. #{strg.class} is not supported." end wait_until(browser, "'#{strg}' #{desc}", timeout) { browser.text.include? strg } end |
#wait_until_visible(browser, element, how, what, desc = '') ⇒ Object
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/awetestlib/regression/waits.rb', line 318 def wait_until_visible(browser, element, how, what, desc = '') start = Time.now.to_f Watir::Wait.until { browser.exists? } sleep_for(1) Watir::Wait.until(20) { browser.element(how, what).exists? } begin case element when :link Watir::Wait.until { browser.link(how, what).visible? } when :button Watir::Wait.until { browser.(how, what).visible? } when :radio Watir::Wait.until { browser.radio(how, what).visible? } when :checkbox Watir::Wait.until { browser.checkbox(how, what).visible? } when :div Watir::Wait.until { browser.div(how, what).visible? } when :select_list Watir::Wait.until { browser.select_list(how, what).visible? } when :text_field Watir::Wait.until { browser.text_field(how, what).visible? } else Watir::Wait.until { browser.element(how, what).visible? } # raise "#{__method__}: Element #{what} not supported." end rescue => e if e.class.to_s =~ /TimeOutException/ failed_to_log("Wait until (#{what} :#{how}=>#{what}) visible. #{desc}: '#{$!}' #{desc}") return false elsif not rescue_me(e, __method__, rescue_me_command(element, how, what, :visible?), "#{browser.class}") raise e end end stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{start} stop:#{stop}") # sleep 1 passed_to_log("Wait until (#{element} :#{how}=>#{what}) visible. #{desc} (#{stop - start} seconds)") true rescue failed_to_log("Unable to complete wait until (#{element} :#{how}=>#{what}) visible. #{desc}: '#{$!}'") end |
#wait_while(browser, desc, timeout = 45, &block) ⇒ Boolean Also known as: wait_while_true
Wait while expression in *&block* returns true.
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 |
# File 'lib/awetestlib/regression/waits.rb', line 112 def wait_while(browser, desc, timeout = 45, &block) #TODO: Would like to be able to see the block code in the log message instead of the identification msg = "Wait while #{desc}:" start = Time.now.to_f Watir::Wait.until { browser.exists? } begin #Watir::Wait.until(timeout) { block.call(nil) } if block.call(nil) Watir::Wait.while(timeout) { block.call(nil) } end rescue => e if e.class.to_s =~ /TimeOutException/ or e. =~ /timed out/ failed_to_log("#{msg}: '#{$!}' ") return false elsif not rescue_me(e, __method__, "#{block.to_s}", "#{browser.class}") raise e end end stop = Time.now.to_f #debug_to_log("#{__method__}: start:#{start} stop:#{stop} block: #{block.to_s}") # sleep 1 passed_to_log("#{msg} (#{"%.5f" % (stop - start)} seconds)") # {#{block.to_s}}") true rescue failed_to_log("Unable to complete #{msg}. '#{$!}'") end |