Module: Awetestlib::Regression::Waits

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

Altenatives collapse

Instance Method Details

#hold_for_text(browser, how_long, text, desc = '', threshold = 20, interval = 0.25) ⇒ Boolean Also known as: wait_for_text

Note:

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.

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • text (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output

  • threshold (Fixnum) (defaults to: 20) —

    The number of seconds after which a warning is added to the report message.

  • interval (Fixnum) (defaults to: 0.25) —

    The time between checks that the text exists.

Returns:

  • (Boolean) —

    Returns true if the text appears before how_long has expired.



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/awetestlib/regression/waits.rb', line 299

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, 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.

Parameters:

  • seconds (Fixnum) —

    The number of seconds to wait.

  • dbg (Boolean) —

    If true, includes a trace in the message

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output.



16
17
18
19
20
21
 
# File 'lib/awetestlib/regression/waits.rb', line 16

def sleep_for(seconds, desc = '')
  trace = $debug ? "\n#{get_debug_list}" : ''
  msg = build_message("Sleeping for #{seconds} seconds.", desc, trace)
  info_to_log(msg, 3)
  sleep(seconds)
end

#wait_for(how_long, what_for, interval = 0.25) ⇒ Object

Note:

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.

Parameters:

  • how_long (Fixnum) —

    Timeout limit

  • what_for (Watir::Element) —

    A reference to a Dom element to wait for.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/awetestlib/regression/waits.rb', line 337

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.

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • how (Symbol) —

    The element attribute used to identify the specific element. Valid values depend on the kind of element. Common values: :text, :id, :title, :name, :class, :href (:link only)

  • what (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output

  • timeout (Fixnum) (defaults to: 20)

Returns:

  • (Boolean) —

    Returns true if disappears and reappears, each within the timeout limit



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

Note:

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.

Parameters:

  • how_long (Fixnum) —

    Timeout limit

  • what_for (Watir::Element) —

    A reference to a Dom element to wait for.



328
329
330
 
# File 'lib/awetestlib/regression/waits.rb', line 328

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

Note:

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.

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • how (Symbol) —

    The element attribute used to identify the specific element. Valid values depend on the kind of element. Common values: :text, :id, :title, :name, :class, :href (:link only)

  • what (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • wait (Fixnum) (defaults to: 6) —

    Timeout limit.

  • interval (Fixnum) (defaults to: 0.25) —

    How long to wait before checking again.

Returns:

  • (Boolean) —

    True if element exists within wait time



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/awetestlib/regression/waits.rb', line 365

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.

Examples:

wait_until(browser, 'Textfield is enabled.', 10) { browser.text_field(:id, 'this text field').exists?}

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • desc (String) —

    Contains a message or description intended to appear in the log and/or report output

  • timeout (Fixnum) (defaults to: 45) —

    Maximum time to wait, in seconds.

  • &block (Proc) —

    A ruby expression that evaluates to true or false. The expression is usually a watir or watir-webdriver command like .exists?, enabled?, etc. on a specific DOM element. Note that *&block* is listed as the last parameter inside the signature parentheses, but is passed in curly braces outside the signature parentheses in the call. This is the way Ruby works.

Returns:

  • (Boolean) —

    True if condition in *&block* returns true within time limit.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/awetestlib/regression/waits.rb', line 146

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   = build_message("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.message =~ /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
  msg += " (#{"%.5f" % (stop - start)} seconds)"
  passed_to_log(msg) unless skip_pass #  {#{block.to_s}}")
  true
rescue
  failed_to_log(unable_to(msg))
end

#wait_until_enabled(browser, element, how, what, desc = '') ⇒ Object 



241
242
243
 
# File 'lib/awetestlib/regression/waits.rb', line 241

def wait_until_enabled(browser, element, how, what, desc = '')
  wait_until_ready(browser, how, what, desc, timeout = 90, verbose = true, quiet = false)
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)

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • element (Symbol) —

    The kind of element to click. Must be one of the elements recognized by Watir. Some common values are :link, :button, :image, :div, :span.

  • how (Symbol) —

    The element attribute used to identify the specific element. Valid values depend on the kind of element. Common values: :text, :id, :title, :name, :class, :href (:link only)

  • what (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output

Returns:

  • (Boolean) —

    True if element exists within timeout limit



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 = build_message("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
  # TODO: Webdriver compatibility?
  Watir::Wait.until { browser.exists? }
  begin
    case element
      when :link
        Watir::Wait.until { browser.link(how, what).exists? }
      when :button
        Watir::Wait.until { browser.button(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
  msg += " (#{"%.5f" % (stop - start)} seconds)"
  passed_to_log(msg)
  true
rescue
  failed_to_log(unable_to(msg))
end

#wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = true, quiet = 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.

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • how (Symbol) —

    The element attribute used to identify the specific element. Valid values depend on the kind of element. Common values: :text, :id, :title, :name, :class, :href (:link only)

  • what (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output

  • timeout (Fixnum) (defaults to: 90) —

    Maximum time to wait, in seconds.

  • verbose (Boolean) (defaults to: true) —

    When set to true, actual wait time is reported.

  • quiet (Boolean) (defaults to: false) —

    When set to true, only fail messages are logged and reported.

Returns:

  • (Boolean) —

    True if element is ready within time limit.



183
184
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
 
# File 'lib/awetestlib/regression/waits.rb', line 183

def wait_until_ready(browser, how, what, desc = '', timeout = 90, verbose = true, quiet = false)
  msg = build_message("Wait until element :#{how}=>'#{what}') is ready.", desc)
  ok  = false
  start = Time.now.to_f if verbose
  Watir::Wait.until(timeout) { browser.exists? }

  if $using_webdriver
    proc_present = Proc.new { browser.element(how, what).present? }
    if Watir::Wait.until(timeout) { proc_present.call(nil) }
      ok = true
    end
  else
    proc_exists  = Proc.new { browser.element(how, what).exists? }
    proc_enabled = Proc.new { browser.element(how, what).enabled? }
    if how == :href
      proc_exists  = Proc.new { browser.link(how, what).exists? }
      proc_enabled = Proc.new { browser.link(how, what).enabled? }
    end
    if Watir::Wait.until(timeout) { proc_exists.call(nil) }
      if Watir::Wait.until(timeout) { proc_enabled.call(nil) }
        ok = true
      end
    end
  end

  if verbose
    stop = Time.now.to_f
    msg += " (#{"%.5f" % (stop - start)} seconds)"
  end
  if ok
    unless quiet
      passed_to_log(msg)
    end
  else
    failed_to_log(msg)
  end
  ok
rescue
  failed_to_log(unable_to(msg))
end

#wait_until_ready_quiet(browser, how, what, desc = '', timeout = 90, quiet = true, 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. By default reports only failures.

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • how (Symbol) —

    The element attribute used to identify the specific element. Valid values depend on the kind of element. Common values: :text, :id, :title, :name, :class, :href (:link only)

  • what (String, Regexp) —

    A string or a regular expression to be found in the how attribute that uniquely identifies the element.

  • desc (String) (defaults to: '') —

    Contains a message or description intended to appear in the log and/or report output

  • timeout (Fixnum) (defaults to: 90) —

    Maximum time to wait, in seconds.

  • verbose (Boolean) (defaults to: false) —

    When set to true, actual wait time is reported.

  • quiet (Boolean) (defaults to: true) —

    When set to true, only fail messages are logged and reported.

Returns:

  • (Boolean) —

    True if element is ready within time limit.



228
229
230
 
# File 'lib/awetestlib/regression/waits.rb', line 228

def wait_until_ready_quiet(browser, how, what, desc = '', timeout = 90, quiet = true, verbose = false)
  wait_until_ready(browser, how, what, desc, timeout, verbose, quiet)
end

#wait_until_text(browser, strg, desc = '', refs = '', timeout = 60) ⇒ Object Also known as: wait_until_by_text 



232
233
234
235
236
237
 
# File 'lib/awetestlib/regression/waits.rb', line 232

def wait_until_text(browser, strg, desc = '', refs = '', timeout = 60)
  unless strg.class.to_s.match('String')
    raise "#{__method__} requires String for search target. #{strg.class} is not supported."
  end
  wait_until(browser, "'#{strg}' #{desc} #{refs}", timeout) { browser.text.include? strg }
end

#wait_until_visible(browser, element, how, what, desc = '', timeout = 60) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/awetestlib/regression/waits.rb', line 245

def wait_until_visible(browser, element, how, what, desc = '', timeout = 60)
  msg = build_message("Wait until #{element} :#{how}=>'#{what}') is visible.", desc)
  start = Time.now.to_f
  Watir::Wait.until { browser.exists? }
  sleep_for(1)
  Watir::Wait.until(timeout) { browser.element(how, what).exists? }
  begin
    case element
      when :link
        Watir::Wait.until { browser.link(how, what).visible? }
      when :button
        Watir::Wait.until { browser.button(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
  msg += " (#{"%.5f" % (stop - start)} seconds)"
  passed_to_log(msg)
  true
rescue
  failed_to_log(unable_to(msg))
end

#wait_while(browser, desc, timeout = 45, &block) ⇒ Boolean Also known as: wait_while_true

Wait while expression in *&block* returns true.

Examples:

wait_while(browser, 'Textfield is enabled.', 10) { browser.text_field(:id, 'this text field').enabled?}

Parameters:

  • browser (Watir::Browser) —

    A reference to the browser window or container element to be tested.

  • desc (String) —

    Contains a message or description intended to appear in the log and/or report output

  • timeout (Fixnum) (defaults to: 45) —

    Maximum time to wait, in seconds.

  • &block (Proc) —

    A ruby expression that evaluates to true or false. The expression is usually a watir or watir-webdriver command like .exists?, enabled?, etc. on a specific DOM element. Note that *&block* is listed as the last parameter inside the signature parentheses, but is passed in curly braces outside the signature parentheses in the call. This is the way Ruby works.

Returns:

  • (Boolean) —

    True if condition returns false within time limit.



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
 
# 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   = build_message("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.message =~ /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
  msg += " (#{"%.5f" % (stop - start)} seconds)"
  passed_to_log(msg)
  true
rescue
  failed_to_log("Unable to complete #{msg}. '#{$!}'")
end