Module: Applitools::Utils::EyesSeleniumUtils
- Extended by:
- EyesSeleniumUtils
- Included in:
- EyesSeleniumUtils
- Defined in:
- lib/applitools/utils/eyes_selenium_utils.rb
Constant Summary collapse
- JS_GET_TRANSFORM_VALUE =
JS_GET_TRANSFORM_VALUE = <<-JS.freeze
document.documentElement.style['%{key}']
JS
JS_SET_TRANSFORM_VALUE = <<-JS.freeze
document.documentElement.style['%{key}'] = '%{value}'
JS
<<-JS.freeze %{element}.style['%{key}'] JS
- JS_SET_TRANSFORM_VALUE =
<<-JS.freeze %{element}.style['%{key}'] = '%{value}' JS
- JS_TRANSFORM_KEYS =
['transform', '-webkit-transform', '-ms-transform', '-moz-transform'].freeze
- BROWSER_SIZE_CALCULATION_RETRIES =
3
- VERIFY_RETRIES =
Number of attemts to set browser size
3
- VERIFY_SLEEP_PERIOD =
A time delay (in seconds) before next attempt to set browser size
1
- MAX_DIFF =
Maximum different (in pixels) between calculated browser size and real browser size when it tries to achieve target size incrementally
3
Instance Method Summary collapse
-
#android?(_driver) ⇒ Boolean
true if test is running on Android device.
- #current_element_transforms(executor, element) ⇒ Object
- #current_frame_content_entire_size(executor) ⇒ Object
-
#current_scroll_position(executor) ⇒ Applitools::Location
Location instance which indicates current scroll position.
- #current_transforms(executor) ⇒ Object
- #device_pixel_ratio(executor) ⇒ Object
- #element_translate_to(executor, element, location) ⇒ Object
- #entire_page_size(executor) ⇒ Object
- #extract_viewport_size(executor) ⇒ Object
- #hide_scrollbars(executor) ⇒ Object
-
#ios?(_driver) ⇒ Boolean
true if test is running on iOS device.
-
#mobile_device?(_driver) ⇒ Boolean
true if test is running on mobile device.
- #page_metrics(executor) ⇒ Object
- #platform_version(_driver) ⇒ Object
-
#scroll_to(executor, point) ⇒ Object
scrolls browser to position specified by point.
- #scroll_to_bottom_right(executor) ⇒ Object
- #set_browser_size(executor, required_size) ⇒ Object
- #set_browser_size_by_viewport_size(executor, actual_viewport_size, required_size) ⇒ Object
- #set_current_transforms(executor, transform) ⇒ Object
- #set_element_transforms(executor, element, transform) ⇒ Object
- #set_overflow(executor, overflow) ⇒ Object
- #set_transforms(executor, value) ⇒ Object
- #set_viewport_size(executor, viewport_size) ⇒ Object
- #translate_to(executor, location) ⇒ Object
-
#user_agent(executor) ⇒ String
User agent string.
Instance Method Details
#android?(_driver) ⇒ Boolean
true if test is running on Android device
174 175 176 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 174 def android?(_driver) false end |
#current_element_transforms(executor, element) ⇒ Object
290 291 292 293 294 295 296 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 290 def current_element_transforms(executor, element) transform_script = JS_TRANSFORM_KEYS.map do |tk| "'#{tk}': #{JS_GET_TRANSFORM_VALUE % { element: 'arguments[0]', key: tk }}" end.join(', ') script = "return { #{transform_script} };" executor.execute_script(script, element) end |
#current_frame_content_entire_size(executor) ⇒ Object
246 247 248 249 250 251 252 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 246 def current_frame_content_entire_size(executor) return Applitools::MOCK_ENTIRE_SIZE if defined?(Applitools::MOCK_ENTIRE_SIZE) dimensions = executor.execute_script(JS_GET_CONTENT_ENTIRE_SIZE) Applitools::RectangleSize.new(dimensions.first.to_i, dimensions.last.to_i) rescue raise Applitools::EyesDriverOperationException.new 'Failed to extract entire size!' end |
#current_scroll_position(executor) ⇒ Applitools::Location
Returns Location instance which indicates current scroll position.
197 198 199 200 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 197 def current_scroll_position(executor) position = Applitools::Utils.symbolize_keys executor.execute_script(JS_GET_CURRENT_SCROLL_POSITION).to_hash Applitools::Location.new position[:left], position[:top] end |
#current_transforms(executor) ⇒ Object
254 255 256 257 258 259 260 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 254 def current_transforms(executor) transform_script = JS_TRANSFORM_KEYS.map do |tk| "'#{tk}': #{JS_GET_TRANSFORM_VALUE % { element: 'document.documentElement', key: tk }}" end.join(', ') script = "return { #{transform_script} };" executor.execute_script(script) end |
#device_pixel_ratio(executor) ⇒ Object
308 309 310 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 308 def device_pixel_ratio(executor) executor.execute_script(JS_GET_DEVICE_PIXEL_RATIO) end |
#element_translate_to(executor, element, location) ⇒ Object
303 304 305 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 303 def element_translate_to(executor, element, location) set_element_transforms(executor, element, "translate(#{location.x}px, #{location.y}px)") end |
#entire_page_size(executor) ⇒ Object
234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 234 def entire_page_size(executor) return Applitools::MOCK_ENTIRE_SIZE if defined?(Applitools::MOCK_ENTIRE_SIZE) metrics = page_metrics(executor) max_document_element_height = [metrics[:client_height], metrics[:scroll_height]].max max_body_height = [metrics[:body_client_height], metrics[:body_scroll_height]].max total_width = [metrics[:scroll_width], metrics[:body_scroll_width]].max total_height = [max_document_element_height, max_body_height].max Applitools::RectangleSize.new(total_width, total_height) end |
#extract_viewport_size(executor) ⇒ Object
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 211 def (executor) Applitools::EyesLogger.debug 'extract_viewport_size()' begin width, height = executor.execute_script(JS_GET_VIEWPORT_SIZE) result = Applitools::RectangleSize.from_any_argument width: width, height: height Applitools::EyesLogger.debug "Viewport size is #{result}." return result rescue => e Applitools::EyesLogger.error "Failed extracting viewport size using JavaScript: (#{e.})" end Applitools::EyesLogger.info 'Using window size as viewport size.' width, height = executor.manage.window.size.to_a width, height = height, width if executor.landscape_orientation? && height > width result = Applitools::RectangleSize.new width, height Applitools::EyesLogger.debug "Viewport size is #{result}." result end |
#hide_scrollbars(executor) ⇒ Object
318 319 320 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 318 def (executor) set_overflow executor, OVERFLOW_HIDDEN end |
#ios?(_driver) ⇒ Boolean
true if test is running on iOS device
179 180 181 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 179 def ios?(_driver) false end |
#mobile_device?(_driver) ⇒ Boolean
true if test is running on mobile device
169 170 171 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 169 def mobile_device?(_driver) nil end |
#page_metrics(executor) ⇒ Object
313 314 315 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 313 def page_metrics(executor) Applitools::Utils.underscore_hash_keys(executor.execute_script(JS_GET_PAGE_METRICS)) end |
#platform_version(_driver) ⇒ Object
184 185 186 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 184 def platform_version(_driver) nil end |
#scroll_to(executor, point) ⇒ Object
scrolls browser to position specified by point.
206 207 208 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 206 def scroll_to(executor, point) with_timeout(0.25) { executor.execute_script(JS_SCROLL_TO % { left: point.left, top: point.top }) } end |
#scroll_to_bottom_right(executor) ⇒ Object
428 429 430 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 428 def scroll_to_bottom_right(executor) executor.execute_script(JS_SCROLL_TO_BOTTOM_RIGHT) end |
#set_browser_size(executor, required_size) ⇒ Object
399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 399 def set_browser_size(executor, required_size) retries_left = VERIFY_RETRIES current_size = Applitools::RectangleSize.new(0, 0) while retries_left > 0 && current_size != required_size Applitools::EyesLogger.info "Trying to set browser size to #{required_size}" executor.manage.window.size = required_size sleep VERIFY_SLEEP_PERIOD current_size = Applitools::RectangleSize.from_any_argument(executor.manage.window.size) Applitools::EyesLogger.info "Current browser size: #{required_size}" retries_left -= 1 end current_size == required_size end |
#set_browser_size_by_viewport_size(executor, actual_viewport_size, required_size) ⇒ Object
413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 413 def (executor, , required_size) browser_size = executor.manage.window.size if browser_size.width.nil? || browser_size.height.nil? raise( Applitools::EyesError, 'driver.manage.window.size returned nil values. ' \ 'Please ensure that you use the latest version of browser and its driver!' ) end browser_size = Applitools::RectangleSize.from_any_argument(browser_size) Applitools::EyesLogger.info "Current browser size: #{browser_size}" required_browser_size = browser_size + required_size - set_browser_size(executor, required_browser_size) end |
#set_current_transforms(executor, transform) ⇒ Object
262 263 264 265 266 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 262 def set_current_transforms(executor, transform) value = {} JS_TRANSFORM_KEYS.map { |tk| value[tk] = transform } set_transforms(executor, value) end |
#set_element_transforms(executor, element, transform) ⇒ Object
281 282 283 284 285 286 287 288 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 281 def set_element_transforms(executor, element, transform) value = {} JS_TRANSFORM_KEYS.map { |tk| value[tk] = transform } script = value.keys.map do |k| JS_SET_TRANSFORM_VALUE % { element: 'arguments[0]', key: k, value: value[k] } end.join('; ') executor.execute_script(script, element) end |
#set_overflow(executor, overflow) ⇒ Object
323 324 325 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 323 def set_overflow(executor, overflow) with_timeout(0.1) { executor.execute_script(JS_SET_OVERFLOW % { overflow: overflow }) } end |
#set_transforms(executor, value) ⇒ Object
268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 268 def set_transforms(executor, value) root_element = executor.browser.running_browser_name == :internet_explorer ? 'document.body' : 'document.documentElement' script = value.keys.map do |k| JS_SET_TRANSFORM_VALUE % { element: root_element, key: k, value: value[k] } end.join('; ') executor.execute_script(script) end |
#set_viewport_size(executor, viewport_size) ⇒ Object
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 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 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 329 def (executor, ) Applitools::ArgumentGuard.not_nil 'viewport_size', Applitools::EyesLogger.info "Set viewport size #{}" required_size = Applitools::RectangleSize.from_any_argument = Applitools::RectangleSize.from_any_argument((executor)) Applitools::EyesLogger.info "Initial viewport size: #{}" if == required_size Applitools::EyesLogger.info 'Required size is already set.' return end # Before resizing the window, set its position to the upper left corner (otherwise, there might not be enough # "space" below/next to it and the operation won't be successful). begin executor.manage.window.position = Selenium::WebDriver::Point.new(0, 0) rescue Selenium::WebDriver::Error::UnsupportedOperationError => e Applitools::EyesLogger.error e. << '\n Continue...' end (executor, , required_size) = (executor) return if == required_size # Additional attempt. This Solves the "maximized browser" bug # (border size for maximized browser sometimes different than # non-maximized, so the original browser size calculation is # wrong). Applitools::EyesLogger.info 'Trying workaround for maximization...' (executor, , required_size) = (executor) Applitools::EyesLogger.info "Current viewport size: #{}" return if == required_size width_diff = .width - required_size.width width_step = width_diff > 0 ? -1 : 1 height_diff = .height - required_size.height height_step = height_diff > 0 ? -1 : 1 browser_size = Applitools::RectangleSize.from_any_argument(executor.manage.window.size) current_width_change = 0 current_height_change = 0 if width_diff.abs <= MAX_DIFF && height_diff <= MAX_DIFF Applitools::EyesLogger.info 'Trying workaround for zoom...' while current_width_change.abs <= width_diff && current_height_change.abs <= height_diff current_width_change += width_step if .width != required_size.width current_height_change += height_step if .height != required_size.height set_browser_size executor, browser_size.dup + Applitools::RectangleSize.new(current_width_change, current_height_change) = Applitools::RectangleSize.from_any_argument (executor) Applitools::EyesLogger.info "Current viewport size: #{}" return if == required_size end Applitools::EyesLogger.error 'Zoom workaround failed.' end raise Applitools::TestFailedError.new "Failed to set viewport size (#{})" end |
#translate_to(executor, location) ⇒ Object
298 299 300 301 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 298 def translate_to(executor, location) set_current_transforms(executor, "translate(10px, #{-location.y}px)") set_current_transforms(executor, "translate(#{-location.x}px, #{-location.y}px)") end |
#user_agent(executor) ⇒ String
Returns User agent string.
190 191 192 |
# File 'lib/applitools/utils/eyes_selenium_utils.rb', line 190 def user_agent(executor) executor.execute_script(JS_GET_USER_AGENT) end |