Class: TestCentricity::PageSection

Inherits:
Object
  • Object
show all
Includes:
Capybara::DSL, Capybara::Node::Matchers, Test::Unit::Assertions
Defined in:
lib/testcentricity_web/page_sections_helper.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent, locator, context) ⇒ PageSection

Returns a new instance of PageSection.



12
13
14
15
16
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 12

def initialize(parent, locator, context)
  @parent = parent
  @locator = locator
  @context = context
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



9
10
11
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 9

def context
  @context
end

#locator ⇒ Object (readonly)

Returns the value of attribute locator.



9
10
11
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 9

def locator
  @locator
end

#parent ⇒ Object

Returns the value of attribute parent.



10
11
12
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 10

def parent
  @parent
end

Class Method Details

.button(element_name, locator) ⇒ Object

Declare and instantiate a button UI Element for this page section.

Examples:

button :checkout_button, 'button.checkout_button'
button :login_button,    "//input[@id='submit_button']"

Parameters:

  • element_name (Symbol) —

    name of button object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



56
57
58
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 56

def self.button(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Button.new(self, "#{locator}", :section);end))
end

.buttons(element_hash) ⇒ Object 



60
61
62
63
64
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 60

def self.buttons(element_hash)
  element_hash.each do |element_name, locator|
    button(element_name, locator)
  end
end

.checkbox(element_name, locator, proxy = nil) ⇒ Object

Declare and instantiate a checkbox UI Element for this page section.

Examples:

checkbox :remember_checkbox,     "//input[@id='RememberUser']"
checkbox :accept_terms_checkbox, 'input#accept_terms_conditions', :accept_terms_label

Parameters:

  • element_name (Symbol) —

    name of checkbox object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object

  • proxy (Symbol) (defaults to: nil) —

    Optional name (as a symbol) of proxy object to receive click actions



93
94
95
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 93

def self.checkbox(element_name, locator, proxy = nil)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::CheckBox.new(self, "#{locator}", :section, #{proxy});end))
end

.checkboxes(element_hash) ⇒ Object 



97
98
99
100
101
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 97

def self.checkboxes(element_hash)
  element_hash.each do |element_name, locator|
    checkbox(element_name, locator)
  end
end

.element(element_name, locator) ⇒ Object

Declare and instantiate a generic UI Element for this page section.

Examples:

element :undo_record_item,  "//li[@rn='Undo Record']/a"
element :basket_header,     'div.basket_header'

Parameters:

  • element_name (Symbol) —

    name of UI object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



38
39
40
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 38

def self.element(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section);end))
end

.elements(element_hash) ⇒ Object 



42
43
44
45
46
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 42

def self.elements(element_hash)
  element_hash.each do |element_name, locator|
    element(element_name, locator)
  end
end

.filefield(element_name, locator) ⇒ Object

Declare and instantiate a File Field UI Element for this page section.

Examples:

filefield :attach_file, 's_SweFileName'

Parameters:

  • element_name (Symbol) —

    name of file field object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



235
236
237
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 235

def self.filefield(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::FileField.new(self, "#{locator}", :section);end))
end

.image(element_name, locator) ⇒ Object

Declare and instantiate an image UI Element for this page section.

Examples:

image :basket_item_image,    'div.product_image'
image :corporate_logo_image, "//img[@alt='MyCompany_logo']"

Parameters:

  • element_name (Symbol) —

    name of image object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



218
219
220
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 218

def self.image(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Image.new(self, "#{locator}", :section);end))
end

.images(element_hash) ⇒ Object 



222
223
224
225
226
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 222

def self.images(element_hash)
  element_hash.each do |element_name, locator|
    image(element_name, locator)
  end
end

.label(element_name, locator) ⇒ Object

Declare and instantiate a label UI Element for this page section.

Examples:

label :welcome_label,      'div.Welcome'
label :rollup_price_label, "//div[contains(@id, 'Rollup Item Price')]"

Parameters:

  • element_name (Symbol) —

    name of label object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



130
131
132
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 130

def self.label(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Label.new(self, "#{locator}", :section);end))
end

.labels(element_hash) ⇒ Object 



134
135
136
137
138
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 134

def self.labels(element_hash)
  element_hash.each do |element_name, locator|
    label(element_name, locator)
  end
end

.link(element_name, locator) ⇒ Object

Declare and instantiate a link UI Element for this page section.

