Module: Awetestlib::Regression::DragAndDrop

Included in:
Runner
Defined in:
lib/awetestlib/regression/drag_and_drop.rb

Overview

Note:

Still experimental. Works with IE but not fully tested with Firefox or Chrome in Windows using Watir-webdriver. Not compatible with Mac Rdoc is work in progress

Methods for moving and resizing elements, manipulating the mouse, and checking for relative positioning of elements, including overlap, overlay, etc.

Instance Method Summary collapse

Instance Method Details

#adjust_dimensions_by_percent(w, h, p, returnnew = nil) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 259

def adjust_dimensions_by_percent(w, h, p, returnnew=nil)
  p      += 100
  nw     = (w * (p/100.0)).to_i
  nh     = (h * (p/100.0)).to_i
  deltaw = nw - w
  deltah = nh - h
  if returnnew
    [deltaw, deltah, nw, nh]
  else
    [deltaw, deltah]
  end
end

#drag_and_drop(x1, y1, dx, dy, speed = nil) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 300

def drag_and_drop(x1, y1, dx, dy, speed=nil)
  speed = 10 if not speed
  x2 = x1 + dx
  y2 = y1 + dy
  debug_to_log("drag_and_drop: start: [#{x1}, #{y1}] end: [#{x2}, #{y2}]")

  @ai.MouseMove(x1, y1, speed)
  @ai.MouseClick("primary", x1, y1)
  sleep_for(0.5)
  @ai.MouseClick("primary", x1, y1)
  sleep_for(0.5)
  @ai.MouseClickDrag("primary", x1, y1, x2, y2, speed)
end

#drag_and_drop_div(browser, how, what, delta_x, delta_y, desc = '') ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 287

def drag_and_drop_div(browser, how, what, delta_x, delta_y, desc = '')
  #TODO: webdriver
  #TODO: assumes element is div
  msg = "Drag and drop element :#{how}=>#{what} by x=>#{delta_x} y=>#{delta_y}."
  msg << " #{desc}" if desc.length > 0
  drag_me = browser.div(how, what)
  drag_me.drag_and_drop_by(delta_x, delta_y)
  passed_to_log(msg)
  true
rescue
  failed_to_log(unable_to)
end

#drag_and_drop_element(browser, element, dx, dy, speed = nil) ⇒ Object 



314
315
316
317
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
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 314

def drag_and_drop_element(browser, element, dx, dy, speed = nil)
  speed = 10 if not speed
  w1, h1, x1, y1, xc1, yc1, xlr1, ylr1 = get_element_coordinates(browser, element, true)
  msg                                  = "Move #{element} by [#{dx}, #{dy}] from center[#{xc1}, #{yc1}] "
  newxc                                = xc1 + dx
  newyc                                = yc1 + dy
  msg << "to center[[#{newxc}, #{newyc}]"
  sleep_for(0.5)

  drag_and_drop(xc1, yc1, dx, dy)

  sleep_for(1)
  w2, h2, x2, y2, xc2, yc2, xlr2, ylr2 = get_element_coordinates(browser, element, true)

  # TODO This adjustment is adhoc and empirical. Needs to be derived more rigorously
  xcerr                                = xc2 - xc1
  ycerr                                = yc2 - yc1

  debug_to_log("\n" +
                   "\t\t   xc1: #{xc1}\n" +
                   "\t\t   yc1: #{yc1}\n" +
                   "\t\t   xc2: #{xc2}\n" +
                   "\t\t   yc2: #{yc2}\n" +
                   "\t\t xcerr: #{xlrerr}\n" +
                   "\t\t ycerr: #{ylrerr}\n" +
                   "\t\t x tol: #{@x_tolerance}\n" +
                   "\t\t y tol: #{@y_tolerance}\n"
  )

  #TODO Add check that window _was_ resized.
  x_ok, x_msg = validate_drag_drop(xcerr, @x_tolerance, newxc, xc2)
  y_ok, y_msg = validate_drag_drop(ycerr, @y_tolerance, newyc, yc2)
  msg         = msg + "x: #{x_msg}, y: #{y_msg}"

  if x_ok and y_ok
    passed_to_log(msg)
  else
    failed_to_log(msg)
  end
  sleep_for(1)
rescue
  failed_to_log("Unable to validate drag and drop. #{$!} (#{__LINE__})")
  sleep_for(1)
end

#get_browser_coord(browser = nil, dbg = nil) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 272

def get_browser_coord(browser=nil, dbg=nil)
  browser = @myBrowser if not browser
  title = browser.title
  x     = @ai.WinGetPosX(title)
  y     = @ai.WinGetPosY(title)
  w     = @ai.WinGetPosWidth(title)
  h     = @ai.WinGetPosHeight(title)
  if dbg
    debug_to_log("\n\t\tBrowser #{browser.inspect}\n"+
                     "\t\tdimensions:   x: #{w} y: #{h}"+
                     "\t\tscreen offset x: #{x} y: #{y}")
  end
  [x, y, w, h]
