[rb] move chromium based logging from Manager to Driver Extension

Author: titusfortner

rb/lib/selenium/webdriver/chrome/driver.rb

@@ -33,6 +33,7 @@ class Driver < WebDriver::Driver
         include DriverExtensions::DownloadsFiles
         include DriverExtensions::HasDevTools
         include DriverExtensions::HasAuthentication
+        include DriverExtensions::HasLogs
         include DriverExtensions::HasLogEvents
         include DriverExtensions::PrintsPage
 

rb/lib/selenium/webdriver/chrome/options.rb

@@ -21,7 +21,7 @@ module Selenium
   module WebDriver
     module Chrome
       class Options < WebDriver::Options
-        attr_accessor :profile
+        attr_accessor :profile, :logging_prefs
 
         KEY = 'goog:chromeOptions'
         BROWSER = 'chrome'
@@ -80,6 +80,7 @@ def initialize(profile: nil, **opts)
                       perf_logging_prefs: {},
                       window_types: []}.merge(@options)
 
+          @logging_prefs = options.delete(:logging_prefs) || {}
           @encoded_extensions = @options.delete(:encoded_extensions) || []
           @extensions = []
           (@options.delete(:extensions)).each(&method(:validate_extension))
@@ -194,7 +195,13 @@ def add_emulation(**opts)
 
         private
 
+        def enable_logging(browser_options)
+          browser_options['goog:loggingPrefs'] = @logging_prefs
+        end
+
         def process_browser_options(browser_options)
+          enable_logging(browser_options) unless @logging_prefs.empty?
+
           options = browser_options[self.class::KEY]
           options['binary'] ||= binary_path if binary_path
           if @profile

rb/lib/selenium/webdriver/common.rb

@@ -64,6 +64,7 @@
 require 'selenium/webdriver/common/driver_extensions/has_addons'
 require 'selenium/webdriver/common/driver_extensions/has_devtools'
 require 'selenium/webdriver/common/driver_extensions/has_authentication'
+require 'selenium/webdriver/common/driver_extensions/has_logs'
 require 'selenium/webdriver/common/driver_extensions/has_log_events'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/profile_helper'

rb/lib/selenium/webdriver/common/driver_extensions/has_logs.rb

@@ -0,0 +1,30 @@
+# 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.
+
+module Selenium
+  module WebDriver
+    module DriverExtensions
+      module HasLogs
+        def logs
+          @logs ||= Logs.new(@bridge)
+        end
+      end # HasLogs
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

rb/lib/selenium/webdriver/common/manager.rb

@@ -109,6 +109,7 @@ def timeouts
       #
 
       def logs
+        WebDriver.logger.deprecate('Manager#logs', 'Chrome::Driver#logs')
         @logs ||= Logs.new(@bridge)
       end
 

rb/lib/selenium/webdriver/edge/options.rb

@@ -26,6 +26,12 @@ class Options < Selenium::WebDriver::Chrome::Options
         KEY = 'ms:edgeOptions'
         BROWSER = 'MicrosoftEdge'
 
+        protected
+
+        def enable_logging(browser_options)
+          browser_options['ms:loggingPrefs'] = @logging_prefs
+        end
+
         private
 
         def binary_path

rb/spec/integration/selenium/webdriver/chrome/driver_spec.rb

@@ -80,6 +80,43 @@ module Chrome
             end
           end
         end
+
+        describe '#logs' do
+          before do
+            quit_driver
+            options = Options.new(logging_prefs: {browser: 'ALL',
+                                                  driver: 'ALL',
+                                                  performance: 'ALL'})
+            create_driver!(capabilities: options)
+            driver.navigate.to url_for('errors.html')
+          end
+
+          after(:all) { quit_driver }
+
+          it 'can fetch available log types' do
+            expect(driver.logs.available_types).to include(:performance, :browser, :driver)
+          end
+
+          it 'can get the browser log' do
+            driver.find_element(tag_name: 'input').click
+
+            entries = driver.logs.get(:browser)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+
+          it 'can get the driver log' do
+            entries = driver.logs.get(:driver)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+
+          it 'can get the performance log' do
+            entries = driver.logs.get(:performance)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+        end
       end
     end # Chrome
   end # WebDriver

