selenium-webdriver 4.0.0.alpha1 → 4.0.0.alpha6

data/lib/selenium/webdriver/devtools/overlay.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module WebDriver
+    class DevTools
+      def overlay
+        @overlay ||= Overlay.new(self)
+      end
+
+      class Overlay
+        EVENTS = {
+          inspect_node_requested: 'inspectNodeRequested',
+          node_highlight_requested: 'nodeHighlightRequested',
+          screenshot_requested: 'screenshotRequested',
+          inspect_mode_canceled: 'inspectModeCanceled',
+        }
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["Overlay.#{event}"] << block
+        end
+
+        def disable
+          @devtools.send_cmd('Overlay.disable')
+        end
+
+        def enable
+          @devtools.send_cmd('Overlay.enable')
+        end
+
+        def get_highlight_object_for_test(node_id:, include_distance: nil, include_style: nil, color_format: nil)
+          @devtools.send_cmd('Overlay.getHighlightObjectForTest',
+                             nodeId: node_id,
+                             includeDistance: include_distance,
+                             includeStyle: include_style,
+                             colorFormat: color_format)
+        end
+
+        def hide_highlight
+          @devtools.send_cmd('Overlay.hideHighlight')
+        end
+
+        def highlight_frame(frame_id:, content_color: nil, content_outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightFrame',
+                             frameId: frame_id,
+                             contentColor: content_color,
+                             contentOutlineColor: content_outline_color)
+        end
+
+        def highlight_node(highlight_config:, node_id: nil, backend_node_id: nil, object_id: nil, selector: nil)
+          @devtools.send_cmd('Overlay.highlightNode',
+                             highlightConfig: highlight_config,
+                             nodeId: node_id,
+                             backendNodeId: backend_node_id,
+                             objectId: object_id,
+                             selector: selector)
+        end
+
+        def highlight_quad(quad:, color: nil, outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightQuad',
+                             quad: quad,
+                             color: color,
+                             outlineColor: outline_color)
+        end
+
+        def highlight_rect(x:, y:, width:, height:, color: nil, outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightRect',
+                             x: x,
+                             y: y,
+                             width: width,
+                             height: height,
+                             color: color,
+                             outlineColor: outline_color)
+        end
+
+        def set_inspect_mode(mode:, highlight_config: nil)
+          @devtools.send_cmd('Overlay.setInspectMode',
+                             mode: mode,
+                             highlightConfig: highlight_config)
+        end
+
+        def set_show_ad_highlights(show:)
+          @devtools.send_cmd('Overlay.setShowAdHighlights',
+                             show: show)
+        end
+
+        def set_paused_in_debugger_message(message: nil)
+          @devtools.send_cmd('Overlay.setPausedInDebuggerMessage',
+                             message: message)
+        end
+
+        def set_show_debug_borders(show:)
+          @devtools.send_cmd('Overlay.setShowDebugBorders',
+                             show: show)
+        end
+
+        def set_show_fpscounter(show:)
+          @devtools.send_cmd('Overlay.setShowFPSCounter',
+                             show: show)
+        end
+
+        def set_show_paint_rects(result:)
+          @devtools.send_cmd('Overlay.setShowPaintRects',
+                             result: result)
+        end
+
+        def set_show_layout_shift_regions(result:)
+          @devtools.send_cmd('Overlay.setShowLayoutShiftRegions',
+                             result: result)
+        end
+
+        def set_show_scroll_bottleneck_rects(show:)
+          @devtools.send_cmd('Overlay.setShowScrollBottleneckRects',
+                             show: show)
+        end
+
+        def set_show_hit_test_borders(show:)
+          @devtools.send_cmd('Overlay.setShowHitTestBorders',
+                             show: show)
+        end
+
+        def set_show_viewport_size_on_resize(show:)
+          @devtools.send_cmd('Overlay.setShowViewportSizeOnResize',
+                             show: show)
+        end
+
+        def set_show_hinge(hinge_config: nil)
+          @devtools.send_cmd('Overlay.setShowHinge',
+                             hingeConfig: hinge_config)
+        end
+
+      end # Overlay
+    end # DevTools
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/devtools/page.rb