Examples:

link :registration_link,    'a.account-nav__link.register'
link :shopping_basket_link, "//a[@href='shopping_basket']"

Parameters:

  • element_name (Symbol) —

    name of link object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



148
149
150
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 148

def self.link(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Link.new(self, "#{locator}", :section);end))
end

.links(element_hash) ⇒ Object 



152
153
154
155
156
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 152

def self.links(element_hash)
  element_hash.each do |element_name, locator|
    link(element_name, locator)
  end
end

.list(element_name, locator) ⇒ Object

Declare and instantiate a list UI Element for this page section.

Examples:

list :y_axis_list, 'g.y_axis'

Parameters:

  • element_name (Symbol) —

    name of list object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



200
201
202
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 200

def self.list(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::List.new(self, "#{locator}", :section);end))
end

.lists(element_hash) ⇒ Object 



204
205
206
207
208
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 204

def self.lists(element_hash)
  element_hash.each do |element_name, locator|
    list(element_name, locator)
  end
end

.radio(element_name, locator, proxy = nil) ⇒ Object

Declare and instantiate a radio button UI Element for this page section.

Examples:

radio :accept_terms_radio,  "//input[@id='Accept_Terms']"
radio :decline_terms_radio, 'input#decline_terms_conditions', :decline_terms_label

Parameters:

  • element_name (Symbol) —

    name of radio object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object

  • proxy (Symbol) (defaults to: nil) —

    Optional name (as a symbol) of proxy object to receive click actions



112
113
114
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 112

def self.radio(element_name, locator, proxy = nil)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Radio.new(self, "#{locator}", :section, #{proxy});end))
end

.radios(element_hash) ⇒ Object 



116
117
118
119
120
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 116

def self.radios(element_hash)
  element_hash.each do |element_name, locator|
    radio(element_name, locator)
  end
end

.section(section_name, class_name, locator = nil) ⇒ Object

Instantiate a PageSection object within this PageSection object.

Examples:

section :search_form, SearchForm

Parameters:

  • section_name (Symbol) —

    name of PageSection object (as a symbol)

  • class_name (String) —

    Class name of PageSection object



246
247
248
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 246

def self.section(section_name, class_name, locator = nil)
  class_eval(%Q(def #{section_name.to_s};@#{section_name.to_s} ||= #{class_name.to_s}.new(self, "#{locator}", :section);end))
end

.sections(section_hash) ⇒ Object 



250
251
252
253
254
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 250

def self.sections(section_hash)
  section_hash.each do |section_name, class_name|
    section(section_name, class_name)
  end
end

.selectlist(element_name, locator) ⇒ Object

Declare and instantiate a select list UI Element for this page section.

Examples:

selectlist :category_selector, 'select#search_form_category_chosen'
selectlist :gender_select,     "//select[@id='customer_gender']"

Parameters:

  • element_name (Symbol) —

    name of select list object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



183
184
185
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 183

def self.selectlist(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::SelectList.new(self, "#{locator}", :section);end))
end

.selectlists(element_hash) ⇒ Object 



187
188
189
190
191
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 187

def self.selectlists(element_hash)
  element_hash.each do |element_name, locator|
    selectlist(element_name, locator)
  end
end

.table(element_name, locator) ⇒ Object

Declare and instantiate a table UI Element for this page section.

Examples:

table :payments_table, "//table[@class='payments_table']"

Parameters:

  • element_name (Symbol) —

    name of table object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



165
166
167
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 165

def self.table(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::Table.new(self, "#{locator}", :section);end))
end

.tables(element_hash) ⇒ Object 



169
170
171
172
173
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 169

def self.tables(element_hash)
  element_hash.each do |element_name, locator|
    table(element_name, locator)
  end
end

.textfield(element_name, locator) ⇒ Object

Declare and instantiate a text field UI Element for this page section.

Examples:

textfield :user_id_field,  "//input[@id='UserName']"
textfield :password_field, 'input#consumer_password'

Parameters:

  • element_name (Symbol) —

    name of text field object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



74
75
76
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 74

def self.textfield(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::TextField.new(self, "#{locator}", :section);end))
end

.textfields(element_hash) ⇒ Object 



78
79
80
81
82
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 78

def self.textfields(element_hash)
  element_hash.each do |element_name, locator|
    textfield(element_name, locator)
  end
end

