Class: TestCentricity::UIElement

Inherits:
Object
  • Object
show all
Includes:
Capybara::DSL, Test::Unit::Assertions
Defined in:
lib/testcentricity_web/web_elements/ui_elements_helper.rb,
lib/testcentricity_web/web_elements/siebel_open_ui_helper.rb

Constant Summary collapse

XPATH_SELECTORS = 
['//', '[@', '[contains(']
CSS_SELECTORS = 
['#', ':nth-child(', ':first-child', ':last-child', ':nth-of-type(', ':first-of-type', ':last-of-type', '^=', '$=', '*=', ':contains(']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, parent, locator, context) ⇒ UIElement

Returns a new instance of UIElement.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 51

def initialize(name, parent, locator, context)
  @name           = name
  @parent         = parent
  @locator        = locator
  @context        = context
  @type           = nil
  @alt_locator    = nil
  @original_style = nil
  set_locator_type
end

Instance Attribute Details

#alt_locator ⇒ Object

Returns the value of attribute alt_locator.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def alt_locator
  @alt_locator
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def context
  @context
end

#locator ⇒ Object (readonly)

Returns the value of attribute locator.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def locator
  @locator
end

#locator_type ⇒ Object

Returns the value of attribute locator_type.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def locator_type
  @locator_type
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def name
  @name
end

#original_style ⇒ Object

Returns the value of attribute original_style.



46
47
48
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 46

def original_style
  @original_style
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def parent
  @parent
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



45
46
47
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 45

def type
  @type
end

Instance Method Details

#aria_autocomplete ⇒ Integer

Return state of UI object's aria-autocomplete property

Examples:

email_field.aria_autocomplete

Returns:

  • (Integer) 


806
807
808
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 806

def aria_autocomplete
  get_attribute('aria-autocomplete')
end

#aria_busy? ⇒ Boolean

Return state of UI object's aria-busy property

Examples:

home_phone_field.aria_busy?

Returns:

  • (Boolean) 


936
937
938
939
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 936

def aria_busy?
  state = get_attribute('aria-busy')
  state.boolean? ? state : state == 'true'
end

#aria_checked? ⇒ Boolean

Return state of UI object's aria-checked property

Examples:

allow_new_users_checkbox.aria_checked?

Returns:

  • (Boolean) 


892
893
894
895
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 892

def aria_checked?
  state = get_attribute('aria-checked')
  state.boolean? ? state : state == 'true'
end

#aria_colcount ⇒ Integer

Return state of UI object's aria-colcount property

Examples:

user_grid.aria_colcount

Returns:

  • (Integer) 


726
727
728
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 726

def aria_colcount
  get_attribute('aria-colcount')
end

#aria_controls ⇒ Integer

Return state of UI object's aria-controls property

Examples:

video_menu.aria_controls

Returns:

  • (Integer) 


816
817
818
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 816

def aria_controls
  get_attribute('aria-controls')
end

#aria_describedby ⇒ String

Return state of UI object's aria-describedby property

Examples:

buy_now_button.aria_describedby

Returns:



686
687
688
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 686

def aria_describedby
  get_attribute('aria-describedby')
end

#aria_disabled? ⇒ Boolean

Return state of UI object's aria-disabled property

Examples:

buy_now_button.aria_disabled?

Returns:

  • (Boolean) 


826
827
828
829
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 826

def aria_disabled?
  state = get_attribute('aria-disabled')
  state.boolean? ? state : state == 'true'
end

#aria_expanded? ⇒ Boolean

Return state of UI object's aria-expanded property

Examples:

catalog_tree.aria_expanded?

Returns:

  • (Boolean) 


859
860
861
862
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 859

def aria_expanded?
  state = get_attribute('aria-expanded')
  state.boolean? ? state : state == 'true'
end

#aria_haspopup? ⇒ Boolean

Return state of UI object's aria-haspopup property

Examples:

user_avatar.aria_haspopup?

Returns:

  • (Boolean) 


903
904
905
906
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 903

def aria_haspopup?
  state = get_attribute('aria-haspopup')
  state.boolean? ? state : state == 'true'
end

#aria_hidden? ⇒ Boolean

Return state of UI object's aria-hidden property

Examples:

nutrition_info_tab.aria_hidden?

Returns:

  • (Boolean) 


848
849
850
851
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 848

def aria_hidden?
  state = get_attribute('aria-hidden')
  state.boolean? ? state : state == 'true'
end

