Class: Applitools::Selenium::VisualGridEyes
- Inherits:
-
Object
- Object
- Applitools::Selenium::VisualGridEyes
- 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
-
#api_key ⇒ Object
Returns the value of attribute api_key.
-
#current_config ⇒ Object
Returns the value of attribute current_config.
-
#current_url ⇒ Object
Returns the value of attribute current_url.
-
#dont_get_title ⇒ Object
Returns the value of attribute dont_get_title.
-
#driver ⇒ Object
Returns the value of attribute driver.
-
#driver_lock ⇒ Object
Returns the value of attribute driver_lock.
-
#fetched_cache_map ⇒ Object
Returns the value of attribute fetched_cache_map.
-
#opened ⇒ Object
Returns the value of attribute opened.
-
#proxy ⇒ Object
Returns the value of attribute proxy.
-
#server_url ⇒ Object
Returns the value of attribute server_url.
-
#test_list ⇒ Object
Returns the value of attribute test_list.
-
#visual_grid_manager ⇒ Object
Returns the value of attribute visual_grid_manager.
Instance Method Summary collapse
- #abort_async ⇒ Object
- #abort_if_not_closed ⇒ Object (also: #abort)
- #add_mouse_trigger(_mouse_action, _element) ⇒ Object
- #add_text_trigger(_control, _text) ⇒ Object
- #check(*args) ⇒ Object
- #close(throw_exception = true) ⇒ Object
- #close_async ⇒ Object
- #collect_selenium_regions(target) ⇒ Object
- #configuration ⇒ Object (also: #get_configuration)
- #configuration=(value) ⇒ Object (also: #set_configuration)
- #configure {|config| ... } ⇒ Object
- #element_or_region(target_element, target, options_key) ⇒ Object
- #ensure_config ⇒ Object
- #eyes_connector ⇒ Object
- #full_agent_id ⇒ Object
-
#get_all_test_results ⇒ Object
rubocop:disable Style/AccessorMethodName.
- #get_regions_x_paths(target) ⇒ Object
- #get_viewport_size(web_driver = driver) ⇒ Object
-
#initialize(visual_grid_manager, server_url = nil) ⇒ VisualGridEyes
constructor
A new instance of VisualGridEyes.
- #open(*args) ⇒ Object
- #open? ⇒ Boolean
- #server_connector ⇒ Object
-
#set_viewport_size(value) ⇒ Object
rubocop:disable Style/AccessorMethodName.
- #setup_size_mode(target_element, target, key) ⇒ Object
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.
29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 29 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 end |
Instance Attribute Details
#api_key ⇒ Object
Returns the value of attribute api_key.
21 22 23 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 21 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.
21 22 23 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 21 def opened @opened end |
#proxy ⇒ Object
Returns the value of attribute proxy.
21 22 23 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 21 def proxy @proxy end |
#server_url ⇒ Object
Returns the value of attribute server_url.
21 22 23 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 21 def server_url @server_url end |
#test_list ⇒ Object
Returns the value of attribute test_list.
19 20 21 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 19 def test_list @test_list 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
326 327 328 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 326 def abort_async test_list.each(&:abort) end |
#abort_if_not_closed ⇒ Object Also known as: abort
330 331 332 333 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 330 def abort_if_not_closed self.opened = false test_list.each(&:abort) end |
#add_mouse_trigger(_mouse_action, _element) ⇒ Object
396 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 396 def add_mouse_trigger(_mouse_action, _element); end |
#add_text_trigger(_control, _text) ⇒ Object
398 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 398 def add_text_trigger(_control, _text); end |
#check(*args) ⇒ Object
112 113 114 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 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 112 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. 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.[:script_hooks], config.rendering_grid_force_put, Applitools::Utils::EyesSeleniumUtils.user_agent(driver), .merge(target_to_check.[: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.})" '' 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. end end |
#close(throw_exception = true) ⇒ Object
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 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 297 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 (r), r if r.new? raise Applitools::DiffsFoundError.new (r), r if r.unresolved? && !r.new? raise Applitools::TestFailedError.new (r), r if r.failed? end end failed_results.empty? ? all_results.first : failed_results end |
#close_async ⇒ Object
293 294 295 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 293 def close_async test_list.each(&:close) end |
#collect_selenium_regions(target) ⇒ Object
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 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 211 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
384 385 386 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 384 def configuration config.deep_dup end |
#configuration=(value) ⇒ Object Also known as: set_configuration
388 389 390 391 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 388 def configuration=(value) Applitools::ArgumentGuard.is_a?(value, :configuration, Applitools::Selenium::Configuration) self.config = value.deep_dup end |
#configure {|config| ... } ⇒ Object
51 52 53 54 55 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 51 def configure return unless block_given? yield(config) nil end |
#element_or_region(target_element, target, options_key) ⇒ Object
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 277 def element_or_region(target_element, target, ) 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, ) else target.replace_region(target_element, Applitools::Selenium::VGRegion.new(region, padding_proc), ) end region else target_element end end |
#ensure_config ⇒ Object
43 44 45 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 43 def ensure_config self.config = Applitools::Selenium::Configuration.new end |
#eyes_connector ⇒ Object
104 105 106 107 108 109 110 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 104 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
47 48 49 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 47 def full_agent_id "eyes.selenium.visualgrid.ruby/#{Applitools::VERSION}" end |
#get_all_test_results ⇒ Object
rubocop:disable Style/AccessorMethodName
342 343 344 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 342 def get_all_test_results test_list.map(&:test_result) end |
#get_regions_x_paths(target) ⇒ Object
197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 197 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
99 100 101 102 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 99 def (web_driver = driver) Applitools::ArgumentGuard.not_nil 'web_driver', web_driver Applitools::Utils::EyesSeleniumUtils.(driver) end |
#open(*args) ⇒ Object
57 58 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 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 57 def open(*args) self.test_uuid = SecureRandom.uuid = Applitools::Utils.(args) Applitools::ArgumentGuard.hash(, 'options', [:driver]) config.app_name = [:app_name] if [:app_name] config.test_name = [:test_name] if [:test_name] if config..nil? || config. && config..empty? config. = Applitools::RectangleSize.from_any_argument([:viewport_size]) if [:viewport_size] end self.driver = Applitools::Selenium::SeleniumEyes.eyes_driver(.delete(:driver), self) self.current_url = driver.current_url if () else self. = 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() 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
337 338 339 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 337 def open? opened end |
#server_connector ⇒ Object
377 378 379 380 381 382 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 377 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
348 349 350 351 352 353 354 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 348 def (value) Applitools::Utils::EyesSeleniumUtils. driver, value rescue => e logger.error e.class.to_s logger.error e. raise Applitools::TestFailedError.new "#{e.class} - #{e.}" end |
#setup_size_mode(target_element, target, key) ⇒ Object
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 |
# File 'lib/applitools/selenium/visual_grid/visual_grid_eyes.rb', line 245 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.[:stitch_content] 'full-selector' else 'selector' end when Applitools::Region if element_or_region == Applitools::Region::EMPTY if target.[:stitch_content] 'full-page' else element_or_region = Applitools::Region.from_location_size( Applitools::Location::TOP_LEFT, ) 'region' end else 'region' end else 'full-page' end self.region_to_check = element_or_region end |