rb: Extract Chrome service into a parent class that can be shared

Author: p0deje

rb/lib/selenium/webdriver/chrome/service.rb

@@ -25,12 +25,9 @@ module Chrome
       # @api private
       #
 
-      class Service
-        START_TIMEOUT       = 20
-        SOCKET_LOCK_TIMEOUT = 45
-        STOP_TIMEOUT        = 5
-        DEFAULT_PORT        = 9515
-        MISSING_TEXT        = "Unable to find the chromedriver executable. Please download the server from http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH. More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver."
+      class Service < WebDriver::Service
+        DEFAULT_PORT = 9515
+        MISSING_TEXT = "Unable to find the chromedriver executable. Please download the server from http://chromedriver.storage.googleapis.com/index.html and place it somewhere on your PATH. More info at https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver."
 
         def self.executable_path
           @executable_path ||= (
@@ -42,58 +39,12 @@ def self.executable_path
           )
         end
 
-        def self.executable_path=(path)
-          Platform.assert_executable path
-          @executable_path = path
-        end
-
         def self.default_service(*extra_args)
           new executable_path, DEFAULT_PORT, *extra_args
         end
 
-        def initialize(executable_path, port, *extra_args)
-          @executable_path = executable_path
-          @host            = Platform.localhost
-          @port            = Integer(port)
-
-          raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
-
-          @extra_args = extra_args
-        end
-
-        def start
-          Platform.exit_hook { stop } # make sure we don't leave the server running
-
-          socket_lock.locked do
-            find_free_port
-            start_process
-            connect_until_stable
-          end
-        end
-
-        def stop
-          return if @process.nil? || @process.exited?
-
-          Net::HTTP.start(@host, @port) do |http|
-            http.open_timeout = STOP_TIMEOUT / 2
-            http.read_timeout = STOP_TIMEOUT / 2
-
-            http.get("/shutdown")
-          end
-        ensure
-          stop_process
-        end
-
-        def uri
-          URI.parse "http://#{@host}:#{@port}"
-        end
-
         private
 
-        def find_free_port
-          @port = PortProber.above @port
-        end
-
         def start_process
           server_command = [@executable_path, "--port=#{@port}", *@extra_args]
           @process       = ChildProcess.build(*server_command)
@@ -102,12 +53,6 @@ def start_process
           @process.start
         end
 
-        def stop_process
-          @process.poll_for_exit STOP_TIMEOUT
-        rescue ChildProcess::TimeoutError
-          @process.stop STOP_TIMEOUT
-        end
-
         def connect_until_stable
           socket_poller = SocketPoller.new @host, @port, START_TIMEOUT
 
@@ -116,10 +61,6 @@ def connect_until_stable
           end
         end
 
-        def socket_lock
-          @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
-        end
-
       end # Service
     end # Chrome
   end # WebDriver

rb/lib/selenium/webdriver/common.rb

@@ -23,6 +23,7 @@
 require 'selenium/webdriver/common/proxy'
 require 'selenium/webdriver/common/log_entry'
 require 'selenium/webdriver/common/file_reaper'
+require 'selenium/webdriver/common/service'
 require 'selenium/webdriver/common/socket_lock'
 require 'selenium/webdriver/common/socket_poller'
 require 'selenium/webdriver/common/port_prober'

rb/lib/selenium/webdriver/common/service.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+#
+# 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
+
+    #
+    # @api private
+    #
+
+    class Service
+      START_TIMEOUT       = 20
+      SOCKET_LOCK_TIMEOUT = 45
+      STOP_TIMEOUT        = 5
+
+      def self.executable_path=(path)
+        Platform.assert_executable path
+        @executable_path = path
+      end
+
+      def initialize(executable_path, port, *extra_args)
+        @executable_path = executable_path
+        @host            = Platform.localhost
+        @port            = Integer(port)
+        @extra_args      = extra_args
+
+        raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1
+      end
+
+      def start
+        Platform.exit_hook { stop } # make sure we don't leave the server running
+
+        socket_lock.locked do
+          find_free_port
+          start_process
+          connect_until_stable
+        end
+      end
+
+      def stop
+        return if @process.nil? || @process.exited?
+
+        stop_server
+      ensure
+        stop_process
+      end
+
+      def uri
+        @uri ||= URI.parse("http://#{@host}:#{@port}")
+      end
+
+      private
+
+      def find_free_port
+        @port = PortProber.above(@port)
+      end
+
+      def start_process
+        raise NotImplementedError, "subclass responsibility"
+      end
+
+      def stop_server
+        Net::HTTP.start(@host, @port) do |http|
+          http.open_timeout = STOP_TIMEOUT / 2
+          http.read_timeout = STOP_TIMEOUT / 2
+
+          http.get("/shutdown")
+        end
+      end
+
+      def stop_process
+        @process.poll_for_exit STOP_TIMEOUT
+      rescue ChildProcess::TimeoutError
+        @process.stop STOP_TIMEOUT
+      end
+
+      def connect_until_stable
+        raise NotImplementedError, "subclass responsibility"
+      end
+
+      def socket_lock
+        @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
+      end
+
+    end # Chrome
+  end # WebDriver
+end # Service