.trait(trait_name, &block) ⇒ Object

Define a trait for this page section.

Examples:

trait(:section_locator)  { "//div[@class='Messaging_Applet']" }
trait(:list_table_name)  { '#Messages' }

Parameters:

  • trait_name (Symbol) —

    name of trait (as a symbol)

  • block (&block) —

    trait value



26
27
28
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 26

def self.trait(trait_name, &block)
  define_method(trait_name.to_s, &block)
end

Instance Method Details

#click_at(x, y) ⇒ Object

Click at a specific location within a Section object

Examples:

bar_chart_section.click_at(10, 10)

Parameters:

  • x (Integer) —

    X offset

  • y (Integer) —

    Y offset



358
359
360
361
362
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 358

def click_at(x, y)
  section, _ = find_section
  raise "Section #{get_locator} not found" unless section
  section.click_at(x, y)
end

#disabled? ⇒ Boolean

Is Section object disabled (not enabled)?

Examples:

bar_chart_section.disabled?

Returns:

  • (Boolean) 


292
293
294
295
296
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 292

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

#enabled? ⇒ Boolean

Is Section object enabled?

Examples:

bar_chart_section.enabled?

Returns:

  • (Boolean) 


282
283
284
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 282

def enabled?
  not disabled?
end

#exists? ⇒ Boolean

Does Section object exists?

Examples:

navigation_toolbar.exists?

Returns:

  • (Boolean) 


271
272
273
274
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 271

def exists?
  section, _ = find_section
  section != nil
end

#get_attribute(attrib) ⇒ Object 



488
489
490
491
492
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 488

def get_attribute(attrib)
  section, _ = find_section
  raise "Section #{locator} not found" unless section
  section[attrib]
end

#get_locator ⇒ Object 



256
257
258
259
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 256

def get_locator
  (@locator.empty? && defined?(section_locator)) ? locator = section_locator : locator = @locator
  (@context == :section && !@parent.nil? && !@parent.get_locator.nil?) ? "#{@parent.get_locator}|#{locator}" : locator
end

#get_native_attribute(attrib) ⇒ Object 



494
495
496
497
498
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 494

def get_native_attribute(attrib)
  section, _ = find_section
  raise "Section #{locator} not found" unless section
  section.native.attribute(attrib)
end

#hidden? ⇒ Boolean

Is Section object hidden (not visible)?

Examples:

navigation_toolbar.hidden?

Returns:

  • (Boolean) 


319
320
321
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 319

def hidden?
  not visible?
end

#populate_data_fields(data) ⇒ Object

Populate the specified UI elements in this Section object with the associated data from a Hash passed as an argument. Data values must be in the form of a String for textfield and select list controls. For checkbox and radio buttons, data must either be a Boolean or a String that evaluates to a Boolean value (Yes, No, 1, 0, true, false)

Examples:

data = { prefix_select      => 'Mr.',
         first_name_field   => 'Ignatious',
         last_name_field    => 'Snickelfritz',
         gender_select      => 'Male',
         dob_field          => '12/14/1957',
         organ_donor_check  => 'Yes',
         dnr_on_file_check  => 'Yes'
       }
populate_data_fields(data)

Parameters:

  • data (Hash) —

    UI element(s) and associated data to be entered



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 461

def populate_data_fields(data)
  data.each do | data_field, data_param |
    unless data_param.blank?
      # make sure the intended UI target element exists before trying to set its value
      data_field.wait_until_exists(2)
      if data_param == '!DELETE'
        data_field.set('')
      else
        case data_field.get_object_type
          when :checkbox
            (data_field.get_siebel_object_type == 'JCheckBox') ?
                data_field.set_siebel_checkbox_state(data_param.to_bool) :
                data_field.set_checkbox_state(data_param.to_bool)
          when :selectlist
            (data_field.get_siebel_object_type == 'JComboBox') ?
                data_field.set("#{data_param}\t") :
                data_field.choose_option(data_param)
          when :radio
            data_field.set_selected_state(data_param.to_bool)
          when :textfield
            data_field.set("#{data_param}\t")
        end
      end
    end
  end
end

#set_parent(parent) ⇒ Object 



261
262
263
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 261

def set_parent(parent)
  @parent = parent
end

#verify_ui_states(ui_states) ⇒ Object 



364
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 364

