Class: Applitools::Selenium::VisualGridEyes

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Concerns::SeleniumEyes
Defined in:
lib/applitools/selenium/visual_grid/visual_grid_eyes.rb

Constant Summary collapse

DOM_EXTRACTION_TIMEOUT =

seconds or 5 minutes

300
USE_DEFAULT_MATCH_TIMEOUT = 
-1

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Concerns::SeleniumEyes

#check_frame, #check_in_frame, #check_region, #check_region_in_frame, #check_window, #test

Constructor Details

#initialize(visual_grid_manager, server_url = nil) ⇒ VisualGridEyes

Returns a new instance of VisualGridEyes.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 30

def initialize(visual_grid_manager, server_url = nil)
  ensure_config
  @server_connector = Applitools::Connectivity::ServerConnector.new(server_url)
  @server_connector.obtain_agent_id do
    full_agent_id
  end
  self.server_url = server_url if server_url
  self.visual_grid_manager = visual_grid_manager
  self.test_list = Applitools::Selenium::TestList.new
  self.opened = false
  self.test_list ||= Applitools::Selenium::TestList.new
  self.driver_lock = Mutex.new
  self.utils = Applitools::Utils::EyesSeleniumUtils
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



22
23
24
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 22

def api_key
  @api_key
end

#current_config ⇒ Object

Returns the value of attribute current_config.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def current_config
  @current_config
end

#current_url ⇒ Object

Returns the value of attribute current_url.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def current_url
  @current_url
end

#dont_get_title ⇒ Object

Returns the value of attribute dont_get_title.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def dont_get_title
  @dont_get_title
end

#driver ⇒ Object

Returns the value of attribute driver.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def driver
  @driver
end

#driver_lock ⇒ Object

Returns the value of attribute driver_lock.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def driver_lock
  @driver_lock
end

#fetched_cache_map ⇒ Object

Returns the value of attribute fetched_cache_map.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def fetched_cache_map
  @fetched_cache_map
end

#opened ⇒ Object

Returns the value of attribute opened.



22
23
24
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 22

def opened
  @opened
end

#proxy ⇒ Object

Returns the value of attribute proxy.



22
23
24
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 22

def proxy
  @proxy
end

#server_url ⇒ Object

Returns the value of attribute server_url.



22
23
24
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 22

def server_url
  @server_url
end

#test_list ⇒ Object

Returns the value of attribute test_list.



20
21
22
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 20

def test_list
  @test_list
end

#utils ⇒ Object

Returns the value of attribute utils.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def utils
  @utils
end

#visual_grid_manager ⇒ Object

Returns the value of attribute visual_grid_manager.



17
18
19
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 17

def visual_grid_manager
  @visual_grid_manager
end

Instance Method Details

#abort_async ⇒ Object 



329
330
331
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 329

def abort_async
  test_list.each(&:abort)
end

#abort_if_not_closed ⇒ Object Also known as: abort 



333
334
335
336
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 333

def abort_if_not_closed
  self.opened = false
  test_list.each(&:abort)
end

#add_mouse_trigger(_mouse_action, _element) ⇒ Object 



399
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 399

def add_mouse_trigger(_mouse_action, _element); end

#add_text_trigger(_control, _text) ⇒ Object 



401
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 401

def add_text_trigger(_control, _text); end

#check(*args) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 115

def check(*args)
  args.compact!
  case (first_arg = args.shift)
  when String
    tag = first_arg
    target = args.shift
  when Applitools::Selenium::Target
    target = first_arg
  when Hash
    target = first_arg[:target]
    tag = first_arg[:name] || first_arg[:tag]
  end

  script = <<-END
    #{Applitools::Selenium::Scripts::PROCESS_PAGE_AND_POLL} return __processPageAndSerializePoll(document, {skipResources: [#{visual_grid_manager.resource_cache.urls_to_skip}]});
  END
  render_task = nil
  target.default_full_page_for_vg

  target_to_check = target.finalize
  begin
    check_in_frame(target_frames: target_to_check.frames) do
      sleep wait_before_screenshots
      Applitools::EyesLogger.info 'Trying to get DOM snapshot...'

      script_thread = Thread.new do
        result = {}
        while result['status'] != 'SUCCESS'
          Thread.current[:script_result] = driver.execute_script(script)
          begin
            Thread.current[:result] = result = Oj.load(Thread.current[:script_result])
            sleep 0.5
          rescue Oj::ParseError => e
            Applitools::EyesLogger.warn e.message
          end
        end
      end
      sleep 0.5
      script_thread_result = script_thread.join(DOM_EXTRACTION_TIMEOUT)
      raise ::Applitools::EyesError.new 'Timeout error while getting dom snapshot!' unless script_thread_result
      Applitools::EyesLogger.info 'Done!'

      mod = Digest::SHA2.hexdigest(script_thread_result[:script_result])

      region_x_paths = get_regions_x_paths(target_to_check)

      render_task = RenderTask.new(
        "Render #{config.short_description} - #{tag}",
        script_thread_result[:result]['value'],
        visual_grid_manager,
        server_connector,
        region_x_paths,
        size_mod,
        region_to_check,
        target_to_check.options[:script_hooks],
        config.rendering_grid_force_put,
        self.utils.user_agent(driver),
        visual_grid_options.merge(target_to_check.options[:visual_grid_options]),
        mod
      )
    end

    if size_mod == 'selector' || size_mod == 'full-selector'
      target_to_check.convert_coordinates(&Applitools::Selenium::VgMatchWindowData::CONVERT_COORDINATES)
    end

    title = begin
      driver.title
    rescue StandardError => e
      logger.warn "failed (#{e.message})"
      ''
    end

    test_list.select { |t| t.test_uuid == test_uuid }.each do |t|
      t.check(tag, target_to_check, render_task, title)
    end
    test_list.each(&:becomes_not_rendered)
    visual_grid_manager.enqueue_render_task render_task
  rescue StandardError => e
    test_list.each(&:becomes_tested)
    Applitools::EyesLogger.error e.class.to_s
    Applitools::EyesLogger.error e.message
  end
