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



50
51
52
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 50

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

.checkbox(element_name, locator) ⇒ Object

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

Examples:

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

Parameters:

  • element_name (Symbol) —

    name of checkbox 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.checkbox(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :checkbox);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, nil);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



133
134
135
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 133

def self.image(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :image);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



86
87
88
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 86

def self.label(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :label);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



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

def self.link(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :link);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



144
145
146
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 144

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

.selectlist(element_name, locator) ⇒ Object

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

Examples:

selectlist :category_selector, "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



121
122
123
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 121

def self.selectlist(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :selectlist);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



109
110
111
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 109

def self.table(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :table);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, "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



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

def self.textfield(element_name, locator)
  class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :textfield);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

#exists? ⇒ Boolean

Does Section object exists?

Examples:

navigation_toolbar.exists?

Returns:

  • (Boolean) 


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

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

#get_locator ⇒ Object 



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

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

#hidden? ⇒ Boolean

Is Section object hidden (not visible)?

Examples:

navigation_toolbar.hidden?

Returns:

  • (Boolean) 


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

def hidden?
  not visible?
end

#set_parent(parent) ⇒ Object 



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

def set_parent(parent)
  @parent = parent
end

#verify_ui_states(ui_states) ⇒ Object 



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
258
259
260
261
262
263
264
265
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 232

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 :visible
          actual = ui_object.visible?
        when :readonly
          actual = ui_object.read_only?
        when :checked
          actual = ui_object.checked?
        when :value
          actual = ui_object.get_value
        when :maxlength
          actual = ui_object.get_max_length
        when :options
          actual = ui_object.get_options
        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)
          end
      end
      ExceptionQueue.enqueue_assert_equal(state, actual, "Expected #{ui_object.get_locator} #{property.to_s} property")
    end
  end
  ExceptionQueue.post_exceptions
end

#visible? ⇒ Boolean

Is Section object visible?

Examples:

navigation_toolbar.visible?

Returns:

  • (Boolean) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 174

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

#wait_until_exists(seconds) ⇒ 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) —

    wait time in seconds



210
211
212
213
214
215
216
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 210

def wait_until_exists(seconds)
  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) ⇒ 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) —

    wait time in seconds



224
225
226
227
228
229
230
 
# File 'lib/testcentricity_web/page_sections_helper.rb', line 224

def wait_until_gone(seconds)
  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