end

#get_element_coordinates(browser, element, dbg = nil) ⇒ Object

:category: GUI



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 222

def get_element_coordinates(browser, element, dbg=nil)
  bx, by, bw, bh = get_browser_coord(browser, dbg)
  if @browserAbbrev == 'IE'
    x_hack = @horizontal_hack_ie
    y_hack = @vertical_hack_ie
  elsif @browserAbbrev == 'FF'
    x_hack = @horizontal_hack_ff
    y_hack = @vertical_hack_ff
  end
  sleep_for(1)
  w, h   = element.dimensions.to_a
  xc, yc = element.client_offset.to_a
  #    xcc, ycc = element.client_center.to_a
  xcc    = xc + w/2
  ycc    = yc + h/2
  # screen offset:
  xs     = bx + x_hack + xc - 1
  ys     = by + y_hack + yc - 1
  # screen center:
  xsc    = xs + w/2
  ysc    = ys + h/2
  xslr   = xs + w
  yslr   = ys + h
  if dbg
    debug_to_log(
        "\n\t\tElement: #{element.inspect}"+
            "\n\t\tbrowser screen offset: x: #{bx} y: #{by}"+
            "\n\t\t           dimensions: x: #{w} y: #{h}"+
            "\n\t\t         client offset x: #{xc} y: #{yc}"+
            "\n\t\t         screen offset x: #{xs} y: #{ys}"+
            "\n\t\t         client center x: #{xcc} y: #{ycc}"+
            "\n\t\t         screen center x: #{xsc} y: #{ysc}"+
            "\n\t\t    screen lower right x: #{xslr} y: #{yslr}")
  end
  [w, h, xs, ys, xsc, ysc, xslr, yslr]
end

#get_resize_handle_by_class(element, strg, dbg = nil) ⇒ Object

:category: GUI



214
215
216
217
218
219
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 214

def get_resize_handle_by_class(element, strg, dbg=nil)
  handle = get_div_by_class(element, strg, dbg)
  sleep_for(0.5)
  handle.flash(5)
  return handle
end

#get_resize_handle_by_id(element, id, dbg = nil) ⇒ Object

:category: GUI



206
207
208
209
210
211
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 206

def get_resize_handle_by_id(element, id, dbg=nil)
  handle = get_div_by_id(element, id, dbg)
  sleep_for(1)
  handle.flash(5)
  return handle
end

#hover(browser, element, wait = 2) ⇒ Object 



85
86
87
88
89
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 85

def hover(browser, element, wait = 2)
  w1, h1, x1, y1, xc1, yc1, xlr1, ylr1 = get_element_coordinates(browser, element, true)
  @ai.MoveMouse(xc1, yc1)
  sleep_for(1)
end

#left_click(element) ⇒ Object 



365
366
367
368
369
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 365

def left_click(element)
  x = element.left_edge_absolute + 2
  y = element.top_edge_absolute + 2
  @ai.MouseClick("primary", x, y)
end

#move_element_with_handle(browser, element, handle_id, dx, dy) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 91

def move_element_with_handle(browser, element, handle_id, dx, dy)
  #    msg = "Move element "
  #    w1, h1, x1, y1, xc1, yc1, xlr1, ylr1 = get_element_coordinates(browser, element, true)
  #    newx   = w1 + dx
  #    newy   = h1 + dy
  #    msg << " by [#{dx}, #{dy}] to expected [[#{newx}, #{newy}] "
  #    handle = get_resize_handle(element, handle_id)
  #    hw, hh, hx, hy, hxc, hyc, hxlr, hylr  = get_element_coordinates(browser, handle, true)

  #    drag_and_drop(hxc, hyc, dx, dy)

  #    w2, h2, x2, y2, xc2, yc2, xlr2, ylr2 = get_element_coordinates(browser, element, true)

  #    xerr = x2 - newx
  #    yerr = y2 - newy
  #    xdsp = (x1 - x2).abs
  #    ydsp = (y1 - y2).abs

  #    if x2 == newx and y2 == newy
  #      msg << "succeeded."
  #      passed_to_log(msg)
  #    else
  #      msg << "failed. "
  #      failed_to_log(msg)
  #      debug_to_log("x: actual #{x2}, error #{xerr}, displace #{xdsp}. y: actual #{y2}, error #{yerr}, displace #{ydsp}.")
  #    end

end

#overlay?(inner, outer, side = :bottom) ⇒ Boolean

Returns:

  • (Boolean) 


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
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 55