end

#close(throw_exception = true) ⇒ Object 



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
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 300

def close(throw_exception = true)
  return false if test_list.empty?
  close_async

  until (states = test_list.map(&:state_name).uniq).count == 1 && states.first == :completed
    sleep 0.5
  end
  self.opened = false

  test_list.select { |t| t.pending_exceptions && !t.pending_exceptions.empty? }.each do |t|
    t.pending_exceptions.each do |e|
      raise e
    end
  end

  all_results = test_list.map(&:test_result).compact
  failed_results = all_results.select { |r| !r.as_expected? }

  if throw_exception
    all_results.each do |r|
      raise Applitools::NewTestError.new new_test_error_message(r), r if r.new?
      raise Applitools::DiffsFoundError.new diffs_found_error_message(r), r if r.unresolved? && !r.new?
      raise Applitools::TestFailedError.new test_failed_error_message(r), r if r.failed?
    end
  end

  failed_results.empty? ? all_results.first : failed_results
end

#close_async ⇒ Object 



296
297
298
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 296

def close_async
  test_list.each(&:close)
end

#collect_selenium_regions(target) ⇒ Object 



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
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 214

def collect_selenium_regions(target)
  selenium_regions = {}
  target_element = target.region_to_check
  setup_size_mode(target_element, target, :none)
  target.ignored_regions.each do |r|
    selenium_regions[element_or_region(r, target, :ignore)] = :ignore
  end
  target.floating_regions.each do |r|
    selenium_regions[element_or_region(r, target, :floating)] = :floating
  end
  target.layout_regions.each do |r|
    selenium_regions[element_or_region(r, target, :layout_regions)] = :layout
  end
  target.strict_regions.each do |r|
    selenium_regions[element_or_region(r, target, :strict_regions)] = :strict
  end
  target.content_regions.each do |r|
    selenium_regions[element_or_region(r, target, :content_regions)] = :content
  end
  target.accessibility_regions.each do |r|
    case (r = element_or_region(r, target, :accessibility_regions))
    when Array
      r.each do |rr|
        selenium_regions[rr] = :accessibility
      end
    else
      selenium_regions[r] = :accessibility
    end
  end
  selenium_regions[region_to_check] = :target if size_mod == 'selector' || size_mod == 'full-selector'

  selenium_regions
end

#configuration ⇒ Object Also known as: get_configuration 



387
388
389
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 387

def configuration
  config.deep_dup
end

#configuration=(value) ⇒ Object Also known as: set_configuration 



391
392
393
394
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 391

def configuration=(value)
  Applitools::ArgumentGuard.is_a?(value, :configuration, Applitools::Selenium::Configuration)
  self.config = value.deep_dup
end

#configure {|config| ... } ⇒ Object

Yields:

  • (config) 


53
54
55
56
57
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 53

def configure
  return unless block_given?
  yield(config)
  nil
end

#element_or_region(target_element, target, options_key) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 280

def element_or_region(target_element, target, options_key)
  if target_element.respond_to?(:call)
    region, padding_proc = target_element.call(driver, true)
    case region
    when Array
      regions_to_replace = region.map { |r| Applitools::Selenium::VGRegion.new(r, padding_proc) }
      target.replace_region(target_element, regions_to_replace, options_key)
    else
      target.replace_region(target_element, Applitools::Selenium::VGRegion.new(region, padding_proc), options_key)
    end
    region
  else
    target_element
  end
end

#ensure_config ⇒ Object 



45
46
47
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 45