#aria_invalid? ⇒ Boolean

Return state of UI object's aria-invalid property

Examples:

home_phone_field.aria_invalid?

Returns:

  • (Boolean) 


881
882
883
884
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 881

def aria_invalid?
  state = get_attribute('aria-invalid')
  state.boolean? ? state : state == 'true'
end

#aria_keyshortcuts ⇒ Integer

Return state of UI object's aria-keyshortcuts property

Examples:

play_button.aria_keyshortcuts

Returns:

  • (Integer) 


786
787
788
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 786

def aria_keyshortcuts
  get_attribute('aria-keyshortcuts')
end

#aria_label ⇒ String

Return state of UI object's aria-label property

Examples:

buy_now_button.aria_label

Returns:



666
667
668
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 666

def aria_label
  get_attribute('aria-label')
end

#aria_labelledby ⇒ String

Return state of UI object's aria-labelledby property

Examples:

buy_now_button.aria_labelledby

Returns:



676
677
678
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 676

def aria_labelledby
  get_attribute('aria-labelledby')
end

#aria_live ⇒ String

Return state of UI object's aria-live property

Examples:

properties_list.aria_live

Returns:



696
697
698
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 696

def aria_live
  get_attribute('aria-live')
end

#aria_modal? ⇒ Boolean

Return state of UI object's aria-modal property

Examples:

add_user_modal.aria_modal?

Returns:

  • (Boolean) 


947
948
949
950
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 947

def aria_modal?
  state = get_attribute('aria-modal')
  state.boolean? ? state : state == 'true'
end

#aria_multiline? ⇒ Boolean

Return state of UI object's aria-multiline property

Examples:

description_field.aria_multiline?

Returns:

  • (Boolean) 


958
959
960
961
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 958

def aria_multiline?
  state = get_attribute('aria-multiline')
  state.boolean? ? state : state == 'true'
end

#aria_multiselectable? ⇒ Boolean

Return state of UI object's aria-multiselectable property

Examples:

channels_select.aria_multiselectable?

Returns:

  • (Boolean) 


969
970
971
972
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 969

def aria_multiselectable?
  state = get_attribute('aria-multiselectable')
  state.boolean? ? state : state == 'true'
end

#aria_orientation ⇒ Integer

Return state of UI object's aria-orientation property

Examples:

volume_slider.aria_orientation

Returns:

  • (Integer) 


776
777
778
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 776

def aria_orientation
  get_attribute('aria-orientation')
end

#aria_pressed? ⇒ Boolean

Return state of UI object's aria-pressed property

Examples:

option1_button.aria_pressed?

Returns:

  • (Boolean) 


914
915
916
917
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 914

def aria_pressed?
  state = get_attribute('aria-pressed')
  state.boolean? ? state : state == 'true'
end

#aria_readonly? ⇒ Boolean

Return state of UI object's aria-readonly property

Examples:

home_phone_field.aria_readonly?

Returns:

  • (Boolean) 


925
926
927
928
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 925

def aria_readonly?
  state = get_attribute('aria-readonly')
  state.boolean? ? state : state == 'true'
end

#aria_required? ⇒ Boolean

Return state of UI object's aria-required property

Examples:

home_phone_field.aria_required?

Returns:

  • (Boolean) 


870
871
872
873
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 870

def aria_required?
  state = get_attribute('aria-required')
  state.boolean? ? state : state == 'true'
end

#aria_roledescription ⇒ Integer

Return state of UI object's aria-roledescription property

Examples:

editor_button.aria_roledescription

Returns:

  • (Integer) 


796
797
798
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 796

def aria_roledescription
  get_attribute('aria-roledescription')
end

#aria_rowcount ⇒ Integer

Return state of UI object's aria-rowcount property

Examples:

user_grid.aria_rowcount

Returns:

  • (Integer) 


716
717
718
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 716

def aria_rowcount
  get_attribute('aria-rowcount')
end

#aria_selected? ⇒ Boolean

Return state of UI object's aria-selected property

Examples:

nutrition_info_tab.aria_selected?

Returns:

  • (Boolean) 


837
838
839
840
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 837

def aria_selected?
  state = get_attribute('aria-selected')
  state.boolean? ? state : state == 'true'
end

#aria_sort ⇒ String

Return state of UI object's aria-sort property

Examples:

name_column.aria_sort

Returns:



706
707
708
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 706

def aria_sort
  get_attribute('aria-sort')
end

#aria_valuemax ⇒ Integer