def verify_ui_states(ui_states)
  ui_states.each do | ui_object, object_states |
    object_states.each do | property, state |
      case property
        when :exists
          actual = ui_object.exists?
        when :enabled
          actual = ui_object.enabled?
        when :disabled
          actual = ui_object.disabled?
        when :visible
          actual = ui_object.visible?
        when :hidden
          actual = ui_object.hidden?
        when :readonly
          actual = ui_object.read_only?
        when :checked
          actual = ui_object.checked?
        when :selected
          actual = ui_object.selected?
        when :value, :caption
          actual = ui_object.get_value
        when :maxlength
          actual = ui_object.get_max_length
        when :rowcount
          actual = ui_object.get_row_count
        when :columncount
          actual = ui_object.get_column_count
        when :placeholder
          actual = ui_object.get_placeholder
        when :options, :items, :list_items
          actual = ui_object.get_list_items
        when :optioncount, :itemcount
          actual = ui_object.get_item_count
        when :column_headers
          actual = ui_object.get_header_columns
        when :siebel_options
          actual = ui_object.get_siebel_options
        else
          if property.to_s.start_with? ('cell_')
            cell = property.to_s.gsub('cell_', '')
            cell = cell.split('_')
            actual = ui_object.get_table_cell(cell[0].to_i, cell[1].to_i)
          elsif property.to_s.start_with? ('row_')
            row = property.to_s.gsub('row_', '')
            actual = ui_object.get_table_row(row.to_i)
          elsif property.to_s.start_with? ('column_')
            column = property.to_s.gsub('column_', '')
            actual = ui_object.get_table_column(column.to_i)
          end
      end

      if state.is_a?(Hash) && state.length == 1
        error_msg = "Expected #{ui_object.get_locator} #{property.to_s} property to"
        state.each do |key, value|
          case key
            when :lt, :less_than
              ExceptionQueue.enqueue_exception("#{error_msg} be less than #{value} but found #{actual}") unless actual < value
            when :lt_eq, :less_than_or_equal
              ExceptionQueue.enqueue_exception("#{error_msg} be less than or equal to #{value} but found #{actual}") unless actual <= value
            when :gt, :greater_than
              ExceptionQueue.enqueue_exception("#{error_msg} be greater than #{value} but found #{actual}") unless actual > value
            when :gt_eq, :greater_than_or_equal
              ExceptionQueue.enqueue_exception("#{error_msg} be greater than or equal to  #{value} but found #{actual}") unless actual >= value
            when :starts_with
              ExceptionQueue.enqueue_exception("#{error_msg} start with '#{value}' but found #{actual}") unless actual.start_with?(value)
            when :ends_with
              ExceptionQueue.enqueue_exception("#{error_msg} end with '#{value}' but found #{actual}") unless actual.end_with?(value)
            when :contains
              ExceptionQueue.enqueue_exception("#{error_msg} contain '#{value}' but found #{actual}") unless actual.include?(value)
          end
        end
      else
        ExceptionQueue.enqueue_assert_equal(state, actual, "Expected #{ui_object.get_locator} #{property.to_s} property")
      end
    end
  end
  ExceptionQueue.post_exceptions
end

#visible? ⇒ Boolean

Is Section object visible?

Examples:

navigation_toolbar.visible?

Returns:

  • (Boolean) 


304
305
306
307
308
309
310
311
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 304

def visible?
  section, _ = find_section
  exists = section
  visible = false
  visible = section.visible? if exists
  # the section is visible if it exists and it is not invisible
  (exists && visible) ? true : false
end

#wait_until_exists(seconds = nil) ⇒ Object

Wait until the Section object exists, or until the specified wait time has expired.

Examples:

navigation_toolbar.wait_until_exists(0.5)

Parameters:

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

    wait time in seconds



329
330
331
332
333
334
335
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 329

def wait_until_exists(seconds = nil)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { exists? }
rescue
  raise "Could not find section #{get_locator} after #{timeout} seconds" unless exists?
end

#wait_until_gone(seconds = nil) ⇒ Object

Wait until the Section object no longer exists, or until the specified wait time has expired.

Examples:

navigation_toolbar.wait_until_gone(5)

Parameters:

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

    wait time in seconds



343
344
345
346
347
348
349
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 343

def wait_until_gone(seconds = nil)
  timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { !exists? }
rescue
  raise "Section #{get_locator} remained visible after #{timeout} seconds" if exists?
end