def ensure_config
  self.config = Applitools::Selenium::Configuration.new
end

#eyes_connector ⇒ Object 



107
108
109
110
111
112
113
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 107

def eyes_connector
  logger.info('Creating VisualGridEyes server connector')
  ::Applitools::Selenium::EyesConnector.new(server_url, driver_lock: driver_lock).tap do |connector|
    connector.batch = batch
    connector.config = config.deep_clone
  end
end

#full_agent_id ⇒ Object 



49
50
51
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 49

def full_agent_id
  "eyes.selenium.visualgrid.ruby/#{Applitools::VERSION}"
end

#get_all_test_results ⇒ Object

rubocop:disable Style/AccessorMethodName



345
346
347
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 345

def get_all_test_results
  test_list.map(&:test_result)
end

#get_regions_x_paths(target) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 200

def get_regions_x_paths(target)
  result = []
  collect_selenium_regions(target).each do |el, v|
    next unless [::Selenium::WebDriver::Element, Applitools::Selenium::Element].include?(el.class)

    xpath = driver.execute_script(Applitools::Selenium::Scripts::GET_ELEMENT_XPATH_JS, el)
    web_element_region = Applitools::Selenium::WebElementRegion.new(xpath, v)
    self.region_to_check = web_element_region.dup if v == :target && (size_mod == 'selector' || size_mod == 'full-selector')
    result << web_element_region
    target.regions[el] = result.size - 1
  end
  result
end

#get_viewport_size(web_driver = driver) ⇒ Object 



102
103
104
105
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 102

def get_viewport_size(web_driver = driver)
  Applitools::ArgumentGuard.not_nil 'web_driver', web_driver
  self.utils.extract_viewport_size(driver)
end

#open(*args) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 59

def open(*args)
  self.test_uuid = SecureRandom.uuid
  options = Applitools::Utils.extract_options!(args)
  Applitools::ArgumentGuard.hash(options, 'options', [:driver])

  config.app_name = options[:app_name] if options[:app_name]
  config.test_name = options[:test_name] if options[:test_name]
  config.agent_run_id = "#{config.test_name}--#{SecureRandom.hex(10)}"

  if config.viewport_size.nil? || config.viewport_size && config.viewport_size.empty?
    config.viewport_size = Applitools::RectangleSize.from_any_argument(options[:viewport_size]) if options[:viewport_size]
  end

  self.driver = Applitools::Selenium::SeleniumEyes.eyes_driver(options.delete(:driver), self)
  self.current_url = driver.current_url

  if viewport_size
    set_viewport_size(viewport_size)
  else
    self.viewport_size = get_viewport_size
  end

  visual_grid_manager.open(self)
  visual_grid_manager.add_batch(batch.id) do
    server_connector.close_batch(batch.id)
  end

  logger.info('Getting all browsers info...')
  browsers_info_list = config.browsers_info
  logger.info('Creating test descriptors for each browser info...')
  browsers_info_list.each(viewport_size) do |bi|
    test = Applitools::Selenium::RunningTest.new(eyes_connector, bi, driver).tap do |t|
      t.on_results_received do |results|
        visual_grid_manager.aggregate_result(results)
      end
      t.test_uuid = test_uuid
    end
    test_list.push test
  end
  self.opened = true
  driver
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


340
341
342
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 340

def open?
  opened
end

#server_connector ⇒ Object 



380
381
382
383
384
385
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 380

def server_connector
  @server_connector.server_url = config.server_url
  @server_connector.api_key = config.api_key
  @server_connector.proxy = config.proxy if config.proxy
  @server_connector
end

#set_viewport_size(value) ⇒ Object

rubocop:disable Style/AccessorMethodName



351
352
353
354
355
356
357
 
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 351

def set_viewport_size(value)
  self.utils.set_viewport_size driver, value
rescue => e
  logger.error e.class.to_s
  logger.error e.message
  raise Applitools::TestFailedError.new "#{e.class} - #{e.message}"
end

#setup_size_mode(target_element, target, key) ⇒ Object 



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/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 248

def setup_size_mode(target_element, target, key)
  self.size_mod = 'full-page'

  element_or_region = element_or_region(target_element, target, key)

  self.size_mod = case element_or_region
                  when ::Selenium::WebDriver::Element, Applitools::Selenium::Element
                    if target.options[:stitch_content]
                      'full-selector'
                    else
                      'selector'
                    end
                  when Applitools::Region
                    if element_or_region == Applitools::Region::EMPTY
                      if target.options[:stitch_content]
                        'full-page'
                      else
                        element_or_region = Applitools::Region.from_location_size(
                          Applitools::Location::TOP_LEFT, viewport_size
                        )
                        'region'
                      end
                    else
                      'region'
                    end
                  else
                    'full-page'
                  end

  self.region_to_check = element_or_region
end