Return state of UI object's aria-valuemax property

Examples:

volume_slider.aria_valuemax

Returns:

  • (Integer) 


736
737
738
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 736

def aria_valuemax
  get_attribute('aria-valuemax')
end

#aria_valuemin ⇒ Integer

Return state of UI object's aria-valuemin property

Examples:

volume_slider.aria_valuemin

Returns:

  • (Integer) 


746
747
748
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 746

def aria_valuemin
  get_attribute('aria-valuemin')
end

#aria_valuenow ⇒ Integer

Return state of UI object's aria-valuenow property

Examples:

volume_slider.aria_valuenow

Returns:

  • (Integer) 


756
757
758
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 756

def aria_valuenow
  get_attribute('aria-valuenow')
end

#aria_valuetext ⇒ Integer

Return state of UI object's aria-valuetext property

Examples:

volume_slider.aria_valuetext

Returns:

  • (Integer) 


766
767
768
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 766

def aria_valuetext
  get_attribute('aria-valuetext')
end

#clear_alt_locator ⇒ Object 



107
108
109
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 107

def clear_alt_locator
  @alt_locator = nil
end

#click ⇒ Object

Click on an object

Examples:

basket_link.click


116
117
118
119
120
121
122
123
124
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 116

def click
  obj, type = find_element
  object_not_found_exception(obj, type)
  begin
    obj.click
  rescue StandardError
    obj.click_at(10, 10)
  end
end

#click_at(x, y) ⇒ Object

Click at a specific location within an object

Examples:

basket_item_image.click_at(10, 10)

Parameters:

  • x (Integer) —

    X offset

  • y (Integer) —

    Y offset



155
156
157
158
159
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 155

def click_at(x, y)
  obj, = find_element
  raise "UI #{object_ref_message} not found" unless obj
  obj.click_at(x, y)
end

#content_editable? ⇒ Boolean

Return state of UI object's contenteditable property

Examples:

description_field.content_editable?

Returns:

  • (Boolean) 


980
981
982
983
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 980

def content_editable?
  state = get_attribute('contenteditable')
  state.boolean? ? state : state == 'true'
end

#count(visible = true) ⇒ Object

Return the number of occurrences of an object with an ambiguous locator that evaluates to multiple UI elements.

Examples:

num_uploads = upload_progress_bars.count(:all)

Parameters:

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


432
433
434
435
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 432

def count(visible = true)
  obj_locator = @alt_locator.nil? ? @locator : @alt_locator
  page.all(@locator_type, obj_locator, wait: 0.01, visible: visible, minimum: 0).count
end

#disabled? ⇒ Boolean

Is UI object disabled (not enabled)?

Examples:

.disabled?

Returns:

  • (Boolean) 


260
261
262
263
264
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 260

def disabled?
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.disabled?
end

#displayed? ⇒ Boolean

Is UI object displayed in browser window?

Examples:

basket_link.displayed??

Returns:

  • (Boolean) 


501
502
503
504
505
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 501

def displayed?
  obj, type = find_element(false)
  object_not_found_exception(obj, type)
  obj.displayed?
end

#double_click ⇒ Object

Double-click on an object

Examples:

file_image.double_click


131
132
133
134
135
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 131

def double_click
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.double_click(obj.native).perform
end

#drag_and_drop(target, right_offset = nil, down_offset = nil) ⇒ Object 



573
574
575
576
577
578
579
580
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 573

def drag_and_drop(target, right_offset = nil, down_offset = nil)
  source, type = find_element
  object_not_found_exception(source, type)
  page.driver.browser.action.click_and_hold(source.native).perform
  sleep(1)
  target_drop, = target.find_element
  page.driver.browser.action.move_to(target_drop.native, right_offset.to_i, down_offset.to_i).release.perform
end

#drag_by(right_offset, down_offset) ⇒ Object 



565
566
567
568
569
570
571
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 565

def drag_by(right_offset, down_offset)
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.click_and_hold(obj.native).perform
  sleep(1)
  obj.drag_by(right_offset, down_offset)
end

#enabled? ⇒ Boolean

Is UI object enabled?

Examples:

.enabled?

Returns:

  • (Boolean) 


250
251
252
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 250

def enabled?
  !disabled?
end

#exists?(visible = true) ⇒ Boolean

Does UI object exists?

Examples:

basket_link.exists?

Returns:

  • (Boolean) 


197
198
199
200
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 197