def overlay?(inner, outer, side = :bottom)
  #mark_testlevel("#{__method__.to_s.titleize}", 3)
  inner_t, inner_b, inner_l, inner_r = inner.bounding_rectangle_offsets
  outer_t, outer_b, outer_l, outer_r = outer.bounding_rectangle_offsets
  #overlay = false
  case side
    when :bottom
      overlay = inner_b > outer_t
    when :top
      overlay = inner_t > outer_t
    when :left
      overlay = inner_l < outer_r
    when :right
      overlay = inner_r > outer_r
    when :inside
      overlay = !(inner_t > outer_t and
          inner_r < outer_r and
          inner_l > outer_l and
          inner_b < outer_b)
    else
      overlay = (inner_t > outer_b or
          inner_r > outer_l or
          inner_l < outer_r or
          inner_b < outer_t)
  end
  overlay
rescue
  failed_to_log("Unable to determine overlay. '#{$!}'")
end

#resize_element_with_handle(browser, element, target, dx, dy = nil) ⇒ Object 



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 120

def resize_element_with_handle(browser, element, target, dx, dy=nil)
  #TODO enhance to accept differing percentages in each direction
  msg                                  = "Resize element "
  w1, h1, x1, y1, xc1, yc1, xlr1, ylr1 = get_element_coordinates(browser, element, true)
  if dy
    deltax = dx
    deltay = dy
    neww   = w1 + dx
    newh   = h1 + dy
    msg << " by [#{dx}, #{dy}] " #"" to expected dimension [#{neww}, #{newh}] "
  else
    deltax, deltay, neww, newh = adjust_dimensions_by_percent(w1, h1, dx, true)
    msg << "by #{dx} percent " #"" to expected dimension [#{neww}, #{newh}] "
  end
  handle = get_resize_handle_by_class(element, target) #, true)
  sleep_for(0.5)
  hw, hh, hx, hy, hxc, hyc, hxlr, hylr = get_element_coordinates(browser, handle, true)
  hxlr_diff                            = 0
  hylr_diff                            = 0

  # TODO These adjustments are adhoc and empirical. Need to be derived more rigorously
  if @browserAbbrev == 'IE'
    hxlr_diff = (xlr1 - hxlr)
    hylr_diff = (ylr1 - hylr)
    x_start   = hxlr - 2
    y_start   = hylr - 2
  else
    hxlr_diff = (xlr1 - hxlr) / 2 unless (xlr1 - hxlr) == 0
    hylr_diff = (ylr1 - hylr) / 2 unless (ylr1 - hylr) == 0
    x_start = hxlr
    y_start = hylr
  end

  newxlr = xlr1 + deltax
  newylr = ylr1 + deltay
  #    msg << ", lower right [#{newxlr}, #{newylr}] - "
  sleep_for(0.5)

  drag_and_drop(x_start, y_start, deltax, deltay)

  sleep_for(1.5)
  w2, h2, x2, y2, xc2, yc2, xlr2, ylr2 = get_element_coordinates(browser, element, true)

  werr   = w2 - neww
  herr   = h2 - newh

  # TODO This adjustment is adhoc and empirical. Needs to be derived more rigorously
  xlrerr = xlr2 - newxlr + hxlr_diff
  ylrerr = ylr2 - newylr + hylr_diff

  xlrdsp = (xlr1 - xlr2).abs
  ylrdsp = (ylr1 - ylr2).abs

  debug_to_log("\n" +
                   "\t\t  hxlr_diff: #{hxlr_diff}\n" +
                   "\t\t  hylr_diff: #{hylr_diff}\n" +
                   "\t\t       werr: #{werr}\n" +
                   "\t\t       herr: #{herr}\n" +
                   "\t\t     xlrerr: #{xlrerr}\n" +
                   "\t\t     ylrerr: #{ylrerr}\n" +
                   "\t\t     xlrdsp: #{xlrdsp}\n" +
                   "\t\t     ylrdsp: #{ylrdsp}\n" +
                   "\t\t @min_width: #{@min_width}\n" +
                   "\t\t@min_height: #{@min_height}\n" +
                   "\t\t      x tol: #{@x_tolerance}\n" +
                   "\t\t      y tol: #{@y_tolerance}\n"
  )

  #TODO Add check that window _was_ resized.
  x_ok, x_msg = validate_move(w2, xlrerr, @x_tolerance, @min_width, xlr2)
  y_ok, y_msg = validate_move(h2, ylrerr, @y_tolerance, @min_height, ylr2)
  msg         = msg + "x: #{x_msg}, y: #{y_msg}"

  if x_ok and y_ok
    passed_to_log(msg)
  else
    failed_to_log(msg)
    debug_to_log("x - actual #{xlr2}, error #{xlrerr}, displace #{xlrdsp}, y - actual #{ylr2}, error #{ylrerr}, displace #{ylrdsp}.")
  end
  sleep_for(1)
