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, proxy = nil) ⇒ 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", :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



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

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}", :page, #{proxy});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



161
162
163
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 161

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



150
151
152
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 150

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



92
93
94
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 92

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



104
105
106
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 104

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

.list(element_name, locator) ⇒ Object

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

Examples:

list :x_axis_list, "g.x-axis"

Parameters:

  • element_name (Symbol) —

    name of list object (as a symbol)

  • locator (String) —

    CSS selector or XPath expression that uniquely identifies object



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

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

.radio(element_name, locator, proxy = nil) ⇒ 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", :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



80
81
82
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 80

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}", :page, #{proxy});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



172
173
174
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 172

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



127
128
129
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 127

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



115
116
117
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 115

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) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 226

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 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 201

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 



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

def navigate_to; end

#open_portal ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 176

def open_portal
  environment = Environ.current
  environment.hostname.blank? ?
      url = "#{environment.base_url}#{environment.append}" :
      url = "#{environment.hostname}/#{environment.base_url}#{environment.append}"
  if environment.user_id.blank? || environment.password.blank?
    visit "#{environment.protocol}://#{url}"
  else
    visit "#{environment.protocol}://#{environment.user_id}:#{environment.password}@#{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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 360

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

#secure? ⇒ Boolean

Is current Page object URL secure?

Examples:

home_page.secure?

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 248

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

#verify_page_contains(content) ⇒ Object 



216
217
218
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 216

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

#verify_page_exists ⇒ Object 



189
190
191
192
193
194
195
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 189

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 



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

def verify_page_ui; end

#verify_ui_states(ui_states) ⇒ Object 



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
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
 
# File 'lib/testcentricity_web/page_objects_helper.rb', line 252

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
          if ui_object.get_object_type == :selectlist
            actual = ui_object.get_selected_option
          else
            actual = ui_object.selected?
          end
        when :value
          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
          if ui_object.get_object_type == :selectlist
            actual = ui_object.get_options
          else
            actual = ui_object.get_list_items
          end
        when :optioncount, :itemcount
          if ui_object.get_object_type == :selectlist
            actual = ui_object.get_option_count
          else
            actual = ui_object.get_item_count
          end
        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 be"
        state.each do |key, value|
          case key
            when :lt, :less_than
              ExceptionQueue.enqueue_exception("#{error_msg} less than #{value} but found #{actual}") unless actual < value
            when :lt_eq, :less_than_or_equal
              ExceptionQueue.enqueue_exception("#{error_msg} less than or equal to #{value} but found #{actual}") unless actual <= value
            when :gt, :greater_than
              ExceptionQueue.enqueue_exception("#{error_msg} greater than #{value} but found #{actual}") unless actual > value
            when :gt_eq, :greater_than_or_equal
              ExceptionQueue.enqueue_exception("#{error_msg} 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