[rb] implement proxy support for Selenium Manager

titusfortner · titusfortner · commit ed313de742b6 · 2023-05-13T21:45:22.000-05:00
diff --git a/rb/lib/selenium/webdriver/common/logger.rb b/rb/lib/selenium/webdriver/common/logger.rb
@@ -41,7 +41,7 @@ class Logger
                      :debug?,
                      :info?,
                      :warn?,
-                     :error, :error?,
+                     :error?,
                      :fatal, :fatal?,
                      :level
 
@@ -137,6 +137,17 @@ def info(message, id: [], &block)
         discard_or_log(:info, message, id, &block)
       end
 
+      #
+      # Used to supply information that suggests an error occurred
+      #
+      # @param [String] message
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield see #deprecate
+      #
+      def error(message, id: [], &block)
+        discard_or_log(:error, message, id, &block)
+      end
+
       #
       # Used to supply information that suggests action be taken by user
       #
diff --git a/rb/lib/selenium/webdriver/common/selenium_manager.rb b/rb/lib/selenium/webdriver/common/selenium_manager.rb
@@ -40,6 +40,18 @@ def driver_path(options)
             raise ArgumentError, "SeleniumManager requires a WebDriver::Options instance, not #{options.inspect}"
           end
 
+          command = generate_command(binary, options)
+
+          location = run(*command)
+          WebDriver.logger.debug("Driver found at #{location}", id: :selenium_manager)
+          Platform.assert_executable location
+
+          location
+        end
+
+        private
+
+        def generate_command(binary, options)
           command = [binary, '--browser', options.browser_name, '--output', 'json']
           if options.browser_version
             command << '--browser-version'
@@ -49,17 +61,14 @@ def driver_path(options)
             command << '--browser-path'
             command << options.binary.gsub('\\', '\\\\\\')
           end
+          if options.proxy
+            command << '--proxy'
+            (command << options.proxy.ssl) || options.proxy.http
+          end
           command << '--debug' if WebDriver.logger.debug?
-
-          location = run(*command)
-          WebDriver.logger.debug("Driver found at #{location}", id: :selenium_manager)
-          Platform.assert_executable location
-
-          location
+          command
         end
 
-        private
-
         # @return [String] the path to the correct selenium manager
         def binary
           @binary ||= begin
@@ -92,12 +101,12 @@ def run(*command)
             raise Error::WebDriverError, "Unsuccessful command executed: #{command}", e.message
           end
 
-          if status.exitstatus.positive?
-            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
+          (json_output&.fetch('logs') || []).each do |log|
+            WebDriver.logger.send(log['level'].downcase, log['message'], id: :selenium_manager)
           end
 
-          json_output['logs'].each do |log|
-            WebDriver.logger.send(log['level'].downcase, log['message'], id: :selenium_manager)
+          if status.exitstatus.positive?
+            raise Error::WebDriverError, "Unsuccessful command executed: #{command}\n#{result}#{stderr}"
           end
 
           result
diff --git a/rb/spec/unit/selenium/webdriver/common/selenium_manager_spec.rb b/rb/spec/unit/selenium/webdriver/common/selenium_manager_spec.rb
@@ -106,7 +106,28 @@ def stub_binary(binary)
           }.to have_warning(:selenium_manager)
 
           expect(described_class).to have_received(:run)
-            .with('selenium-manager', '--browser', 'chrome', '--output', 'json', '--browser-version', 1)
+            .with('selenium-manager',
+                  '--browser', 'chrome',
+                  '--output', 'json',
+                  '--browser-version', 1)
+        end
+
+        it 'uses proxy if specified' do
+          proxy = Selenium::WebDriver::Proxy.new(ssl: 'proxy')
+          allow(described_class).to receive(:run)
+          allow(described_class).to receive(:binary).and_return('selenium-manager')
+          allow(Platform).to receive(:assert_executable)
+          options = Options.chrome(proxy: proxy)
+
+          expect {
+            described_class.driver_path(options)
+          }.to have_warning(:selenium_manager)
+
+          expect(described_class).to have_received(:run)
+            .with('selenium-manager',
+                  '--browser', 'chrome',
+                  '--output', 'json',
+                  '--proxy', 'proxy')
         end
 
         it 'uses browser location if specified' do