def exists?(visible = true)
  obj, = find_object(visible)
  obj != nil
end

#find_element(visible = true) ⇒ Object 



997
998
999
1000
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 997

def find_element(visible = true)
  wait = Selenium::WebDriver::Wait.new(timeout: Capybara.default_max_wait_time)
  wait.until { find_object(visible) }
end

#focused? ⇒ Boolean

Does UI object have the current focus?

Examples:

first_name_field.focused?

Returns:

  • (Boolean) 


284
285
286
287
288
289
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 284

def focused?
  obj, type = find_element(visible = :all)
  object_not_found_exception(obj, type)
  focused_obj = page.driver.browser.switch_to.active_element
  focused_obj == obj.native
end

#get_attribute(attrib) ⇒ Object 



985
986
987
988
989
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 985

def get_attribute(attrib)
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj[attrib]
end

#get_locator ⇒ Object 



95
96
97
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 95

def get_locator
  @locator
end

#get_locator_type ⇒ Object 



77
78
79
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 77

def get_locator_type
  @locator_type
end

#get_name ⇒ Object 



99
100
101
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 99

def get_name
  @name
end

#get_native_attribute(attrib) ⇒ Object 



991
992
993
994
995
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 991

def get_native_attribute(attrib)
  obj, type = find_element(visible = false)
  object_not_found_exception(obj, type)
  obj.native.attribute(attrib)
end

#get_object_type ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 81

def get_object_type
  if @type
    @type
  else
    obj, type = find_element
    object_not_found_exception(obj, type)
    if obj.tag_name
      obj.tag_name
    elsif obj.native.attribute('type')
      obj.native.attribute('type')
    end
  end
end

#get_siebel_object_type ⇒ Object 



9
10
11
12
13
 
# File 'lib/testcentricity_web/web_elements/siebel_open_ui_helper.rb', line 9

def get_siebel_object_type
  obj, = find_element
  object_not_found_exception(obj, 'Siebel object')
  obj.native.attribute('ot')
end

#get_value(visible = true) ⇒ Object Also known as: get_caption 



507
508
509
510
511
512
513
514
515
516
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 507

def get_value(visible = true)
  obj, type = find_element(visible)
  object_not_found_exception(obj, type)
  case obj.tag_name.downcase
  when 'input', 'select', 'textarea'
    obj.value
  else
    obj.text
  end
end

#height ⇒ Integer

Return height of object.

Examples:

button_height = my_button.height

Returns:

  • (Integer) 


455
456
457
458
459
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 455

def height
  obj, type = find_element(false)
  object_not_found_exception(obj, type)
  obj.get_height
end

#hidden? ⇒ Boolean

Is UI object hidden (not visible)?

Examples:

remember_me_checkbox.hidden?

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 240

def hidden?
  !visible?
end

#highlight(duration = 1) ⇒ Object

Highlight an object with a 3 pixel wide, red dashed border for the specified wait time. If wait time is zero, then the highlight will remain until the page is refreshed

Examples:

error_message.highlight(3)

Parameters:

  • duration (Integer or Float) (defaults to: 1) —

    wait time in seconds



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 589

def highlight(duration = 1)
  obj, type = find_element
  object_not_found_exception(obj, type)
  # store original style so it can be reset later
  @original_style = obj.native.attribute('style')
  # style element with red border
  page.execute_script(
    'arguments[0].setAttribute(arguments[1], arguments[2])',
    obj,
    'style',
    'border: 3px solid red; border-style: dashed;'
  )
  # keep element highlighted for duration and then revert to original style
  if duration.positive?
    sleep duration
    page.execute_script(
      'arguments[0].setAttribute(arguments[1], arguments[2])',
      obj,
      'style',
      @original_style
    )
  end
end

#hover(visible = true) ⇒ Object

Hover the cursor over an object

Examples:

basket_link.hover

Parameters:

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


540
541
542
543
544
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 540

def hover(visible = true)
  obj, type = find_element(visible)
  object_not_found_exception(obj, type)
  obj.hover
end

#hover_at(x, y, visible = true) ⇒ Object

Hover at a specific location within an object

Examples:

timeline_bar.hover_at(100, 5)

Parameters:

  • x (Integer) —

    X offset

  • y (Integer) —

    Y offset

  • visible (Boolean, Symbol) (defaults to: true) —

    Only find elements with the specified visibility:

    • true - only finds visible elements.
    • false - finds invisible and visible elements.
    • :all - same as false; finds visible and invisible elements.
    • :hidden - only finds invisible elements.
    • :visible - same as true; only finds visible elements.