rb/spec/integration/selenium/webdriver/devtools_spec.rb

@@ -25,9 +25,9 @@ module WebDriver
       let(:username) { SpecSupport::RackServer::TestApp::BASIC_AUTH_CREDENTIALS.first }
       let(:password) { SpecSupport::RackServer::TestApp::BASIC_AUTH_CREDENTIALS.last }
 
-      after do
-        quit_driver
-      end
+      before(:all) { quit_driver }
+
+      after { reset_driver! }
 
       it 'sends commands' do
         driver.devtools.page.navigate(url: url_for('xhtmlTest.html'))
@@ -40,6 +40,7 @@ module WebDriver
         driver.devtools.page.enable
         driver.devtools.page.on(:load_event_fired) { callback.call }
         driver.navigate.to url_for('xhtmlTest.html')
+        sleep 0.5
 
         expect(callback).to have_received(:call)
       end
@@ -68,11 +69,15 @@ module WebDriver
         driver.navigate.to url_for('javascriptPage.html')
 
         driver.execute_script("console.log('I like cheese');")
+        sleep 0.5
         driver.execute_script("console.log(true);")
+        sleep 0.5
         driver.execute_script("console.log(null);")
+        sleep 0.5
         driver.execute_script("console.log(undefined);")
+        sleep 0.5
         driver.execute_script("console.log(document);")
-        wait.until { logs.size == 5 }
+        sleep 0.5
 
         expect(logs).to include(
           an_object_having_attributes(type: :log, args: ['I like cheese']),

rb/spec/integration/selenium/webdriver/edge/driver_spec.rb

@@ -52,6 +52,43 @@ module Edge
             driver.execute_cdp('Page.removeScriptToEvaluateOnNewDocument', identifier: res['identifier'])
           end
         end
+
+        describe '#logs' do
+          before do
+            quit_driver
+            options = Options.new(logging_prefs: {browser: 'ALL',
+                                                  driver: 'ALL',
+                                                  performance: 'ALL'})
+            create_driver!(capabilities: options)
+            driver.navigate.to url_for('errors.html')
+          end
+
+          after(:all) { quit_driver }
+
+          it 'can fetch available log types' do
+            expect(driver.logs.available_types).to include(:performance, :browser, :driver)
+          end
+
+          it 'can get the browser log' do
+            driver.find_element(tag_name: 'input').click
+
+            entries = driver.logs.get(:browser)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+
+          it 'can get the driver log' do
+            entries = driver.logs.get(:driver)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+
+          it 'can get the performance log' do
+            entries = driver.logs.get(:performance)
+            expect(entries).not_to be_empty
+            expect(entries.first).to be_kind_of(LogEntry)
+          end
+        end
       end
     end # Edge
   end # WebDriver

rb/spec/integration/selenium/webdriver/manager_spec.rb

@@ -22,36 +22,6 @@
 module Selenium
   module WebDriver
     describe Manager do
-      describe 'logs', except: [{browser: %i[firefox ie safari safari_preview]},
-                                {driver: :remote, browser: %i[chrome edge]}] do
-        it 'can fetch remote log types', only: {driver: :remote} do
-          expect(driver.manage.logs.available_types).to include(:server, :browser, :driver)
-        end
-
-        it 'can fetch available log types', except: {driver: :remote} do
-          expect(driver.manage.logs.available_types).to include(:browser, :driver)
-          expect(driver.manage.logs.available_types).not_to include(:server)
-        end
-
-        it 'can get the browser log' do
-          driver.navigate.to url_for('errors.html')
-          driver.find_element(tag_name: 'input').click
-
-          entries = driver.manage.logs.get(:browser)
-          expect(entries).not_to be_empty
-          expect(entries.first).to be_kind_of(LogEntry)
-        end
-
-        # Chrome - turned off by default
-        it 'can get the driver log', except: {browser: %i[chrome edge]} do
-          driver.navigate.to url_for('simpleTest.html')
-
-          entries = driver.manage.logs.get(:driver)
-          expect(entries).not_to be_empty
-          expect(entries.first).to be_kind_of(LogEntry)
-        end
-      end
-
       describe 'cookie management' do
         after { driver.manage.delete_all_cookies }