rescue
  failed_to_log("Unable to validate resize. #{$!} (#{__LINE__})")
  sleep_for(1)
end

#right_click(element) ⇒ Object 



359
360
361
362
363
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 359

def right_click(element)
  x = element.left_edge_absolute + 2
  y = element.top_edge_absolute + 2
  @ai.MouseClick("secondary", x, y)
end

#screen_center(element, browser = nil) ⇒ Object 



378
379
380
381
382
383
384
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 378

def screen_center(element, browser=nil)
  bx, by, bw, bh = get_browser_coord(browser)
  w, h           = element.dimensions.to_a
  cx             = bx + w/2
  cy             = by + h/2
  [cx, cy]
end

#screen_lower_right(element, browser = nil) ⇒ Object 



386
387
388
389
390
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 386

def screen_lower_right(element, browser=nil)
  bx, by, bw, bh = get_browser_coord(browser)
  w, h           = element.dimensions.to_a
  [bx + w, by + h]
end

#screen_offset(element, browser = nil) ⇒ Object 



371
372
373
374
375
376
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 371

def screen_offset(element, browser=nil)
  bx, by, bw, bh = get_browser_coord(browser)
  ex             = element.left_edge
  ey             = element.top_edge
  [bx + ex, by + ey]
end

#validate_drag_drop(err, tol, exp, act) ⇒ Object 



408
409
410
411
412
413
414
415
416
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 408

def validate_drag_drop(err, tol, exp, act)
  ary = [false, "failed, expected: #{exp}, actual: #{act}, err: #{err}"]
  if err == 0
    ary = [true, 'succeeded ']
  elsif err.abs <= tol
    ary = [true, "within tolerance (+-#{tol}px) "]
  end
  ary
end

#verify_element_inside(inner_element, outer_element, desc = '') ⇒ Object

Verify that specified inner_element is fully enclosed by outer_element.

Parameters:

  • inner_element (Watir::Element) —

    A reference to a DOM element

  • outer_element (Watir::Element) —

    A reference to a DOM element

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

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



14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 14

def verify_element_inside(inner_element, outer_element, desc = '')
  mark_testlevel("#{__method__.to_s.titleize}", 3)
  msg = build_message("#{inner_element.class.to_s} (:id=#{inner_element.id}) is fully enclosed by "+
                      "#{outer_element.class.to_s} (:id=#{outer_element.id}).", desc)
  if overlay?(inner_element, outer_element, :inside)
    failed_to_log(msg)
  else
    passed_to_log(msg)
    true
  end
rescue
  failed_to_log("Unable to verify that #{msg} '#{$!}'")
end

#verify_no_element_overlap(browser, above_element, above_how, above_what, below_element, below_how, below_what, side, desc = '') ⇒ Object

Verify that two elements, identified by specified attribute and value, do not overlap on a given side.

Parameters:

  • above_element (Symbol) —

    The element type for the first element, e.g. :div, :span, etc.

  • above_how (Symbol) —

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

  • above_what (String, Regexp) —

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

  • below_element (Symbol) —

    The element type for the second element, e.g. :div, :span, etc.

  • below_how (Symbol) —

    The element attribute used to identify the below_element.

  • below_what (String, Regexp) —

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

  • side (Symbol) —

    :top, :bottom, :left, :right, :inside, or :outside

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

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 39

def verify_no_element_overlap(browser, above_element, above_how, above_what, below_element, below_how, below_what, side, desc = '')
  mark_testlevel("#{__method__.to_s.titleize}", 3)
  msg = build_message("#{above_element.to_s.titleize} #{above_how}=>#{above_what} does not overlap "+
                      "#{below_element.to_s.titleize} #{below_how}=>#{below_what} at the #{side}.", desc)
  above = browser.element(above_how, above_what)
  below = browser.element(below_how, below_what)
  if overlay?(above, below, side)
    failed_to_log(msg)
  else
    passed_to_log(msg)
    true
  end
rescue
  failed_to_log("Unable to verify that #{msg} '#{$!}'")
end

#verify_resize(d, err, tol, min, act) ⇒ Object Also known as: validate_move, validate_resize 



392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/awetestlib/regression/drag_and_drop.rb', line 392

def verify_resize(d, err, tol, min, act)
  ary = [false, "failed, actual #{act} err #{err}"]
  if err == 0
    ary = [true, 'succeeded ']
    #TODO need to find way to calculate this adjustment
  elsif d <= min + 4
    ary = [true, "reached minimum (#{min}) "]
  elsif err.abs <= tol
    ary = [true, "within tolerance (+-#{tol}px) "]
  end
  ary
end