Add service handler and minimal update to driver to use service

Author: AutomatedTester

Diff for: py/selenium/webdriver/firefox/service.py

@@ -0,0 +1,113 @@
+#!/usr/bin/python
+#
+# Copyright 2011 Webdriver_name committers
+# Copyright 2011 Google Inc.
+#
+# Licensed 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.
+import os
+import subprocess
+from subprocess import PIPE
+import time
+
+from selenium.common.exceptions import WebDriverException
+from selenium.webdriver.common import utils
+
+class Service(object):
+    """
+    Object that manages the starting and stopping of the GeckoDriver
+    """
+
+    def __init__(self, executable_path, firefox_binary=None, port=0, service_args=None,
+                 log_path=None, env=None):
+        """
+        Creates a new instance of the Service
+
+        :Args:
+         - executable_path : Path to the GeckoDriver
+         - port : Port the service is running on
+         - service_args : List of args to pass to the Geckodriver service
+         - log_path : Path for the GeckoDriver service to log to"""
+
+        self.port = port
+        self.path = executable_path
+        self.firefox_binary = firefox_binary
+        self.service_args = service_args or []
+
+        if self.port == 0:
+            self.port = utils.free_port()
+        self.env = env
+
+    def start(self):
+        """
+        Starts the GeckoDriver "wires" Service.
+
+        :Exceptions:
+         - WebDriverException : Raised either when it can't start the service
+           or when it can't connect to the service
+        """
+        env = self.env or os.environ
+        try:
+            #import pdb; pdb.set_trace()
+            self.process = subprocess.Popen([
+              self.path,
+              "-b", self.firefox_binary, '--webdriver-port', "%d" % self.port],
+              env=env, stdout=PIPE)
+        except Exception as e:
+            raise WebDriverException(
+                "'" + os.path.basename(self.path) + "' executable needs to be \
+                available in the path.\n %s" % str(e))
+        count = 0
+        while not utils.is_connectable(self.port):
+            count += 1
+            time.sleep(1)
+            if count == 30:
+                raise WebDriverException("Can not connect to the '" +
+                                         os.path.basename(self.path) + "'")
+
+    @property
+    def service_url(self):
+        """
+        Gets the url of the GeckoDriver Service
+        """
+        return "http://localhost:%d" % self.port
+
+    def stop(self):
+        """
+        Tells the GeckoDriver to stop and cleans up the process
+        """
+        #If its dead dont worry
+        if self.process is None:
+            return
+
+        #Tell the Server to die!
+        '''try:
+            from urllib import request as url_request
+        except ImportError:
+            import urllib2 as url_request
+
+        url_request.urlopen("http://127.0.0.1:%d/shutdown" % self.port)
+        count = 0
+        while utils.is_connectable(self.port):
+            if count == 30:
+               break
+            count += 1
+            time.sleep(1)
+        '''
+        #Tell the Server to properly die in case
+        try:
+            if self.process:
+                self.process.kill()
+                self.process.wait()
+        except OSError:
+            # kill may not be available under windows environment
+            pass

Diff for: py/selenium/webdriver/firefox/webdriver.py

@@ -25,6 +25,7 @@
 import socket
 import sys
 from .firefox_binary import FirefoxBinary
+from .service import Service
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.firefox.extension_connection import ExtensionConnection
 from selenium.webdriver.firefox.firefox_profile import FirefoxProfile
@@ -36,8 +37,8 @@ class WebDriver(RemoteWebDriver):
     # There is no native event support on Mac
     NATIVE_EVENTS_ALLOWED = sys.platform != "darwin"
 
-    def __init__(self, firefox_profile=None, firefox_binary=None, timeout=30,
-                 capabilities=None, proxy=None):
+    def __init__(self, firefox_profile=None, firefox_binary='/Users/dburns/development/mozilla/mozilla-inbound/obj-ff-dbg/dist/Nightly.app/Contents/MacOS/firefox', timeout=30,
+                 capabilities=None, proxy=None, executable_path='wires'):
 
         self.binary = firefox_binary
         self.profile = firefox_profile
@@ -57,9 +58,11 @@ def __init__(self, firefox_profile=None, firefox_binary=None, timeout=30,
         if proxy is not None:
             proxy.add_to_capabilities(capabilities)
 
+        self.service = Service(executable_path, firefox_binary=self.binary)
+        self.service.start()
+
         RemoteWebDriver.__init__(self,
-            command_executor=ExtensionConnection("127.0.0.1", self.profile,
-            self.binary, timeout),
+            command_executor=self.service.service_url,
             desired_capabilities=capabilities,
             keep_alive=True)
         self._is_remote = False
@@ -72,13 +75,13 @@ def quit(self):
             # Happens if Firefox shutsdown before we've read the response from
             # the socket.
             pass
-        self.binary.kill()
-        try:
+        self.service.stop()
+        '''try:
             shutil.rmtree(self.profile.path)
             if self.profile.tempfolder is not None:
                 shutil.rmtree(self.profile.tempfolder)
         except Exception as e:
-            print(str(e))
+            print(str(e))'''
 
     @property
     def firefox_profile(self):