Firefox profile dir (#1401)

Support for FirefoxProfile instance for Open Browser keyword

Author: aaltat

src/SeleniumLibrary/keywords/browsermanagement.py

@@ -115,7 +115,9 @@ def open_browser(self, url, browser='firefox', alias=None,
         Optional ``ff_profile_dir`` is the path to the Firefox profile
         directory if you wish to overwrite the default profile Selenium
         uses. Notice that prior to SeleniumLibrary 3.0, the library
-        contained its own profile that was used by default.
+        contained its own profile that was used by default. The
+        ``ff_profile_dir`` can also be instance of the
+        [https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.firefox_profile.html?highlight=firefoxprofile#selenium.webdriver.firefox.firefox_profile.FirefoxProfile|selenium.webdriver.FirefoxProfile].
 
         Optional ``service_log_path`` argument defines the name of the
         file where to write the browser driver logs. If the
@@ -149,7 +151,9 @@ def open_browser(self, url, browser='firefox', alias=None,
 
         Using ``alias`` to decide, is the new browser opened is new
         in SeleniumLibrary 4.0. Also the ``service_log_path`` is new
-        in SeleniumLibrary 4.0.
+        in SeleniumLibrary 4.0. Support for ``ff_profile_dir`` accepting
+        instance of the `selenium.webdriver.FirefoxProfile` is new in
+        SeleniumLibrary 4.0.
         """
         index = self.drivers.get_index(alias)
         if index:

src/SeleniumLibrary/keywords/webdrivertools.py

@@ -20,6 +20,7 @@
 from robot.api import logger
 from robot.utils import ConnectionCache
 from selenium import webdriver
+from selenium.webdriver import FirefoxProfile
 
 from SeleniumLibrary.utils import is_falsy, is_truthy, is_noney
 
@@ -122,6 +123,8 @@ def create_firefox(self, desired_capabilities, remote_url, ff_profile_dir, optio
                                  **desired_capabilities)
 
     def _get_ff_profile(self, ff_profile_dir):
+        if isinstance(ff_profile_dir, FirefoxProfile):
+            return ff_profile_dir
         if is_falsy(ff_profile_dir):
             return webdriver.FirefoxProfile()
         return webdriver.FirefoxProfile(ff_profile_dir)

utest/test/keywords/test_webdrivercreator.py

@@ -186,6 +186,24 @@ def test_firefox(self):
         self.assertEqual(driver, expected_webdriver)
         verify(webdriver).FirefoxProfile()
 
+    def test_get_ff_profile_real_path(self):
+        profile_path = '/path/to/profile'
+        profile_mock = mock()
+        when(webdriver).FirefoxProfile(profile_path).thenReturn(profile_mock)
+        profile = self.creator._get_ff_profile(profile_path)
+        self.assertEqual(profile, profile_mock)
+
+    def test_get_ff_profile_no_path(self):
+        profile_mock = mock()
+        when(webdriver).FirefoxProfile().thenReturn(profile_mock)
+        profile = self.creator._get_ff_profile(None)
+        self.assertEqual(profile, profile_mock)
+
+    def test_get_ff_profile_instance_FirefoxProfile(self):
+        input_profile = webdriver.FirefoxProfile()
+        profile = self.creator._get_ff_profile(input_profile)
+        self.assertEqual(profile, input_profile)
+
     def test_firefox_remote_no_caps(self):
         url = 'http://localhost:4444/wd/hub'
         profile = mock()