Removes SeleniumLibrary Firefox profile (robotframework#885)

aaltat · web-flow · commit 091e35988780 · 2017-09-07T00:02:23.000+03:00
* Removes SeleniumLibrary Firefox profile The SeleniumLibrary default Firefox profile is now removed. When Firefox created and if Firefox profile is not defined, then the default Selenium FirefoxProfile is used. Updated Open Browser keyword documentation when the FF profile has changed. Adds namedtuple which contains selenium version Fixes based on the comments Fixes robotframework#883
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -7,5 +7,4 @@ exclude */*.rst # limit previous command to include only *.rst files in root fol
 include docs/SeleniumLibrary.html
 
 recursive-include src *.py
-graft src/SeleniumLibrary/resources
 recursive-exclude src *.pyc
diff --git a/src/SeleniumLibrary/base/librarycomponent.py b/src/SeleniumLibrary/base/librarycomponent.py
@@ -14,9 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+
 from robot.api import logger
+from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
 
 from .context import ContextAware
+from .robotlibcore import PY2
 
 
 LOG_LEVELS = ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR']
@@ -56,3 +60,13 @@ def assert_page_not_contains(self, locator, tag=None, message=None,
                                  loglevel='INFO'):
         self.element_finder.assert_page_not_contains(locator, tag, message,
                                                      loglevel)
+
+    @property
+    def log_dir(self):
+        try:
+            logfile = BuiltIn().get_variable_value('${LOG FILE}')
+            if logfile == 'NONE':
+                return BuiltIn().get_variable_value('${OUTPUTDIR}')
+            return os.path.dirname(logfile)
+        except RobotNotRunningError:
+            return os.getcwdu() if PY2 else os.getcwd()
diff --git a/src/SeleniumLibrary/keywords/browsermanagement.py b/src/SeleniumLibrary/keywords/browsermanagement.py
@@ -25,7 +25,8 @@
 from SeleniumLibrary.base import LibraryComponent, keyword
 from SeleniumLibrary.locators.windowmanager import WindowManager
 from SeleniumLibrary.utils import (is_truthy, is_falsy,
-                                   secs_to_timestr, timestr_to_secs)
+                                   secs_to_timestr, timestr_to_secs,
+                                   SELENIUM_VERSION)
 
 
 ROOT_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
@@ -126,7 +127,11 @@ def open_browser(
         (created with 'Create Dictionary') to allow for more complex configurations.
 
         Optional 'ff_profile_dir' is the path to the firefox profile dir if you
-        wish to overwrite the default.
+        wish to overwrite the default. Starting from SeleniumLibrary 3.0.0
+        the SeleniumLibrary does not anymore contain own profile, instead
+        Selenium
+        [https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.firefox_profile.html|webdriver.FirefoxProfile()]
+        is used.
         """
         if is_truthy(remote_url):
             self.info("Opening browser '%s' to base url '%s' through "
@@ -601,16 +606,17 @@ def _make_browser(self, browser_name, desired_capabilities=None,
         return browser
 
     def _make_ff(self, remote, desired_capabilites, profile_dir):
-
         if is_falsy(profile_dir):
-            profile_dir = FIREFOX_PROFILE_DIR
-        profile = webdriver.FirefoxProfile(profile_dir)
+            profile = webdriver.FirefoxProfile()
+        else:
+            profile = webdriver.FirefoxProfile(profile_dir)
         if is_truthy(remote):
             browser = self._create_remote_web_driver(
                 webdriver.DesiredCapabilities.FIREFOX, remote,
                 desired_capabilites, profile)
         else:
-            browser = webdriver.Firefox(firefox_profile=profile)
+            browser = webdriver.Firefox(firefox_profile=profile,
+                                        **self._geckodriver_log_config)
         return browser
 
     def _make_ie(self, remote, desired_capabilities, profile_dir):
@@ -718,3 +724,9 @@ def _log_list(self, items, what='item'):
             msg.append('{}: {}'.format(index + 1, item))
         self.info('\n'.join(msg))
         return items
+
+    @property
+    def _geckodriver_log_config(self):
+        if SELENIUM_VERSION.major == '3':
+            return {'log_path': os.path.join(self.log_dir, 'geckodriver.log')}
+        return {}
diff --git a/src/SeleniumLibrary/keywords/screenshot.py b/src/SeleniumLibrary/keywords/screenshot.py
@@ -18,7 +18,6 @@
 import os
 import re
 
-from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
 from robot.utils import get_link_path
 
 from SeleniumLibrary.base import LibraryComponent, keyword
@@ -147,7 +146,7 @@ def _get_screenshot_directory(self):
             return self.screenshot_root_directory
 
         # Otherwise use RF's log directory
-        return self._get_log_dir()
+        return self.log_dir
 
     # should only be called by set_screenshot_directory
     def _restore_screenshot_directory(self):
@@ -170,24 +169,12 @@ def _get_screenshot_paths(self, filename_template):
                     index=self._get_screenshot_index(filename_template))
 
         filename = filename.replace('/', os.sep)
-        logdir = self._get_log_dir()
         path = os.path.join(screenshotdir, filename)
-        link = get_link_path(path, logdir)
+        link = get_link_path(path, self.log_dir)
         return path, link
 
     def _get_screenshot_index(self, filename):
         if filename not in self._screenshot_index:
             self._screenshot_index[filename] = 0
         self._screenshot_index[filename] += 1
         return self._screenshot_index[filename]
-
-    def _get_log_dir(self):
-        try:
-            logfile = BuiltIn().get_variable_value('${LOG FILE}')
-        except RobotNotRunningError:
-            logfile = os.getcwd()
-        if logfile != 'NONE':
-            logdir = os.path.dirname(logfile)
-        else:
-            logdir = BuiltIn().get_variable_value('${OUTPUTDIR}')
-        return logdir
diff --git a/src/SeleniumLibrary/resources/firefoxprofile/localstore.rdf b/src/SeleniumLibrary/resources/firefoxprofile/localstore.rdf
diff --git a/src/SeleniumLibrary/resources/firefoxprofile/prefs.js b/src/SeleniumLibrary/resources/firefoxprofile/prefs.js
diff --git a/src/SeleniumLibrary/utils/__init__.py b/src/SeleniumLibrary/utils/__init__.py
@@ -19,6 +19,7 @@
 from .browsercache import BrowserCache
 from .deprecated import Deprecated
 from .librarylistener import LibraryListener
+from .seleniumversion import SELENIUM_VERSION
 from .types import is_string, is_truthy, is_falsy
 
 
diff --git a/src/SeleniumLibrary/utils/seleniumversion.py b/src/SeleniumLibrary/utils/seleniumversion.py
@@ -0,0 +1,23 @@
+# Copyright 2008-2011 Nokia Networks
+# Copyright 2011-2016 Ryan Tomac, Ed Manlove and contributors
+# Copyright 2016-     Robot Framework Foundation
+#
+# 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.
+
+from collections import namedtuple
+
+import selenium
+
+SeleniumVersion = namedtuple('SeleniumVersion', 'major minor micro')
+major, minor, micro = (selenium.__version__.split('.') + ['0', '0'])[:3]
+SELENIUM_VERSION = SeleniumVersion(major=major, minor=minor, micro=micro)