@@ -0,0 +1,374 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module WebDriver
+    class DevTools
+      def page
+        @page ||= Page.new(self)
+      end
+
+      class Page
+        EVENTS = {
+          dom_content_event_fired: 'domContentEventFired',
+          file_chooser_opened: 'fileChooserOpened',
+          frame_attached: 'frameAttached',
+          frame_cleared_scheduled_navigation: 'frameClearedScheduledNavigation',
+          frame_detached: 'frameDetached',
+          frame_navigated: 'frameNavigated',
+          frame_resized: 'frameResized',
+          frame_requested_navigation: 'frameRequestedNavigation',
+          frame_scheduled_navigation: 'frameScheduledNavigation',
+          frame_started_loading: 'frameStartedLoading',
+          frame_stopped_loading: 'frameStoppedLoading',
+          download_will_begin: 'downloadWillBegin',
+          download_progress: 'downloadProgress',
+          interstitial_hidden: 'interstitialHidden',
+          interstitial_shown: 'interstitialShown',
+          javascript_dialog_closed: 'javascriptDialogClosed',
+          javascript_dialog_opening: 'javascriptDialogOpening',
+          lifecycle_event: 'lifecycleEvent',
+          load_event_fired: 'loadEventFired',
+          navigated_within_document: 'navigatedWithinDocument',
+          screencast_frame: 'screencastFrame',
+          screencast_visibility_changed: 'screencastVisibilityChanged',
+          window_open: 'windowOpen',
+          compilation_cache_produced: 'compilationCacheProduced',
+        }
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["Page.#{event}"] << block
+        end
+
+        def add_script_to_evaluate_on_load(script_source:)
+          @devtools.send_cmd('Page.addScriptToEvaluateOnLoad',
+                             scriptSource: script_source)
+        end
+
+        def add_script_to_evaluate_on_new_document(source:, world_name: nil)
+          @devtools.send_cmd('Page.addScriptToEvaluateOnNewDocument',
+                             source: source,
+                             worldName: world_name)
+        end
+
+        def bring_to_front
+          @devtools.send_cmd('Page.bringToFront')
+        end
+
+        def capture_screenshot(format: nil, quality: nil, clip: nil, from_surface: nil)
+          @devtools.send_cmd('Page.captureScreenshot',
+                             format: format,
+                             quality: quality,
+                             clip: clip,
+                             fromSurface: from_surface)
+        end
+
+        def capture_snapshot(format: nil)
+          @devtools.send_cmd('Page.captureSnapshot',
+                             format: format)
+        end
+
+        def clear_device_metrics_override
+          @devtools.send_cmd('Page.clearDeviceMetricsOverride')
+        end
+
+        def clear_device_orientation_override
+          @devtools.send_cmd('Page.clearDeviceOrientationOverride')
+        end
+
+        def clear_geolocation_override
+          @devtools.send_cmd('Page.clearGeolocationOverride')
+        end
+
+        def create_isolated_world(frame_id:, world_name: nil, grant_univeral_access: nil)
+          @devtools.send_cmd('Page.createIsolatedWorld',
+                             frameId: frame_id,
+                             worldName: world_name,
+                             grantUniveralAccess: grant_univeral_access)
+        end
+
+        def delete_cookie(cookie_name:, url:)
+          @devtools.send_cmd('Page.deleteCookie',
+                             cookieName: cookie_name,
+                             url: url)
+        end
+
+        def disable
+          @devtools.send_cmd('Page.disable')
+        end
+
+        def enable
+          @devtools.send_cmd('Page.enable')
+        end
+
+        def get_app_manifest
+          @devtools.send_cmd('Page.getAppManifest')
+        end
+
+        def get_installability_errors
+          @devtools.send_cmd('Page.getInstallabilityErrors')
+        end
+
+        def get_manifest_icons
+          @devtools.send_cmd('Page.getManifestIcons')
+        end
+
+        def get_cookies
+          @devtools.send_cmd('Page.getCookies')
+        end
+
+        def get_frame_tree
+          @devtools.send_cmd('Page.getFrameTree')
+        end
+
+        def get_layout_metrics
+          @devtools.send_cmd('Page.getLayoutMetrics')
+        end
+
+        def get_navigation_history
+          @devtools.send_cmd('Page.getNavigationHistory')
+        end
+
+        def reset_navigation_history
+          @devtools.send_cmd('Page.resetNavigationHistory')
+        end
+
+        def get_resource_content(frame_id:, url:)
+          @devtools.send_cmd('Page.getResourceContent',
+                             frameId: frame_id,
+                             url: url)
+        end
+
+        def get_resource_tree
+          @devtools.send_cmd('Page.getResourceTree')
+        end
+
+        def handle_java_script_dialog(accept:, prompt_text: nil)
+          @devtools.send_cmd('Page.handleJavaScriptDialog',
+                             accept: accept,
+                             promptText: prompt_text)
+        end
+
+        def navigate(url:, referrer: nil, transition_type: nil, frame_id: nil, referrer_policy: nil)
+          @devtools.send_cmd('Page.navigate',
+                             url: url,
+                             referrer: referrer,
+                             transitionType: transition_type,
+                             frameId: frame_id,
+                             referrerPolicy: referrer_policy)
+        end
+
+        def navigate_to_history_entry(entry_id:)
+          @devtools.send_cmd('Page.navigateToHistoryEntry',
+                             entryId: entry_id)
+        end
+
+        def print_to_pdf(landscape: nil, display_header_footer: nil, print_background: nil, scale: nil, paper_width: nil, paper_height: nil, margin_top: nil, margin_bottom: nil, margin_left: nil, margin_right: nil, page_ranges: nil, ignore_invalid_page_ranges: nil, header_template: nil, footer_template: nil, prefer_csspage_size: nil, transfer_mode: nil)
+          @devtools.send_cmd('Page.printToPDF',
+                             landscape: landscape,
+                             displayHeaderFooter: display_header_footer,
+                             printBackground: print_background,
+                             scale: scale,
+                             paperWidth: paper_width,
+                             paperHeight: paper_height,
+                             marginTop: margin_top,
+                             marginBottom: margin_bottom,
+                             marginLeft: margin_left,
+                             marginRight: margin_right,
+                             pageRanges: page_ranges,
+                             ignoreInvalidPageRanges: ignore_invalid_page_ranges,
+                             headerTemplate: header_template,
+                             footerTemplate: footer_template,
+                             preferCSSPageSize: prefer_csspage_size,
+                             transferMode: transfer_mode)
+        end
+
+        def reload(ignore_cache: nil, script_to_evaluate_on_load: nil)
+          @devtools.send_cmd('Page.reload',
+                             ignoreCache: ignore_cache,
+                             scriptToEvaluateOnLoad: script_to_evaluate_on_load)
+        end
+
+        def remove_script_to_evaluate_on_load(identifier:)
+          @devtools.send_cmd('Page.removeScriptToEvaluateOnLoad',
+                             identifier: identifier)
+        end
+
+        def remove_script_to_evaluate_on_new_document(identifier:)
+          @devtools.send_cmd('Page.removeScriptToEvaluateOnNewDocument',
+                             identifier: identifier)
+        end
+
+        def screencast_frame_ack(session_id:)
+          @devtools.send_cmd('Page.screencastFrameAck',
+                             sessionId: session_id)
+        end
+
+        def search_in_resource(frame_id:, url:, query:, case_sensitive: nil, is_regex: nil)
+          @devtools.send_cmd('Page.searchInResource',
+                             frameId: frame_id,
+                             url: url,
+                             query: query,
+                             caseSensitive: case_sensitive,
+                             isRegex: is_regex)
+        end
+
+        def set_ad_blocking_enabled(enabled:)
+          @devtools.send_cmd('Page.setAdBlockingEnabled',
+                             enabled: enabled)
+        end
+
+        def set_bypass_csp(enabled:)
+          @devtools.send_cmd('Page.setBypassCSP',
+                             enabled: enabled)
+        end
+
+        def set_device_metrics_override(width:, height:, device_scale_factor:, mobile:, scale: nil, screen_width: nil, screen_height: nil, position_x: nil, position_y: nil, dont_set_visible_size: nil, screen_orientation: nil, viewport: nil)
+          @devtools.send_cmd('Page.setDeviceMetricsOverride',
+                             width: width,
+                             height: height,
+                             deviceScaleFactor: device_scale_factor,
+                             mobile: mobile,
+                             scale: scale,
+                             screenWidth: screen_width,
+                             screenHeight: screen_height,
+                             positionX: position_x,
+                             positionY: position_y,
+                             dontSetVisibleSize: dont_set_visible_size,
+                             screenOrientation: screen_orientation,
+                             viewport: viewport)
+        end
+
+        def set_device_orientation_override(alpha:, beta:, gamma:)
+          @devtools.send_cmd('Page.setDeviceOrientationOverride',
+                             alpha: alpha,
+                             beta: beta,
+                             gamma: gamma)
+        end
+
+        def set_font_families(font_families:)
+          @devtools.send_cmd('Page.setFontFamilies',
+                             fontFamilies: font_families)
+        end
+
+        def set_font_sizes(font_sizes:)
+          @devtools.send_cmd('Page.setFontSizes',
+                             fontSizes: font_sizes)
+        end
+
+        def set_document_content(frame_id:, html:)
+          @devtools.send_cmd('Page.setDocumentContent',
+                             frameId: frame_id,
+                             html: html)
+        end
+
+        def set_download_behavior(behavior:, download_path: nil)
+          @devtools.send_cmd('Page.setDownloadBehavior',
+                             behavior: behavior,
+                             downloadPath: download_path)
+        end
+
+        def set_geolocation_override(latitude: nil, longitude: nil, accuracy: nil)
+          @devtools.send_cmd('Page.setGeolocationOverride',
+                             latitude: latitude,
+                             longitude: longitude,
+                             accuracy: accuracy)
+        end
+
+        def set_lifecycle_events_enabled(enabled:)
+          @devtools.send_cmd('Page.setLifecycleEventsEnabled',
+                             enabled: enabled)
+        end
+
+        def set_touch_emulation_enabled(enabled:, configuration: nil)
+          @devtools.send_cmd('Page.setTouchEmulationEnabled',
+                             enabled: enabled,
+                             configuration: configuration)
+        end
+
+        def start_screencast(format: nil, quality: nil, max_width: nil, max_height: nil, every_nth_frame: nil)
+          @devtools.send_cmd('Page.startScreencast',
+                             format: format,
+                             quality: quality,
+                             maxWidth: max_width,
+                             maxHeight: max_height,
+                             everyNthFrame: every_nth_frame)
+        end
+
+        def stop_loading
+          @devtools.send_cmd('Page.stopLoading')
+        end
+
+        def crash
+          @devtools.send_cmd('Page.crash')
+        end
+
+        def close
+          @devtools.send_cmd('Page.close')
+        end
+
+        def set_web_lifecycle_state(state:)
+          @devtools.send_cmd('Page.setWebLifecycleState',
+                             state: state)
+        end
+
+        def stop_screencast
+          @devtools.send_cmd('Page.stopScreencast')
+        end
+
+        def set_produce_compilation_cache(enabled:)
+          @devtools.send_cmd('Page.setProduceCompilationCache',
+                             enabled: enabled)
+        end
+
+        def add_compilation_cache(url:, data:)
+          @devtools.send_cmd('Page.addCompilationCache',
+                             url: url,
+                             data: data)
+        end
+
+        def clear_compilation_cache
+          @devtools.send_cmd('Page.clearCompilationCache')
+        end
+
+        def generate_test_report(message:, group: nil)
+          @devtools.send_cmd('Page.generateTestReport',
+                             message: message,
+                             group: group)
+        end
+
+        def wait_for_debugger
+          @devtools.send_cmd('Page.waitForDebugger')
+        end
+
+        def set_intercept_file_chooser_dialog(enabled:)
+          @devtools.send_cmd('Page.setInterceptFileChooserDialog',
+                             enabled: enabled)
+        end
+
+      end # Page
+    end # DevTools
+  end # WebDriver
+end # Selenium