Class: TestCentricity::PageObject

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.button(element_name, locator) ⇒ Object

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

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



42
43
44
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 42

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

.checkbox(element_name, locator) ⇒ Object

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

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



66
67
68
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 66

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

.element(element_name, locator) ⇒ Object

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

Examples:

element :siebel_view,  'div#_sweview'
element :siebel_busy,  "//html[contains(@class, 'siebui-busy')]"

Parameters:

  • element_name (Symbol) —

    name of UI object (as a symbol)

  • locator (String) —

    css selector or xpath expression that uniquely identifies object



30
31
32
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 30

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

.filefield(element_name, locator) ⇒ Object

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

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



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

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

.image(element_name, locator) ⇒ Object

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

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



137
138
139
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 137

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

.label(element_name, locator) ⇒ Object

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

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



90
91
92
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 90

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

.link(element_name, locator) ⇒ Object

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

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



102
103
104
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 102

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

.radio(element_name, locator) ⇒ Object

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

Examples:

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

Parameters:

  • element_name (Symbol) —

    name of radio object (as a symbol)

  • locator (String) —

    css selector or xpath expression that uniquely identifies object



78
79
80
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 78

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

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

Instantiate a PageSection object for this page 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



159
160
161
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 159

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}", :page);end))
end

.selectlist(element_name, locator) ⇒ Object

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

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



125
126
127
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 125

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

.table(element_name, locator) ⇒ Object

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

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



113
114
115
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 113

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

.textfield(element_name, locator) ⇒ Object

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

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



54
55
56
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 54

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

.trait(trait_name, &block) ⇒ Object

Define a trait for this page object.

Examples:

trait(:page_name)     { 'Shopping Basket' }
trait(:page_url)      { "/shopping_basket" }
trait(:page_locator)  { "//body[@class='shopping_baskets']" }

Parameters:

  • trait_name (Symbol) —

    name of trait (as a symbol)

  • block (&block) —

    trait value



18
19
20
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 18

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

Instance Method Details

#exists? ⇒ Boolean

Does Page object exists?

Examples:

home_page.exists?

Returns:

  • (Boolean) 


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 213

def exists?
  saved_wait_time = Capybara.default_max_wait_time
  Capybara.default_max_wait_time = 0.1
  tries ||= 2
  attributes = [:id, :css, :xpath]
  type = attributes[tries]
  obj = page.find(type, page_locator)
  obj != nil
rescue
  Capybara.default_max_wait_time = saved_wait_time
  retry if (tries -= 1) > 0
  false
ensure
  Capybara.default_max_wait_time = saved_wait_time
end

#load_page ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 188

def load_page
  return if exists?
  if defined?(page_url) && !page_url.nil?
    visit page_url
    begin
      page.driver.browser.switch_to.alert.accept
    rescue => e
    end unless Environ.browser == :safari || Environ.browser == :ie || Environ.is_device?
  else
    navigate_to
  end
  verify_page_exists
  PageManager.set_current_page(self)
end

#navigate_to ⇒ Object 



184
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 184

def navigate_to; end

#open_portal ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 163

def open_portal
  environment = Environ.current
  (environment.hostname.length > 0) ?
      url = "#{environment.hostname}/#{environment.base_url}#{environment.append}" :
      url = "#{environment.base_url}#{environment.append}"
  if environment.user_id.length > 0 && environment.password.length > 0
    visit "#{environment.protocol}://#{environment.user_id}:#{environment.password}@#{url}"
  else
    visit "#{environment.protocol}://#{url}"
  end
  Environ.set_portal_state(:open)
end

#populate_data_fields(data) ⇒ Object

Populate the specified UI elements on this page 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      => 'Ms',
         first_name_field   => 'Priscilla',
         last_name_field    => 'Pumperknickle',
         gender_select      => 'Female',
         dob_field          => '11/18/1976',
         email_field        => '[email protected]',
         mailing_list_check => 'Yes'
       }
registration_page.populate_data_fields(data)

Parameters:

  • data (Hash) —

    UI element(s) and associated data to be entered



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 296

def populate_data_fields(data)
  data.each do | data_field, data_param |
    unless data_param.blank?
      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

#secure? ⇒ Boolean

Is current Page object URL secure?

Examples:

home_page.secure?

Returns:

  • (Boolean) 


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

def secure?
  !current_url.match(/^https/).nil?
end

#verify_page_contains(content) ⇒ Object 



203
204
205
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 203

def verify_page_contains(content)
  raise "Expected page to have content '#{content}'" unless page.has_content?(:visible, content)
end

#verify_page_exists ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 176

def verify_page_exists
  unless page.has_selector?(page_locator)
    body_class = find(:xpath, '//body')[:class]
    error_message = "Expected page to have selector '#{page_locator}' but found '#{body_class}' instead.\nURL of page loaded = #{URI.parse(current_url)}"
    raise error_message
  end
end

#verify_page_ui ⇒ Object 



186
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 186

def verify_page_ui; end

#verify_ui_states(ui_states) ⇒ Object 



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
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 239

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