Class: TestCentricity::ScreenObject

Inherits:
Object
  • Object
show all
Includes:
Test::Unit::Assertions
Defined in:
lib/testcentricity/app_core/screen_objects_helper.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScreenObject

Returns a new instance of ScreenObject.



9
10
11
12
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 9

def initialize
  raise "Screen object #{self.class.name} does not have a page_name trait defined" unless defined?(page_name)
  @locator = page_locator if defined?(page_locator)
end

Instance Attribute Details

#locator ⇒ Object (readonly)

Returns the value of attribute locator.



7
8
9
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 7

def locator
  @locator
end

Class Method Details

.alert(element_name, locator) ⇒ Object 



108
109
110
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 108

def self.alert(element_name, locator)
  class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::AppAlert.new("#{element_name}", self, #{locator}, :page);end))
end

.button(element_name, locator) ⇒ Object 



28
29
30
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 28

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

.buttons(element_hash) ⇒ Object 



32
33
34
35
36
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 32

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

.checkbox(element_name, locator) ⇒ Object 



58
59
60
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 58

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

.checkboxes(element_hash) ⇒ Object 



62
63
64
65
66
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 62

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

.element(element_name, locator) ⇒ Object 



18
19
20
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 18

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

.elements(element_hash) ⇒ Object 



22
23
24
25
26
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 22

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

.image(element_name, locator) ⇒ Object 



98
99
100
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 98

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

.images(element_hash) ⇒ Object 



102
103
104
105
106
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 102

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

.label(element_name, locator) ⇒ Object 



68
69
70
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 68

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

.labels(element_hash) ⇒ Object 



72
73
74
75
76
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 72

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

.list(element_name, locator) ⇒ Object 



78
79
80
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 78

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

.lists(element_hash) ⇒ Object 



82
83
84
85
86
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 82

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

.section(section_name, class_name) ⇒ Object 



112
113
114
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 112

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

.sections(section_hash) ⇒ Object 



116
117
118
119
120
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 116

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 



88
89
90
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 88

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

.selectlists(element_hash) ⇒ Object 



92
93
94
95
96
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 92

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

.switch(element_name, locator) ⇒ Object 



48
49
50
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 48

def self.switch(element_name, locator)
  class_eval(%(def #{element_name};@#{element_name} ||= TestCentricity::AppSwitch.new("#{element_name}", self, #{locator}, :page);end))
end

.switches(element_hash) ⇒ Object 



52
53
54
55
56
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 52

def self.switches(element_hash)
  element_hash.each do |element_name, locator|
    switch(element_name, locator)
  end
end

.textfield(element_name, locator) ⇒ Object 



38
39
40
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 38

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

.textfields(element_hash) ⇒ Object 



42
43
44
45
46
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 42

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

.trait(trait_name, &block) ⇒ Object 



14
15
16
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 14

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

Instance Method Details

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 137

def exists?
  @locator.is_a?(Array) ? tries ||= 2 : tries ||= 1
  if @locator.is_a?(Array)
    loc = @locator[tries - 1]
    find_element(loc.keys[0], loc.values[0])
  else
    find_element(@locator.keys[0], @locator.values[0])
  end
  true
rescue
  retry if (tries -= 1) > 0
  false
end

#load_page ⇒ Object 



171
172
173
174
175
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 171

def load_page
  navigate_to unless exists?
  verify_page_exists
  PageManager.current_page = self
end

#navigate_to ⇒ Object 



167
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 167

def navigate_to; end

#open_portal ⇒ Object 



123
124
125
126
127
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 123

def open_portal
  environment = Environ.current

  Environ.portal_state = :open
end

#populate_data_fields(data, wait_time = nil) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 276

def populate_data_fields(data, wait_time = nil)
  timeout = wait_time.nil? ? 5 : wait_time
  data.each do |data_field, data_param|
    unless data_param.blank?
      # make sure the intended UI target element is visible before trying to set its value
      data_field.wait_until_visible(timeout)
      if data_param == '!DELETE'
        data_field.clear
      else
        case data_field.get_object_type
        when :checkbox
          data_field.set_checkbox_state(data_param.to_bool)
        when :textfield
          data_field.set("#{data_param}\t")
        end
      end
    end
  end
end

#verify_page_exists ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 129

def verify_page_exists
  wait = Selenium::WebDriver::Wait.new(timeout: Environ.default_max_wait_time)
  wait.until { exists? }
  PageManager.current_page = self
rescue
  raise "Could not find page_locator for screen object '#{self.class.name}' (#{@locator}) after #{Environ.default_max_wait_time} seconds"
end

#verify_page_ui ⇒ Object 



169
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 169

def verify_page_ui; end

#verify_ui_states(ui_states) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
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
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
266
267
268
269
270
271
272
273
274
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 179

def verify_ui_states(ui_states)
  ui_states.each do |ui_object, object_states|
    object_states.each do |property, state|

      puts "#{ui_object.get_name} - #{property} = #{state}" if ENV['DEBUG']

      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 :checked
        actual = ui_object.checked?
      when :selected
        actual = ui_object.selected?
      when :value
        actual = ui_object.get_value
      when :caption
        actual = ui_object.get_caption
      when :name
        actual = ui_object.tag_name
      when :placeholder
        actual = ui_object.get_placeholder
      when :readonly
        actual = ui_object.read_only?
      when :maxlength
        actual = ui_object.get_max_length
      when :items
        actual = ui_object.get_list_items
      when :itemcount
        actual = ui_object.get_item_count
      when :width
        actual = ui_object.width
      when :height
        actual = ui_object.height
      when :x
        actual = ui_object.x_loc
      when :y
        actual = ui_object.y_loc
      end

      if state.is_a?(Hash) && state.length == 1
        error_msg = "Expected UI object '#{ui_object.get_name}' (#{ui_object.get_locator}) #{property} 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)
          when :not_contains, :does_not_contain
            ExceptionQueue.enqueue_exception("#{error_msg} not contain '#{value}' but found '#{actual}'") if actual.include?(value)
          when :not_equal
            ExceptionQueue.enqueue_exception("#{error_msg} not equal '#{value}' but found '#{actual}'") if actual == value
          when :like, :is_like
            actual_like = actual.delete("\n")
            actual_like = actual_like.delete("\r")
            actual_like = actual_like.delete("\t")
            actual_like = actual_like.delete(' ')
            actual_like = actual_like.downcase
            expected    = value.delete("\n")
            expected    = expected.delete("\r")
            expected    = expected.delete("\t")
            expected    = expected.delete(' ')
            expected    = expected.downcase
            ExceptionQueue.enqueue_exception("#{error_msg} be like '#{value}' but found '#{actual}'") unless actual_like.include?(expected)
          when :translate
            expected = I18n.t(value)
            ExceptionQueue.enqueue_assert_equal(expected, actual, "Expected UI object '#{ui_object.get_name}' (#{ui_object.get_locator}) translated #{property} property")
          end
        end
      else
        ExceptionQueue.enqueue_assert_equal(state, actual, "Expected UI object '#{ui_object.get_name}' (#{ui_object.get_locator}) #{property} property")
      end
    end
  end
rescue ObjectNotFoundError => e
  ExceptionQueue.enqueue_exception(e.message)
ensure
  ExceptionQueue.post_exceptions
end

#wait_until_exists(seconds = nil) ⇒ Object 



151
152
153
154
155
156
157
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 151

def wait_until_exists(seconds = nil)
  timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { exists? }
rescue
  raise "Screen object #{self.class.name} not found after #{timeout} seconds" unless exists?
end

#wait_until_gone(seconds = nil) ⇒ Object 



159
160
161
162
163
164
165
 
# File 'lib/testcentricity/app_core/screen_objects_helper.rb', line 159

def wait_until_gone(seconds = nil)
  timeout = seconds.nil? ? Environ.default_max_wait_time : seconds
  wait = Selenium::WebDriver::Wait.new(timeout: timeout)
  wait.until { !exists? }
rescue
  raise "Screen object #{self.class.name} remained visible after #{timeout} seconds" if exists?
end