559
560
561
562
563
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 559

def hover_at(x, y, visible = true)
  obj, = find_element(visible)
  raise "UI #{object_ref_message} not found" unless obj
  obj.hover_at(x, y)
end

#inspect ⇒ String

Return a human readable representation of the UI element

Examples:

buy_now_button.inspect

Returns:



297
298
299
300
301
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 297

def inspect
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.inspect
end

#invoke_siebel_dialog(popup, seconds = nil) ⇒ Object 



3
4
5
6
7
 
# File 'lib/testcentricity_web/web_elements/siebel_open_ui_helper.rb', line 3

def invoke_siebel_dialog(popup, seconds = nil)
  invoke_siebel_popup
  timeout = seconds.nil? ? 15 : seconds
  popup.wait_until_exists(timeout)
end

#obscured? ⇒ Boolean

Is UI object obscured (not currently in viewport and not clickable)?

Examples:

buy_now_button.obscured?

Returns:

  • (Boolean) 


272
273
274
275
276
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 272

def obscured?
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.obscured?
end

#right_click ⇒ Object

Right-click on an object

Examples:

basket_item_image.right_click


142
143
144
145
146
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 142

def right_click
  obj, type = find_element
  object_not_found_exception(obj, type)
  page.driver.browser.action.context_click(obj.native).perform
end

#role ⇒ String

Return state of UI object's role property

Examples:

buy_now_button.role

Returns:



646
647
648
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 646

def role
  get_attribute('role')
end

#scroll_to(position) ⇒ Object

Scroll the object to its top, middle, or bottom

Examples:

cue_list.scroll_to(:bottom)

Parameters:

  • position (Symbol) —

    :top, :bottom, :center



167
168
169
170
171
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 167

def scroll_to(position)
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.scroll_to(position)
end

#send_keys(*keys) ⇒ Object

Send keystrokes to this object.

Examples:

comment_field.send_keys(:enter)

Parameters:



185
186
187
188
189
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 185

def send_keys(*keys)
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.send_keys(*keys)
end

#set(value) ⇒ Object 



173
174
175
176
177
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 173

def set(value)
  obj, type = find_element
  object_not_found_exception(obj, type)
  obj.set(value)
end

#set_alt_locator(temp_locator) ⇒ Object 



103
104
105
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 103

def set_alt_locator(temp_locator)
  @alt_locator = temp_locator
end

#set_locator_type(locator = nil) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 62

def set_locator_type(locator = nil)
  locator = @locator if locator.nil?
  is_xpath = XPATH_SELECTORS.any? { |selector| locator.include?(selector) }
  is_css = CSS_SELECTORS.any? { |selector| locator.include?(selector) }
  @locator_type = if is_xpath && !is_css
                    :xpath
                  elsif is_css && !is_xpath
                    :css
                  elsif !is_css && !is_xpath
                    :css
                  else
                    :css
                  end
end

#style ⇒ String

Return UI object's style property

Examples:

buy_now_button.style

Returns:



636
637
638
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 636

def style
  get_attribute('style')
end

#tabindex ⇒ String

Return state of UI object's tabindex property

Examples:

buy_now_button.tabindex

Returns:



656
657
658
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 656

def tabindex
  get_attribute('tabindex')
end

#title ⇒ String

Return UI object's title property

Examples:

buy_now_button.title

Returns:



491
492
493
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 491

def title
  get_attribute(:title)
end

#unhighlight ⇒ Object

Restore a highlighted object's original style

Examples:

store_link.unhighlight


618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 618

def unhighlight
  obj, type = find_element
  object_not_found_exception(obj, type)
  return if @original_style.nil?
  page.execute_script(
    'arguments[0].setAttribute(arguments[1], arguments[2])',
    obj,
    'style',
    @original_style
  )
end

#verify_value(expected, enqueue = false) ⇒ Object Also known as: verify_caption 



520
521
522
523
524
525
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 520

def verify_value(expected, enqueue = false)
  actual = get_value
  enqueue ?
      ExceptionQueue.enqueue_assert_equal(expected.strip, actual.strip, "Expected UI #{object_ref_message}") :
      assert_equal(expected.strip, actual.strip, "Expected UI #{object_ref_message} to display '#{expected}' but found '#{actual}'")
end

#visible? ⇒ Boolean

Is UI object visible?

Examples:

