Move WebDriverCache and WebDriverCreator under same module (#1046)

The WebDriverCache and WebDriverCreator are moved
to under keywords.webdrivertools module.

Fixes #1040

Author: aaltat

src/SeleniumLibrary/__init__.py

@@ -33,10 +33,10 @@
                                       SelectElementKeywords,
                                       TableElementKeywords,
                                       WaitingKeywords,
+                                      WebDriverCache,
                                       WindowKeywords)
 from SeleniumLibrary.locators import ElementFinder
-from SeleniumLibrary.utils import (Deprecated, LibraryListener, timestr_to_secs,
-                                   WebDriverCache)
+from SeleniumLibrary.utils import Deprecated, LibraryListener, timestr_to_secs
 
 
 __version__ = '3.0.2.dev1'

src/SeleniumLibrary/keywords/__init__.py

@@ -26,5 +26,6 @@
 from .selectelement import SelectElementKeywords
 from .tableelement import TableElementKeywords
 from .waiting import WaitingKeywords
-from .webdrivercreator import WebDriverCreator
+from .webdrivertools import WebDriverCache
+from .webdrivertools import WebDriverCreator
 from .window import WindowKeywords

src/SeleniumLibrary/keywords/browsermanagement.py

@@ -24,7 +24,7 @@
 from SeleniumLibrary.utils import (is_truthy, is_noney, secs_to_timestr,
                                    timestr_to_secs)
 
-from .webdrivercreator import WebDriverCreator
+from .webdrivertools import WebDriverCreator
 
 
 class BrowserManagementKeywords(LibraryComponent):
@@ -93,12 +93,13 @@ def open_browser(self, url, browser='firefox', alias=None,
         opened, and reset back to 1 when `Close All Browsers` is called.
         See `Switch Browser` for more information and examples.
 
-        Optional ``remote_url`` is the URL for a remote Selenium server. If
-        you specify a value for a remote, you can also specify
-        ``desired_capabilities`` to configure, for example, a proxy server
-        for Internet Explorer or a browser and operating system when using
-        [http://saucelabs.com|Sauce Labs]. Desired capabilities can be given
-        either as a Python dictionary or as a string in format
+        Optional ``remote_url`` is the URL for a
+        [https://github.com/SeleniumHQ/selenium/wiki/Grid2|Selenium Grid].
+
+        Optional ``desired_capabilities`` can be used to configure, for example,
+        logging preferences for a browser or a browser and operating system
+        when using [http://saucelabs.com|Sauce Labs]. Desired capabilities can
+        be given either as a Python dictionary or as a string in format
         ``key1:value1,key2:value2``.
         [https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities|
         Selenium documentation] lists possible capabilities that can be
@@ -117,6 +118,9 @@ def open_browser(self, url, browser='firefox', alias=None,
         If the provided configuration options are not enough, it is possible
         to use `Create Webdriver` to customize browser initialization even
         more.
+
+        Applying ``desired_capabilities`` argument also for local browser is
+        new in SeleniumLibrary 3.1.
         """
         if is_truthy(remote_url):
             self.info("Opening browser '%s' to base url '%s' through "

…niumLibrary/keywords/webdrivercreator.py …leniumLibrary/keywords/webdrivertools.pysrc/SeleniumLibrary/keywords/webdrivercreator.py renamed to src/SeleniumLibrary/keywords/webdrivertools.py src/SeleniumLibrary/keywords/webdrivercreator.py renamed to src/SeleniumLibrary/keywords/webdrivertools.py

@@ -14,9 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import copy
 import os
 
+from robot.utils import ConnectionCache
 from selenium import webdriver
 
 from SeleniumLibrary.utils import is_falsy, is_truthy, SELENIUM_VERSION
@@ -80,15 +80,16 @@ def create_chrome(self, desired_capabilities, remote_url, options=None):
             return self._remote(default, desired_capabilities, remote_url)
         capabilities = self._combine_capabilites(default, desired_capabilities)
         if SELENIUM_VERSION.major >= '3' and SELENIUM_VERSION.minor >= '8':
-            return webdriver.Chrome(desired_capabilities=capabilities, options=options)
+            return webdriver.Chrome(desired_capabilities=capabilities,
+                                    options=options)
         return webdriver.Chrome(desired_capabilities=capabilities)
 
     def create_headless_chrome(self, desired_capabilities, remote_url):
         if SELENIUM_VERSION.major >= '3' and SELENIUM_VERSION.minor >= '8':
             options = webdriver.ChromeOptions()
             options.set_headless()
         else:
-            options=None
+            options = None
         return self.create_chrome(desired_capabilities, remote_url, options)
 
     def create_firefox(self, desired_capabilities, remote_url, ff_profile_dir,
@@ -191,3 +192,36 @@ def _combine_capabilites(self, default, user):
         default = default.copy()
         default.update(user)
         return default
+
+
+class WebDriverCache(ConnectionCache):
+
+    def __init__(self):
+        ConnectionCache.__init__(self, no_current_msg='No current browser')
+        self._closed = set()
+
+    @property
+    def drivers(self):
+        return self._connections
+
+    @property
+    def active_drivers(self):
+        open_drivers = []
+        for driver in self._connections:
+            if driver not in self._closed:
+                open_drivers.append(driver)
+        return open_drivers
+
+    def close(self):
+        if self.current:
+            driver = self.current
+            driver.quit()
+            self.current = self._no_current
+            self._closed.add(driver)
+
+    def close_all(self):
+        for driver in self._connections:
+            if driver not in self._closed:
+                driver.quit()
+        self.empty_cache()
+        return self.current

test/unit/utils/test_webdrivercache.py test/unit/keywords/test_webdrivercache.pytest/unit/utils/test_webdrivercache.py renamed to test/unit/keywords/test_webdrivercache.py

@@ -2,7 +2,7 @@
 
 from mockito import mock, verify
 
-from SeleniumLibrary.utils import WebDriverCache
+from SeleniumLibrary.keywords import WebDriverCache
 
 
 class WebDriverCacheTests(unittest.TestCase):