remember_me_checkbox.visible?

Returns:

  • (Boolean) 


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 208

def visible?
  obj, type = find_element
  exists = obj
  invisible = false
  if type == :css
    Capybara.using_wait_time 0.1 do
      # is object itself hidden with .ui-helper-hidden class?
      self_hidden = page.has_css?("#{@locator}.ui-helper-hidden")
      # is parent of object hidden, thus hiding the object?
      parent_hidden = page.has_css?(".ui-helper-hidden > #{@locator}")
      # is grandparent of object, or any other ancestor, hidden?
      other_ancestor_hidden = page.has_css?(".ui-helper-hidden * #{@locator}")
      # if any of the above conditions are true, then object is invisible
      invisible = self_hidden || parent_hidden || other_ancestor_hidden
    end
  else
    invisible = !obj.visible? if exists
  end
  # the object is visible if it exists and it is not invisible
  if exists && !invisible
    true
  else
    false
  end
end

#wait_until_exists(seconds = nil, post_exception = true) ⇒ Object

Wait until the object exists, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_exists(0.5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 310

def wait_until_exists(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { exists? }
rescue StandardError
  if post_exception
    raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless exists?
  else
    exists?
  end
end

#wait_until_gone(seconds = nil, post_exception = true) ⇒ Object

Wait until the object no longer exists, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

logout_button.wait_until_gone(5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 329

def wait_until_gone(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { !exists? }
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if exists?
  else
    exists?
  end
end

#wait_until_hidden(seconds = nil, post_exception = true) ⇒ Object

Wait until the object is hidden, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_hidden(10)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 367

def wait_until_hidden(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { hidden? }
rescue StandardError
  if post_exception
    raise "UI #{object_ref_message} remained visible after #{timeout} seconds" if visible?
  else
    visible?
  end
end

#wait_until_value_changes(seconds = nil, post_exception = true) ⇒ Object

Wait until the object's value changes to a different value, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

basket_grand_total_label.wait_until_value_changes(5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 408

def wait_until_value_changes(seconds = nil, post_exception = true)
  value = get_value
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { get_value != value }
rescue StandardError
  if post_exception
    raise "Value of UI #{object_ref_message} failed to change from '#{value}' after #{timeout} seconds" if get_value == value
  else
    get_value == value
  end
end

#wait_until_value_is(value, seconds = nil, post_exception = true) ⇒ Object

Wait until the object's value equals the specified value, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

card_authorized_label.wait_until_value_is('Card authorized', 5)
  or
total_weight_field.wait_until_value_is({ greater_than: '250' }, 5)

Parameters:

  • value (String or Hash) —

    value expected or comparison hash

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 389

def wait_until_value_is(value, seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { compare(value, get_value) }
rescue StandardError
  if post_exception
    raise "Value of UI #{object_ref_message} failed to equal '#{value}' after #{timeout} seconds" unless get_value == value
  else
    get_value == value
  end
end

#wait_until_visible(seconds = nil, post_exception = true) ⇒ Object

Wait until the object is visible, or until the specified wait time has expired. If the wait time is nil, then the wait time will be Capybara.default_max_wait_time.

Examples:

run_button.wait_until_visible(0.5)

Parameters:

  • seconds (Integer or Float) (defaults to: nil) —

    wait time in seconds



348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 348

def wait_until_visible(seconds = nil, post_exception = true)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { visible? }
rescue StandardError
  if post_exception
    raise "Could not find UI #{object_ref_message} after #{timeout} seconds" unless visible?
  else
    visible?
  end
end

#width ⇒ Integer

Return width of object.

Examples:

button_width = my_button.width

Returns:

  • (Integer) 


443
444
445
446
447
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 443

def width
  obj, type = find_element(false)
  object_not_found_exception(obj, type)
  obj.get_width
end

#x ⇒ Integer

Return x coordinate of object's location.

Examples:

button_x = my_button.x

Returns:

  • (Integer) 


467
468
469
470
471
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 467

def x
  obj, type = find_element(false)
  object_not_found_exception(obj, type)
  obj.get_x
end

#y ⇒ Integer

Return y coordinate of object's location.

Examples:

button_y = my_button.y

Returns:

  • (Integer) 


479
480
481
482
483
 
# File 'lib/testcentricity_web/web_elements/ui_elements_helper.rb', line 479

def y
  obj, type = find_element(false)
  object_not_found_exception(obj, type)
  obj.get_y
end